Using Good Messaging Command Line Utilities for User Management

This section describes some of the management and troubleshooting utilities available to manage users.

User Management Utilities

The following user management are available:

• GoodLinkAddUser - Adds a new user to Good Messaging Server.
• GoodLinkDeleteUser - Deletes a user from Good Messaging Server.
• GoodLinkQueryUser - Provides essential information about existing users.
• GoodLinkEraseData - Issues an Erase Data command to a Good Messaging handheld to wipe all data on the handheld.
• GoodLinkRegenOTAPIN - Generates a new OTA PIN for the specified user.
• GoodLinkUpdateUser - Enables/disables Good Intranet once a user is already Good Messaging enabled.

Troubleshooting Utilities

The following troubleshooting utilities are available:

• gdmapiarchiveutil.exe - Archives and restores the Good Messaging configuration for any mailbox.
• gmexportstats - Exports handheld user statistics, user software policy settings and status information, and server software policy information to a file in CSV format, for backup and audit use.
• manageprofile - Replacement tool for the NTWMS tool
• testcreateprofile - Tests the GoodAdmin profile and Good Messaging Server's ability to create temporary user profiles.
• purgeuser - Purges a Good Messaging user's configuration folders and disconnects the user's handheld from Good Messaging Server
• testcdo - Creates a MAPI login for the indicated user, attempts to access all of the user's calendar events stored in the calendar folder, prints them out, and then logs out
• GdGLSConnect - Tests connectivity from the server that it is running on to the Good Data Center.
• uploadLog - Allows Good Messaging diagnostic files to be easily uploaded to a Good Operations Center server.

GoodLinkAddUser Utility

GoodLinkAddUser adds a user to Good Messaging Server. The utility is available on machines with Good Management Server or Good Management Console installed on them. Run the utility from the installed Server or Console \bin directory.

The user or process that launches this utility must have Administrator rights in Console > Roles > Rights or must have "Add user for cabled Provisioning" or "Add user for OTA Setup Provisioning" rights for Good Messaging to add a cabled or OTA Setup user, respectively. (To test, log on as the user with the necessary rights and attempt to add a user from the Console). To add a user, you must know at least the user's Exchange display name and alias, or know the user's Exchange address.

If the user is already registered for the Good Messaging Service with Good Technology, you need provide only the serial number on the command line. Otherwise, you need to provide all parameters required by the Console New User option.

For a usage example, go to C:\Program Files\Good Technology\Good Management Console\bin (or C:\Program Files\Good Technology\Good Management Server\bin) and run GoodLinkAddUser without any parameters specified.

Syntax

GoodLinkAddUser -GMS GMS Machine Name -GLS GoodLink Server Name -ProvType Type -HHSlNo Handheld Serial Number -HHPhoneNo Handheld Phone Number -HHID Handheld ID
-HHNetwork Handheld Network -UserDisplayName User Exchange GAL Display Name
-UserAlias User Exchange Alias -UserDN User
Exchange DN -GIS Good Intranet Server Name -PolicyGroup PolicyGroup -SoftwareGroup SoftwareGroup -Membership Membership
-LogFile Log File Path

