This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


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

SQL Table Name: Security.KMIPServer

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DOMAIN = %Utility;
Default Localization Domain


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 methods: DBEncStartKeyListDisplayToLogical(), DBEncStartKeyListGet(), DBEncStartKeyListGetStored(), DBEncStartKeyListIsValid(), DBEncStartKeyListLogicalToDisplay(), DBEncStartKeyListLogicalToOdbc(), DBEncStartKeyListNormalize(), DBEncStartKeyListSet()
property Description as %String (MAXLEN = 256);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Flags as %Integer [ InitialExpression = 82 , Required ];
Flags argument to KMIP_CMD_new()
Property methods: FlagsDisplayToLogical(), FlagsGet(), FlagsGetStored(), FlagsIsValid(), FlagsLogicalToDisplay(), FlagsNormalize(), FlagsSet(), FlagsXSDToLogical()
property Host as %String (MAXLEN = 255) [ Required ];
Server host DNS name.
Property methods: HostDisplayToLogical(), HostGet(), HostGetStored(), HostIsValid(), HostLogicalToDisplay(), HostLogicalToOdbc(), HostNormalize(), HostSet()
property NBIO as %Boolean [ InitialExpression = 1 , Required ];
Non-blocking I/O.
Property methods: NBIODisplayToLogical(), NBIOGet(), NBIOGetStored(), NBIOIsValid(), NBIOLogicalToDisplay(), NBIOLogicalToXSD(), NBIONormalize(), NBIOSet(), NBIOXSDToLogical()
property Name as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Name of this KMIP Server.
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Port as %Integer [ InitialExpression = 5696 , Required ];
TCP port number. 5696 is the value assigned by the IANA.
Property methods: PortDisplayToLogical(), PortGet(), PortGetStored(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet(), PortXSDToLogical()
property Protocol as %Integer [ InitialExpression = 2 , Required ];
OASIS KMIP protocol version. Default is KMIP v1.2.
Property methods: ProtocolDisplayToLogical(), ProtocolGet(), ProtocolGetStored(), ProtocolIsValid(), ProtocolLogicalToDisplay(), ProtocolNormalize(), ProtocolSet(), ProtocolXSDToLogical()
property Reconnect as %Boolean [ InitialExpression = 0 , Required ];
Property methods: ReconnectDisplayToLogical(), ReconnectGet(), ReconnectGetStored(), ReconnectIsValid(), ReconnectLogicalToDisplay(), ReconnectLogicalToXSD(), ReconnectNormalize(), ReconnectSet(), ReconnectXSDToLogical()
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 methods: SSLConfigDisplayToLogical(), SSLConfigGet(), SSLConfigGetStored(), SSLConfigIsValid(), SSLConfigLogicalToDisplay(), SSLConfigLogicalToOdbc(), SSLConfigNormalize(), SSLConfigSet()
property Timeout as %Integer [ InitialExpression = 10 , Required ];
I/O timeout, in seconds.
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutGetStored(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutNormalize(), TimeoutSet(), TimeoutXSDToLogical()


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


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


index (NameIndex on Name) [IdKey, Type = key];
Index methods: NameIndexCheck(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheStorage (Security.KMIPServer)