DomainUpdateSpec

DomainUpdateSpec

Contains the parameters required to perform update operation on domain

JSON Example

{
    "clusterSpec": {
        "advancedOptions": {
            "evcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
            "highAvailability": {
                "enabled": false
            }
        },
        "clusterImageId": "string",
        "datastoreSpec": {
            "nfsDatastoreSpecs": [
                {
                    "datastoreName": "string",
                    "nasVolume": {
                        "path": "string",
                        "readOnly": false,
                        "serverName": [
                            "string"
                        ],
                        "userTag": "string"
                    }
                }
            ],
            "vmfsDatastoreSpec": {
                "fcSpec": [
                    {
                        "datastoreName": "string"
                    }
                ]
            },
            "vsanDatastoreSpec": {
                "datastoreName": "string",
                "dedupAndCompressionEnabled": false,
                "failuresToTolerate": 0,
                "licenseKey": "string"
            },
            "vsanRemoteDatastoreClusterSpec": {
                "vsanRemoteDatastoreSpec": [
                    {
                        "datastoreUuid": "string"
                    }
                ]
            },
            "vvolDatastoreSpecs": [
                {
                    "name": "string",
                    "vasaProviderSpec": {
                        "storageContainerId": "string",
                        "storageProtocolType": "One among: ISCSI, NFS, FC",
                        "userId": "string",
                        "vasaProviderId": "string"
                    }
                }
            ]
        },
        "hostSpecs": [
            {
                "azName": "string",
                "hostName": "string",
                "hostNetworkSpec": {
                    "vmNics": [
                        {
                            "id": "string",
                            "moveToNvds": false,
                            "uplink": "string",
                            "vdsName": "string"
                        }
                    ]
                },
                "id": "string",
                "ipAddress": "string",
                "licenseKey": "string",
                "password": "string",
                "serialNumber": "string",
                "sshThumbprint": "string",
                "username": "string"
            }
        ],
        "name": "string",
        "networkSpec": {
            "nsxClusterSpec": {
                "nsxTClusterSpec": {
                    "geneveVlanId": 0,
                    "ipAddressPoolSpec": {
                        "description": "string",
                        "ignoreUnavailableNsxtCluster": false,
                        "name": "string",
                        "subnets": [
                            {
                                "cidr": "string",
                                "gateway": "string",
                                "ipAddressPoolRanges": [
                                    {
                                        "end": "string",
                                        "start": "string"
                                    }
                                ]
                            }
                        ]
                    }
                }
            },
            "vdsSpecs": [
                {
                    "isUsedByNsxt": false,
                    "mtu": 0,
                    "name": "string",
                    "niocBandwidthAllocationSpecs": [
                        {
                            "niocTrafficResourceAllocation": {
                                "limit": 0,
                                "reservation": 0,
                                "sharesInfo": {
                                    "level": "One among: low, normal, high, custom",
                                    "shares": 0
                                }
                            },
                            "type": "string"
                        }
                    ],
                    "portGroupSpecs": [
                        {
                            "activeUplinks": [
                                "string"
                            ],
                            "name": "string",
                            "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
                        }
                    ]
                }
            ]
        },
        "skipThumbprintValidation": false,
        "vxRailDetails": {
            "adminCredentials": {
                "credentialType": "One among: SSH",
                "password": "string",
                "username": "string"
            },
            "arrayContextWithKeyValuePair": {
                "arrayContextWithKeyValuePair": {
                    "arrayContextWithKeyValuePair": [
                        {
                            "arrayAssociationContext": {
                                "arrayAttributeIdsKeyValue": {
                                    "arrayAttributeIdsKeyValue": "string"
                                },
                                "parent": "VxRailArrayAssociationContext Object"
                            },
                            "simpleAttributes": [
                                {
                                    "attributeName": "string",
                                    "datatype": "string",
                                    "value": "string"
                                }
                            ]
                        }
                    ]
                }
            },
            "contextWithKeyValuePair": {
                "contextWithKeyValuePair": {
                    "contextWithKeyValuePair": [
                        {
                            "attributeName": "string",
                            "datatype": "string",
                            "value": "string"
                        }
                    ]
                }
            },
            "dnsName": "string",
            "ipAddress": "string",
            "networks": [
                {
                    "freeIps": [
                        "string"
                    ],
                    "gateway": "string",
                    "id": "string",
                    "ipPools": [
                        {
                            "end": "string",
                            "start": "string"
                        }
                    ],
                    "mask": "string",
                    "mtu": 0,
                    "subnet": "string",
                    "type": "string",
                    "usedIps": [
                        "string"
                    ],
                    "vlanId": 0
                }
            ],
            "nicProfile": "string",
            "rootCredentials": {
                "credentialType": "One among: SSH",
                "password": "string",
                "username": "string"
            },
            "sshThumbprint": "string",
            "sslThumbprint": "string"
        }
    },
    "markForDeletion": false,
    "name": "string",
    "nsxTSpec": {
        "formFactor": "string",
        "ipAddressPoolSpec": {
            "description": "string",
            "ignoreUnavailableNsxtCluster": false,
            "name": "string",
            "subnets": [
                {
                    "cidr": "string",
                    "gateway": "string",
                    "ipAddressPoolRanges": [
                        {
                            "end": "string",
                            "start": "string"
                        }
                    ]
                }
            ]
        },
        "licenseKey": "string",
        "nsxManagerAdminPassword": "string",
        "nsxManagerAuditPassword": "string",
        "nsxManagerSpecs": [
            {
                "name": "string",
                "networkDetailsSpec": {
                    "dnsName": "string",
                    "gateway": "string",
                    "ipAddress": "string",
                    "subnetMask": "string"
                }
            }
        ],
        "vip": "string",
        "vipFqdn": "string"
    }
}

ClusterSpec

clusterSpec

Optional

This specification contains the parameters required to add a cluster to a workload domain

boolean

markForDeletion

Optional

Enable deletion for the domain

string

name

Optional

Name of the domain

NsxTSpec

nsxTSpec

Optional

This specification contains the parameters required to install and configure NSX in a workload domain

Parameter To

Update Domain

Validate Domains Operations