-add

Syntax: -add

You can use the -add parameter to add a user account to the BlackBerry Device Service.

Optional parameters and subparameters are enclosed in square brackets ( [ ] ).

-add : add user
	-u <user name> : user name
		-b <instance> : instance name of the BlackBerry Device Service
				component
		[-utype <type>] : user type - display_name, email_address
	or
	-localuser : local user
		-b <instance> : instance name of the BlackBerry Device Service
				component
		-login_name <login name> : login name
		-login_password <login password> : login password
		-display_name <display name> : display name
		[-email_address <email address>] : email address
	[-group <group name>] : assign group name
	[-w <password>] : enterprise activation password
		[-wt <expiry time>] : enterprise activation password expiry time
				(number of hours)
	or
	[-wrandom] : generate and email a random enterprise activation password
	[-it_policy <IT policy name>] : IT policy name
	[-activation_type <type>] : activation type - blackberry_balance,
				work_space_only

Subparameter

Description

[-activation_type <type>]

This subparameter specifies the activation type for the user account:
  • blackberry_balance: The personal space and the work space are available on the BlackBerry device. This activation type requires an EMM Corporate license.
  • work_space_only: Only the work space is available on the device. This activation type requires an EMM Corporate license and a device running BlackBerry 10 OS version 10.1 or later and a service plan that supports this feature.

-b <server_name>

This subparameter specifies the BlackBerry Device Service instance for the action (for example, server1).

Use the name of the BlackBerry Device Service instance as it appears in the BlackBerry Administration Service.

-display_name <display_name>

This subparameter specifies a display name for a local user account. Use this subparameter with -localuser.

[-email_address <email_address>]

This subparameter specifies an email address for a local user account. Use this subparameter with -localuser.

[-group <group_name>]

This subparameter specifies the name of the group that you want to add the user account to.

[-it_policy <IT_policy_name>]

This subparameter specifies the name of the IT policy that you want to apply to the user account.

You can view a list of the IT policies available in the BlackBerry Enterprise Service 10 domain if you use the -list -it_policies parameter.

-localuser

This subparameter creates a local user account. Local user accounts are not integrated with Microsoft Active Directory.

-login_name <login_name>

This subparameter specifies a login name (also referred to as a username) for a local user account. Use this subparameter with -localuser.

-login_password <login_password>

This subparameter specifies a password for a local user account. Use this subparameter with -localuser.

[-u <user_name>]

This subparameter specifies the user account for the action. Searches are not case-sensitive. If the value that you specify contains a space, enclose the value in quotation marks (for example, "Julie Palmer").

Examples of searching for user accounts:
  • -u "Julie Palmer" -utype display_name
  • -u jpalmer@test.rim.net -utype email_address

If you do not specify a type using the -utype subparameter, the tool searches for user accounts using the display name first, then the email address. This subparameter uses ANR search functionality.

You can search for an exact match by enclosing the value in double-quotes (" ").

[-utype <type>]

This subparameter specifies which of the following options the tool uses to search for the user account:
  • display_name
  • email_address

[-w <password>]

This subparameter specifies the activation password that you want to assign to a user account.

[-wrandom]

This subparameter generates and emails a random activation password to a user account. You can use this subparameter instead of the -w and -wt subparameters.

[-wt <expiry_time>]

This subparameter specifies the number of hours before the activation password for a user account expires. The default expiry time is 48 hours. Use this subparameter with the -w subparameter.



Was this information helpful? Send us your comments.