list (SAP CC 5.0 Admin+)

list

Definition

To view the list of system instances of the connected SAP CC system and communication settings

Command Usage

Syntax

list [<FILTER> ...]

Command Arguments

Name	Description
`<FILTER>`	Command filter, that is based on instance identifiers, types or statuses

Detailed Information

The list command gives the possibility to display the dynamic map of the instances (dispatchers, guiders, raters, updaters, taxers and bulkloaders) that are deployed within the Core Server system you are connected to. This dynamic instance map:

Is managed by the master dispatcher instance
Includes the following real-time values related to the instances:
- The instance IDs that uniquely identify the instances within the Core Server system
- The hostnames or IP addresses (IPv4 or IPv6) where the instances are deployed
- The public and private access points of the instances, for each provided technical interface that can be: HCI (HTTP Communication Interface), Web Services (WS), and Message TCP
- The secure modes of the communication channels
- Some date/time information related to the instances (the date and time when each instance started, the current date/time of each instance)
- The status of each instance
- The list of partition ranges handled by the rater and guider instances, that represents a crucial information in an SAP CC landscape. For further information, refer to the SAP CC Application Help documentation.

Instance Statuses

In a Core Server system, each instance may have the following statuses:

Instance Status	Definition
STARTING	The instance is executing its starting sequence
WAITING	This status represents an intermediate status that is only used to inform that the instance is currently registering on the dispatcher instance and is thus waiting for permission in order to continue the starting sequence of its services
ON	The instance services are started and ready for completing operation requests
STOPPING	The instance began executing a shutdown sequence
OFF	The instance is completely stopped and cannot perform any further operation
STANDBY	The instance is currently in standby, which means that this instance is excluded from the scope of the charging operations, and that its handled partitions have been transferred to the other instances whose status is "on"
GOING_INTO_STANDBY	The instance is going into standby, which means that this instance is still performing charging operations, while its handled partitions are being transferred to the other instances whose status is "on"

Depending on the instance type, additional information can complete the status. For example: "Master" indicates that the related dispatcher is currently the master dispatcher instance.

Use

Filtering

To display information related to a subset of deployed instances, you can specify one or several of the following criteria (separated by the space character):

Instance identifier (e.g. rater#1)
Instance type (e.g. dispatcher)
Instance status (e.g. starting)

Note

When using several criteria:

An OR statement will be used for instances (identifiers and types)
An OR statement will be used for statuses
An AND statement will be used between instances and statuses

Example

Considering the following filter:
dispatcher rater guider#1 on waiting
The following expression will be used to filter the dynamic instance map:
(<INSTANCE_TYPE=dispatcher> or <INSTANCE_TYPE=rater> or <INSTANCE_ID=guider#1>) and (<STATUS=on> or <STATUS=waiting>)
And the following instances will be displayed:

All dispatchers whose status is ON or WAITING
All raters whose status is ON or WAITING
guider#1 in case its status is ON or WAITING

Viewing

Your user interface displays the following information about all the deployed instances (dispatcher, guider, rater, updater, taxer, and bulkloader):


        +----+---------+-----+---------+---------+-------------+-----------+-------+------------+
        |ID  |HOSTNAME |HTTP |EXTERNAL |INTERNAL |CURRENT DATE |START DATE |STATUS | PARTITIONS |
        +----+---------+-----+---------+---------+-------------+-----------+-------+------------+
        | .. |         |WS@  |TCP@     |TCP@     |             |           |       |            |
        |    |         |HCI@ |TCP@     |TCP@     |             |           |       |            |
        +----+---------+-----+---------+---------+-------------+-----------+-------+------------+

Legend:

Column Name	Description
ID	The identifier of an instance of the SAP CC Core Server system; Use this identifier to define the target instances of your commands with Admin+
HOSTNAME	The name or the IP address (IPv4 or IPv6) of the machine that hosts one or several instances of the Core Server system
HTTP (HCI, WS)	The visible access points of the HTTP communications dedicated to both the HCI and Web Services (WS) technical interfaces. The client applications or systems have to know this information as it defines the endpoints of the system.
EXTERNAL	The visible access points of the TCP/IP communications dedicated to the high-speed Message TCP technical interface. The client applications or systems have to know this information.
INTERNAL	The private access points of the internal TCP/IP communications between the different instances of the Core Server system. These settings are the base for the interinstance communications.
START DATE	The date and time when the instance started
CURRENT DATE	The current date and time of the instance in the SAP CC system
STATUS	The status of the instance
PARTITIONS	The CSV list of partition ranges handled by the instance (only for rater and guider instances)

Tip

In your SAP system landscape, you can get the list of the client applications (or systems) connected via the Message TCP technical interface for convergent charging services: a mediation system, the SAP CC BART Server system, an SAP CC IEC application.

Authorization

To work with this command in the user interface, you must have a specific role in your SAP CC user profile.

Refer to the SAP CC 5.0 Security Guide for more user assistance and information about the necessary authorizations.

Additional Information

Instance ID identifies an instance in a Core Server system uniquely. When several Core Server systems are deployed in your SAP system landscape, the instance ID information may be not unique anymore depending on the deployment options.

Features and Concepts

Consult the SAP CC 5.0 Application Help for more information about:

the dynamic instance map handled by the master dispatcher instance in your running Core Server system
the architecture of the Core Server system
the back-end database partitioning (feature, business partitioning, database partitions, associated mechanisms)

SAP CC provides several endpoints for accessing the Web Services. Consult the Endpoints of SAP CC Web Services section in the SAP CC 5.0 Web Services Documentation for more user assistance.

Administration, Technical Operations

Consult:

'instancemap export' command in the SAP CC Setup Tool - Primary Help (SAP site)
Starting and stoping instances: see Management of SAP CC in the SAP CC 5.0 Operations Guide

Messages

Code	Message	Action
err.communication_failure	Error: A communication failure occurred with {host}:{port}.
err.invalid_filter	Error: Invalid filter: {filter}