Top
ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)
ServerView

5.3 rcxadm agtctl

Name

[Windows] [Hyper-V]
Installation_folder\Agent\bin\rcxadm agtctl - Agent control

[Linux] [VMware] [Xen] [KVM]
/opt/FJSVrcxat/bin/rcxadm agtctl - Agent control

[Solaris]
/opt/FJSVrcvat/bin/rcxadm agtctl - Agent control


Format

rcxadm agtctl start
rcxadm agtctl stop
rcxadm agtctl modify -manager ip
rcxadm agtctl snap [-dir directory] [-full]

Description

rcxadm agtctl is the command used to start and stop agents, collect troubleshooting data and modify the admin LAN IP address of the manager that is registered in the agent.

For information on starting and stopping agents, refer to "2.2 Starting and Stopping Agents" in the "Operation Guide CE".
For information on collecting troubleshooting data, refer to "1.1.1 Collecting Initial Troubleshooting Data" and "1.1.2 Collecting Exhaustive Troubleshooting Data" in the "Troubleshooting".
For information on changing the manager's admin LAN IP address, refer to "6.1 Changing Admin IP Addresses" in the "User's Guide for Infrastructure Administrators (Resource Management) CE".


Subcommands

start

Starts the Agent.

stop

Stops the Agent.

modify [Physical server] [Hyper-V]

Modifies the admin LAN IP address of the manager that is registered in the agent.

snap

Collects troubleshooting data from the managed server.

The collected data is stored in the following compressed files:

[Windows] [Hyper-V]
rcxtssnap_server_name.jar

[Linux] [Solaris] [VMware] [Xen] [KVM]
When collecting troubleshooting data, data is compressed on managed servers using the bzip2, the gzip, or the compress command. Depending on the command used, the name assigned to troubleshooting data will be one of the following.
Resource Orchestrator uses the command with the best compression ratio (bzip2 -> gzip -> compress) available on the managed server.

  • When Compressing with bzip2

    rcxtssnap_server_name.tar.bz2

  • When Compressing with gzip

    rcxtssnap_server_name.tar.gz

  • When Compressing with compress

    rcxtssnap_server_name.tar.Z


Options

Specify the following options when using the modify subcommand:

-manager ip

Specify the new manager IP address.


The following options can be specified for the snap subcommand:

-dir directory(Optional)

Specify the folder used to store the collected data in directory.
If this option is omitted, the data will be stored in the following folder:

[Windows] [Hyper-V]
The folder defined by the TEMP environment variable

[Linux] [Solaris] [VMware]
/tmp

Note

  • When using full paths in the dir and the TEMP environment variable

    The length of the full path string must not exceed 100 characters. If more than 100 characters are used the troubleshooting data cannot be collected, and message number 67131 or message number 67265 will be displayed.

  • When using relative paths in the dir and the TEMP environment variable

    When specifying a relative folder path, its equivalent full path must not exceed 100 characters (calculated using the Windows 8.3 format (*)). If the converted full path string exceeds 100 characters, the troubleshooting data will not be collected, and the "Message number 67131" will be displayed.

    * Note: This rule specifies that the file name can be a maximum of 8 characters, with a file extension of up to 3 characters

  • The following symbols cannot be specified in the name of the folder in which the collected data is stored:

    """, "|", "*", "?", "/", "<", ">", ",", "%", "&", "^", "=", "!", ";"

[Windows] [Hyper-V]

  • When specifying a folder using a relative path, specify the folder adding ".\" as the first characters.

    -dir .\folder_name

-full (Optional)

Collects exhaustive managed server troubleshooting data. This data is required to isolate the cause of a problem which could not be identified from initial troubleshooting data alone.
This requires significantly more disk space for the generated data files. This option can be omitted when collecting troubleshooting data for an initial investigation (first diagnostic).


Requirements

Permissions

OS Administrator

Location

Managed server


Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.