ssocolstart
Format
- To start collection based on all collection conditions:
ssocolstart [-S connection-destination-server-name] -all [-stime collection-start-time] [-ptime collection-end-time | -period collection-period]
- To specify a server or resource and start collection:
-
(a) When you specify a server (either -s or -sf is needed)
ssocolstart [-S conection-destination-server-name] {-s server-name,... |-sf group-definition-file-name,group-name} [-r resource-ID,... | -rf group-definition-file-name,group-name] [-stime collection-start-time] [-ptime collection-end-time | -period collection-period]
(b) When you specify a resource (either -r or -rf is needed)
ssocolstart [-S conection-destination-server-name] [-s server-name,... | -sf group-definition-file-name,group-name] {-r resource-ID,... | -rf group-definition-file-name,group-name} [-stime collection-start-time] [-ptime collection-end-time | -period collection-period]
- To specify the name of a collection status definition file and start collection:
ssocolstart [-S connection-destination-server-name] -i collection-status-definition-file
- To output the command usage:
ssocolstart -h
Function
The ssocolstart command starts collection of resources.
This command is effective for collection conditions whose collection status is Deferred, Completed, Impossibile, or SNMP error. It is ineffective for collection conditions having any other collection status.
Options
-S connection-destination-server-name
Specifies the monitoring manager on which you want to start collection. Specify the host name or IP address in 255 bytes or less. If you omit this option, the command starts collection on the server on which you executed the command.
-all
Starts collection of all the collection conditions set in the collection condition configuration file.
-stime collection-start-time
Specifies the date and time at which to start collection in the format yyyy.mm.dd.hh.mm.ss. The specifiable range is January 1, 1980 00:00:00 to December 31, 2099 23:59:59. If you omit this option or if the specified collection start time has passed, collection starts at the time the command is executed.
-ptime collection-end-time
Specifies the date and time at which to end collection in the format yyyy.mm.dd.hh.mm.ss. The specifiable range is January 1, 1980 00:00:00 to December 31, 2099 23:59:59. If you specify this option together with the -stime option to set collection dates and times, specify a later date and time than the start date and time. If you omit the -ptime and -period options, the command collects resources indefinitely. You cannot specify this option together with the -period option.
-period collection-period
Specifies the resource collection end time by using time elapsed from the collection start time. Specify the collection period in one of days, hours, and minutes. The unit is d (days), h (hours), and m (minutes). You can specify a period not longer than 31 days. The default unit of time is m (minutes). If you omit the -period and -ptime options, the command collects resources indefinitely. You cannot specify this option together with the -ptime option.
-s server-name,...
Starts collection on the specified server. Specify the host name or IP address in 255 bytes or less. If the collection conditions configuration file contains no collection conditions for the specified server, the command takes no action. To specify multiple server names, delimit the names with a comma (,).
You can specify this option together with the -r or -rf option. If you do not specify the -r or -rf option, the command starts collection of all resources of the specified server.
-sf group-definition-file-name, group-name
Starts collection on the servers defined in the specified group. If the collection conditions configuration file contains no collection conditions for the defined servers, the command takes no action.
You can specify this option together with the -r or -rf option. If you do not specify the -r or -rf option, the command starts collection of all resources of the servers defined in the group.
Specify the group definition file in 512 bytes or less, including the path name. For details about group definition files, see 6.3.5 Group definition file.
-r resource-ID,...
Starts collection of the resource having the specified resource ID. If the collection conditions configuration file contains no collection conditions for the specified resource ID, the command takes no action. To specify multiple resource IDs, delimit the IDs with a comma (,).
You can specify this option together with the -s or -sf option. If you do not specify the -s or -sf option, the command starts collection of the specified resource on all servers set in the collection conditions configuration file.
For details about the correspondence between resource IDs and resources, see E. Resource IDs.
-rf group-definition-file-name, group-name
Starts collection of the resources defined in the specified group. If the collection conditions configuration file contains no collection conditions for the defined resource IDs, the command takes no action.
You can specify this option together with the -s or -sf option. If you do not specify the -s or -sf option, the command starts collection of the resources defined in the group on all servers set in the collection conditions configuration file.
Specify the group definition file in 512 bytes or less, including the path name. For details about group definition files, see 6.3.5 Group definition file.
-i collection-status-definition-file-name
Reads the collection status definition file specified in this option, and then starts collection as specified in the file.
For details on how to define the collection status definition file, see 6.3.17 Collecting condition definition file.
-h
Outputs the command usage. This option cannot be specified together with other options.
Examples
-
The following example starts collection based on all set collection conditions on a server (vr260):
ssocolstart -S vr260 -all
-
The following example starts collection of resource IDs 1 and 2 from the set collection conditions on a server (vr260):
ssocolstart -S vr260 -r 1,2
-
The following example starts collection of the group RSC contained in a group definition file (/tmp/file.grp) from the set collection conditions on a server (vr260):
ssocolstart -S vr260 -rf /tmp/file.grp,RSC
-
The following example starts collection according to the collection status definition file name (/tmp/file.col) from the set collection conditions on a server (vr260):
ssocolstart -S vr260 -i /tmp/file.col
Return values
0 |
Normal termination |
-1 |
Execution error such as incorrect arguments |
Note
If you execute this command, do not cancel it before processing finishes.