Hitachi

Job Management Partner 1 Version 10 Job Management Partner 1/Performance Management - Remote Monitor for Virtual Machine Description, User's Guide and Reference


G.5 Command reference

The instance environment and monitoring targets of PFM - RM for Virtual Machine are created on the basis of the PFM - Agent for Virtual Machine instance environment, and then the data in the Store database is migrated. The migration-source (PFM - Agent for Virtual Machine) instance environment is not deleted when migration is performed. We recommend that the source instance environment be kept until stable operation of the migration destination (PFM - RM for Virtual Machine) is confirmed. After confirmation, you can delete the source environment.

For Store database migration methods, see G.1(2)(b) Migration methods.

Organization of this subsection

(1) Migration command

This subsection describes the permission that is required to execute the migration command. This subsection also describes the format of the command.

Command name
jpcaovm2rmvm
Execution permission

Administrator permissions

Storage folder

installation-folder\agt8\tools

Format
jpcaovm2rmvm <subcmd> [-<option> [<value>]]

(2) Subcommands that can be specified in the migration command

The subcommands specified in the migration command select the Store database migration method. The instance definitions and the Store database are migrated according to the selected method. The following describes subcommands that can be specified in the migration command.

(a) Defineonly

Format
defineonly
   -aoinst <PFM - Agent for Virtual Machine instance name>
   -rminst <PFM - RM for Virtual Machine instance name>
   -target <PFM - RM for Virtual Machine monitoring-target-name>
   [-targethost <Target Host>]
   [-aolhost PFM-Agent-for-Virtual-Machine-logical-host-name [-rmlhost PFM-RM-for-Virtual-Machine-logical-host-name]]
   [-targetadd [-instupdate]]
Description

The defineonly subcommand migrates only the instance and monitoring target definitions.

Specify this subcommand if you want to start operation of PFM - RM for Virtual Machine without migrating the Store database. You can also specify this subcommand when running both PFM - Agent for Virtual Machine (migration source) and PFM - RM for Virtual Machine (migration destination), and then importing data from the source to the destination.

Notes
  • Before you execute the migration command with the defineonly subcommand specified, you must stop the service of the migration-target instance.

  • If the -targetadd option is not specified, the specified instance environment and monitoring target are created when migration is performed.

  • If the -targetadd option is specified, the specified monitoring target is added to an existing instance environment at the migration destination.

(b) Store2store

Format
store2store
   -aoinst <PFM - Agent for Virtual Machine instance name>
   -rminst <PFM - RM for Virtual Machine instance name>
   -target <PFM - RM for Virtual Machine monitoring-target-name>
   [-targethost <Target Host>]
   [-aolhost PFM-Agent-for-Virtual-Machine-logical-host-name [-rmlhost PFM-RM-for-Virtual-Machine-logical-host-name]]
   [-targetadd [-instupdate]]
   [-sizecheck]
Description

The Store database of PFM - Agent for Virtual Machine is directly migrated to the Store database of the PFM - RM for Virtual Machine.

Because direct read and write operations are performed on these Store databases, the services of both the PFM - Agent for Virtual Machine and PFM - RM for Virtual Machine instances must be stopped. For this reason, this method is suited for migration of a small-scale environment.

Notes
  • Before you execute the migration command with the store2store subcommand specified, you must stop the services of both the migration-source and migration-target instances.

  • If the -targetadd option is not specified, the specified instance environment and monitoring target are created when migration is performed.

  • If the -targetadd option is specified, the specified monitoring target is added to an existing instance environment at the migration destination.

(c) Backup2store

Format
backup2store
   -aobkpath PFM-Agent-for-Virtual-Machine's-Store-database-backup-directory
   -rminst <PFM - RM for Virtual Machine instance name>
   -target PFM-RM-for-Virtual-Machine-monitoring-target-name
   [-targethost target-host]
   [-aolhost PFM-Agent-for-Virtual-Machine-logical-host-name [-rmlhost PFM-RM-for-Virtual-Machine-logical-host-name]]
   [-targetadd [-instupdate]]
   [-sizecheck]
Description

A backup file for the Store database of PFM - Agent for Virtual Machine is created. Then data is migrated from that file to the Store database of PFM - RM for Virtual Machine.

This method is suited when you want to perform migration without stopping the service of the source instance.

Notes
  • Before you execute the migration command with the backup2store subcommand specified, you must stop the service of the migration-target instance. (You do not need to stop the service of the migration-source instance.)

  • If the -targetadd option is not specified, the specified instance environment and monitoring target are created when migration is performed.

  • If the -targetadd option is specified, the specified monitoring target is added to an existing instance environment at the migration destination.

(d) Backup2backup

