Host Network System Get Network Info

Host Network System Get Network Info

The network configuration and runtime information.

Request
URI
GET
https://{api_host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/networkInfo
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostNetworkSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostNetworkInfo of type(s) application/json
"HostNetworkInfo Object"
array of object
vswitch
Optional

Virtual switches configured on the host.

array of object
proxySwitch
Optional

Proxy switches configured on the host.

array of object
portgroup
Optional

Port groups configured on the host.

array of object
pnic
Optional

Physical network adapters as seen by the primary operating system.

array of object
rdmaDevice
Optional

Remote direct memory access devices, if any are present on the host.

array of object
vnic
Optional

Virtual network adapters configured on the host (hosted products) or the vmkernel.

In the hosted architecture, these network adapters are used by the host to communicate with the virtual machines running on that host. In the VMkernel architecture, these virtual network adapters provide the ESX Server with external network access through a virtual switch that is bridged to a physical network adapter. The VMkernel uses these network adapters for features such as VMotion, NAS, iSCSI, and remote MKS connections.

array of object
consoleVnic
Optional

Virtual network adapters configured for use by the service console.

The service console uses this network access for system management and bootstrapping services like network boot. The two sets of virtual network adapters are mutually exclusive. A virtual network adapter in this list cannot be used for things like VMotion. Likewise, a virtual network adapter in the other list cannot be used by the service console.

object
dnsConfig
Optional

This data object type describes the DNS configuration.

All IPv4 addresses, subnet addresses, and netmasks are specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of the symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373.

object
ipRouteConfig
Optional

IP Route Configuration.

All IPv4 addresses, subnet addresses, and netmasks are specified as strings using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373.

object
consoleIpRouteConfig
Optional

IP Route Configuration.

All IPv4 addresses, subnet addresses, and netmasks are specified as strings using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373.

object
routeTableInfo
Optional

IpRouteTableInfo.

This is the list of all static routes on the host

array of object
dhcp
Optional

DHCP Service instances configured on the host.

array of object
nat
Optional

NAT service instances configured on the host.

boolean
ipV6Enabled
Optional

Enable or disable IPv6 protocol on this system.

boolean
atBootIpV6Enabled
Optional

If true then dual IPv4/IPv6 stack enabled else IPv4 only.

array of object
netStackInstance
Optional

List of NetStackInstances

array of object
opaqueSwitch
Optional

List of opaque switches configured on the host.

array of object
opaqueNetwork
Optional

List of opaque networks

string
nsxTransportNodeId
Optional

The nsx transport node Id

boolean
nvdsToVdsMigrationRequired
Optional

Whether NSX N-VDS to VDS migration is required

Since: vSphere API Release 7.0.2.0

string
migrationStatus
Optional

Current status of NVDS to VDS migration.

See HostNetworkConfig.HostNetworkConfigMigrationStatusEnum for supported values.

Since: vSphere API Release 7.0.2.0


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/networkInfo
                
Host Network System Operations
POST
Host Network System Add Port Group
POST
Host Network System Add Service Console Virtual Nic
POST
Host Network System Add Virtual Nic
POST
Host Network System Add Virtual Switch
POST
Host Network System Query Network Hint
POST
Host Network System Refresh Network System
POST
Host Network System Remove Port Group
POST
Host Network System Remove Service Console Virtual Nic
POST
Host Network System Remove Virtual Nic
POST
Host Network System Remove Virtual Switch
POST
Host Network System Restart Service Console Virtual Nic
POST
Host Network System Set Custom Value
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
Deprecated
POST
Host Network System Update Ip Route Config
Deprecated
POST
Host Network System Update Ip Route Table Config
Deprecated
POST
Host Network System Update Network Config
POST
Host Network System Update Physical Nic Link Speed
POST
Host Network System Update Port Group
POST
Host Network System Update Service Console Virtual Nic
POST
Host Network System Update Virtual Nic
POST
Host Network System Update Virtual Switch
GET
Host Network System Get Available Field
GET
Host Network System Get Capabilities
GET
Host Network System Get Console Ip Route Config
GET
Host Network System Get Dns Config
Deprecated
GET
Host Network System Get Ip Route Config
Deprecated
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
Deprecated
GET
Host Network System Get Value