Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [Security] >  [KMIPServer]
Private  Storage   

persistent class Security.KMIPServer extends %Persistent, %XML.Adaptor, %SYSTEM.Help

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 11 12 2 1


Summary

Properties
DBEncStartKeyList Description Flags Host
NBIO Name Port Protocol
Reconnect SSLConfig Timeout

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject Configure
Export Help Import XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters

• parameter DOMAIN = "%Utility";
Default Localization Domain

Properties

• property DBEncStartKeyList as %String(MAXLEN=9471);
Comma-delimited list of data encryption key IDs for activation at startup 256 36-character key IDs plus commas
• property Description as %String(MAXLEN=256);
• property Flags as %Integer [ InitialExpression = 82,Required ];
Flags argument to KMIP_CMD_new()
• property Host as %String(MAXLEN=255) [ Required ];
Server host DNS name.
• property NBIO as %Boolean [ InitialExpression = 1,Required ];
Non-blocking I/O.
• property Name as %String(MAXLEN=64,MINLEN=1) [ Required ];
Name of this KMIP Server.
• property Port as %Integer [ InitialExpression = 5696,Required ];
TCP port number. 5696 is the value assigned by the IANA.
• property Protocol as %Integer [ InitialExpression = 2,Required ];
OASIS KMIP protocol version. Default is KMIP v1.2.
• property Reconnect as %Boolean [ InitialExpression = 0,Required ];
Auto-reconnect.
• property SSLConfig as %String(MAXLEN=64,MINLEN=1) [ InitialExpression = "KMIP",Required ];
SSL/TLS configuration name. This must be a Client configuration with Server certificate verification set to Require and file(s) containing the client's X.509 certificate and associated private key.
• property Timeout as %Integer [ InitialExpression = 10,Required ];
I/O timeout, in seconds.

Methods

• method Configure() as %Status
• classmethod Export(FileName As %String = "KMIPServerExport.xml", ByRef NumExported As %Integer = 0, Name As %String = "*") as %Status
• classmethod Import(FileName As %String = "KMIPServerExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status

Queries

• query Detail(Names As %String = "*")
Selects Name As %String, Description As %String, Host As %String, Port As %Integer, Protocol As %Integer, SSLConfig As %String, NBIO As %Boolean, Reconnect As %Boolean, Timeout As %Integer, Flags As %Integer, DBEncStartKeyList As %String
List all KMIP Server records, brief display.
Names - Comma separated list of KMIP Server names, "*" = All
Note: This query may change in future versions
• query List(Names As %String)
Selects Name As %String, Description As %String
List all KMIP Server records, brief display.
Names - Comma separated list of KMIPServer names, "*" = All
Note: This query may change in future versions

Indices

•index (NameIndex on Name) [IdKey];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.