jcfcolvmkvm
- Organization of this page
Function
This command acquires virtualization configuration information from KVM, and outputs it to a virtualization configuration information file.
For details about the prerequisite conditions for executing this command, see 3.3.1(1) Prerequisites for managing a virtualization configuration in the JP1/Integrated Management 2 - Manager Configuration Guide.
Format
jcfcolvmkvm
-u user-ID
-i private-key-file-path
[-port port-number]
-c host-name [host-name]
-o output-file-name
Execution permission
In Windows: Administrators permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: Superuser permissions
Storage directory
- In Windows:
-
Manager-path\bin\imcf\
- In UNIX:
-
/opt/jp1imm/bin/imcf/
Arguments
- -u user-ID
-
Specifies the user ID of the host where the connection destination KVM is running. Specify a character string with a maximum of 255 bytes, excluding control characters, for the user ID.
- -i private-key-file-path
-
Specifies the name of the private key file that is used to communicate with the connection destination KVM in absolute path format. Specify a character string with a maximum of 256 bytes, excluding control characters, for the private key file. The private key file path is case sensitive. If the path contains a space, enclose the entire path in double-quotation marks (").
- -port port-number
-
Specifies the port number for an SSH connection with the connection destination KVM. Specify a numeric value with one-byte characters from 1 to 65535. If you omit this option, 22 is assumed.
- -c host-name [host-name]
-
Specifies the names of hosts where KVM is running. For a host name, specify a maximum of 255 characters. You can specify multiple host names by separating them with the space character or the tab delimiter.
- -o output-file-name
-
Specifies the relative or absolute path name of the virtualization configuration information file that is to store the configuration information acquired from KVM. This option is mandatory. If the path contains a space, enclose the entire path in double-quotation marks (").
Return values
|
0 |
Normal termination#1 |
|
1 |
Argument error |
|
2 |
Insufficient memory |
|
3 |
JavaVM start error occurred |
|
4 |
Execution permission error |
|
5 |
Command was not executed from the administrator console |
|
6 |
Output file already exists |
|
7 |
Acquisition of virtualization configuration information failed#2 |
|
8 |
An input/output error occurred |
|
99 |
Other error |
- #1
-
The command terminates normally even when some of the virtualization configuration information has not been acquired.
- #2
-
The command outputs a return value if it is unable to acquire virtualization configuration information from any host.
Format of the virtualization configuration information file
|
Item |
Output value |
|---|---|
|
Identification character string for a virtualization configuration information file |
#VM |
|
File format version |
101000 |
|
Character encoding |
UTF-8 fixed |
|
Item |
Output value |
|---|---|
|
Host name |
Host_name |
|
VMM host name |
VMM_host_name |
|
Virtualization management type |
Virtual_manager_type |
|
Virtualization management product version |
Manager_version |
|
Virtualization configuration management host |
Virtual_host_manager |
|
Item |
Description |
|---|---|
|
Host name |
Host name |
|
VMM host name |
Name of the host where virtualization environment software is running. In the case of a VMM host with no guest OS, the virtual host name field is blank and only the VMM host name is set. |
|
Virtualization management type |
Type of the product that manages the virtualization configuration: For KVM, KVM is output. |
|
Virtualization management product version |
Version of the product that manages a virtualization configuration. |
|
Virtualization configuration management host |
Name of the host that manages a VMM host. For the jcfcolvmkvm command, this field is always blank. |
Example output
#VM,101000,UTF-8 Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager jp1-sf7800b,,KVM,0.12.1, kv7801,jp1-sf7800b,,, kv7802,jp1-sf7800b,,, kv7803,jp1-sf7800b,,, kv7804,jp1-sf7800b,,,