Monitoring

  1. Monitor data grids in the user interface
  2. Monitor activities with tasks
  3. xscmd utility
  4. CSV files
  5. xsadmin utility
  6. SNMP


Monitoring

You can monitor several aspects of the appliance, including...

To see data in either the Tasks view or the Monitor view in the user interface, your appliance must be configured and have data grids created that are receiving new entries from the applications.


Monitor data grids in the user interface

Use the charting capabilities of WebSphere DataPower XC10 appliance to view the overall performance of the data grids in your environment.

After you create the data grids and configure the applications to use the data grids, allow some time to pass for the statistics to become available. For example, with a dynamic cache data grid, statistics are not available until a WebSphere Application Server running a dynamic cache connects to the dynamic cache data grid on the appliance. If you are using a collective, the collective initialization must be complete before statistics are available. In general, wait up to one minute after a major configuration change to see the changes in your statistics.


Charting behavior

The day, week and month data series are persisted long-term. However, the Last hour data series is only stored in memory. The last hour data is stored in the following locations:

If a piece of statistics data is lost in only one of these memory locations, then the data is still available. However, if the data is lost in both locations, the data does not display in the chart.


Memory data loss conditions:

To view the performance of all of the data grids...

This page contains the following information:

  • To view individual data grids, click...

      Monitor | Individual data grid overview | data_grid_name

    This page shows a summary that includes...

    • number of cache entries
    • average transaction time
    • average throughput
    • cache hit rate
    • percentage of limited capacity over the last 30 seconds

    You can also view the following charts:

      Used Capacity

      Used capacity of the cache versus the actual number of entries and the configured capacity limit of the cache. You can edit the time range that is displayed: last hour, last day, last week, last month. The level of detail that is showed on the chart varies depending on the time range that you select.

      Examples...

      • For dynamic cache data grids:

        94 cache entries are created by default for every dynamic cache data grid. Therefore, 94 cache entries are displayed in the monitoring panel before you add any data to the dynamic cache data grid. These cache entries contain statistics and configuration for WebSphere Application Server.

      • For dynamic cache data grids:

        166 cache entries are created by default for every dynamic cache data grid. Each dynamic cache grid has 83 partitions, and each partition or shard is initialized with two entries for dynamic cache grids. Therefore, the number of cache entries at initialization is 166. These cache entries contain statistics and configuration for WebSphere Application Server. Therefore, 166 cache entries are displayed in the monitoring panel before you add any data to the dynamic cache data grid.

      • For session data grids:

        The number of entries in the data grid includes counts for the number of sessions, the number of attributes across all sessions, and eviction table entries. The eviction table is populated when a timed out session that has not been invalidated by the Web container exists. The eviction table is only populated during an application server failover.

      Cache Usage

      Visualize the number of successful queries to the cache. Display cache attempts, cache hits, and the cache hit rate.

      Average Throughput

      Average number of transactions per second being processed over a given time range and the average length of time for each transaction.

  • To view further details about a specific data grid...

      Monitor | Data grid detail reports

    A tree displays with all of the data grids in the configuration. You can drill down into a specific data grid to view the maps that are a part of that data grid. You can either click a data grid name or a map for further information:

      Data grid details

      You can view the used capacity, and a list of zones to which the data grid belongs. A chart that shows the capacity consumed by the top 25 maps in the data grid displays. You can also view a total pool, which includes the capacity by zone. A chart shows how much data grid capacity is consumed across the top 25 zones.

      Map details

      View further information about the maps in each grid, including...

      • total number of cache entries in the map
      • average throughput
      • average transaction time
      • total capacity of the map broken down by the top 25 partitions


    Monitor activities with tasks

    Use tasks to monitor the progress of administrative changes, such as adding appliances to the collective. You can view the state of a task from beginning to end. A task has an overall status of queued, success or failed.

    Icon Description
    Queued () The task has entered the task queue and has not yet started running.
    Running () The task is currently running.
    Success () The task has completed without any errors.
    Failed () The task did not complete.

    Each task consists of one or more messages that give more information about the task status.

    Icon Description
    Information () The message contains information about a step of the task running.
    Error () The task did not complete.

    1. In the user interface, click Tasks.

    2. You can view a specific task by clicking the task name for more information.

      Each task includes information such as...

      • Type of task
      • Started and completed date and time of the task
      • List of specific status messages to show more specific information about task progress

      Until the task completes with a state of Success or Failed, the page refreshes every 10 seconds to update the status of the task.


    Monitor with the xscmd utility

    With the xscmd utility, you can display textual information about the data grids that are running on your appliance.

    Use the xscmd utility to view the current layout and specific state of the data grid, such as map content. In this example, the layout of the data grid in this task consists of a single ObjectGridA data grid with one MapA map that belongs to the MapSetA map set. This example demonstrates how you can display all active containers within a data grid and print out filtered metrics regarding the map size of the MapA map. To see all possible command options, run the xscmd utility without any arguments or with the -help option.

    Monitor the environment with the xscmd utility.

    • Enable statistics for all of the servers...

        ./xscmd.sh -c setStatsSpec -spec ALL=enabled -g ObjectGridA

    • Display all online container servers for a data grid...

        ./xscmd.sh -c showPlacement -g ObjectGridA -ms MapSetA

      To obtain this information when TLS/SSL is enabled, start the catalog and container servers with the JMX service port set...

      • -JMXServicePort option on the startOgServer script
      • Call the setJMXServicePort method on the ServerProperties interface

    • Display information about the maps for the ObjectGridA data grid...

        ./xscmd.sh -c showMapSizes -g ObjectGridA -ms MapSetA

    • Connect to the catalog service and display information about the MapA map for the entire catalog service domain...

        ./xscmd.sh -c showMapSizes -g ObjectGridA -ms MapSetA -m MapA -cep CatalogMachine:6645

    • Display the configured and runtime placement of the configuration...

      • xscmd -c placementServiceStatus
      • xscmd -c placementServiceStatus -g ObjectGridA -ms MapSetA
      • xscmd -c placementServiceStatus -ms MapSetA
      • xscmd -c placementServiceStatus -g ObjectGridA

      You can scope the command to display placement information for the entire configuration, a single data grid, a single map set, or a combination of a data grid and map set.


    Monitor with CSV files

    Monitoring data is automatically written to CSV files. These CSV files can contain information about the servers, map, or data grid.

    Monitoring data to be written to CSV files by default. You can download and analyze historical data for the servers that are running on the appliance. Data begins being collected when the servers start. You can then download the CSV files at any time and use the files as you choose.

    1. Download the CSV file.

      When you download the log files from the appliance, the CSV files are included in the trace.zip file. To download this file...

        Appliance | Troubleshooting | Logging | Download log files

      Within the trace.zip file , the CSV files are in...

        server_name/logs

      The files are named:

      • jvmstats.log
      • mapstats.log
      • ogstats.log.

      • Import the CSV file into the program that you are using to process the data, such as a spreadsheet.


    CSV file statistics definitions

    The CSV files that you can download for a server include statistics that you can use to build historical charts or other information.


    JVM statistics log

      TimeStamp (column 1)

      Specifies the date and time of the statistics snapshot that was taken for the JVM.

      ServerName (column 2)

      Server name of the JVM.

      Hostname (column 3)

      Host name of the JVM.

      DomainName (column 4)

      Catalog service domain to which the JVM belongs.

      FreeMemory (column 5)

      Number of available bytes for the JVM.

      MaxMemory (column 6)

      Maximum number of bytes that can be allocated for the JVM.

      TotalMemory (column 7)

      Display the real memory usage in the server run time.

      AvailProcs (column 8)

      Display the number of processors that are available to this catalog service and its maps. For the highest stability, run your servers at 60% processor loading and JVM heaps at 60% heap loading. Spikes can then drive the processor usage to 80.90%, but do not regularly run your servers higher than these levels


    Map statistics log

      TimeStamp (column 1)

      Specifies the date and time of the statistics snapshot that was taken for the map.

      MapName (column 2)

      Name of the map.

      PartitionId (column 3)

      ID of the partition.

      OgName (column 4)

      Name of the data grid to which this map belongs.

      MapSetName (column 5)

      Map set to which this map belongs.

      HitRate (column 6)

      Display the hit rate (hit ratio) for the selected map. A high hit rate is desirable. The hit rate indicates how well the data grid is helping to avoid accessing the persistent store.

      Count (column 7)

      Indicates a count of the data samples that have been gathered since the server started. For example, a value of 100 indicates that the entry is the 100th sample entry that has been gathered since the server started.

      TotalGetCount (column 8)

      Display the total number of times the map had to access the persistent store to obtain data.

      TotalHitCount (column 9)

      Display the total number of times the requested data was found in the map, avoiding the need to access persistent store.

      StartTime (column 10)

      Time that the counters began from last reset call. The resets occur when the server starts or restarts.

      LastCount (column 11)

      Amount of time since the last data sample was taken.

      LastTotalGetCount (column 12)

      Indicates the current total number of get operations from the cache minus the number of get operations in the previous time period.

      LastTotalHitCount (column 13)

      Indicates the current total number of hits from the cache minus the number of hits in the previous time period.

      UsedBytes (column 14)

      Display memory consumption by this map. The used bytes statistics are accurate only when you are using simple objects or the COPY_TO_BYTES copy mode.

      MinUsedBytes (column 15)

      Display the low point in memory consumption by this catalog service and its maps. The used bytes statistics are accurate only when you are using simple objects or the COPY_TO_BYTES copy mode.

      MaxUsedBytes (column 16)

      Display the high point in memory consumption by this catalog service and its maps. The used bytes statistics are accurate only when you are using simple objects or the COPY_TO_BYTES copy mode.

      LastUsedBytes (column 17)

      Indicates the current UsedBytes value minus the UsedBytes value from the previous statistics collection period.

      SampleLen (column 18)

      Indicates the length, in milliseconds, of the time period during with the data was sampled.


    ObjectGrid statistics log

      TimeStamp (column 1)

      Specifies the date and time of the statistics snapshot that was taken for the data grid.

      OgName (column 2)

      Name of the data grid.

      Count (column 3)

      Indicates a count of the data samples that have been gathered since the server started. For example, a value of 100 indicates that the entry is the 100th sample entry that has been gathered since the server started.

      PartitionId (column 4)

      Partition ID.

      Hostname (column 5)

      Host name.

      DomainName (column 6)

      Catalog service domain to which this data grid belongs.

      MaxTime (column 7)

      Display the time spent by the most time-consuming transaction for this server.

      MinTime (column 8)

      Display the time spent by the least time-consuming transaction for this server.

      MeanTime (column 9)

      Average time spent on a transaction.

      TotalTime (column 10)

      Display total time spent on transactions for this server, since the time for this server was initialized.

      AvgTransTime (column 11)

      Display the average time required to complete a transaction for this server.

      AvgThroughPut (column 12)

      Display the average number of transactions per second for this server.

      SumOfSquares (column 13)

      Sum of squares value for the transaction time. This value measures the deviation from the mean at the given point in time.

      SampleLen (column 14)

      Indicates the length, in milliseconds, of the time period during with the data was sampled.

      LastDataSample (column 15)

      Time since the last sample was taken.

      LastTotalTime (column 16)

      Current total time minus the previous total time for the data sample.

      StartTime (column 17)

      Indicates the time that the statistics began to be collected since the last reset of the data. The data is reset when the server restarts.


    Monitor with xsadmin.sh

    With xsadmin.sh, you can format and display textual information about the data grids that are running on your WebSphere DataPower XC10 appliance. The sample utility provides a method for parsing and discovering current deployment data, and can be used as a foundation for writing custom utilities.

    • The xsadmin utility is provided as a sample of how you can create custom utilities for the deployment. The xscmd utility is provided as a supported utility for monitoring and administering your environment.

    • The xsadmin utility is included in the WebSphere eXtreme Scale Client installation.

    • For xsadmin.sh to display results, have data grids created and configured on your appliance.

    The xsadmin utility uses an implementation of Managed Beans (MBeans). You can extend the capabilities of this utility using the interfaces in the com.ibm.websphere.objectgrid.management package. You can look at the source code of the xsadmin application in the wxs_client_home/samples/xsadmin.jar file in a stand-alone installation, or in the wxs_client_home/optionalLibraries/ObjectGrid/xsadmin.jar file in a WebSphere Application Server installation.

    1. Download the active truststore for the appliance to the client.

      From the appliance user interface...

      The default truststore file is the xsatruststore.jks file. The default password for this file is: xc10pass.

    2. On the command line, set the JAVA_HOME environment variable.

      • export JAVA_HOME=javaHome
      • set JAVA_HOME=javaHome

    3. Go to the bin directory.

      cd wxs_client_home/bin

    4. Run xsadmin.sh. To connect to the appliance, you must include the security arguments for the truststore that you downloaded, the user name and password you use to log in to the appliance, and the host name of your appliance each time you run the command:

      xsadmin.sh -trustPath xsatruststore.jks -trustType jks -ssl -trustPass xc10pass 
      -username xcadmin -password xcadmin -ch myxc10.mycompany.com 
      [additional_xsadmin_parameters]
      You can also create a configuration file to save these parameters. An example of a properties file with the required parameters included follows:

      XSADMIN_TRUST_PATH=xsatruststore.jks
      XSADMIN_TRUST_TYPE=JKS
      XSADMIN_TRUST_PASS=xc10pass
      XSADMIN_USERNAME=xcadmin
      XSADMIN_PASSWORD=xcadmin
      To run xsadmin.sh with the properties file, use the -profile argument to indicate the location of the properties file.

      xsadmin.sh -profile myxc10.properties -ssl -ch myxc10.mycompany.com 
      [additional_xsadmin_parameters]


    xsadmin utility reference

    You can pass arguments to xsadmin.sh with two different methods: with a command-line argument, or with a properties file.


    xsadmin arguments

    You can define a properties file for xsadmin.sh with WebSphere eXtreme Scale Client Version 7.1 Fix 1 or later. By creating a properties file, you can save some of the frequently used arguments, such as the user name. The properties that you can add to a properties file are in the following table. If you specify both a property in a properties file and the equivalent command-line argument, the command-line argument value overrides the properties file value.

    Arguments for xsadmin.sh...

    Command Line Argument Equivalent Property Name in Properties File Description and valid values
    -bp n/a

    Indicates the listener port.

    Default:2809

    -ch n/a

    Indicates the JMX host name for the catalog server.

    Default:localhost

    -clear n/a

    Clears the specified map.

    Allows the following filters: -fm

    -containers n/a For each data grid and map set, displays a list of container servers.

    Allows the following filters: -fnp

    -continuous n/a Continuous map size results to monitor the data grid. When you run this command with the -mapsizes argument, the map size is displayed every 20 seconds.
    -coregroups n/a Displays all core groups for the catalog server. This argument is used for advanced diagnostics.
    -dismissLink <catalog_service_domain> n/a Does not apply for WebSphere DataPower XC10 appliance configurations.
    -dmgr n/a Does not apply for WebSphere DataPower XC10 appliance configurations.
    -empties n/a Show empty containers in the output.
    -establishLink <foreign_domain_name> <host1:port1,host2:port2...> n/a Does not apply for WebSphere DataPower XC10 appliance configurations.
    -fc n/a Filters for only this container. If you are filtering container servers in a WAS ND environment, use the following format:

      <cell_name>/<node_name>/<serverName_containerSuffix>

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec

    -fh n/a Filters for only this host.

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable

    -fm n/a Filters only for this map.

    Arguments: -clear, -mapsizes

    -fnp n/a Filters servers that have no primary shards.

    Arguments: -containers

    -fp n/a Filters for only this partition.

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable

    -fs n/a Filters for only this server.

    If you are filtering application servers in a WebSphere Application Server Network Deployment environment, use the following format:

    <cell_name>/<node_name>/<server_name>

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec

    -fst n/a Filters for only this shard type. Specify P for primary shards only, A for asynchronous replica shards only, and S for synchronous replica shards only.

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec

    -fz n/a Filters for only this zone.

    Arguments: -mapsizes, -teardown,-revisions,-getTraceSpec,-setTraceSpec,-getStatsSpec,-setStatsSpec,-routetable

    -force n/a Forces the action that is in the command, disabling any preemptive prompts. This argument is useful for running batched commands.
    -g n/a Specifies the ObjectGrid name.
    -getstatsspec n/a Displays the current statistics specification. You can set the statistics specification with the -setstatsspec argument.

    Allows the following filters: -fst -fc -fz -fs -fh -fp

    -getTraceSpec n/a Displays the current trace specification. You can set the trace specification with the -settracespec argument.

    Allows the following filters: -fst -fc -fz -fs -fh -fp

    -h n/a Displays the help for xsadmin.sh, which includes a list of arguments.
    -hosts n/a Displays all of the hosts in the configuration.
    -jmxUrl XSADMIN_JMX_URL Address of a JMX API connector server in the following format: service:jmx:protocol:sap. The protocol and sap variable definitions follow:

      protocol

      Transport protocol to be used to connect to the connector server.

      sap

      Address at which the connector server is found.
    -l n/a Displays all known data grids and map sets.
    -m n/a Name of the map set.
    -mapsizes n/a Displays the size of each map on the catalog server to verify that key distribution is uniform over the shards.

    Allows the following filters: -fm -fst -fc -fz -fs -fh -fp

    -mbeanservers n/a Displays a list of all MBean server end points.
    -overridequorum n/a

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -password XSADMIN_PASSWORD Password to log in to xsadmin.sh. Do not specify the password in your properties file if you want your password to remain secure.
    -p n/a

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

      n/a Displays the configured placement and runtime placement of the configuration. You can scope the output to a combination of data grids and map sets, or for the entire configuration:

    • Entire configuration:

      -placementStatus

    • For a specific data grid:

      -placementStatus -g my_grid

    • For a specific map set:

      -placementStatus -m my_mapset

    • For a specific data grid and map set:

      -placementStatus  -g my_grid 
      -m my_mapset

    -primaries n/a Displays a list of the primary shards.
    -profile n/a Specifies a fully qualified path to the properties file for xsadmin.sh.
    -quorumstatus n/a

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -releaseShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a Used in conjunction with the -reserveShard argument. The -releaseShard argument must be invoked after a shard has been reserved and placed. . The -releaseShard argument invokes the ContainerMBean.release() method.
    -reserved n/a Used with the -containers argument to display only shards that have been reserved with the -reserveShard argument.
    -reserveShard <container_server_name> <objectgrid_name> <map_set_name> <partition_name> n/a Moves a primary shard to the specified container server. The ContainerMBean.reserve() method is invoked by this argument.

    -resumeBalancing <objectgrid_name> <map_set_name>

    n/a Attempts to balance requests. Enables future rebalancing attempts on the specified ObjectGrid and map set.
    -revisions n/a Displays revision identifiers for a catalog service domain including: each data grid, partition number, partition type (primary or replica), catalog service domain, lifetime ID, and number of data revisions for each specific shard. Use this argument to determine if an asynchronous replica or linked domain is caught up. This argument invokes the ObjectGridMBean.getKnownRevisions() method.

    Allows the following filters: -fst -fc -fz -fs -fh -fp

    -routetable n/a Displays the current state of the data grid from a client server perspective. The route table is the information that an ObjectGrid client server uses to communicate with the data grid. Use the route table as a diagnostic aid when you are trying to identify connection problems or TargetNotAvailable exceptions.

    Required arguments: In a stand-alone environment, specify the -bp and -p parameters with this argument if you are not using the default values for the bootstrap listener port and JMX port for the catalog server host.

    Allows the following filters: -fz -fh -fp

    -settracespec <trace_string> n/a

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations. trace on the appliance.

    Allows the following filters: -fst -fc -fz -fs -fh -fp

    -swapShardWithPrimary <container_server_name> <objectgrid_name> <map_set_name> <partition_name>

    n/a Swaps the specified replica shard from the specified container server with the primary shard. By running this command, you can manually balance primary shards when needed.
    -setstatsspec <stats_spec> n/a Enables statistics gathering. This argument invokes the DynamicServerMBean.setStatsSpec and DynamicServerMBean.getStatsSpec methods.

    Allows the following filters: -fm -fst -fc -fz -fs -fh -fp

    -suspendBalancing <objectgrid_name> <map_set_name>

    n/a Prevents future attempts to balance the specified ObjectGrid and map set.
    -ssl n/a Indicates that SSL is enabled.
    -teardown n/a

    Allows the following filters: -fst -fc -fz -fs -fh -fp

      Format to provide a list of servers:

      server_name_1,server_name_2 ...

      To stop all servers in a zone, include the -fz argument:

      .fz <zone_name>

      To stop all servers on a host, include the -fh argument:

      .fh <host_name>

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

      n/a Forces shard placement to run, ignoring the configured numInitialContainers value in the deployment XML file. Use this argument when you are performing maintenance on your servers to allow shard placement to continue running, even though the numInitialContainers value is lower than the configured value.
    -trustPass XSADMIN_TRUST_PASS Password for the specified truststore.
    -trustPath XSADMIN_TRUST_PATH Path to the truststore file.

    Example: etc/test/security/server.public

    -trustType XSADMIN_TRUST_TYPE Type of truststore.

    Valid values: JKS, JCEK, PKCS12, and so on.

    -unassigned n/a Displays a list of shards that cannot be placed on the data grid. Shards cannot be placed when the placement service has a constraint that is preventing placement.
    -username XSADMIN_USERNAME Specifies the user name to log in to xsadmin.sh.
    -v n/a Enables the verbose command-line action. Use 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.
    -xml n/a Prints the unfiltered output from the PlacementServiceMBean.listObjectGridPlacement() method. The other xsadmin arguments filter the output of this method and organize the data into a more consumable format.


    xsadmin tool to xscmd tool migration

    In previous releases, the xsadmin tool was a sample command-line utility to monitor the state of the environment. The xscmd tool has been introduced as an officially supported administrative and monitoring command-line tool. If you were previously using the xsadmin tool, consider migrating your commands to the new xscmd tool.


    xsadmin and xscmd command equivalents

    xsadmin argument xscmd equivalent xscmd parameters
    -bp

    • -cep hostname:listener_port
    • --catalogEndpoint hostname:listener_port

    n/a
    -ch

    • -cep hostname:listener_port
    • --catalogEndpoint hostname:listener_port

    n/a
    -clear -c clearGrid -g, -ms, -v, -m, (-cep)
    -containers

    • -c listCoreGroups
    • -c listCoreGroupMembers -cg core_group

    -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
    -continuous n/a n/a
    -coregroups

    • -c listCoreGroups
    • -c listCoreGroupMembers -cg core_group

    n/a
    -dismissLink <catalog_service_domain> -c dismissLink

    • -fd <foreignCatalogServiceDomain>
    • --foreignCatalogServiceDomain <foreignCatalogServiceDomain>

    -dmgr n/a - this argument is automatically determined with xscmd n/a
    -empties arg specific to a new command n/a
    -establishLink <foreign_domain_name> <host1:port1,host2:port2...> -c establishLink

    • -fd <foreignCatalogServiceDomain> -fe <host1:port1,host2:port2...>
    • --foreignCatalogServiceDomain <foreignCatalogServiceDomain> -foreignEndPoints <host1:port1,host2:port2...>

    -fc

    • -ct
    • --container

    n/a
    -fh

    • -hf
    • --hostFilter

    n/a
    -fm

    • -m
    • --map

    n/a
    -fnp

    • -snp
    • --serversWithNoPrimaries

    n/a
    -fp

    • -p
    • --partitionId

    n/a
    -fs

    • -s
    • --server

    n/a
    -fst

    • -st <shard_type>
    • --shardType <shard_type>

    Shard values: P=primary A=asyncReplica S=syncReplica

    n/a
    -fz

    • -z
    • --zone

    n/a
    -force arg specific to a new command  
    -g

    • -g
    • --objectGrid

    n/a
    -getstatsspec -c getStatsSpec n/a
    -getTraceSpec -c getTraceSpec n/a
    -h You can run help with or without a specific command name:

    • -h
    • --help
    • -h <command_name>
    • --help <command_name>

    n/a
    -hosts -c listHosts -g, -ms, -st, -c, -s, -hf, -z
    -jmxUrl

    • -cep hostname:listener_port
    • --catalogEndpoint hostname:listener_port

    n/a
    -l -c listObjectGridNames n/a
    -m

    • -ms
    • --mapSet

    n/a
    -mapsizes -c showMapSizes -g, -ms, -i, [-ct, -z, -s, -hf, sht [P,A,S], -p]
    -mbeanservers -c listAllJMXAddresses n/a
    -overridequorum -c overrideQuorum n/a
    -password

    • -pwd
    • --password

    n/a
    -p

    • -cep hostname:listener_port
    • --catalogEndpoint hostname:listener_port

    n/a
    -placementStatus -c placementServiceStatus -g, -ms
    -primaries -c showPlacement -sf P -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
    -profile To save the current security settings as a security profile:

    • -ssp profile_name
    • --saveSecProfile profile_name

    To use a specified security profile:

    • -sp profile_name
    • --securityProfile profile_name

     
    -quorumstatus -c showQuorumStatus n/a
    -releaseShard

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c releaseShard

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c, -g, -ms, -p
    -reserved

    • -sf R
    • --shardFilter R

    n/a
    -reserveShard

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c reserveShard

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c, -g, -ms, -p
    -resumeBalancing <objectgrid_name> <map_set_name>

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c resumeBalancing

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -g, -ms
    -revisions -c revisions -s,-p,-g,-m
    -routetable -c routetable -z, -hf,-p,-g,-ms
    -settracespec <trace_string> -c setTraceSpec -spec <trace_string>
    -swapShardWithPrimary

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c swapShardWithPrimary

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c -g, -ms, -p
    -setstatsspec <stats_spec> -c setStatsSpec -spec <stats_spec>
    -suspendBalancing <objectgrid_name> <map_set_name>

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c suspendBalancing

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -g, -ms
    -ssl

    • -ssl
    • --enableSSL

    n/a
    -teardown

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c teardown

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -f, , -st, -snp, -c, -s, -p, -hf, -z, -g, -ms, -m
    -triggerPlacement

    This command-line argument does not apply for WebSphere DataPower XC10 appliance configurations.

    -c triggerPlacement. Does not apply for WebSphere DataPower XC10 appliance configurations. -g, -ms
    -trustPass

    • -tsp
    • --trustStorePassword

    n/a
    -trustPath

    • -ts
    • --trustStore

    n/a
    -trustType

    • -tst
    • --trustStoreType

    n/a
    -unassigned -c showPlacement -sf U -e, -i, , -st, -snp, -ct, -s, -p, -hf, -z, -g, -m, -ms
    -username

    • -user
    • --username

    n/a
    -v

    • -v
    • --verbose

    n/a
    -xml -c showPlacement n/a


    Monitor with Simple Network Monitoring Protocol (SNMP)

    With Simple Network Monitoring Protocol (SNMP) support, you can monitor the status of a IBM WebSphere DataPower XC10 appliance as a part of a larger group of systems in a data center. SNMP monitoring enhances your ability to notice system issues quickly and then responding to them promptly.

    Configure an SNMP client before completing these steps. These steps can be completed without an SNMP client configured, but SNMP monitoring can only be used if a client has been configured. Use the following steps to enable SNMP monitoring for your IBM WebSphere DataPower XC10 appliance. The SNMP settings are unique to the appliance and do not get propagated among the other appliances in the collective.

    Because the SNMP statistics are provided for a single appliance, the reported values are different from the values that are reported by the monitoring panels in the user interface. The user interface reports data on the collective. For example, a value in the SNMP gridStats table, mapStats table, or jvmStats table reports a subset of the total value that is reported in the user interface.


    Enable SNMP monitoring for your appliance

    Simple Network Monitoring Protocol (SNMP) monitoring can be enabled for your IBM WebSphere DataPower XC10 appliance. You can download the management information bases (MIBs) provided on the appliance to specify the SNMP data available to the SNMP client.

    Configure an SNMP client before completing these steps. These steps can be completed without an SNMP client configured, but SNMP monitoring can only be used if a client has been configured. SNMP monitoring is not enabled for IBM WebSphere DataPower XC10 appliance by default. The SNMP settings are unique to the appliance and do not get propagated among the other appliances in the collective.

    1. Navigate to the Monitoring panel. In the IBM appliance user interface, click...

        Appliance | SNMP Settings

    2. Select the check box to enable SNMP monitoring. If you want to disable SNMP monitoring, clear the check box.

    3. Download the Management Information Base (MIB) files that are available on the appliance.

      The Enterprise MIB files describe what functions and data are available from the embedded SNMP agent so that your client can appropriately access them. The client can issue SNMP GET, GET-NEXT and GET-BULK commands. You can download the MIB files and import them into your client to access data beyond the base MIB-II data definitions. Expand Enterprise MIBs, and click the name of each MIB to download the MIB from the appliance.

        Statistics MIB Information similar to the statistics seen with the user interface monitoring functionality. Includes JVM statistics.
        HW Status MIB Information about the state of the hardware, including temperatures, date and time, and so on.

    After completing these steps, you have enabled SNMP monitoring for your appliance and downloaded the MIB data for your SNMP client. Use your SNMP client to view the MIB data.

    Because the SNMP statistics are provided for a single appliance, the reported values are different from the values that are reported by the monitoring panels in the user interface. The user interface reports data on the collective. For example, a value in the SNMP statistics gridStats table, mapStats table, or jvmStats table is a subset of the total value that is reported in the user interface.


    Configure SNMP communities

    You can define access to the SNMP data on your appliance by creating one or more SNMP communities. An SNMP community is required when monitoring is enabled.

    Configure an SNMP client before completing these steps. These steps can be completed without an SNMP client configured, but SNMP monitoring can only be used if a client has been configured. A community is required to authenticate with the SNMP agent embedded on the appliance and access the SNMP data. The SNMP agent embedded on the appliance expects the client to provide a defined community name to authenticate with the agent before it returns the requested data. If a community is not provided, the SNMP agent ignores the request from the client. The SNMP communities are unique to the appliance and do not get propagated among the other appliances in the collective.

    1. Navigate to the Monitoring panel. From the menu bar at the top of the IBM appliance user interface, navigate to Appliance > SNMP Monitoring.

    2. Expand SNMP Communities.

    3. Click Create community.

    4. Complete the form to describe the SNMP community that you would like to create.

        Name

        This field specifies the name used to describe an SNMP community.

        Host restriction

        This field specifies an IP address to be used for communication in IPv4 format and IPv6 format. It also accepts host names that resolve to a host. You can further restrict access to a specified subnet by using a Classless Inter-Domain Routing (CIDR) IP address or host name. If a host restriction is included, communication with any other IP address or subnet is denied. If you leave this field empty, then you allow communication with all IP addresses.

    5. Click the remove icon remove an SNMP community. Existing communities cannot be modified. If a community must be modified, then it must be removed and then recreated.