5.11.53 Get the physical adapter information list
Function
This plugin outputs information about physical adapters connected to an ESX server in a VMware vSphere environment.
If you specify a physical adapter name (VMware.physicalAdapterName property), only the link status of the specified physical adapter is set to the VMware.outPhysicalAdapterStatus property.
If you omit a physical adapter name (VMware.physicalAdapterName property), a listing of information about physical adapters connected to the ESX server is output, in CSV format, to the physical-adapter information output file on the vCenter control server. This file is specified by the VMware.esxAdapterOutputFileName property.
The encoding format of the output file is the default encoding of the system of the vCenter control server.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- ESX server
A server on which VMware vSphere ESXi is installed
- vCenter control server (execution target server)
A server on which VMware vSphere PowerCLI is installed. The plugin is transferred to and executed on this server by JP1/AO.
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes the physical-adapter information output file name (VMware.esxAdapterOutputFileName property).
- The specification of this property is ignored if a physical adapter name (VMware.physicalAdapterName property) is specified.
Use this plug-in script to execute the following VMware vSphere PowerCLI cmdlet:
Get-EsxCli -VMHost VMHost object#1
#1: Object obtained from the value of the ESX server name (VMware.vmHostName property)
Obtain the value of network.nic.list() from the execution results of the above cmdlet, and then store the value in "State of the physical adapter (VMware.outPhysicalAdapterStatus property)".
The following shows the items in the CSV file that is output.
The items are separated by commas.
(a) ESX server name (header name: VmHostName)
(b) Standard virtual switch name (header name: VirtualSwitchName)
(c) Physical adapter name (header name: PhysicalAdapterName)
(d) Physical adapter status (header name: PhysicalAdapterStatus)
Example of CSV file output
"VmHostName","VirtualSwitchName","PhysicalAdapterName","PhysicalAdapterStatus"
"sysbsx10","vSwitch0","vmnic0","Up"
"sysbsx10","vSwitch1","vmnic1","Up"
"sysbsx10","vSwitch1","vmnic2","Down"
Use situation
This plugin can be used to obtain information about physical adapters connected to an ESX server.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products for the system, prerequisite products for the execution-target system, prerequisite products on the execution-target server, and the supported OSs for the prerequisite products for the execution-target server.
Prerequisite products for the system:
JP1/Automatic Operation 11-10 or later
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0
(2) 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
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESX must be managed by VMware vCenter Server.
(2) Conditions for settings on VMware vSphere ESX
- The VMware-related name shown below is case sensitive in VMware, but the specified name is not case sensitive in a vSphere PowerCLI instance that is executed by this plugin.
Therefore, this plugin cannot be used in an environment in which duplicate names with different case letters are used.
- Standard virtual switch name
Prerequisite products on the execution-target server:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release 1, 5.5 Release 2, 5.5 Release 1, 5.1 Release 2, 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
Supported OSs for the prerequisite products for the execution-target server:
- 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 specify a string containing a double quotation mark (") or single quotation mark (') for a property of this plugin.
(2) If the file specified by the physical adapter information output file name (VMware.esxAdapterOutputFileName property) already exists, that file will be overwritten. Therefore, carefully confirm that the specified file name is correct.
(3) If no folder exists in which the physical-adapter information output file (specified by the VMware.esxAdapterOutputFileName property) is to be created, that folder will be created.
(4) If you omit a physical adapter name (VMware.physicalAdapterName property), you must specify a physical-adapter information output file name (VMware.esxAdapterOutputFileName property). If you also omit the physical-adapter information output file name, this plugin ends abnormally.
Execution privilege
(1) Users who connect to VMware vCenter Server must have system administrator permissions.
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereOutputPhysicalAdapInfo
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.vCenterServerName |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
|
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
|
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
|
VMware.vmHostName |
Host name of the ESX server |
Specify the host name of the ESX server. |
-- |
Input |
R |
|
VMware.physicalAdapterName |
Physical adapter name |
Specifies the name of the physical adapter for which information is to be obtained. |
-- |
Input |
O |
|
VMware.esxAdapterOutputFileName |
Name of the file output as the physical adapter information list |
Specifies the full path name of the file to which the physical adapter information list for the ESX server is to be output. |
-- |
Input |
O |
|
VMware.outPhysicalAdapterStatus |
State of the physical adapter |
Stores the specified physical adapter state. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |