Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
Groovy Scripted Password Generator provide password generator implementations defined in a dynamically-loaded Groovy script which implements the ScriptedPasswordGenerator class defined in the UnboundID server SDK.
↓Parent Component
↓Properties
↓dsconfig Usage
The Groovy Scripted Password Generator component inherits from the Scripted Password Generator
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ script-argument | |
| ↓ script-class |
| Description | A description for this Password Generator |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Password Generator is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of arguments used to customize the behavior for the Scripted Password Generator. Each configuration property should be given in the form 'name=value'. |
| Default Value | None |
| Allowed Values | An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Password Generator. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Password Generators:
dsconfig list-password-generators
[--property {propertyName}] ...
To view the configuration for an existing Password Generator:
dsconfig get-password-generator-prop
--generator-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Password Generator:
dsconfig set-password-generator-prop
--generator-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Groovy Scripted Password Generator:
dsconfig create-password-generator
--generator-name {name}
--type groovy
--set enabled:{propertyValue}
--set script-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Password Generator:
dsconfig delete-password-generator
--generator-name {name}