Click or drag to resize

KeyProviderKmip Class

KeyProviderKmip A Key Provider describes both a mechanism and a location for retrieving authentication keys for use with cluster features such as Encryption At Rest. Some Key Providers may imply that there can only be one Key Provider of that type, while others may allow multiple Key Providers of the same type but retrieving authentication keys from different locations for different purposes. A KMIP (Key Management Interoperability Protocol) Key Provider can represent a single KMIP server, a logical cluster of KMIP servers which should be kept in sync, or an actual cluster which we treat as a single server. There can be multiple KMIP Key Providers but they must contain mutually-exclusive sets of servers. Key UUID's will only be considered as unique within a Key Provider so there could be collisions (and resulting errors) otherwise.
Inheritance Hierarchy
SystemObject
  SolidFire.CoreRpcBase
    SolidFire.Element.ApiKeyProviderKmip

Namespace:  SolidFire.Element.Api
Assembly:  SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntax
C#
public class KeyProviderKmip : RpcBase

The KeyProviderKmip type exposes the following members.

Constructors
  NameDescription
Public methodKeyProviderKmip
Initializes a new instance of the KeyProviderKmip class
Top
Properties
  NameDescription
Public propertyKeyProviderID
The ID of the KMIP Key Provider. This is a unique value assigned by the cluster during CreateKeyProviderKmip which cannot be changed.
Public propertyKeyProviderIsActive
True if the KMIP Key Provider is active. A provider is considered active if are still outstanding keys which were created but not yet deleted and therefore assumed to still be in use.
Public propertyKeyProviderName
The name of the KMIP Key Provider.
Public propertyKeyServerIDs
A list of keyServerIDs which are grouped together within this provider. At least one server must be added via AddKeyServerToProviderKmip before this provider can become active. The last server cannot be removed via RemoveKeyServerFromProviderKmip or DeleteKeyServerKmip while this provider is active.
Public propertyKmipCapabilities
The capabilities of this KMIP Key Provider including details about the underlying library, FIPS compliance, SSL provider, etc.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.)
Top
See Also