Format
backup2backup
   -aobkpath PFM-Agent-for-Virtual-Machine's-Store-database-backup-directory
   -rmbkpath PFM-RM-for-Virtual-Machine's-Store-database-backup-directory
   -rminst <PFM - RM for Virtual Machine instance name>
   -target PFM-RM-for-Virtual-Machine-monitoring-target-name
   [-aolhost PFM-Agent-for-Virtual-Machine-logical-host-name [-rmlhost PFM-RM-for-Virtual-Machine-logical-host-name]]
Description

A backup file for the Store database of PFM - Agent for Virtual Machine is created. Then data is migrated from that file to the backup directory of PFM - RM for Virtual Machine.

The data migrated to the backup directory is then imported to PFM - RM for Virtual Machine.

With this method, you do not need to stop the services of the migration-source and migration-destination instances. You can perform migration while both PFM - Agent for Virtual Machine and PFM - RM for Virtual Machine are running concurrently.

Notes
  • You do not need to stop the services of the migration-source and migration-destination instances before executing the migration command with the backup2backup subcommand specified.

  • Make sure that the instance you specify for the -rminst option and the monitoring target you specify for the -target option exist before executing the migration command.

(3) Arguments of the migration commands

This subsection describes the arguments that can be specified in the migration commands.

(a) Aoinst

Format
-aoinst <PFM - Agent for Virtual Machine instance name>
Description

Use this option to specify the name of the migration-source PFM - Agent for Virtual Machine instance. The string that you specify must be 1 through 32 bytes long and can have single-byte alphanumeric characters.

(b) Aobkpath

Format
-aobkpath PFM-Agent-for-Virtual-Machine's-Store-database-backup-directory-path
Description

Use this option to specify the path of the backup directory for the Store database of the migration-source PFM - Agent for Virtual Machine instance. You can specify either an absolute path or relative path. In both cases, the path length must be 1 through 214 bytes. If you specify a relative path, its actual path (absolute path) must also be 1 through 214 bytes long. When you specify a relative path, the directory that is the current directory when the command is executed is the base directory. You can specify only a directory on the local disk.

(c) Rmbkpath

Format
-rmbkpath PFM-RM-for-Virtual-Machine's-Store-database-backup-directory-path
Description

Use this option to specify the path of the backup directory for the Store database of the migration-destination PFM - RM for Virtual Machine instance. You can specify either an absolute path or relative path. In both cases, the path length must be 1 through 214 bytes. If you specify a relative path, its actual path (absolute path) must also be 1 through 214 bytes long. When you specify a relative path, the directory that is the current directory when the command is executed is the base directory. You can specify only a directory on the local disk.

Notes

The migration-destination directory must be empty. If it is not empty, an error occurs.

(d) Rminst

Format
-rminst <PFM - RM for Virtual Machine instance name>
Description

Use this option to specify the name of the PFM - RM for Virtual Machine instance that you want to create or update, or for which you want to set a monitoring target. The string that you specify must be 1 through 32 bytes long and can have single-byte alphanumeric characters.

Notes
  • To add a monitoring target to an existing instance environment, use the -targetadd option, instead of using the -rminst option. If you specify the name of an existing instance for the -rminst option, an error occurs.

  • When you specify an instance for the -rminst option of the backup2backup subcommand, make sure that the instance exists. If the instance does not exist, an error occurs.

(e) Target

Format
-target PFM-RM-for-Virtual-Machine-monitoring-target-name
Description

Use this option to specify a string that identifies a monitoring target of the instance. The string that you specify must be 1 through 32 bytes long, and can have single-byte alphanumeric characters and hyphens (-).

Notes
  • If you specify the same name as the name of another monitoring target of the same instance, an error occurs.

  • You cannot specify a monitoring target name that begins with a hyphen (-).

  • When you specify the -target option of the backup2backup subcommand, make sure that the instance specified for the -rminst option exists. If the instance does not exist, an error occurs.

(f) Targethost

Format
-targethost <Target Host>
Description

Use this option to specify the name of the monitoring-target host that is the migration destination. The string that you specify must be 1 through 32 bytes long, and can have single-byte alphanumeric characters and hyphens (-).

Notes
  • You cannot specify a monitoring-target host name that begins with a hyphen (-).

  • If you omit specifying the monitoring-target host name, the VM_Host value of PFM - Agent for Virtual Machine will be used. However, if that value is not 1 through 32 bytes long or that value uses characters that are not single-byte alphanumeric characters or hyphens (-), an error occurs.

(g) Aolhost

Format
-aolhost PFM-Agent-for-Virtual-Machine-logical-host-name
Description

