OpenTP1 Version 7 Operation

[Contents][Index][Back][Next]

rtsstats (Change targets and items for real-time statistics acquisition)

Format

rtsstats{-a [-r]|-d }
        {-u sys|
          -u srv -s server-name|
          -u svc -s server-name -v service-name|
          -u obj [-o acquisition-target-name-1][-b acquisition-target-name-2]}
         [-e item-ID[,item-ID]...]
         [-f name-of-definition-file-for-items-to-be-acquired-in-real-time]

Function

The rtsstats command changes the targets for the acquisition of real-time statistics and the items to be acquired.

Options

-a

Adds the targets of real-time statistics acquisition and the items to be acquired.

-r

When you add an item to be acquired for the specified target for real-time statistics acquisition, this option deletes all existing items and adds the new item.

If you do not specify the -r option, existing items remain and the new item is added.

-d

Deletes the targets of real-time statistics acquisition and the acquired items.

-u {sys|srv|svc|obj}

Specifies the type of the new target of real-time statistics acquisition.

sys
Specifies the entire system as the target of real-time statistics acquisition.
When sys is specified, the value of the rts_service_max operand in the real-time statistics service definition is not affected.

srv
Specifies a server as the target of real-time statistics acquisition.
The following statistics are acquired when you add a user server name as the target in the -s option:
  • Statistics for the specified server
  • Statistics for all the services specified in the service operand of the user service definition for the specified user server
  • Statistics for processing that is not related to services
This causes the number of targets for which statistics are to be acquired to be the number of services specified in the service operand plus 2.
If you specify the name of a server that has no services, such as the system server or an SUP, the command acquires statistics for only the specified server.

svc
Specifies a service of a user server as the target of real-time statistics acquisition.

obj
When you specify this option, also use the -o and -b options to specify an object as the target about which statistics are acquired.
For details on the combination of the target objects and options, see the explanation of the -o and -b options.

-s server-name~<Alphanumeric string of 1-8 characters beginning with an alphabetic character>

Specifies the name of the target server.

When srv or svc is specified in the -u option, always specify the -s option. When sys or obj is specified in the -u option, the -s option cannot be specified.

-v service-name~<identifier of 1-31 characters>

Specifies the name of the target service.

When svc is specified in the -u option, always specify the -v option. When sys, srv, or obj is specified in the -u option, the -v option cannot be specified.

-o acquisition-target-name-1~<1-8 characters>

-b acquisition-target-name-2~<1-63 characters>

Specifies the name of the target object when you specify obj in the -u option.

The following table shows the objects you can specify in the -o and -b options as targets. When obj is specified in the -u option, specify arguments in the -o and -b options according to the table.

Table 13-10 Arguments of the -o and -b options in the rtsstats command, and the object determined from the specified arguments

Argument of the -o option Argument of the -b option Object determined from the arguments
Port number# IP address# Node for which the specified service information is referenced
Logical terminal name Not specified Specified logical terminal
Not specified Service group name Specified service group name

#
Specify the port number and IP address of a node specified in the all_node operand of the system common definition or in the domain definition file.

When sys, srv, or svc is specified in the -u option, the -o or -b option cannot be specified.

-e item-ID~<decimal number from 1000 to 9999>

Specifies the item ID of the item to be added or deleted.

You can specify a maximum of 64 item IDs. For details about item IDs, see E.5 Real-time statistics.

-f name-of-definition-file-for-items-to-be-acquired-in-real-time~<identifier of 1-8 characters>

Specifies the name of the definition file for the items to be acquired in real time that contains the item to be added or deleted.

If you want to add items, this option adds the items for which you have specified Y in the specified definition file for the items to be acquired in real time.

If you want to delete items, this option deletes all items except for the items for which you have specified Y in the specified definition file for the items to be acquired in real time.

Output messages

Message ID Description Output destination
KFCA32712-E The combination of version and revision of the real-time statistics service is incorrect. Standard error output
KFCA32714-E Processing cannot continue due to insufficient process memory. Standard error output
KFCA32719-E The command was used incorrectly. Standard error output
KFCA32720-E The value specified in a command option is invalid. Standard error output
KFCA32722-E Processing cannot be executed because shared memory is not available. Standard error output
KFCA32723-E Processing cannot be executed because the real-time statistics service has not started. Standard error output
KFCA32724-E The specified target for the acquisition of real-time statistics is not registered. Standard error output
KFCA32737-I Help message Standard output
KFCA32742-E No more targets can be added because the number of registered targets for real-time statistics acquisition is already at the maximum. Standard error output
KFCA32743-E No more items can be added because the number of registered items to be acquired as real-time statistics is already at the maximum. Standard error output
KFCA32752-E Processing cannot be executed because the extended feature of the real-time statistics service has not started. Standard error output
KFCA32754-E An error occurred when the RPC was executed. Standard error output
KFCA32755-E A timeout error occurred during the wait for a response from the extended feature of the real-time statistics service. Standard error output
KFCA32756-E Processing cannot be executed because the area for storing service requests for the extended feature of the real-time statistics service is insufficient. Standard error output
KFCA32758-E An error occurred during the analysis of the specified definition file. Standard error output
KFCA32760-E The number of arguments specified in the command option is invalid. Standard error output

Notes