Retrieve Virtual NIC Configuration operation

The Retrieve Virtual NIC Configuration operation retrieves details about the virtual NIC of the host network.

The following table describes the elements for this request.

Adapter request elements for the Retrieve Virtual NIC Configuration operation

Element	Definition	Required
<operation-type>	Defines the type of the operation: Host	Yes
<operation-name>	Defines the name of the operation: Retrieve_Virtual_NIC_Configuration	Yes
<soap-url>	Specifies the URL for the remote SOAP service running on the VMware VirtualCenter If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration. Default format for HTTPS: https://<hostName>:<port>/sdk/vim Default format for HTTP: http://<hostName>:<port>/sdk/vim Note If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.	No
<transport>	Specifies the transport protocol for the message If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration. Valid values: https-rpc (default), http-rpc Note If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.	No
<user-name>	Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center If no user name is specified, the request is executed with the user name that is specified in the configuration.	No
<password>	Specifies the password corresponding to <user-name>	Conditional; required if <user-name> is specified
<parameters>	Contains the <host-system> element required to execute the operation	Yes
<host-system>	DNS name of the host for which the network configuration details are to be retrieved Valid values: dns name	Yes

The following code sample shows a sample adapter request for the Retrieve Virtual NIC Configuration operation.

Sample adapter request for the Retrieve Virtual NIC Configuration operation

<vmware-infrastructure-request>
   <user-name></user-name>
   <password></password>
   <soap-url></soap-url>
   <transport></transport>
   <operation-type>Host</operation-type>
   <operation-name>Retrieve_Virtual_NIC_Configuration</operation-name>
   <parameters>
       <host-system>xyz.bmc.com</host-system>
   </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Retrieve Virtual NIC Configuration operation.

Sample adapter response for the Retrieve Virtual NIC Configuration operation

<vmware-infrastructure-response>
<metadata>
   <status>success</status>
</metadata>
<RetrieveVirtualNICConfigurationResponse>
   <returnval>
     <HostNetworkSystem>networkSystem-75</HostNetworkSystem>
     <propSet>
       <name>networkInfo.vnic</name>
       <ArrayOfHostVirtualNic>
         <HostVirtualNic>
           <device>portgroup8</device>
           <key>key-vim.host.VirtualNic-portgroup8</key>
           <portgroup>VM Network 1</portgroup>
           <spec>
             <ip>
               <dhcp>false</dhcp>
               <ipAddress>127.21.10.252</ipAddress>
               <subnetMask>255.255.255.0</subnetMask>
              <ip>
             <mac>00:50:56:6e:bf:93</mac>
           </spec>
           <port>key-vim.host.PortGroup.Port-16777221</port>
         </HostVirtualNic>
          <HostVirtualNic>
           <device>portgroup12</device>
           <key>key-vim.host.VirtualNic-portgroup12</key>
           <portgroup>Virtual Machine Network 2</portgroup>
           <spec>
             <ip>
               <dhcp>false</dhcp>
               <ipAddress>127.21.10.22</ipAddress>
               <subnetMask>255.255.255.0</subnetMask>
             </ip>
             <mac>00:50:56:6e:0b:4b</mac>
           </spec>
           <port>key-vim.host.PortGroup.Port-67108870</port>
         </HostVirtualNic>
       </ArrayOfHostVirtualNic>
     </propSet>
   </returnval>
</RetrieveVirtualNICConfigurationResponse>
</vmware-infrastructure-response>

The following table describes the response elements that provides details about the virtual NIC.

Adapter response elements for the Retrieve Virtual NIC Configuration operation

Element	Definition
<port>	The port on the port group that the virtual network adapter is using when it is enabled
<portgroup>	The name of port group to which virtual nic is connected
<spec>	The configurable properties for the virtual network adapter object
<device>	The device name for the Virtual NIC

Retrieve Virtual NIC Configuration operation

On this page