Common parameters | Blackberry SWD-504685-0330050601-001 instruction

Administration Guide

Common parameters

Common parameters
	12

The following subparameters are available for use with many of the parameters in the BlackBerry® Enterprise Server User Administration Tool. You can use the command syntax to help you determine whether you can use a subparameter in a particular case.

Subparameter	Description

-b <instance>	This subparameter specifies the instance name of the BlackBerry® Enterprise Server
	component.
-u <user_name>	This subparameter specifies the user account for the action. Depending on the BlackBerry
	Enterprise Server environment, the user account uses one of the following formats:
	•	for Microsoft® Exchange: mailbox name (for example, smoser@test.rim.net)
	•	for IBM® Lotus® Domino®: canonical name (for example, “CN=Sam Moser/
		O=Server01”)
	•	for Novell® GroupWise®: user ID (for example, sammoser)
	•	for MDS Applications: display name of the BlackBerry device
-utype <type>	This subparameter specifies which of the following options the BlackBerry Enterprise
	Server User Administration Tool uses to search for the user account:
	•	display_name
	•	email_address
	•	canonical_name
	•	login_name: name that the account uses to log in to the BlackBerry Administration
		Service

Searches are not case sensitive and appear in the order DisplayName, EmailAddress,

UserName, and MailboxId. Most matches are prefix matches.

44

Image 46

Blackberry SWD-504685-0330050601-001 manual Common parameters

Contents

Administration Guide SWD-504685-0330050601-001 Contents Sending notification messages to BlackBerry devices Input, output, and user feedback parameters Setuseritpolicyrule Overview BlackBerry Enterprise Server User Administration ToolEdit a group across Group Delete a software Configuration Create an application Create a software Configuration View a softwareTemplate View a job Service instance View push rules for Service View pull rules for Add and remove a role across organizations New in this releaseTool Description BlackBerry Enterprise Activation Inputfilename PasswordOutputfilename Servername Supported authentication models Authentication credentials Syntax for authentication credentials Use cases User name SQLU1 Password SQLP1String value requirements Example Setclientauth -username BASU1 -password Following command BESUserAdminClientSetclientauth -basauth -setp password1 BASP1 -basauth -setp password1 Re-install the service using the new client password Add a new user account to the BlackBerry Enterprise Server Managing user accountsAdding user accounts Username Add a new user account to a group Assign a software configuration to a user accountUsername Sw configurationname Add an existing user account to a group Changing and removing user accounts Finding user accountsFind a user account Delete a user account from a group Delete a software configuration from a user accountMove a user account to a different user group Username Instance Change user account settings Delete a user account from the BlackBerry Enterprise Server List the groups in a BlackBerry Domain Managing email message forwarding Turn on or turn off email message forwarding Turn on or turn off email message forwarding for folders Managing IT policies and IT policy rules List the IT policy rules in an IT policy Set IT policy rules for a user account Managing BlackBerry devices Set a password for a BlackBerry deviceSet owner information on a BlackBerry device Resend a service book Delete pending messages Resend the peer-to-peer encryption key Protect a stolen BlackBerry device Infofile filename or Send a notification PIN messageUsername or Groupname Instance Subject subjectlinetext Body messagebodytext Send a notification email message Retrieve user account statistics BlackBerry devicesRetrieving user account statistics and information about Results of a statistics query for a user account PIN of the BlackBerry device Column Description ServerDNThat is associated with the BlackBerry device Device Type Model number of the BlackBerry device State Clear user account statistics Retrieve enterprise activation statistics for a user account Retrieve enterprise activation statistics for a user account Retrieving BlackBerry device information Retrieve the statistics for BlackBerry devices Column Description User Name Name of the user account Results of a statistics query for a BlackBerry deviceUsers userdeviceinformation Groupname Instance Home Carrier Column Description IT Policy Time Software configuration on the deviceUptime Time since the BlackBerry device was last reset System Status Messaging server Enterprise Server instance Instance sentInstance filtered Configuring log files Administration ToolTroubleshooting the BlackBerry Enterprise Server User Yyyymmdd is the date Warn Error Fatal Using the command summary in the help file Common parameters BES1,USER2,GROUP1,false Input, output, and user feedback parametersSubparameter Description BES1,USER7,GROUP2,true Be one of the following types With the BlackBerry Administration ServiceError This level is not currently used Well as messages of earlier levels Add BlackBerry Administration ServiceGroupWise Itpolicy ITpolicyname Ory Wt expiry time Csw configurationname AssignswconfigSubparameters -assignswconfig Description Cannot use this subparameter with -sw Utype type Change Syntax -change Enterprise Server for Novell GroupWise This subparameter clears the users email message filtersBlackBerry Enterprise Server for Novell GroupWise Account Purgependingmessages Account to -add or an existing user account to -changeFrom Password Subparameter Description Canonicalname Subparameters -delete Description Administration Tool does not find the mailboxDelete Force Administration Guide Find Subparameters -find Description Handheldinfo Action. It works with the -u subparameter Subparameters -handheldinfo Description AppnameWork with the -u or -b subparameters Hhstats Subparameter Description Users Instead of one user account Killhandheld Subparameters -killhandheld Description Administration Guide List Apppolicyname Instance ConfigurationnameItpolicy IT policyname Displayname Subparameters -move Description MoveMove the account to Administration Guide Subparameters -resendpeertopeerkey Description ResendpeertopeerkeyAction Resendservicebook Subparameters -resendservicebook Description Body bodytext SendemailInfofile filename.txt Utype type This subparameter specifies the body of the PIN message SendpinSubparameters -sendpin Description This subparameter specifies the name of the user group Displayname Default authentication type Setclientauth Credentials in the Windows registry Interchangeably with -passwordExchange messaging server Sqluser username Server for Novell GroupWise SetfolderredirectionSubparameters -setfolderredirection Description Foldername foldername Username Info ownerinformation SetownerinfoSubparameters -setownerinfo Description Infofile infofile.txt Utype type Setpassword Subparameters -setpassword Description Subparameters -setuseritpolicyrule Description SetuseritpolicyrulePolicyrule policyrulename Administration Guide Subparameters -stats Description Service This subparameter specifies service instancesStats Email emailinstance Utype type Status Glossary Provide feedback Legal notice Administration Guide Administration Guide