REST API - passive

vcenter vcha cluster: passive spec

The passive_spec structure contains the deploy specification for the Passive Node of the VCHA cluster. This structure was added in vSphere API 6.7.1.

Representation:

JSON

{
    "failover_ip" : {
        "ip_family" : "IPV4",
        "default_gateway" : "string",
        "ipv4" : {
            "address" : "string",
            "prefix" : 1,
            "subnet_mask" : "string"
        },
        "ipv6" : {
            "address" : "string",
            "prefix" : 1
        },
        "dns_servers" : [
            "string",
            "string"
        ]
    },
    "ha_ip" : {
        "ip_family" : "IPV4",
        "default_gateway" : "string",
        "ipv4" : {
            "address" : "string",
            "prefix" : 1,
            "subnet_mask" : "string"
        },
        "ipv6" : {
            "address" : "string",
            "prefix" : 1
        },
        "dns_servers" : [
            "string",
            "string"
        ]
    },
    "placement" : {
        "ha_network_type" : "STANDARD_PORTGROUP",
        "folder" : "obj-103",
        "name" : "string",
        "host" : "obj-103",
        "management_network_type" : "STANDARD_PORTGROUP",
        "management_network" : "obj-103",
        "storage" : {
            "datastore" : "obj-103"
        },
        "resource_pool" : "obj-103",
        "ha_network" : "obj-103"
    }
}

Attributes:

Name	Type	Description
Required
placement.name	string	The name of the VCHA node to be used for the virtual machine name. This attribute was added in vSphere API 6.7.1.
placement.folder	string	The identifier of the folder to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Folder:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder:VCenter`.
ha_ip	ip_spec	IP specification for the HA network. This attribute was added in vSphere API 6.7.1.
ha_ip.ip_family	string	Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1.
ha_ip.ipv4.address	string	IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
ha_ip.ipv6.address	string	IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
ha_ip.ipv6.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.
failover_ip.ip_family	string	Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1.
failover_ip.ipv4.address	string	IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
failover_ip.ipv6.address	string	IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1.
failover_ip.ipv6.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1.
Optional
placement	placement_spec	Contains the placement configuration of the node. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the it is assumed that the clone will be done manually by the customer. In this case, the placement configuration for the witness node should also be omitted. Only the network configuration will be setup. Once the passive and witness nodes are cloned from the active node, the VCHA high availability is turned on.
placement.host	string	The identifier of the host to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, see vim.vm.RelocateSpec.host.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `HostSystem:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `HostSystem:VCenter`.
placement.resource_pool	string	The identifier of the resource pool to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the active node's resource pool will be used.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool:VCenter`.
placement.ha_network_type	string	The type of the Network object used by the HA network. If the vcenter.vcha.placement_spec.ha_network field is set, then the vcenter.vcha.placement_spec.ha_network_type field must be set. If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.ha_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If unset and the vcenter.vcha.placement_spec.ha_network field is set, then an error is reported.
placement.ha_network	string	The identifier of the Network object used for the HA network. If the vcenter.vcha.placement_spec.ha_network field is set, then the {#link #haNetworkType} field must be set. If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.ha_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. . When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Network:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network:VCenter`.
placement.management_network_type	string	The type of the Network object used by the Management network. If the vcenter.vcha.placement_spec.management_network field is set, then the {#link #managementNetworkType} field must be set. If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.management_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If unset and the vcenter.vcha.placement_spec.management_network field is set, then an error is reported.
placement.management_network	string	The identifier of the Network object used for the Management network. If the vcenter.vcha.placement_spec.management_network field is set, then the vcenter.vcha.placement_spec.management_network_type field must be set. If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.management_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. . When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Network:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network:VCenter`.
placement.storage	disk_spec	The storage specification to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, see vim.vm.RelocateSpec.datastore.
placement.storage.datastore	string	The identifier of the datastore to put all the virtual disks on. This attribute was added in vSphere API 6.7.1. Optional. This field needs to be set. If unset, then see vim.vm.RelocateSpec.datastore.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore:VCenter`.
ha_ip.ipv4	ipv4_spec	If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of `ip_family` is IP_v4.
ha_ip.ipv4.subnet_mask	string	The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the `prefix` field is unset, then an error will be reported. If unset and the `prefix` field is set, then the `prefix` field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0. If both the `subnet_mask` field and the `prefix` field are set and they do not represent the same value, then an error will be reported.
ha_ip.ipv4.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the `subnet_mask` field is unset, this an error will be reported. If unset and the `subnet_mask` field is set, then the `subnet_mask` field will be used. If both the `subnet_mask` field and the `prefix` field are set and they do not represent the same value, then an error will be reported.
ha_ip.ipv6	ipv6_spec	If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of `ip_family` is IP_v6.
ha_ip.default_gateway	string	The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface.
ha_ip.dns_servers	string[]	The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface.
failover_ip	ip_spec	IP specification for the management network. This attribute was added in vSphere API 6.7.1. Optional. If unset, then it will assume the public IP address of the Active vCenter Server.
failover_ip.ipv4	ipv4_spec	If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of `ip_family` is IP_v4.
failover_ip.ipv4.subnet_mask	string	The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the `prefix` field is unset, then an error will be reported. If unset and the `prefix` field is set, then the `prefix` field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0. If both the `subnet_mask` field and the `prefix` field are set and they do not represent the same value, then an error will be reported.
failover_ip.ipv4.prefix	long	The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the `subnet_mask` field is unset, this an error will be reported. If unset and the `subnet_mask` field is set, then the `subnet_mask` field will be used. If both the `subnet_mask` field and the `prefix` field are set and they do not represent the same value, then an error will be reported.
failover_ip.ipv6	ipv6_spec	If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of `ip_family` is IP_v6.
failover_ip.default_gateway	string	The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface.
failover_ip.dns_servers	string[]	The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface.