VMware ESX Connection by VIM Job

This job discovers the connections to VMware ESX servers using the VIM protocol.

This section includes:

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Discovery Mechanism

Data Flow Management performs the following procedure:

DFM checks the credentials for the VIM protocol.
If the current credential includes a defined port, DFM uses this port.

Otherwise, the port is not specified in the generated connection URL.

The prefix is determined from the current credential's use SSL attribute.

DFM generates a connection URL: <prefix>://<ip_address>:<port>/sdk.
DFM creates a VMware Infrastructure Client and connects using the generated URL and the user name and password from the credentials.
If the connection is successful, DFM obtains the product details for the ESX server (version, build, and description), which will be used to populate the attributes of the Virtualization Layer Software CI.

In addition, DFM retrieves the UUID and name of the ESX server. ESX UUID is stored in the host_key attribute of the VMware ESX Server CI.

The hostname of the ESX server is stored in the name (key) attribute of the VMware ESX Server CI.
DFM clears all errors or warnings and returns all discovered results.

Otherwise, if the connection is unsuccessful, DFM tries the next VIM protocol credential, until all are tried.

Adapter

This job uses the VMware_ESX_Connection_by_VIM adapter.

Triggered CI Data

Name	Description
ip_addresses	List of all IPs connected to Host.

Used Scripts
- memory.py
- shared_resources_util.py
- _vmware_vim_base.py
- _vmware_vim_20.py
- host_discoverer.py
- _vmware_vim_25.py
- _vmware_vim_40.py
- _vmware_vim_41.py
- vmware_vim.py
- vmware_esx_connection_by_vim.py

Adapter Parameters

Parameter	Description
remoteJVMArgs	The JVM parameters that should be passed to the remote process.
remoteJVMClasspath	The class path used by the external Java process.
runInSeparateProcess	When true, this enables the execution of the job in the external java virtual machine. Default: true. Note Do not change this parameter from the default.

Parameter

Description

remoteJVMArgs

The JVM parameters that should be passed to the remote process.

remoteJVMClasspath

The class path used by the external Java process.

runInSeparateProcess

When true, this enables the execution of the job in the external java virtual machine.

Default: true.

Note Do not change this parameter from the default.