GMS Machine Name	The name of the machine where Good Management Server is running. If empty, Good Management Server is assumed to run on the current machine.
Good Messaging Server Name	Name of the Good Messaging Server to add the user. If -Good Intranet is included in the command line, this value cannot be empty.
Type	"Cabled," "OTA," or "CheckEnabled." Defaults to "Cabled." If OTA, the values for handheld type, ID, phone number, and handheld network should be empty. If "CheckEnabled" is specified, the program checks whether user is Good Messaging enabled. All HHxxxx parameters can be empty when this parameter is specified. The program terminates with exit code 0 if the user is Good Messaging enabled. Otherwise it exits with an error code. If the error code is GDLINK_ERR_USER_NOT_GL_ENABLED (error code 0x80040951) (see server/gm/common/goodlinkerrorcodes.h), the user is not Good Messaging enabled. Any other error code is an error in opening the user's mailbox.
Handheld Serial Number	Serial number of the handheld. This value cannot be empty for cabled handhelds. GoodLinkAddUser does not validate serial number format or value. For CDMA handhelds, the serial number format is ESN:HHHHHHHH where H is a hexadecimal number from 0 to 9 and A to F. The number of 'H's is 8, 9 or 10. Example: ESN:600B029E. For GSM/GPRS handhelds, the serial number is of length 20. Format is IMSI: NNNNNNNNNNNNNNN where N is a number from 0-9. Example: IMSI:310260600468961.
Handheld Phone Number	The phone number of the handheld. This value cannot be empty for ESN and IMSI cabled handhelds. The phone number is not validated and should contain only numbers from 0 to 9.
Handheld ID	Canonical name of the handheld: Treo600 - for Palm Treo600 and Treo650 PocketPC2005 - for Phone Edition 2005 Smartphone2005 - for Windows Mobile 2005
Handheld Network	Canonical Name of the home cellular network that services the handheld. This value can be empty for Cingular Mobitex and GSM/GPRS handhelds (with an IMSI). For CDMA handhelds (with ESN in their serial number), it must be specified. Currently, the following values are supported: US Sprint CDMA, US Verizon CDMA. Contact your authorized service representative for an updated list of CDMA networks supported by Good Messaging.
User Exchange GAL Display Name	Display name of the user as specified in the Exchange GAL (or Active Directory)
User Exchange Alias	Alias of the user. This is referred to as mailNickName in Active Directory.
User Exchange DN	User's Exchange Distinguished Name. Represented in MAPI as PR_EMAIL_ADDRESS and as the legacyExchangeDN attribute in Active Directory. Form: /o=Good/ou=BusDev/cn=Recipients/cn=myalias Note: The Good Management Server must resolve the user from Exchange GAL. The UserDN can be empty if both UserDispName and UserAlias are specified. Conversely, UserDispName and UserAlias can be empty if User Exchange DN is specified.
Good Intranet Server Name	Name of the Good Intranet Server, if present. This value cannot be empty.
Membership	Causes the user to inherit software policies from the group specified in Membership. If the specified group does not exist, the user's software policies are inherited from the All Users group. The user is automatically added as a member of the specified group. If this option is not specified, the user automatically inherits the software policies from the All Users group. Case must match that displayed in the Good Management Console.
PolicyGroup	Causes the user to inherit general policies from the group specified in PolicyGroup. If the specified group does not exist, the user's policy is inherited from the All Users group. The user is automatically added as a member of the specified group. If not specified, the user automatically inherits the policies from the All Users group. Case must match that displayed in the Good Management Console.
SoftwareGroup	Causes the user to be added as a member of the group specified in SoftwareGroup. If the specified group does not exist, a warning is logged and the option is ignored. This option can be specified multiple times to add the user as a member to multiple groups. Case must match that displayed in the Good Management Console.
Log File Path	Errors and warnings are appended to this file. The file will not be overwritten. A valid pathname is required. The path cannot be a network path; it must be on the local machine.

GoodLinkDeleteUser Utility

This program deletes a user that was enabled for Good Messaging. All errors are logged into a file. On successful completion, the program will remove the user from the Good Management Console, and the handheld will receive a disconnect message.

The command-line machine must have Good Management Server or Good Management Console installed on it.

Run the utility from the installed Server or Console bin directory.

The user or thread/process/CGI that launches this utility must have "Delete User" rights for Good Messaging (to test, attempt to delete a user from the Console).

Syntax

GoodLinkDeleteUser -GMS GMS Machine Name
-UserDispName User Exchange GAL Display Name
-UserAlias User Exchange Alias -UserDN User Exchange DN -LogFile Log File Path

All parameters are case insensitive. All parameters must be specified even if they are empty.

GMS Machine Name	The machine where Good Management Server is running. If empty, the utility assumes that the Server runs on the current machine.
User Exchange GAL Display Name	Display name of the user as specified in the Exchange GAL (or Active Directory)
User Exchange Alias	Alias of the user. This is referred to as mailNickName in Active Directory.
User Exchange DN	User's Exchange Distinguished Name. Represented in MAPI as PR_EMAIL_ADDRESS and as legacyExchangeDN attribute in Active Directory. Form: /o=Good/ou=BusDev/cn=Recipients/cn=myalias Note: The GMS must resolve the user from Exchange GAL. To do so, User Exchange DN can be empty if both UserDispName and UserAlias are specified. Conversely, UserDispName and UserAlias can be empty if User Exchange DN is specified.
Log File Path	Errors and warnings are appended to this file. The file will not be overwritten.

Example

GoodLinkDeleteUser -GMS "" -UserDisplayName "Test User" -UserAlias tuser -UserDN "/o=OrgRoot/ou=Site1/cn=Recipients/cn=tuser" -LogFile c:\temp\GoodLinkDeleteUser.log

GoodLinkQueryUser Utility

The GoodLinkQueryUser utility takes an existing user's identity and outputs the essential attributes for that user into a simple XML file. The command-line machine must have Good Management Server or Good Management Console installed on it.

Run the utility from the installed Server or Console \bin directory.

The user or process that launches this utility must have, at the minimum, View only Administration rights for Good Messaging.

Running the command-line tool without any options prints its usage.

Syntax

GoodLinkQueryUser -GMS GMS Host Machine Name
-UserDisplayName User Exchange GAL Display Name
-UserAlias User Exchange Alias -UserDN User Exchange DN -EncodeString 0 or 1 -XMLOutFile XML Output File Path
-LogFile Log File Path (all errors logged)[-HHS1No Serial Number]

