add user
Adds a user to the Registry.
Synopsis
add user [-edit] [-load filename] [-firstname string] [-lastname string] [-middleName string] -alias string -keypass string [-post1.type string] [-post1.city string] [-post1.country string] [-post1.postalcode string] [-post1.stateOrProvince string] [-post1.street string] [-post2.streetNumber string] [-post2.type string] [-post2.city string] [-post2.country string] [-post2.postalcode string] [-post2.stateOrProvince string] [-post2.street string] [-post2.streetNumber string] [-post3.type string] [-post3.city string] [-post3.country string] [-post3.postalcode string] [-post3.stateOrProvince string] [-post3.street string] [-post3.streetNumber string] [-telephone1.type string] [-telephone1.areaCode string] [-telephone1.countryCode string] [-telephone1.extension string] [-telephone1.number string] [-telephone1.URL string] [-telephone2.type string] [-telephone2.areaCode string] [-telephone2.countryCode string] [-telephone2.extension string] [-telephone2.number string] [-telephone2.URL string] [-telephone3.type string] [-telephone3.areaCode string] [-telephone3.countryCode string] [-telephone3.extension string] [-telephone3.number string] [-telephone3.URL string] [-email1.type string] [-email1.address string] [-email2.type string] [-email12address string] [-email3.type string] [-email3.address string]Description
The add user command adds a User object. A User object normally contains at least one PostalAddress, TelephoneNumber, and EmailAddress object.
Specify the information about the user either on the command line itself or by using the -load option to specify a Java property file with the information. The information options and the -load option are evaluated in the order in which they appear on the command line. For example, you can specify some properties on the command line, load others from a property file, and then override information in the property file with later command-line options
You can specify up to three addresses, telephone numbers, and email addresses for a new user. If you need more, you can add them later using the Web Console or JAXR.
When you specify an address, telephone number, or email address, you must provide a value for its type: for example, -emailType OfficeEmail.
You can use shorthand options (such as -fn) on the command line for some of the common information that is required for every user. However, you must use the longer form when you provide the information in a property file. For example, you can specify the user’s first email address on the command line using either -email1.address, -emailAddress, or -email. However, when you specify the first email address in a property file, you must use email1.address=. Because there is only one option for the user’s second email address, you must use -email2.address on the command line and email2.address= in a property file.
If you specify the -edit option, the Admin Tool launches an editor so that you can edit the new user’s information. See the option description for details.
Note –
The property files that you load with -load or edit with -edit use the IS0-8859-1 charset, as do all Java property files. See the documentation for java.util.Properties.load(InputStream) for details on how to represent characters not in ISO-8859-1 in property files.
Options
- -edit
-
Causes the Admin Tool to launch an editor so that you can edit the new user’s information. The tool launches the editor after evaluating the other command-line parameters. Therefore, editing starts with the result of evaluating any information that was specified on the command line or in a property file. The editing program must terminate without error before the command can continue. The Admin Tool launches the editor specified by the set editor command (see set); by default, this is the vi editor.
Note –At this release, -edit works with emacsclient and the NetBeansTM command bin/runide.sh --open (but not very well), and has not been shown to work with vi.
- -load
-
Specifies a Java property file whose contents specify properties for the user. The property names are the same as the long forms of the add user command options (for example, lastName and post1.type).
- -fn | -firstName
-
Specifies the first name of a user.
- -ln | -lastName
-
Specifies the last name (surname) of a user. The last name, which is required, must be specified either on the command line or in a property file.
- -mn | -middleName
-
Specifies the middle name of a user.
- -alias
-
The alias to use when accessing the user’s certificate in the keystore. This option is required. The alias must be at least three characters long.
- -keypass
-
The password to use when accessing a user’s certificate in the keystore. This option is required. The password must be at least six characters long.
- -postalType | -post1.type
-
The type of the first PostalAddress. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).
- -city | -post1.city
-
The city of the first PostalAddress.
- -country | -post1.country
-
The country of the first PostalAddress.
- -postalCode | -postcode | -zip | -post1.postalcode
-
The postal code of the first PostalAddress.
- -stateOrProvince | -state | -province | -post1.stateOrProvince
-
The state or province of the first PostalAddress.
- -street | -post1.street
-
The street name of the first PostalAddress.
- -streetNumber | -number | --post1.streetNumber
-
The street number of the first PostalAddress.
- -post2.type
-
The type of the second PostalAddress. If a second PostalAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).
- -post2.city
-
The city of the second PostalAddress.
- -post2.country
-
The country of the second PostalAddress.
- -post2.postalcode
-
The postal code of the second PostalAddress.
- -post2.stateOrProvince
-
The state or province of the second PostalAddress.
- -post2.street
-
The street name of the second PostalAddress.
- -post2.streetNumber
-
The street number of the second PostalAddress.
- -post3.type
-
The type of the third PostalAddress. If a third PostalAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string (for example, Office or Home).
- -post3.city
-
The city of the third PostalAddress.
- -post3.country
-
The country of the third PostalAddress.
- -post3.postalcode
-
The postal code of the third PostalAddress.
- -post3.stateOrProvince
-
The state or province of the third PostalAddress.
- -post3.street
-
The street name of the third PostalAddress.
- -post3.streetNumber
-
The street number of the third PostalAddress.
- -phoneType | -telephone1.type
-
The type of the first TelephoneNumber. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.
- -areaCode | -telephone1.areaCode
-
The area code of the first TelephoneNumber.
- -countryCode | -telephone1.countryCode
-
The country code of the first TelephoneNumber.
- -extension | -telephone1.extension
-
The extension of the first TelephoneNumber.
- -number | -telephone1.number
-
The telephone number suffix, not including the country or area code, of the first TelephoneNumber. The number, which is required, must be specified either on the command line or in a property file.
- -URL | -telephone1.URL
-
The URL of the first TelephoneNumber (the URL that can dial this number electronically).
- -telephone2.type
-
The type of the second TelephoneNumber. If a second TelephoneNumber is specified, the type, which is required, must be specified either on the command line or in a property file. The valu is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.
- -telephone2.areaCode
-
The area code of the second TelephoneNumber.
- -telephone2.countryCode
-
The country code of the second TelephoneNumber.
- -telephone2.extension
-
The extension of the second TelephoneNumber.
- -telephone2.number
-
The telephone number suffix, not including the country or area code, of the second TelephoneNumber. If a second TelephoneNumber is specified, the number, which is required, must be specified either on the command line or in a property file.
- -telephone2.URL
-
The URL of the second TelephoneNumber (the URL that can dial this number electronically).
- -telephone3.type
-
The type of the third TelephoneNumber. If a third TelephoneNumber is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: Beeper, FAX, HomePhone, MobilePhone, or OfficePhone.
- -telephone3.areaCode
-
The area code of the third TelephoneNumber.
- -telephone3.countryCode
-
The country code of the third TelephoneNumber.
- -telephone3.extension
-
The extension of the third TelephoneNumber.
- -telephone3.number
-
The telephone number suffix, not including the country or area code, of the third TelephoneNumber. If a third TelephoneNumber is specified, the number,which is required, must be specified either on the command line or in a property file.
- -telephone3.URL
-
The URL of the third TelephoneNumber (the URL that can dial this number electronically).
- -emailType | -email1.type
-
The type of the first EmailAddress. The type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.
- -emailAddress | -email | -email1.address
-
The first email address. The first email address is required.
- -email2.type
-
The type of the second EmailAddress. If a second EmailAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.
- -email2.address
-
The second email address.
- -email3.type
-
The type of the third EmailAddress. If a third EmailAddress is specified, the type, which is required, must be specified either on the command line or in a property file. The value is an arbitrary string, but you can specify one of the following known types: HomeEmail or OfficeEmail.
- -email3.address
-
The third email address.
Examples
The following command loads the User properties from the file JaneSmith.properties in the user’s home directory.
admin> add user -load ~/JaneSmith.properties |
The following command (all on one line) specifies the minimum properties that are required to create a User object.
admin> add user -ln Smith -postaltype Office -country US -phonetype Office -number 333-3333 -emailtype OfficeEmail -emailaddress JaneSmith@JaneSmith.com -alias 123 -keypass 123456 |
- © 2010, Oracle Corporation and/or its affiliates