Use this option to specify the name of the logical host that contains the migration-source PFM - Agent for Virtual Machine instance environment. The string that you specify must be 1 through 32 bytes long, and can have single-byte alphanumeric characters and hyphens (-).

Notes
  • For the value of this option, you cannot specify the string localhost, an IP address, or a host name that begins with a hyphen (-).

  • The string that you specify cannot include spaces and the following symbols:

    \ (backslash)

    / (slash)

    : (colon)

    ; (semicolon)

    * (asterisk)

    ? (question mark)

    " (double quotation mark)

    <> (angle brackets)

    | (vertical bar)

    . (period)

    = (equal sign)

  • If you omit specifying a logical host name, the physical host name will be assumed.

(h) Rmlhost

Format
-rmlhost PFM-RM-for-Virtual-Machine-logical-host-name
Description

Use this option to specify the name of the PFM - RM for Virtual Machine logical host to which an instance environment will be added. The string that you specify must be 1 through 32 bytes long, and can have single-byte alphanumeric characters and hyphens (-).

Notes
  • For the value of this option, you cannot specify the string localhost, an IP address, or a host name that begins with a hyphen (-).

  • The string that you specify cannot include spaces and the following symbols:

    \ (backslash)

    / (slash)

    : (colon)

    ; (semicolon)

    * (asterisk)

    ? (question mark)

    " (double quotation mark)

    <> (angle brackets)

    | (vertical bar)

    . (period)

    = (equal sign)

  • If you omit specifying a logical host name, the PFM - Agent for Virtual Machine logical host name specified for the -aolhost option will be assumed.

(i) Targetadd

Format
-targetadd
Description

Specify this option to add a monitoring target to an existing PFM - RM for Virtual Machine instance environment.

Notes
  • An attempt to migrate to an existing instance environment without specifying the -targetadd option results in an error.

  • If the specified instance environment does not exist, an error occurs.

  • When adding a monitoring target, make sure that the monitoring target you specify for the -targetadd option has not been deleted by using the jpcconf target unsetup command. If you specify the name of a deleted monitoring target, migration might fail. Specify a new monitoring target name or a new PFM - RM for Virtual Machine instance when performing migration.

(j) Instupdate

Format
-instupdate
Description

Specify this option to update the definitions of an existing PFM - RM for Virtual Machine instance environment.

Notes

(k) Sizecheck

Format
-sizecheck
Description

Specify this option to output the results of checking how large the Store database and its backup file will be after migration. After command execution, a message indicating whether migration is possible is output. With the message, the user can determine whether migration is possible.

Notes

When the migration command is executed without the -sizecheck option, migration immediately starts if the Store database will not become so large that migration fails.

(4) Return values of the migration command

The following table describes the return values of the migration command.

Table G‒1: Return values of the migration command

0

The command terminated normally.

1

There are problems with the specified arguments.

2

A user without sufficient permissions attempted to execute the command.

4

The service of the specified PFM - Agent for Virtual Machine or PFM - RM for Virtual Machine instance has not stopped.

5

The service of the specified PFM - Agent for Virtual Machine or PFM - RM for Virtual Machine instance has not been installed.

100

There are problems with the Performance Management environment.

102

The specified logical host has not been set up.

109

The monitoring target settings could not be reported to PFM - RM.

110

The number of monitoring targets has already reached the maximum.

200

Memory is insufficient.

210

Disk capacity is insufficient.

211

A necessary file or directory could not be accessed.

230

Execution of an internal command failed.

231

Registration of the Windows service failed.

240

The specified PFM - Agent for Virtual Machine instance does not exist.

241

The specified PFM - RM for Virtual Machine instance does not exist.

242

The specified PFM - RM for Virtual Machine instance already exists.

243

The VM_Type values of the specified PFM - Agent for Virtual Machine and PFM - RM for Virtual Machine instances do not match.

244

The -targethost option was omitted and the VM_Host value of the specified PFM - Agent for Virtual Machine instance was not 1 through 32 bytes long or included characters that were not single-byte alphanumeric characters or hyphens (-).

245

The specified PFM - RM for Virtual Machine monitoring target does not exist.

246

The specified PFM - RM for Virtual Machine monitoring target already exists.

247

The version of PFM - Agent for Virtual Machine is 09-00 or earlier.

248

One of the database files that make up the Store database will become larger than 2,048 MB after migration.

250

The specified PFM - Agent for Virtual Machine backup directory does not exist.

251

The specified PFM - RM for Virtual Machine backup directory does not exist.

252

The specified PFM - RM for Virtual Machine backup directory is not empty.

254

The Store version of the specified PFM - Agent for Virtual Machine instance is not 2.0. Alternatively, the data model version of that instance is not 4.0.

255

An unexpected error occurred.