If the HHSlNO parameter is specified with a value, to specify a handheld serial number instead of user parameters, then
-UserDispName, -UserAlias and -UserDN must be set to empty.

The -EncodeString option (if set to 1) escapes non-alphanumeric characters with % sign (e.g., %20 for the space character) as in the HTML specification for string values in the output XML file. This option can be used based on the type of XML parser that you will use. We recommend setting this to 0.

If the program is run against a user who is not enabled for Good Messaging, the program terminates with an error GDLINK_ERR_USER_NOT_GL_ENABLED code (error code 0x80040951).

XML file format

The format is simple, with a set of user properties under <user> tag. The file can be parsed by the simplest XML parser.

Each property has a name, data type, and value. The data type is set to string.

Following is a sample output XML file for a user/handheld enabled for OTA but not yet set up. -EncodeString is set to 0.

<?xml version="1.0" ?>

  <user>

    <UserDisplayName type="string">GoodUsertreo600</User

    DisplayName>

    <UserAlias type="string">GoodUserTreo600</UserAlias>

    <UserDN type="string">/o=Dev Eng Good Technology/

    ou=Site1/cn=Recipients/cn=GoodUserTreo600</UserDN>

    <UserEmail

    type="string">GoodUserTreo600@de.qagood.com

    </UserEmail>

    <OTAEnabled type="string">1</OTAEnabled>

    <OTAPin type="string">blb26lh1j37km2b</OTAPin>

    <OTANumericPin type="string"></OTANumericPin>

    <OTAURL type="string">https://good.com/ota</

    OTAURL>

    <GoodLinkServerName type="string">SBHATXP</

    GoodLinkServerName>

    <GoodLinkServerVersion type="string">4.5.0.0</

    GoodLinkServerVersion>

    <HHSlNo type="string"></HHSlNo>

    <HHType type="string"></HHType>

    <HHPhoneNo type="string"></HHPhoneNo>

    <HHNetworkName type="string"></HHNetworkName>

    <GoodLinkClientVersion type="string"></GoodLink

    ClientVersion>

    <UserDepartment type="string"></UserDepartment>

    <GoodIntranetServerName type="string">GASBHATXP

    </Good IntranetServerName>

    <GoodAppsServerName type="string">GA-SBHATXP

    </Good Intranet Web Services Server Name>

    <EraseDataRequested type="string">1

    </EraseDataRequested>

    <EraseDataState type="string">Error

    </EraseDataState>

</user>

1. If the -EncodeString is set to 1, the string value will be encoded with HTML escaping rules. For example, in the above case, the UserDN of

/o=Dev Eng Good Technology/ou=Site1/cn=Recipients/cn=GoodUserTreo600

will look like

%2Fo%3DDev%20Eng%20Good%20Technology%2Fou%3DSite1%2Fcn%3DRecipients%2Fcn%3DGoodUserTreo600

2. OTAEnabled specifies whether the user is OTA enabled. If it is 1, then the user is enabled. 0 means not enabled.
3. OTAPin is the setup PIN. If the Windows user that executes the utility does not have "View user OTA setup Pin" rights in GMC >Roles >Rights, this field will be empty.
4. OTAURL is the location from which the Good Messaging OTA setup stub can be downloaded.
5. The HHxxxx properties are handheld properties. They will be available once the handheld is fully set up.
6. EraseDataRequested can be 0=False or 1=True.
7. EraseDataState is a string that shows the EraseData transaction state. This state value is valid only if EraseDataRequested is True. The following strings are possible:

"Erase requested" - A request to EraseData is made by Good Management Server to the Good Messaging Server.

"Erase sent to handheld" - Good Messaging Server sent a wireless request to the handheld.

"Erase Confirmed by handheld" - Handheld received the request and erased the data on the handheld.

"Error" - There was an error processing this request.

GoodLinkEraseData Utility

Issues an Erase Data command to a Good Messaging handheld to wipe all data on the handheld. Use GoodLinkQueryUser to query the status of the Erase Data request (see the EraseDataRequested and EraseDataState explanations there).

The command-line machine must have Good Management Server or Good Management Console installed on it.

Run the utility from the installed Server or Console bin directory.

The user or thread/process/CGI that launches this utility must have either Administrator rights or the "Erase handheld data" right for Good Messaging.

Running the command-line tool without any options prints its usage.

Syntax

GoodLinkEraseData -GMS GMS Machine Name -UserDispName User Exchange GAL Display Name -UserAlias User Exchange Alias -UserDN User Exchange DN -LogFile Log File Path.

LogFile must be specified; all errors are logged.

GoodLinkRegenOTAPIN Utility

Issues a new OTA PIN for a user. Analogous to the right-click menu item Regenerate OTA PIN in the Good Management Console, when a user in the user list is selected.

The command-line machine must have Good Management Server or Good Management Console installed on it.

Run the utility from the installed Server or Console bin directory.

The user or thread/process/CGI that launches this utility must have either "Add user for OTA Setup" or "View user OTA Setup PIN" rights for Good Messaging.

Running the command-line tool without any options prints its usage.

Syntax

GoodLinkRegenOTAPIN -GMS GMS Machine Name
-UserDispName User Exchange GAL Display Name
-UserAlias User Exchange Alias -UserDN User Exchange DN -SendEmail 0|1 -LogFile Log File Path.

SendEmail sends the OTA email with the new PIN to the user. 1=Send, 0=Do not send.

LogFile must be specified; all errors are logged.

GoodLinkUpdateUser Utility

The GoodLinkUpdateUser utility enables or disabled Good Intranet once a user is already Good Messaging enabled.

The command-line machine must have Good Management Server or Good Management Console installed on it.

Run the utility from the installed Server or Console \bin directory.

The user or process that launches this utility must have either Add user for OTA Setup or Add user for Cable Setup rights for Good Messaging.

Running the command-line tool without any options prints its usage.

Syntax

GoodLinkUpdateUser -GMS hostname -UserDisplayName DisplayName -UserAlias Alias -UserDN DN -GIS Good Intranet Server Name -LogFile filepath

Specify -GIS only if it needs to be enabled or disabled

hostname - The hostname (NetBIOS or Fully Qualified Domain Name) of the Good Management Server. If the Good Management Server is local, you can specify "".

DisplayName - User display name in Exchange GAL. Parameter must be specified even if empty.

Alias - User alias in Exchange GAL. Parameter must be specified even if empty.

DN - User Exchange address in Exchange GAL. Parameter must be specified even if empty.

Good IntranetSrvName - Good Intranet Server Name. If specified as "", the user will be disabled from Good Intranet.

filepath - Errors and status will be logged in this file.

Example: To enable Good Intranet

GoodLinkUpdateUser -GMS "" -UserDisplayName "Test User" -UserAlias tuser -UserDN "/o=OrgRoot/ou=Site1/cn=Recipients/cn=tuser" -GIS "MyGood IntranetServer" -LogFile c:\temp\GoodLinkUpdateUser.log

Example to disable Good Intranet

GoodLinkUpdateUser -GMS "" -UserDisplayName "Test User" -UserAlias tuser -UserDN "/o=OrgRoot/ou=Site1/cn=Recipients/cn=tuser" -GIS "" -LogFile c:\temp\GoodLinkUpdateUser.log

Gdmapiarchiveutil Utility

Good Management Server automatically archives the entire GoodAdmin mailbox daily at midnight, local time, to an archive file on a directory that can be specified when Good Management Server is installed. The archive file is a simple XML file. Five days of archive files are kept and Good Management Server automatically deletes archived files older than five days to conserve disk space.

The gdmapiarchiveutil utility is also available to archive, and to restore, the Good Messaging configuration for any GoodAdmin mailbox at any time. The tool should be run on the Good Management Server host machine; it is located in the Management Server \bin directory. This tool can be run against any version of Good Messaging's GoodAdmin mailbox.

Syntax

gdmapiarchiveutil.exe -profile "MAPI_Profile"
-file archive_file -operation archive|restore
-forcerestore

Use the forcerestore option to replace the mailbox even if the utility cannot detect problems with the current mailbox (see section below).

Example

gdmapiarchiveutil.exe -profile "Good Management Server" -file c:\temp\gmsarchive.xml -operation archive

Output from successful execution

Start:Good MAPI Archive Profile: GoodLink Management Server
Good MAPI Archive-Loading MAPI Folders... GoodAdmin
Good MAPI Archive-Loading MAPI Messages... GoodAdmin
Good MAPI Archive-Formatting archive file for mailbox... GoodAdmin
Good MAPI Archive-Written archive file... c:\temp\gmsarchive.xml
End:Good MAPI Archive GoodAdmin 0

Restoring the GoodAdmin Mailbox

Use this command-line tool to restore the GoodAdmin mailbox when the existing mailbox contains inconsistent Good Messaging information or no Good Messaging information at all.

Attempting to restore a mailbox that already has Good Messaging information will fail with the following message:

Good MAPI Restore- Error: contains MAPI messages. Plese use -forcerestore to delete the configuration from the mailbox and restore the entire set from archive

End:Good MAPI Restore TestMailbox -2147467259

In this case, verify that you are attempting to restore the proper mailbox and run the utility with the -forcerestore switch to delete all Good Messaging records in the mailbox and restore from the archive:

