Administration guide > Monitor the environment > Monitoring with the xsAdmin sample utility

Attributes and arguments for xsadmin utility

You have several different options when specifying attributes for the xsadmin utility, based on the requirements and scope.

Supported attributes in properties file or from command line

For each of the following pairs: (1) is for the properties file and (2) is an equivalent specification for the command line:

• User Name

  1. XSADMIN_USERNAME

  2. -username

• Password

  1. XSADMIN_PASSWORD

  2. -password

• SSL Trust File Path

  1. XSADMIN_TRUST_PATH

  2. -trustPath

• SSL Trust Type

  1. XSADMIN_TRUST_TYPE

  2. -trustType

• SSL Trust Password

  1. XSADMIN_TRUST_PASS

  2. -trustPass

• Catalog Service JMX Host Name

  1. XSADMIN_JMX_HOST

  2. -ch

• Catalog Service JMX Port

  1. XSADMIN_JMX_PORT

  2. -p

• MBean Server JMX URL

  1. XSADMIN_JMX_URL

  2. -jmxUrl

• WAS Hosted Catalog Service

  1. XSADMIN_DMGR

  2. -dmgr

Help text for utility with command: ./xsadmin -h

The following arguments are optional:

• -profile - Fully-qualified path to a properties file specifying certain available command-line arguments/values. Ex: XSADMIN_TRUST_TYPE=jks

• -g - ObjectGrid name

• -m - Mapset name

• -ch - Catalog service JMX hostname, default value=localhost

• -p - Catalog service JMX port. default: 1099 or 9809 for WAS host

• -jmxUrl - MBean Server URL for if already known and utility generation fails

• -dmgr - Specify this flag if connecting to a WebSphere Application Server hosted catalog service

• -empties - Specify this flag to show empty containers in the output

• -reserved - Used with the -containers command to displays only Shards that are reserved

• -continuous - Specify this flag if you want continuous map size results

• -nopredetermine - Specify this flag to disable predetermination of necessary endpoints

• -internal - Specify this flag to include internal grids in selected operations

• -force - Forces the action, disabling any pre-emptive prompts. It is useful for batched commands

• -v - Verbose output: Specify this flag if you are using environment variables, a properties file, or both to specify certain command-line arguments, and want to view their values

Verbose option

Use the xsadmin verbose option to troubleshoot problems: xsadmin -v, which lists all parameters you have set. For example, if you set a value in a properties file but have forgotten it, the verbose option retrieves it: It gives you all of the values for all scopes.

The following text is an example of output when using the verbose option from the command line.

Command line specified arguments
**********************************
XSADMIN_USERNAME=xsadmin
XSADMIN_PASSWORD=xsadmin
XSADMIN_TRUST_PATH=<unspecified>
XSADMIN_TRUST_TYPE=<unspecified>
XSADMIN_TRUST_PASS=<unspecified>
XSADMIN_PROFILE=/opt/ibm/WebSphere/wxs71/ObjectGrid/properties/test.properties
XSADMIN_JMX_HOST=localhost
XSADMIN_JMX_PORT=portNotSpecified
XSADMIN_JMX_URL=<unspecified>
XSADMIN_DMGR=false
**********************************
Properties file specified arguments
************************************
XSADMIN_USERNAME=xcadmin
XSADMIN_PASSWORD=xcadmin
XSADMIN_TRUST_PATH=/opt/ibm/WebSphere/wxs71/ObjectGrid/security/trust.jks
XSADMIN_TRUST_TYPE=jks
XSADMIN_TRUST_PASS=ogpass
XSADMIN_JMX_HOST=<unspecified>
XSADMIN_JMX_PORT=<unspecified>
XSADMIN_JMX_URL=<unspecified>
XSADMIN_DMGR=<unspecified>
**********************************
Environment-specified arguments
**********************************
XSADMIN_USERNAME=<unspecified>
XSADMIN_PASSWORD=<unspecified>
XSADMIN_TRUST_PATH=<unspecified>
XSADMIN_TRUST_TYPE=<unspecified>
XSADMIN_TRUST_PASS=<unspecified>
XSADMIN_JMX_HOST=<unspecified>
XSADMIN_JMX_PORT=<unspecified>
XSADMIN_JMX_URL=<unspecified>
XSADMIN_DMGR=<unspecified>
**********************************
Effective command line arguments
**********************************
XSADMIN_USERNAME=xcadmin
XSADMIN_PASSWORD=xcadmin
XSADMIN_TRUST_PATH=/opt/ibm/WebSphere/wxs71/ObjectGrid/security/trust.jks
XSADMIN_TRUST_TYPE=jks
XSADMIN_TRUST_PASS=ogpass
XSADMIN_PROFILE=/opt/ibm/WebSphere/wxs71/ObjectGrid/properties/test.properties
XSADMIN_JMX_HOST=localhost
XSADMIN_JMX_PORT=portNotSpecified
XSADMIN_JMX_URL=<unspecified>
XSADMIN_DMGR=false
SSL authentication enabled: true
**********************************

In the prior verbose output, "Effective command line arguments" refers to settings that override values from both other methods: using a properties file or as environmentally set attributes.

Parent topic:

Monitor with the xsAdmin sample utility

+

Search Tips   |   Advanced Search