5.11.5 Obtain list of virtual network information for the ESX server
Function
This obtains the list of virtual network information for the ESX server in the VMware vSphere environment.
The component outputs the list of virtual network information for the ESX server to the file specified with the output file path (common.outputFilePath property).
The encoding style of the output file is the system default encoding of the execution target server.
The server's prerequisites for this component are described below.
- ESX server
Server where VMware vSphere ESXi is installed
- Execution target server
Server where VMware vSphere PowerCLI is installed; this product transfers the component to this server and executes it.
The script in this component executes the following VMware vSphere PowerCLI commandlets to refer to specific items.
- Get-EsxTop -CounterName "NetPort"*1
- ClientName (Interface name, such as the virtual machine name or Kernel port name)
- TeamUplink (Valid adapter name)
- Get-VirtualSwitch
- Name (Virtual switch name)
- Nic (Adapter name)
*1: NetPort, specified for the CounterName option, is a fixed value.
From the result of executing the aforementioned commandlets, obtain the value where Get-VirtualSwitch.Nic agrees with Get-EsxTop.TeamUplink.
The items in the output CSV file are described below.
The output items are separated by commas.
(a) Interface name (Header name: ClientName)
(b) Adapter name (Header name: TeamUplink)
(c) Virtual switch name (Header name: DNAME)
Example CSV file output
"ClientName","TeamUplink","DNAME"
"vmk0","vmnic0","vSwitch0"
"vm01","vmnic1","vSwitch1"
Use situation
The component can be used for referencing valid adapters in the virtual network of the ESX server.
Prerequisites
For the latest support information about [Required product for the system]/[Required product for the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the Release Notes.
[Required product for the system]
- JP1/Automatic Operation 11-10 or later
[Required product for the system executing the service template]
(1) Prerequisite product for VMware vSphere ESX to manage virtual servers
- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
[Use conditions of required product for the system]
None
[Required products for the service template execution server]
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
[Prerequisite product OS running in the system executing the service template]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
- Windows Server 2019 Standard/Datacenter
Cautions
(1) Do not use double or single quotation marks (" " or ' ') in a string specified for the property of this component.
(2) If the file specified for the output file path (common.outputFilePath property) already exists, the existing file is overwritten. Make sure that the specified file name is correct.
(3) If there is no folder in which to create the file specified for the output file path (common.outputFilePath property), the folder is created.
Execution privilege
(1) Users connecting to the ESX server are required to have the privileges of the system administrator role.
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereOutputVmNetworkInfo
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component script.)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.ESXServerName |
ESX Server Name |
Specify the ESX server host name or IP address. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.ESXUserName |
User name for connecting to the ESX Server |
Specify the user name for connecting to the ESX Server. |
-- |
Input |
R |
|
VMware.ESXPassword |
Password for connecting to the ESX Server |
Specify the password for connecting to the ESX Server. |
-- |
Input |
R |
|
VMware.ESXPortNumber |
Port number for connecting to the ESX Server |
Specify the number of the port for connecting to ESX Server. |
443 |
Input |
O |
|
VMware.ESXProtocol |
Protocol for connecting to the ESX Server |
Specify either HTTP or HTTPS as the protocol for connecting to ESX Server. |
HTTPS |
Input |
O |
|
common.outputFilePath |
Output file path |
Specifies the file to be output as a full path. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |