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 UnboundID support in order to understand the potential impact of that change.
The Random Password Generator creates random passwords based on fixed-length strings built from one or more character sets.
↓Parent Component
↓Properties
↓dsconfig Usage
The Random Password Generator component inherits from the Password Generator
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ password-character-set | |
| ↓ password-format |
| 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 | Specifies one or more named character sets. This is a multi-valued property, with each value defining a different character set. The format of the character set is the name of the set followed by a colon and the characters that are in that set. For example, the value "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named "alpha" containing all of the lower-case ASCII alphabetic characters. |
| Default Value | None |
| Allowed Values | A character set name (consisting of ASCII letters) followed by a colon and the set of characters that are included in that character set. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the format to use for the generated password. The value is a comma-delimited list of elements in which each of those elements is comprised of the name of a character set defined in the password-character-set property, a colon, and the number of characters to include from that set. For example, a value of "alpha:3,numeric:2,alpha:3" generates an 8-character password in which the first three characters are from the "alpha" set, the next two are from the "numeric" set, and the final three are from the "alpha" set. |
| Default Value | None |
| Allowed Values | A comma-delimited list whose elements comprise a valid character set name, a colon, and a positive integer indicating the number of characters from that set to be included. |
| 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 Random Password Generator:
dsconfig create-password-generator
--generator-name {name}
--type random
--set enabled:{propertyValue}
--set password-character-set:{propertyValue}
--set password-format:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Password Generator:
dsconfig delete-password-generator
--generator-name {name}