C:\Program Files\Good Technology\GoodLink Management Server\bin>gdmapiarchiveutil.exe -profile "testmailbox profile" -operation restore -file c:\temp\gmsarchive.xml
Start:Good MAPI Restore Profile: bhattest1 c:\temp\gmsarchive.xml
Good MAPI Restore-Loading archive file... c:\temp\gmsarchive.xml
Good MAPI Restore-Processing archive file... c:\temp\gmsarchive.xml
Good MAPI Restore-Checking configuration database exists in the mailbox... TestMailbox
Good MAPI Restore-Creating MAPI Folder Tree in mailbox... TestMailbox
Good MAPI Restore-Creating MAPI Messages in Folder Tree in mailbox... TestMailbox
End:Good MAPI Restore BhatTest1 0

Stop all Good Messaging and Good Intranet services on the Good Management Server host machine before restoring the GoodAdmin mailbox. If you are using multiple Good Management Servers with the same GoodAdmin mailbox, be sure to stop all services on all hosts before the restoration attempt.

Once the GoodAdmin mailbox is restored, launch Good Management Server and verify that the restored Good Messaging information is correct before starting the Good Messaging Service.

Gmexportstats Utility

You can export handheld user and server information to a file in CSV format using the command-line utility gmexportstats, installed with Good Messaging, for backup and audit use. You can use Windows Scheduler to run the utility on an automated basis. You can export the following information:

• User list
• User statistics
• User software policy settings and status
• Group software policy settings

To export user or server information to a file:

1. Open a command shell (CMD.EXE) on a Good Management Server or Good Management Console host.
2. Go to the Good Management Server or Good Management Console installation \bin directory.
3. Run gmexportstats using the following syntax:

gmexportstats -gms hostname -autogenerate yes|no
-file filepath -clearstat yes|no [-exporttype type] [-gls GoodLink Server name]

hostname is the required hostname (NetBIOS or fully qualified domain name) of the Good Management Server. If the Server is local, you can specify "" or the name.

filepath is the required full file path where the statistics file is to created. If the file exists, it will be overwritten. If the autogenerate parameter is no, a filename must be included in the path; if autogenerate is yes, the path must not include a filename.

If the required -autogenerate value is specified as "yes," a file is created in the directory specified by filepath. filepath cannot be the root (C:\). The filename format is 'YYYY-MM-DD.hh-mm-ss-mmmm.csv' and is based on local time. If the autogenerate value is "no," the filename that you provide in filepath is used.

If the -clearstat value is specified as "yes," the user statistics counters will be reset after exporting. This parameter is required if exporttype is specified as "userstats." Otherwise, it is ignored.

Possible values for the optional exporttype parameter:

userlist - Exports Good Messaging-enabled user list. This option outputs minimal user information. Similar to GMC Users->Export.

userstats - Exports user statistics.

usersoftware - Exports user software policy information.

groupsoftware - Exports the policy and software settings (All Users or Custom) for each group.

The default for exporttype is userstats.

Good Messaging Server name: For exporttype "usersoftware," this optional parameter filters users only on the Good Messaging Server specified.

Errors are logged with an .ERR extension in the directory where the CSV file is created.

Column output

userlist

Display Name,Alias Name,Serial No,Server Name,Handheld ID,Network ID,Phone,Handheld Type,OTA Setup,Good Intranet Server,GoodApps Server,Policy,Software,DN

userstats

Display Name,Alias Name,Serial No,Server Name,Handheld ID,Network ID,Phone,Handheld Type,OTA,Good Intranet Server,Good Apps Server,Policy,Software,DN,GoodLink Client Version,Last message received,Last message sent,Email messages sent,Email messages received,Last email message received,Last email message sent,Filtered email,Calendar messages sent,Calendar messages received,Last Calendar message received,Last Calendar message sent,Address Book messages sent,Address Book messages received,Last Address Book message received,Last Address Book message sent,Note messages sent,Note messages received,Last Note message received,Last Note message sent,Task messages sent,Task messages received,Last Task message received,Last Task message sent,Messages sent,Messages received,Software,Handheld Policy State,Handheld MAN#,DN,Exchange Server,Exchange Server Version,GoodLink Server Version,Handheld OS Version,Handheld ROM Version,Network Name,Firmware Version,GoodLink Enabled Time,GoodLink Provisioned Time,Provisioning state,OTA PIN State,OTA Expire Time,Compliance Rule Error,Compliance Rule ErrorMsg,GoodLink Client Language,Handheld OS Language

usersoftware

Server Name,CurGLSServerVersion,Display Name,Alias Name,DN,Serial No,Handheld Type,Handheld Type Family,Policy inheritance,Type,Enabled,Handheld Family,Application ID,GUID,Application Name,Version,Status Time,Status,Low Level Error, Message,Software Notes,Installation Mandatory,Launch after Download

