-change

Syntax: -change

You can use the -change parameter to configure various settings for user accounts and groups.

-change : change user configuration
	-u <user name> : user name
		[-b <instance>] : instance name of the BlackBerry Enterprise Server
				component
		[-utype <type>] : user type - display_name, email_address,
				login_name, canonical_name
		[-group <group name>] : assign group name
		or
		[-cgroup <group name>] : remove user from group
		[-cs] : clear stats
		[-cf] : clear filters
		[-em] : enable BlackBerry MDS Connection Service for the user
		or
		[-dm] : disable BlackBerry MDS Connection Service for the user
		[-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
		[-cw] : clear enterprise activation password
		[-it_policy <IT policy name>] : IT policy name
		[-er] : enable email redirection
		or
		[-dr] : disable email redirection
		[-purge_pending_messages] : purge pending messages
		[-pimaddr <ServerName>!!<RelativePathToDataDirectory>] : address
							book database location
							for the user
		[-pimmemo <ServerName>!!<RelativePathToDataDirectory>] : memo
							database location
							for the user
		[-assign_static_mailbox_agent <agent Id>] : assign static mailbox
							agent
		or
		[-clear_static_mailbox_agent] : clear static mailbox agent
		[-addrsub <AddressBookName>] : address book name to be synchronized
		[-autosignature <signature>] : set auto signature
		or
		[-clear_autosignature] : clear auto signature
		[-synchronize_calendar] : force a calendar synchronization

Subparameter

Description

-addrsub <address_book_name>

Applies to the BlackBerry Enterprise Server for Novell GroupWise only.

This subparameter specifies the name of the address book that you want to synchronize.

-assign_static_mailbox_agent <agent ID>

Applies to the BlackBerry Enterprise Server for Microsoft Exchange only.

This subparameter specifies the static BlackBerry Messaging Agent that you want to associate the user account with. The user account remains associated with the static BlackBerry Messaging Agent and is not associated with any other instance in the MDM domain.

-autosignature "<signature>"

This subparameter adds a signature to the email messages that a user sends from the BlackBerry device.

-b <server_name>

This subparameter specifies the BlackBerry Enterprise Server instance for the action.

You use the name of the BlackBerry Enterprise Server instance as it appears in the BlackBerry Administration Service.

-cf

Does not apply to the BlackBerry Enterprise Server for MDS Applications.

This subparameter clears the user's email message filters.

-cgroup <group_name>

This subparameter removes the specified user account from the group.

-clear_autosignature

This subparameter removes a signature from the email messages that a user sends from a device.

-clear_static_mailbox_agent

Applies to the BlackBerry Enterprise Server for Microsoft Exchange only.

This subparameter removes a user account from a static BlackBerry Messaging Agent.

-cs

This subparameter clears the account statistics of an existing user account.

By default, when you add a user account, the tool reads the existing statistics for the user account.

-cw

This subparameter clears the activation password for an existing user account.

-dm

This subparameter makes the BlackBerry MDS Connection Service unavailable to the user account.

-dr

Does not apply to the BlackBerry Enterprise Server for MDS Applications.

This subparameter turns off message redirection for the user account.

-em

This subparameter makes the BlackBerry MDS Connection Service available to the user account.

-er

Does not apply to the BlackBerry Enterprise Server for MDS Applications.

This subparameter turns on message redirection for the user account.

-g <group_name>>

This subparameter specifies the name of the group for the action.

This subparameter overrides the -u and -b parameters.

-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 valid IT policies in the BlackBerry Administration Service. You can also display the list if you run the tool with the -list -it_policies parameter.

-pimaddr <server_name>!!<Relative_Path_To_Data_Directory>

Applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

This subparameter specifies the name of the BlackBerry Enterprise Server instance and the relative path to the Lotus Notes Data folder where the organizer data for a user account is stored.

-pimmemo <server_name>!!<Relative_Path_To_Data_Directory>

Applies to the BlackBerry Enterprise Server for IBM Lotus Domino only.

You can use this subparameter only with the BlackBerry Enterprise Server for IBM Lotus Domino.

-purge_pending_messages

Does not apply to the BlackBerry Enterprise Server for MDS Applications.

This subparameter specifies the user account that you want to delete pending messages for.

-synchronize_calendar

Applies to the BlackBerry Enterprise Server for IBM Lotus Domino and the BlackBerry Enterprise Server for Microsoft Exchange only.

This subparameter starts the calendar synchronization process manually for a user account.

-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 specifying a user account:

  • -u "Julie Palmer" -utype display_name
  • -u jpalmer@test.net -utype email_address
  • -u JPalmer -utype login_name
  • -u “CN=Julie Palmer/O=Server01” -utype canonical_name

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, then the login name, and then the canonical name. Searching by canonical name is available for the BlackBerry Enterprise Server for IBM Lotus Domino only, and is the least preferred method of searching for user accounts.

Searches (except by canonical name) match on substrings. For example, if you specify -u jpalmer@test.rim.net, and your organization's environment contains the user accounts jpalmer@test.rim.net, ojpalmer@test.rim.net, and rjpalmer@test.rim.net, the search identifies all three user accounts as valid results. If the tool finds more than one user account, the tool selects the user account that matches the value that you specified exactly (in this case, jpalmer@test.rim.net).

If the tool finds more than one user account, and none of the user accounts match the value that you specified exactly, the tool returns an error message stating that multiple matches were found. If you do not want searches to match on substrings, specify the value using the following format: "\"<user>\"" (for example, "\"jpalmer@test.rim.net\"").

-utype <type>

This subparameter specifies which of the following options the tool uses to search for the user account:
  • display_name
  • email_address
  • login_name: name that the account uses to log in to the BlackBerry Administration Service
  • canonical_name

-w <password>

This subparameter specifies the password that is used to activate the device over the wireless network.

-wrandom

This subparameter generates a random activation password and sends it in an email message to the user.

The email message uses the following default format (the tool replaces “$p” with the password and “$x” with the password expiration time):

SUBJECT=BlackBerry activation password

BODY=Hello,

To activate your BlackBerry device over the wireless network, in the device Options screen, select Enterprise Activation. In that screen, enter your work email address and the following password:

$p

This password will expire in $x hours.

-wt <expiry_time>

This subparameter specifies a password expiry time in hours (between 1 and 720). The default expiry time is 48 hours.

Use this subparameter with the -w parameter. You cannot use this subparameter with -wrandom.



Was this information helpful? Send us your comments.