Metrics Engine Documentation Index
Configuration Reference Home

Get Symmetric Key Extended Operation Handler

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

The Get Symmetric Key Extended Operation Handler is used by the cryptographic framework for creating and obtaining symmetric encryption keys.

Parent Component
Properties
dsconfig Usage

Parent Component

The Get Symmetric Key Extended Operation Handler component inherits from the Extended Operation Handler

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled

Basic Properties

description

Description
A description for this Extended Operation Handler
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Extended Operation Handler is enabled (that is, whether the types of extended operations are allowed in the server).
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Extended Operation Handlers:

dsconfig list-extended-operation-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Extended Operation Handler:

dsconfig get-extended-operation-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Extended Operation Handler:

dsconfig set-extended-operation-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Get Symmetric Key Extended Operation Handler:

dsconfig create-extended-operation-handler
     --handler-name {name}
     --type get-symmetric-key
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Extended Operation Handler:

dsconfig delete-extended-operation-handler
     --handler-name {name}