dsconfig create-extended-operation-handler
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig create-extended-operation-handler — Creates Extended Operation Handlers

## Synopsis

`dsconfig create-extended-operation-handler` {options}

## Description

Creates Extended Operation Handlers.

## Options

The dsconfig create-extended-operation-handler command takes the following options:

`--handler-name {name}`

  The name of the new Extended Operation Handler.

  Extended Operation Handler properties depend on the Extended Operation Handler type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Extended Operation Handler types:

  cancel-extended-operation-handler

    Default {name}: Cancel Extended Operation Handler

    Enabled by default: true

    See the section called “Cancel Extended Operation Handler” for the properties of this Extended Operation Handler type.

  get-connection-id-extended-operation-handler

    Default {name}: Get Connection Id Extended Operation Handler

    Enabled by default: true

    See the section called “Get Connection Id Extended Operation Handler” for the properties of this Extended Operation Handler type.

  get-symmetric-key-extended-operation-handler

    Default {name}: Get Symmetric Key Extended Operation Handler

    Enabled by default: true

    See the section called “Get Symmetric Key Extended Operation Handler” for the properties of this Extended Operation Handler type.

  password-modify-extended-operation-handler

    Default {name}: Password Modify Extended Operation Handler

    Enabled by default: true

    See the section called “Password Modify Extended Operation Handler” for the properties of this Extended Operation Handler type.

  password-policy-state-extended-operation-handler

    Default {name}: Password Policy State Extended Operation Handler

    Enabled by default: true

    See the section called “Password Policy State Extended Operation Handler” for the properties of this Extended Operation Handler type.

  start-tls-extended-operation-handler

    Default {name}: Start TLS Extended Operation Handler

    Enabled by default: true

    See the section called “Start TLS Extended Operation Handler” for the properties of this Extended Operation Handler type.

  who-am-i-extended-operation-handler

    Default {name}: Who Am I Extended Operation Handler

    Enabled by default: true

    See the section called “Who Am I Extended Operation Handler” for the properties of this Extended Operation Handler type.

`--set {PROP:VALUE}`

  Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.

  Extended Operation Handler properties depend on the Extended Operation Handler type, which depends on the `--handler-name {name}` option.

`-t | --type {type}`

  The type of Extended Operation Handler which should be created. The value for TYPE can be one of: cancel | custom | get-connection-id | get-symmetric-key | password-modify | password-policy-state | start-tls | who-am-i.

  Extended Operation Handler properties depend on the Extended Operation Handler type, which depends on the {type} you provide.

  By default, OpenDJ directory server supports the following Extended Operation Handler types:

  cancel-extended-operation-handler

    Default {type}: Cancel Extended Operation Handler

    Enabled by default: true

    See the section called “Cancel Extended Operation Handler” for the properties of this Extended Operation Handler type.

  get-connection-id-extended-operation-handler

    Default {type}: Get Connection Id Extended Operation Handler

    Enabled by default: true

    See the section called “Get Connection Id Extended Operation Handler” for the properties of this Extended Operation Handler type.

  get-symmetric-key-extended-operation-handler

    Default {type}: Get Symmetric Key Extended Operation Handler

    Enabled by default: true

    See the section called “Get Symmetric Key Extended Operation Handler” for the properties of this Extended Operation Handler type.

  password-modify-extended-operation-handler

    Default {type}: Password Modify Extended Operation Handler

    Enabled by default: true

    See the section called “Password Modify Extended Operation Handler” for the properties of this Extended Operation Handler type.

  password-policy-state-extended-operation-handler

    Default {type}: Password Policy State Extended Operation Handler

    Enabled by default: true

    See the section called “Password Policy State Extended Operation Handler” for the properties of this Extended Operation Handler type.

  start-tls-extended-operation-handler

    Default {type}: Start TLS Extended Operation Handler

    Enabled by default: true

    See the section called “Start TLS Extended Operation Handler” for the properties of this Extended Operation Handler type.

  who-am-i-extended-operation-handler

    Default {type}: Who Am I Extended Operation Handler

    Enabled by default: true

    See the section called “Who Am I Extended Operation Handler” for the properties of this Extended Operation Handler type.

## Cancel Extended Operation Handler

Extended Operation Handlers of type cancel-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Cancel Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.CancelExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Get Connection Id Extended Operation Handler

Extended Operation Handlers of type get-connection-id-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Get Connection Id Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.GetConnectionIDExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Get Symmetric Key Extended Operation Handler

Extended Operation Handlers of type get-symmetric-key-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Get Symmetric Key Extended Operation Handler implementation.

  Default Value

    org.opends.server.crypto.GetSymmetricKeyExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Password Modify Extended Operation Handler

Extended Operation Handlers of type password-modify-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

identity-mapper
  Description

    Specifies the name of the identity mapper that should be used in conjunction with the password modify extended operation. This property is used to identify a user based on an authorization ID in the 'u:' form. Changes to this property take effect immediately.

  Default Value

    None

  Allowed Values

    The DN of any Identity Mapper. The referenced identity mapper must be enabled when the Password Modify Extended Operation Handler is enabled.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Password Modify Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.PasswordModifyExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Password Policy State Extended Operation Handler

Extended Operation Handlers of type password-policy-state-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Password Policy State Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.PasswordPolicyStateExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Start TLS Extended Operation Handler

Extended Operation Handlers of type start-tls-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Start TLS Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.StartTLSExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Who Am I Extended Operation Handler

Extended Operation Handlers of type who-am-i-extended-operation-handler have the following properties:

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

  Advanced Property

    No

  Read-only

    No

java-class
  Description

    Specifies the fully-qualified name of the Java class that provides the Who Am I Extended Operation Handler implementation.

  Default Value

    org.opends.server.extensions.WhoAmIExtendedOperation

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.api.ExtendedOperationHandler

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Extended Operation Handler must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

Prev | Up | Next
dsconfig create-entry-cache | Home | dsconfig create-group-implementation