groupsoftware

Group Name,Software,Type,Enabled,Handheld Family,Application ID,GUID,Application Name,Version,Description,Software Notes,Installation Mandatory,Launch after Download,Display Reminder to User

Examples

gmexportstats -gms "" -autogenerate no -file c:\temp\export.csv -clearstat no

Exports user statistics to the file named export.csv using the local Good Management Server. The user statistics are not cleared during the export.

gmexportstats -gms localhost -autogenerate no -file "C:\Statistics\GLS01 Users\userstats.csv" -clearstat no

Exports user statistics to the file named userstats.csv using the Good Management Server on the local host. The filename path is quoted because it includes a space in the full file path. The user statistics are not cleared during the export.

gmexportstats -gms GLS01 -autogenerate yes -file c:\temp -clearstat yes

Exports user statistics to the directory C:\temp with an automatically generated name using the Good Management Server located on machine GLS01. The user statistics are cleared during the export.

gmexportstats -gms GLS01 -file "C:\SWSettings\GLS01 Software\GLS01.serversoftware.csv" -exporttype groupsoftware

Exports the user group software policy settings to the file named GLS01.serversoftware.csv using the Good Management Server located on machine GLS01.

gmexportstats -gms GLS01 -autogenerate yes -file "C:\SWSettings\GLS01 Software\UserStates" -exporttype usersoftware -gls GLS01

Exports the user software policy settings and status to the directory C:\SWSettings\GLS01 Software\UserStates with an automatically generated name using the Good Management Server located on machine GLS01. Filter only users who are set up on the Good Management Server named GLS01.

Manageprofile Utility

The manageprofile utility is a command-line tool for managing and testing MAPI profiles. It can be used as a replacement for the NTWMS tool. manageprofile can be used to:

• List the currently configured MAPI profile(s)
• Open an Exchange mailbox using MAPI as well as CDO via the GAL application
• Create a new MAPI profile
• Edit an existing MAPI profile
• Delete an existing MAPI profile

Operational events and errors are logged in a user-defined text file for review and troubleshooting.

