HostConfigSpec
HostConfigSpec
The HostConfigSpec data object provides access to data objects that specify configuration changes to be applied to an ESX host.
AllOf
This class requires all of the following:
JSON Example
{
"_typeName": "string",
"nasDatastore": [
{
"_typeName": "string",
"changeOperation": "string",
"spec": {
"_typeName": "string",
"remoteHost": "string",
"remotePath": "string",
"localPath": "string",
"accessMode": "string",
"type": "string",
"userName": "string",
"password": "string",
"remoteHostNames": [
"string"
],
"securityType": "string",
"vmknicToBind": "string",
"vmknicBound": false,
"connections": 0
}
}
],
"network": {
"_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"
}
}
]
},
"owner": "string"
},
"operation": "string"
}
],
"migrationStatus": "string"
},
"nicTypeSelection": [
{
"_typeName": "string",
"vnic": {
"_typeName": "string",
"portgroup": "string",
"dvPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"opNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
}
},
"nicType": [
"string"
]
}
],
"service": [
{
"_typeName": "string",
"serviceId": "string",
"startupPolicy": "string"
}
],
"firewall": {
"_typeName": "string",
"rule": [
{
"_typeName": "string",
"rulesetId": "string",
"enabled": false,
"allowedHosts": {
"_typeName": "string",
"ipAddress": [
"string"
],
"ipNetwork": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0
}
],
"allIp": false
}
}
],
"defaultBlockingPolicy": {
"_typeName": "string",
"incomingBlocked": false,
"outgoingBlocked": false
}
},
"option": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"datastorePrincipal": "string",
"datastorePrincipalPasswd": "string",
"datetime": {
"_typeName": "string",
"timeZone": "string",
"ntpConfig": {
"_typeName": "string",
"server": [
"string"
],
"configFile": [
"string"
]
},
"ptpConfig": {
"_typeName": "string",
"domain": 0,
"port": [
{
"_typeName": "string",
"index": 0,
"deviceType": "string",
"device": "string",
"ipConfig": {
"_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
}
}
}
]
},
"protocol": "string",
"enabled": false,
"disableEvents": false,
"disableFallback": false,
"resetToFactoryDefaults": false
},
"storageDevice": {
"_typeName": "string",
"hostBusAdapter": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
}
],
"scsiLun": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false,
"deviceReservation": "string"
}
],
"scsiTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"target": [
{
"_typeName": "string",
"key": "string",
"target": 0,
"lun": [
{
"_typeName": "string",
"key": "string",
"lun": 0,
"scsiLun": "string"
}
],
"transport": {
"_typeName": "string"
}
}
]
}
]
},
"nvmeTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"connectedController": [
{
"_typeName": "string",
"key": "string",
"controllerNumber": 0,
"subnqn": "string",
"name": "string",
"associatedAdapter": "string",
"transportType": "string",
"fusedOperationSupported": false,
"numberOfQueues": 0,
"queueSize": 0,
"attachedNamespace": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"id": 0,
"blockSize": 0,
"capacityInBlocks": 0
}
],
"vendorId": "string",
"model": "string",
"serialNumber": "string",
"firmwareVersion": "string"
}
]
}
]
},
"multipathInfo": {
"_typeName": "string",
"lun": [
{
"_typeName": "string",
"key": "string",
"id": "string",
"lun": "string",
"path": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"pathState": "string",
"state": "string",
"isWorkingPath": false,
"adapter": "string",
"lun": "string",
"transport": {
"_typeName": "string"
}
}
],
"policy": {
"_typeName": "string",
"policy": "string"
},
"storageArrayTypePolicy": {
"_typeName": "string",
"policy": "string"
}
}
]
},
"plugStoreTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": "string",
"path": [
"string"
]
}
],
"path": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"channelNumber": 0,
"targetNumber": 0,
"lunNumber": 0,
"adapter": "string",
"target": "string",
"device": "string"
}
],
"target": [
{
"_typeName": "string",
"key": "string",
"transport": {
"_typeName": "string"
}
}
],
"device": [
{
"_typeName": "string",
"key": "string",
"lun": "string",
"path": [
"string"
]
}
],
"plugin": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"device": [
"string"
],
"claimedPath": [
"string"
]
}
]
},
"softwareInternetScsiEnabled": false
},
"license": {
"_typeName": "string",
"source": {
"_typeName": "string"
},
"editionKey": "string",
"disabledFeatureKey": [
"string"
],
"enabledFeatureKey": [
"string"
]
},
"security": {
"_typeName": "string",
"adminPassword": "string",
"removePermission": [
{
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"principal": "string",
"group": false,
"roleId": 0,
"propagate": false
}
],
"addPermission": [
{
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"principal": "string",
"group": false,
"roleId": 0,
"propagate": false
}
]
},
"userAccount": [
{
"_typeName": "string",
"id": "string",
"password": "string",
"description": "string"
}
],
"usergroupAccount": [
{
"_typeName": "string",
"id": "string",
"password": "string",
"description": "string"
}
],
"memory": {
"_typeName": "string",
"serviceConsoleReservation": 0
},
"activeDirectory": [
{
"_typeName": "string",
"changeOperation": "string",
"spec": {
"_typeName": "string",
"domainName": "string",
"userName": "string",
"password": "string",
"camServer": "string",
"thumbprint": "string",
"certificate": "string",
"smartCardAuthenticationEnabled": false,
"smartCardTrustAnchors": [
"string"
]
}
}
],
"genericConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"graphicsConfig": {
"_typeName": "string",
"hostDefaultGraphicsType": "string",
"sharedPassthruAssignmentPolicy": "string",
"deviceType": [
{
"_typeName": "string",
"deviceId": "string",
"graphicsType": "string",
"vgpuMode": "string"
}
]
},
"assignableHardwareConfig": {
"_typeName": "string",
"attributeOverride": [
{
"_typeName": "string",
"instanceId": "string",
"name": "string",
"value": {
"_typeName": "string"
}
}
]
}
}
network
Optional
Network system information.
nicTypeSelection
Optional
Type selection for different VirtualNics.
firewall
Optional
Firewall configuration.
array of
OptionValue
option
Optional
Host configuration options as defined by the OptionValue data object type.
string
datastorePrincipal
Optional
Datastore principal user.
string
datastorePrincipalPasswd
Optional
Password for the datastore principal.
datetime
Optional
DateTime Configuration.
storageDevice
Optional
Storage system information.
license
Optional
License configuration for the host.
security
Optional
Security specification.
array of
HostAccountSpec
usergroupAccount
Optional
List of users to create/update with new password.
memory
Optional
Memory configuration for the host.
graphicsConfig
Optional
Graphics configuration for a host.
assignableHardwareConfig
Optional
Assignable Hardware configuration for the host