VcenterSettingsV1ConfigComponentsInventoryClusterClusterConfigInfo

The ClusterConfigInfo structure contains fields describing the complete configuration of a cluster. It contains cluster-wide configurations of DRS, HA VSAN Cluster etc.


Properties

drs Optional

Cluster-wide configuration of the vSphere DRS service.


drs_vm_overrides Optional

List of virtual machine configurations for the vSphere DRS service. Each entry applies to one virtual machine. If a virtual machine is not specified in this list, the service uses the default settings for that virtual machine. If unset or empty, the value is skipped.


groups Optional

Cluster-wide groups. If unset or empty, the value is skipped.


ha Optional

List of vsphere HA configurations for clusters. If unset, then HA configurations are not set.


ha_vm_overrides Optional

Settings for HA vm overrides.


array of string
hosts Optional

Host configuration on the datacenter. If unset, then no hosts present in the datacenter.


string
name Optional

Name of the cluster


string
parent_path Optional

Absolute path from root folder to cluster’s parent. If unset, then inventory object placed in root folder.


permissions Optional

Permissions defined on the cluster. If unset, then no permissions defined on this inventory object.


proactive_ha Optional

Cluster-wide configuration of the vSphere InfraUpdateHA service. If unset or empty, the value is skipped.


resource_pools Optional

List of Resource pools.


rules Optional

Cluster-wide rules. If unset or empty, the value is skipped.

JSON Example

{
    "drs": {
        "additional_options": {
            "advanced_options": [
                {
                    "key": "string",
                    "value": "string"
                }
            ],
            "scalable_shares": "enum"
        },
        "automation": {
            "automation_level": "enum",
            "migration_threshold": 0,
            "proactive_drs_enabled": false,
            "virtual_machine_automation": false
        },
        "enabled": false,
        "power_management": {
            "automation_level": "enum",
            "dpm_enabled": false,
            "dpm_threshold": {
                "key": "string",
                "value": "string"
            }
        }
    },
    "drs_vm_overrides": [
        {
            "behavior": "enum",
            "name": "string"
        }
    ],
    "groups": {
        "host_groups": [
            {
                "entities": [
                    "string"
                ],
                "name": "string",
                "user_created": false
            }
        ],
        "vm_groups": [
            {
                "entities": [
                    "string"
                ],
                "name": "string",
                "user_created": false
            }
        ]
    },
    "ha": {
        "admission_control": {
            "cluster_resource_percentage": {
                "cpu": 0,
                "memory": 0
            },
            "dedicated_failover_hosts": [
                "string"
            ],
            "host_fail_over_slot_policy": {
                "cpu": 0,
                "memory": 0
            },
            "host_failures_cluster_tolerates": 0,
            "performance_degradation_vm_tolerate": 0,
            "policy_type": "string"
        },
        "advanced_options": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "enabled": false,
        "failures_and_responses": {
            "additional_delay": 0,
            "apd_failure_response": "enum",
            "datastore_with_pdl_failure_response": "enum",
            "default_vm_restart_priority": "enum",
            "host_isolation_response": "enum",
            "host_monitoring": "enum",
            "response_delay": 0,
            "response_recovery": "enum",
            "restart_priority_condition_timeout": 0,
            "vm_monitoring": "enum",
            "vm_tools_monitoring_settings": {
                "cluster_settings": false,
                "enabled": false,
                "failure_interval": 0,
                "max_failure_window": 0,
                "max_failures": 0,
                "min_up_time": 0
            }
        },
        "heartbeat_datastores": {
            "datastores": [
                "string"
            ],
            "heartbeat_datastore_policy": "enum"
        }
    },
    "ha_vm_overrides": [
        {
            "name": "string",
            "vm_additional_delay": 0,
            "vm_apd_failover_delay": 0,
            "vm_apd_failure_response": "enum",
            "vm_apd_response_recovery": "enum",
            "vm_datastore_with_pdl_failure_response": "enum",
            "vm_isolation_response": "enum",
            "vm_monitoring": "enum",
            "vm_restart_priority": "enum",
            "vm_restart_priority_timeout": 0
        }
    ],
    "hosts": [
        "string"
    ],
    "name": "string",
    "parent_path": "string",
    "permissions": [
        {
            "group": false,
            "principal": "string",
            "propagate": false,
            "role_id": 0
        }
    ],
    "proactive_ha": {
        "automation_level": "enum",
        "enabled": false,
        "providers": [
            "string"
        ],
        "remediation": "enum"
    },
    "resource_pools": [
        {
            "child_resource_pools": [
                "string"
            ],
            "config": {
                "cpu_allocation": {
                    "expandable_reservation": false,
                    "limit": 0,
                    "reservation": 0,
                    "shares": {
                        "level": "enum",
                        "shares": 0
                    }
                },
                "memory_allocation": {
                    "expandable_reservation": false,
                    "limit": 0,
                    "reservation": 0,
                    "shares": {
                        "level": "enum",
                        "shares": 0
                    }
                }
            },
            "name": "string",
            "parent_path": "string",
            "permissions": [
                {
                    "group": false,
                    "principal": "string",
                    "propagate": false,
                    "role_id": 0
                }
            ]
        }
    ],
    "rules": {
        "dependency_rule": [
            {
                "depends_on_vm_group": "string",
                "enabled": false,
                "in_compliance": false,
                "mandatory": false,
                "name": "string",
                "status": "enum",
                "user_created": false,
                "vm_group": "string"
            }
        ],
        "vm_affinity_rules": [
            {
                "enabled": false,
                "in_compliance": false,
                "mandatory": false,
                "name": "string",
                "status": "enum",
                "user_created": false,
                "vms": [
                    "string"
                ]
            }
        ],
        "vm_anti_affinity_rules": [
            {
                "enabled": false,
                "in_compliance": false,
                "mandatory": false,
                "name": "string",
                "status": "enum",
                "user_created": false,
                "vms": [
                    "string"
                ]
            }
        ],
        "vm_host_rule": [
            {
                "affine_host_group_name": "string",
                "anti_affine_host_group_name": "string",
                "enabled": false,
                "in_compliance": false,
                "mandatory": false,
                "name": "string",
                "status": "enum",
                "user_created": false,
                "vm_group_name": "string"
            }
        ]
    }
}
Feedback

Was this page helpful?