The manageprofile utility is installed by Good Management Server and can be found under the \bin folder in the Good Management Server installed location. It is also found under the \util folder in the Good Messaging Server installed location. Run the tool from the command line. To run the utility on another computer, you must copy all of the files (including all dll's) from the \util directory.

Syntax

manageprofile -profile profilename -operation <none/edit/delete> -showgal <yes/no> -log filepath
-reconnflags <yes/no>

To list the currently configured MAPI profile(s), enter the following command:

manageprofile -profile "" -operation none -showgal no -log c:\manageprofile\log.txt

This command will output a list of MAPI profile names as well as related attribute information for each profile. Sample output followed by an explanation of each item:

CoInitializeEx for user 'THEFORCE\goodadmin'. Result:0
MAPIInitialize. Result:0
List of all MAPI profiles for the user:'THEFORCE\goodadmin' (Please wait...)
ProfileName[1]:"Good Management Console" [Connected:Yes, ExchSrv:YODA, Mailbox:goodadmin, Default:Yes, Offline:No, GCSrv:yoda.theforce.good.com]
ProfileName[2]:"GoodLink Server" [Connected:Yes, ExchSrv:YODA, Mailbox:goodadmin, Default:No, Offline:No, GCSrv:yoda.theforce.good.com]

Description of the profile attributes

Connected: (Yes/No) - Indicates whether the logged-on user is able to log on with 'logon network security' set to 'NT Password Authentication'. If this is 'No', then it is a sign of trouble. If the profile is set to offline also, this will show as 'No'

ExchSrv - Name of the resolved Exchange server. If "CheckName" was not pressed in the profile, this may be empty. An empty value here is a sign of trouble.

Mailbox - Name (alias or display name) of the resolved Exchange User. If "CheckName" was not pressed in the profile, this may be empty. An empty value here is a sign of trouble.

Default: (Yes/No) - Whether this profile is set to default. This value is not significant for non-Outlook environments.

Offline:(Yes/No) - Whether the profile is Offline or set to "Use Local Copy of Mailbox."

GCSrv - Name of the Global Catalog Server that the profile is connecting to. This value will be present only if connecting to Active Directory and E200x environments. An empty value here is OK. If this value is present, make sure that it is pointing to the correct Active Directory domain controller/Global Catalog Server.

Example log entry for unresolved profile:

12-04-2003 10-51-01 ProfileName[6]:"unresolved" [Connected:No, ExchSrv:, Mailbox:, Default:No, Offline:No, GCSrv:]

To test access to a mailbox via MAPI and CDO, enter the following command:

manageprofile -profile profileName -operation none -showgal yes -log c:\manageprofile\log.txt

When this command is entered, a Global Address List (GAL) application will be launched. Select the user from the list to be tested and then click on the [OK] button. If successful, the following popup window will be displayed.

Opened 'Angel Bocan' mailbox using MAPI and CDO. Please see file 'c:\manageprofile\log.txt' for mailbox details

Click OK to return to GAL application to test another mailbox. From the GAL application, click [Cancel] button to return to command prompt.

To create a new MAPI profile, enter the following command:

manageprofile -profile newProfileName -operation edit -showgal no -log c:\manageprofile\log.txt

When this command is entered, a MAPI profile window will be launched. In the General tab, enter the Microsoft Exchange Server name and enter the Mailbox name. Select the [Check Name] button to resolve the mailbox name - it will underline if mailbox resolves successfully.

To edit an existing MAPI profile, enter the following command:

manageprofile -profile profileName -operation edit -showgal no -log c:\manageprofile\log.txt

When this command is entered, a MAPI profile window will be launched. In the General tab, the Microsoft Exchange Server name and the Mailbox name will be displayed. Modify values as appropriate.

To delete an existing MAPI profile, enter the following command:

manageprofile -profile profileName -operation delete -showgal no -log c:\manageprofile\log.txt

To view the log, enter the following command:

notepad log.txt

Testcreateprofile Utility

The testcreateprofile utility is a command-line tool for testing the GoodAdmin profile and Good Messaging Server's ability to create temporary user profiles. testcreateprofile runs nine separate tests.

The testcreateprofile utility is installed by Good Messaging Server and can be found under the \util folder in the Good Messaging Server installed location. Run the tool from the command line. To run the utility on another computer, you must copy all of the files (including all dll's) from the util directory.

Syntax

testcreateprofile.exe -m mailbox name -p "MAPI profile name" > results.txt

-m Mailbox that you want to test

-p MAPI profile account to use (for example, Good Messaging Server). Quotes required.

Nine tests will be executed. If a test fails, a list of troubleshooting steps will be displayed and logged in results.txt. If all tests are successful, the message "All Tests PASSED!" will be displayed and logged at the end of results.txt.

Contact your authorized support representative if taking the troubleshooting steps doesn't stop test failures.

Purgeuser Utility

The purgeuser utility is a command-line utility that purges a Good Messaging user's configuration folders and disconnects the user's handheld from Good Messaging Server. To be used, the handheld will need to be recradled and set up again.

Run the tool from the command line. The purgeuser utility is found under the \util folder in the Good Messaging Server installed location.

Syntax:

purgeuser "/o=mycompany/ou=myorg/cn=Recipients/cn=myalias"

The required Exchange address information can be found in the Good Management Console by right-clicking on the user you want to purge and going to Properties | Details. The information is displayed on the second line, next to "Mailbox Address (DN)."

Suggestion: Type the user's Exchange address information into Notepad so that when you run purgeuser, you can simply copy the information from Notepad and paste it at the command prompt.

Testcdo Utility

The testcdo utility is a test utility that creates a MAPI login for the indicated user, attempts to access all of the user's calendar events stored in the calendar folder, prints them out, and then logs out. This tool does not search subfolder calendar events.

Run testcdo from the command line. testcdo is found under the \util folder in the Good Messaging Server installed location. To run the utility on another computer, you must copy all of the files (including all dll's) from the util directory.

Syntax

testcdo.exe exchangeserver mailboxname

exchangeserver - Name of the Exchange server that the mailbox username is located on

mailboxname - The mailbox account you want to log onto

Example

testcdo.exe MAIL2K EricaBacardi

If the test is successful, all calendar events will be printed out. If the test is not successful, two things can occur:

• A noted CDO failure
• A popup dialogue box indicating an "Unhandled exception in testcdo.dll. Access denied"

The usual cause for problems is that permissions for the GoodAdmin account are set incorrectly.

Debugging Checklist

Log all the results from this checklist before contacting your service representative.

• Verify the permissions set for the GoodAdmin account. The permissions differ depending on the Exchange environment.
• Locate where CDO.dll is installed on the Good Messaging Server machine and verify that it's the latest version.
• Execute testcdo for the problem user and a newly created dummy user on the same Exchange server. Redirect the output to a file and have the customer send us the file. For example, "testcdo.exe MAIL2K JohnSmith > results.txt"
• Create a temporary profile for the problem account and newly created dummy user on a test machine, log in to the machine under the GoodAdmin account, and open the user's profile account. Report any errors to your service representative.
• Verify that the Public Folder store is mounted. If the Public Folder store is unmounted, the Good Messaging Server will not be able to process Calendar messages from handhelds. The Public Folder store is used to maintain free/busy information. Calendar entries cannot be updated or created while the Public Folders are unavailable

GdGLSConnect Utility

The GdGLSConnect utility tests connectivity from the server that it is running on to the Good Data Center.

Run this tool from the command line. GdGLSConnect is available under the \util folder in the Good Messaging Server installed location. To run the utility on a different computer, you must copy all of the files (including all dll's) from the util directory.

Syntax

GdGLSConnect.exe -k login key -l license_key -s serial_number [-p product name] [-u `<<<url>>>'] [-n requests] [-w seconds] [-t] [-d]

where:

-k login key specifies the product login key. The key is stored in the following registry key on the Good Messaging Server host machine:

HKEY_LOCAL_MACHINE\SOFTWARE\Good Technology\GoodLink Install Parameters

or

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\GoodLinkServer\parameters

-l license key specifies the product license key.

-s serial number specifies the product serial number in serialNumber.hostname format

-u `<<<url>>>' optionally specifies the Good Data Center URL (defaults to '<<<https://xml028.good.com/>>>').

-n number of requests optionally specifies the number of times the request is issued (defaults to 1).

-w seconds between requests optionally specifies the time between requests in seconds when more than one is issued (defaults to 30).

-t turns on tracing.

-d turns on debugging.

Example output

gdglsconnect built Nov 2 2004 at 14:17:12
Will test using
Version 4.8.0.0
URL: https://qa2xml.qa2.good.com/
SerialNumber: QA00000001
LicensKey: ASIA-ASIA-ASIA-ASIA-ASIA-ASIA
Number: 1
Timout: 20

CurDir is C:\Program Files\Good Technology\GoodLink Server\util
SSL dir set to C:\Program Files\Good Technology\GoodLink Server\etc\ssl
SSL library databases initialized OK
Attempting first connection to https://qa2xml.qa2.good.com/
Initial connect to https://qa2xml.qa2.good.com/ okay.
OK (12 ms)
I made 1 operation requests, and all of them succeeded.
PASS

Starting Good Data Center address range check...

We are not using proxy server to get to the Good Data Center...

checkIPRanges took 1 seconds

protocol:HTTP address:gw1.dev1.good.com port:10000 IPRange:172.18.7.31:172.18.7.32 isproxy:0 error:0 error String:errOk
protocol:HTTP address:gw2.dev1.good.com port:10000 IPRange:172.18.7.31:172.18.7.32 isproxy:0 error:0 error String:errOk
protocol:HTTP address:gw2.dev1.good.com port:10003 IPRange:172.18.7.31:172.18.7.32 isproxy:0 error:65538 error String:errNetConnect

Good Data Center address range check for 1 out of 3 range *** FAILED ***

===============================================

Testing retrieving device list from Orca.

Deleted device.xml file from previous run.

2005-12-30 11:38:54 -08:00 getDeviceTable() STARTING
2005-12-30 11:38:54 -08:00 getDeviceTable() FINISH. Bytes Received: 78473
2005-12-30 11:38:54 -08:00 Start saving the device file.
2005-12-30 11:38:54 -08:00 Finished saving the device file.

Total time to download device table from Orca: 0 seconds.

**** GetDeviceList SUCCESS****

uploadLog Utility

The uploadLog utility allows your Good Messaging Server and Good Management Server diagnostic files to be easily uploaded to the Good Operations Center server. Use the utility to upload files when instructed to do so by your authorized service representative.

Run this tool from the command line on the Good Messaging Server or Good Management Server host machine for the Server to be diagnosed, or from Good Management Console. The uploadLog utility is available under the \util folder in the Good Messaging Server installed location and under the \bin folder in the Good Management Server installation location. It is not installed with Good Management Console.

Syntax

uploadLog.exe

Select the type of file to be uploaded (Good Messaging Server or Good Management Server diagnostic file). You must be running the utility on the host machine for this Server.

Select the range of dates for the data to be included in the uploaded file. If instructed to do so by your service representative, click the checkboxes to include System Event Log and/or Application Event Log data.

Diagnostic Log Files

The diagnostic log files that your service representative may ask you to upload are created automatically by Good Messaging Server and Good Management Server during Server operation.

The location of the Good Messaging Server diagnostic files is specified under the value AccessLogDir inside the registry key.

HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\GoodLinkServer\\Parameters\\

The uploadLog utility retrieves the log files from this location.

The location of the Good Management Server diagnostic files is specified under the value LogDir insider the registry key

HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\GoodLinkManagementServer\\Parameters

The uploadLog utility retrievs the log files from this location.

Good Messaging Server diagnostic log files are named

server_namemm-dd-yy.hh-mm-ss.

Good Management Server diagnostic log files are named

GoodLinkManagement.diagnosticsmm-dd-yy.hh-mm-ss

The log files that you specified in the To and From fields are transferred. All files transferred by default will be compressed in gzip format.