jcfcolvmesx
- Organization of this page
Function
This command acquires virtualization configuration information from VMware ESX and outputs it to a virtualization configuration information file.
In order to collect the virtual host name of a guest OS from VMware ESX, VMware Tools must be running on the guest OS. The virtual host name cannot be collected if VMware Tools is not installed or if it is installed but not running.
The virtual host name also cannot be collected if the guest OS itself is not running.
This command uses the interface of VMware Infrastructure SDK for communication.
Format
jcfcolvmesx
[-m communication-type]
-u user-ID
[-p password]
-c host-name [host-name]
-o output-file-name
Execution permission
In Windows: Administrator 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
- -m communication-type
-
Specifies the method used to communicate with VMware ESX.
If https is specified, HTTPS is used for communication with VMware ESX. If http is specified, HTTP is used for communication with VMware ESX.
If this option is omitted, the command uses HTTPS for communication.
- -u user-ID
-
Specifies the user ID associated with the connection-target VMware ESX account.
The user ID must be a maximum of 256 characters. Neither the space nor the tab character can be specified.
- -p password
-
Specifies the password for the user ID that was specified in the -u option.
The password must be a maximum of 256 characters. Neither the space nor the tab character can be specified.
If this option is omitted, the command assumes that there is no password.
- -c host-name [host-name]
-
Specifies the names of hosts where VMware ESX 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 collected from VMware ESX. 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 (Windows only) |
|
5 |
Command was not executed from the administrator console (Windows only) |
|
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 |
090100 |
|
Character encoding |
UTF-8 fixed |
|
Item |
Output value |
|---|---|
|
Host_name |
Host_name |
|
VMM_host_name |
VMM_host_name |
|
Virtual_manager_type |
Virtual_manager_type |
|
Manager_version |
Manager_version |
|
Virtual_host_manager |
Virtual_host_manager |
|
Item |
Description |
|---|---|
|
Host name |
Host name |
|
VMM host name |
Name of the host where virtualization environment software is run. 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. |
|
Virtual_manager_type |
Type of product that manages the virtualization configuration:
|
|
Manager_version |
Version of the product that manages a virtualization configuration |
|
Virtual_host_manager |
Name of the host that manages the VMM host For jcfcolvmesx: a space |
Example output
#VM,090100,UTF-8 Host_name,VMM_host_name,Virtual_manager_type,Manager_version,Virtual_host_manager Vm1,ESX1,,, Vm2,ESX1,,, ESX1,,ESX,4.0,