Host Network System Get Capabilities

Host Network System Get Capabilities

Capability vector indicating the available product features.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/HostNetworkSystem/{moId}/capabilities
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.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostNetCapabilities of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "canSetPhysicalNicLinkSpeed": false,
    "supportsNicTeaming": false,
    "nicTeamingPolicy": [
        "string"
    ],
    "supportsVlan": false,
    "usesServiceConsoleNic": false,
    "supportsNetworkHints": false,
    "maxPortGroupsPerVswitch": 0,
    "vswitchConfigSupported": false,
    "vnicConfigSupported": false,
    "ipRouteConfigSupported": false,
    "dnsConfigSupported": false,
    "dhcpOnVnicSupported": false,
    "ipV6Supported": false,
    "backupNfcNiocSupported": false
}
boolean
canSetPhysicalNicLinkSpeed
Required

The flag to indicate whether or not a physical network adapter's link speed and duplex settings can be changed through this API.

For a hosted product, the host uses its physical network adapters for network connectivity. Configuration of link speed is done through regular host operations. In ESX Server, the configuration can be changed through this API.

boolean
supportsNicTeaming
Required

The flag to indicate whether or not network adapter teaming is available.

Multiple network adapters can be bridged to a virtual switch through a BondBridge. Also, network adapter teaming policies such as failover order and detection are enabled.

array of string
nicTeamingPolicy
Optional

The available teaming policies if the platform supports network adapter teaming.

boolean
supportsVlan
Required

The flag to indicate whether or not VLANs can be configured on PortGroups attached to VirtualSwitch objects.

This allows VLANs for virtual machines without requiring special VLAN capable hardware switches.

boolean
usesServiceConsoleNic
Required

The flag to indicate whether or not a service console network adapter is used or required.

This means that the system software has two TCP/IP stacks. As a result, at least two types of VirtualNics may be created -- the normal VirtualNic and the service console VirtualNic. If this is not set, then only the VirtualNic type is supported.

boolean
supportsNetworkHints
Required

The flag to indicate whether or not the host is able to support the querying of network hints.

integer As int32 As int32
maxPortGroupsPerVswitch
Optional

The maximum number of port groups supported per virtual switch.

This property will not be set if this value is unlimited.

boolean
vswitchConfigSupported
Required

The flag to indicate whether virtual switch configuration is supported.

This means that operations to add, remove, update virtual switches are supported.

boolean
vnicConfigSupported
Required

The flag to indicate whether Virtual NIC configuration is supported.

This means that operations to add, remove, update virtualNic are supported.

boolean
ipRouteConfigSupported
Required

The flag to indicate whether ip route configuration for the host is supported.

boolean
dnsConfigSupported
Required

The flag to indicate whether DNS configuration for the host is supported.

boolean
dhcpOnVnicSupported
Required

This flag indicates whether or not the host is able to support dhcp configuration for vnics.

boolean
ipV6Supported
Required

The flag to indicate whether the host is capable of communicating using ipv6 protocol

boolean
backupNfcNiocSupported
Optional

The flag to indicate whether the host supports Backup NFC NIOC system traffic, Unset means Backup NFC NIOC system traffic is not supported.

Since: vSphere API Release 7.0.1.0


Virtual Infrastructure 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
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
GET
Host Network System Get Ip Route Config
GET
Host Network System Get Network Config
GET
Host Network System Get Network Info
GET
Host Network System Get Offload Capabilities
GET
Host Network System Get Value
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 Start Dpu Failover
POST
Host Network System Update Console Ip Route Config
POST
Host Network System Update Dns Config
POST
Host Network System Update Ip Route Config
POST
Host Network System Update Ip Route Table Config
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