HostNetworkConfig

HostNetworkConfig
HostNetworkConfig

This data object type describes networking host configuration data objects.

These objects contain only the configuration information for networking. The runtime information is available from the NetworkInfo data object type.

See also HostNetworkInfo.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vswitch": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "name": "string",
            "spec": {
                "_typeName": "string",
                "numPorts": 0,
                "bridge": {
                    "_typeName": "string"
                },
                "policy": {
                    "_typeName": "string",
                    "security": {
                        "_typeName": "string",
                        "allowPromiscuous": false,
                        "macChanges": false,
                        "forgedTransmits": false
                    },
                    "nicTeaming": {
                        "_typeName": "string",
                        "policy": "string",
                        "reversePolicy": false,
                        "notifySwitches": false,
                        "rollingOrder": false,
                        "failureCriteria": {
                            "_typeName": "string",
                            "checkSpeed": "string",
                            "speed": 0,
                            "checkDuplex": false,
                            "fullDuplex": false,
                            "checkErrorPercent": false,
                            "percentage": 0,
                            "checkBeacon": false
                        },
                        "nicOrder": {
                            "_typeName": "string",
                            "activeNic": [
                                "string"
                            ],
                            "standbyNic": [
                                "string"
                            ]
                        }
                    },
                    "offloadPolicy": {
                        "_typeName": "string",
                        "csumOffload": false,
                        "tcpSegmentation": false,
                        "zeroCopyXmit": false
                    },
                    "shapingPolicy": {
                        "_typeName": "string",
                        "enabled": false,
                        "averageBandwidth": 0,
                        "peakBandwidth": 0,
                        "burstSize": 0
                    }
                },
                "mtu": 0
            }
        }
    ],
    "proxySwitch": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "uuid": "string",
            "spec": {
                "_typeName": "string",
                "backing": {
                    "_typeName": "string"
                }
            }
        }
    ],
    "portgroup": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "spec": {
                "_typeName": "string",
                "name": "string",
                "vlanId": 0,
                "vswitchName": "string",
                "policy": {
                    "_typeName": "string",
                    "security": {
                        "_typeName": "string",
                        "allowPromiscuous": false,
                        "macChanges": false,
                        "forgedTransmits": false
                    },
                    "nicTeaming": {
                        "_typeName": "string",
                        "policy": "string",
                        "reversePolicy": false,
                        "notifySwitches": false,
                        "rollingOrder": false,
                        "failureCriteria": {
                            "_typeName": "string",
                            "checkSpeed": "string",
                            "speed": 0,
                            "checkDuplex": false,
                            "fullDuplex": false,
                            "checkErrorPercent": false,
                            "percentage": 0,
                            "checkBeacon": false
                        },
                        "nicOrder": {
                            "_typeName": "string",
                            "activeNic": [
                                "string"
                            ],
                            "standbyNic": [
                                "string"
                            ]
                        }
                    },
                    "offloadPolicy": {
                        "_typeName": "string",
                        "csumOffload": false,
                        "tcpSegmentation": false,
                        "zeroCopyXmit": false
                    },
                    "shapingPolicy": {
                        "_typeName": "string",
                        "enabled": false,
                        "averageBandwidth": 0,
                        "peakBandwidth": 0,
                        "burstSize": 0
                    }
                }
            }
        }
    ],
    "pnic": [
        {
            "_typeName": "string",
            "device": "string",
            "spec": {
                "_typeName": "string",
                "ip": {
                    "_typeName": "string",
                    "dhcp": false,
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "ipV6Config": {
                        "_typeName": "string",
                        "ipV6Address": [
                            {
                                "_typeName": "string",
                                "ipAddress": "string",
                                "prefixLength": 0,
                                "origin": "string",
                                "dadState": "string",
                                "lifetime": "string",
                                "operation": "string"
                            }
                        ],
                        "autoConfigurationEnabled": false,
                        "dhcpV6Enabled": false
                    }
                },
                "linkSpeed": {
                    "_typeName": "string",
                    "speedMb": 0,
                    "duplex": false
                },
                "enableEnhancedNetworkingStack": false,
                "ensInterruptEnabled": false
            }
        }
    ],
    "vnic": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "device": "string",
            "portgroup": "string",
            "spec": {
                "_typeName": "string",
                "dynamicProperty": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "val": {
                            "_typeName": "string"
                        }
                    }
                ],
                "ip": {
                    "_typeName": "string",
                    "dhcp": false,
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "ipV6Config": {
                        "_typeName": "string",
                        "ipV6Address": [
                            {
                                "_typeName": "string",
                                "ipAddress": "string",
                                "prefixLength": 0,
                                "origin": "string",
                                "dadState": "string",
                                "lifetime": "string",
                                "operation": "string"
                            }
                        ],
                        "autoConfigurationEnabled": false,
                        "dhcpV6Enabled": false
                    }
                },
                "mac": "string",
                "distributedVirtualPort": {
                    "_typeName": "string",
                    "switchUuid": "string",
                    "portgroupKey": "string",
                    "portKey": "string",
                    "connectionCookie": 0
                },
                "portgroup": "string",
                "mtu": 0,
                "tsoEnabled": false,
                "netStackInstanceKey": "string",
                "opaqueNetwork": {
                    "_typeName": "string",
                    "opaqueNetworkId": "string",
                    "opaqueNetworkType": "string"
                },
                "externalId": "string",
                "pinnedPnic": "string",
                "ipRouteSpec": {
                    "_typeName": "string",
                    "ipRouteConfig": {
                        "_typeName": "string",
                        "defaultGateway": "string",
                        "gatewayDevice": "string",
                        "ipV6DefaultGateway": "string",
                        "ipV6GatewayDevice": "string"
                    }
                },
                "systemOwned": false,
                "dpuId": "string"
            }
        }
    ],
    "consoleVnic": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "device": "string",
            "portgroup": "string",
            "spec": {
                "_typeName": "string",
                "dynamicProperty": [
                    {
                        "_typeName": "string",
                        "name": "string",
                        "val": {
                            "_typeName": "string"
                        }
                    }
                ],
                "ip": {
                    "_typeName": "string",
                    "dhcp": false,
                    "ipAddress": "string",
                    "subnetMask": "string",
                    "ipV6Config": {
                        "_typeName": "string",
                        "ipV6Address": [
                            {
                                "_typeName": "string",
                                "ipAddress": "string",
                                "prefixLength": 0,
                                "origin": "string",
                                "dadState": "string",
                                "lifetime": "string",
                                "operation": "string"
                            }
                        ],
                        "autoConfigurationEnabled": false,
                        "dhcpV6Enabled": false
                    }
                },
                "mac": "string",
                "distributedVirtualPort": {
                    "_typeName": "string",
                    "switchUuid": "string",
                    "portgroupKey": "string",
                    "portKey": "string",
                    "connectionCookie": 0
                },
                "portgroup": "string",
                "mtu": 0,
                "tsoEnabled": false,
                "netStackInstanceKey": "string",
                "opaqueNetwork": {
                    "_typeName": "string",
                    "opaqueNetworkId": "string",
                    "opaqueNetworkType": "string"
                },
                "externalId": "string",
                "pinnedPnic": "string",
                "ipRouteSpec": {
                    "_typeName": "string",
                    "ipRouteConfig": {
                        "_typeName": "string",
                        "defaultGateway": "string",
                        "gatewayDevice": "string",
                        "ipV6DefaultGateway": "string",
                        "ipV6GatewayDevice": "string"
                    }
                },
                "systemOwned": false,
                "dpuId": "string"
            }
        }
    ],
    "dnsConfig": {
        "_typeName": "string",
        "dhcp": false,
        "virtualNicDevice": "string",
        "ipv6VirtualNicDevice": "string",
        "hostName": "string",
        "domainName": "string",
        "address": [
            "string"
        ],
        "searchDomain": [
            "string"
        ]
    },
    "ipRouteConfig": {
        "_typeName": "string",
        "defaultGateway": "string",
        "gatewayDevice": "string",
        "ipV6DefaultGateway": "string",
        "ipV6GatewayDevice": "string"
    },
    "consoleIpRouteConfig": {
        "_typeName": "string",
        "defaultGateway": "string",
        "gatewayDevice": "string",
        "ipV6DefaultGateway": "string",
        "ipV6GatewayDevice": "string"
    },
    "routeTableConfig": {
        "_typeName": "string",
        "ipRoute": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "route": {
                    "_typeName": "string",
                    "network": "string",
                    "prefixLength": 0,
                    "gateway": "string",
                    "deviceName": "string"
                }
            }
        ],
        "ipv6Route": [
            {
                "_typeName": "string",
                "changeOperation": "string",
                "route": {
                    "_typeName": "string",
                    "network": "string",
                    "prefixLength": 0,
                    "gateway": "string",
                    "deviceName": "string"
                }
            }
        ]
    },
    "dhcp": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "key": "string",
            "spec": {
                "_typeName": "string",
                "virtualSwitch": "string",
                "defaultLeaseDuration": 0,
                "leaseBeginIp": "string",
                "leaseEndIp": "string",
                "maxLeaseDuration": 0,
                "unlimitedLease": false,
                "ipSubnetAddr": "string",
                "ipSubnetMask": "string"
            }
        }
    ],
    "nat": [
        {
            "_typeName": "string",
            "changeOperation": "string",
            "key": "string",
            "spec": {
                "_typeName": "string",
                "virtualSwitch": "string",
                "activeFtp": false,
                "allowAnyOui": false,
                "configPort": false,
                "ipGatewayAddress": "string",
                "udpTimeout": 0,
                "portForward": [
                    {
                        "_typeName": "string",
                        "type": "string",
                        "name": "string",
                        "hostPort": 0,
                        "guestPort": 0,
                        "guestIpAddress": "string"
                    }
                ],
                "nameService": {
                    "_typeName": "string",
                    "dnsAutoDetect": false,
                    "dnsPolicy": "string",
                    "dnsRetries": 0,
                    "dnsTimeout": 0,
                    "dnsNameServer": [
                        "string"
                    ],
                    "nbdsTimeout": 0,
                    "nbnsRetries": 0,
                    "nbnsTimeout": 0
                }
            }
        }
    ],
    "ipV6Enabled": false,
    "netStackSpec": [
        {
            "_typeName": "string",
            "netStackInstance": {
                "_typeName": "string",
                "key": "string",
                "name": "string",
                "dnsConfig": {
                    "_typeName": "string",
                    "dhcp": false,
                    "virtualNicDevice": "string",
                    "ipv6VirtualNicDevice": "string",
                    "hostName": "string",
                    "domainName": "string",
                    "address": [
                        "string"
                    ],
                    "searchDomain": [
                        "string"
                    ]
                },
                "ipRouteConfig": {
                    "_typeName": "string",
                    "defaultGateway": "string",
                    "gatewayDevice": "string",
                    "ipV6DefaultGateway": "string",
                    "ipV6GatewayDevice": "string"
                },
                "requestedMaxNumberOfConnections": 0,
                "congestionControlAlgorithm": "string",
                "ipV6Enabled": false,
                "routeTableConfig": {
                    "_typeName": "string",
                    "ipRoute": [
                        {
                            "_typeName": "string",
                            "changeOperation": "string",
                            "route": {
                                "_typeName": "string",
                                "network": "string",
                                "prefixLength": 0,
                                "gateway": "string",
                                "deviceName": "string"
                            }
                        }
                    ],
                    "ipv6Route": [
                        {
                            "_typeName": "string",
                            "changeOperation": "string",
                            "route": {
                                "_typeName": "string",
                                "network": "string",
                                "prefixLength": 0,
                                "gateway": "string",
                                "deviceName": "string"
                            }
                        }
                    ]
                }
            },
            "operation": "string"
        }
    ],
    "migrationStatus": "string"
}
vswitch
Optional

Virtual switches configured on the host.

proxySwitch
Optional

Host proxy switches configured on the host.

portgroup
Optional

Port groups configured on the host.

pnic
Optional

Physical network adapters as seen by the primary operating system.

vnic
Optional

Virtual network adapters configured for use by the host operating system network adapter.

consoleVnic
Optional

Virtual network adapters configured for use by the Service Console.

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.

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.

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.

routeTableConfig
Optional

IpRouteEntry.

Routing entries are individual static routes which combined with the default route form all of the routing rules for a host.

dhcp
Optional

Dynamic Host Control Protocol (DHCP) Service instances configured on the host.

nat
Optional

Network address translation (NAT) Service instances configured on the host.

boolean
ipV6Enabled
Optional

Enable or disable IPv6 protocol on this system.

This property must be set by itself, no other property can accompany this change. Following the successful change, the system should be rebooted to have the change take effect.

netStackSpec
Optional

The list of network stack instance spec

string
migrationStatus
Optional

Current status of NVDS to VDS migration.

See HostNetworkConfig.HostNetworkConfigMigrationStatusEnum for supported values.

Since: vSphere API Release 7.0.2.0