VcenterSettingsV1DesiredState

The DesiredState structure defines the configuration about different components in vCenter. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


Properties

appliance Optional

Appliance Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


authmgmt Optional

Authentication Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


inventory Optional

Inventory Configurations. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

JSON Example

{
    "appliance": {
        "access_settings": {
            "console_cli": {
                "enabled": false
            },
            "dcui": {
                "enabled": false
            },
            "shell": {
                "enabled": false,
                "timeout": 0
            },
            "ssh": {
                "enabled": false
            }
        },
        "backup_schedules": [
            {
                "backup_password": "string",
                "enable": false,
                "location": "string",
                "location_password": "string",
                "location_user": "string",
                "parts": [
                    "string"
                ],
                "recurrence_info": {
                    "days": "enum",
                    "hour": 0,
                    "minute": 0
                },
                "retention_info": {
                    "max_count": 0
                },
                "schedule_id": "string"
            }
        ],
        "ceip": {
            "enabled": false
        },
        "datetime_config": {
            "ntp": {
                "servers": [
                    "string"
                ]
            },
            "time_sync": {
                "mode": "enum"
            },
            "time_zone": {
                "name": "string"
            }
        },
        "network": {
            "dns_server_configuration": {
                "domains": [
                    "string"
                ],
                "mode": "enum",
                "servers": [
                    "string"
                ]
            },
            "firewall_rule_policies": [
                {
                    "address": "string",
                    "interface_name": "string",
                    "policy": "enum",
                    "prefix": 0
                }
            ],
            "interfaces": [
                {
                    "ipv4": {
                        "address": "string",
                        "configurable": false,
                        "default_gateway": "string",
                        "mode": "enum",
                        "prefix": 0
                    },
                    "ipv6": {
                        "addresses": [
                            {
                                "address": "string",
                                "origin": "enum",
                                "prefix": 0,
                                "status": "enum"
                            }
                        ],
                        "autoconf": false,
                        "configurable": false,
                        "default_gateway": "string",
                        "dhcp": false
                    },
                    "mac": "string",
                    "name": "string",
                    "status": "enum"
                }
            ],
            "proxy_configuration": [
                {
                    "enabled": false,
                    "password": "string",
                    "port": 0,
                    "protocol": "enum",
                    "server": "string",
                    "username": "string"
                }
            ]
        },
        "smtp": {
            "mail_server": "string",
            "relay_port": "string"
        },
        "software_update_policy": {
            "auto_stage": false,
            "check_schedule": [
                {
                    "day": "enum",
                    "hour": "string",
                    "minute": "string"
                }
            ],
            "default_URL": "string",
            "enable_SSL_cert_validation": false,
            "password": "string",
            "url": "string",
            "username": "string"
        },
        "syslog": [
            {
                "hostname": "string",
                "port": 0,
                "protocol": "enum"
            }
        ],
        "user_account_settings": {
            "local_accounts_policy": {
                "max_days": 0,
                "min_days": 0,
                "warn_days": 0
            },
            "root_account_policy": {
                "email": "string",
                "enabled": false,
                "fullname": "string",
                "has_password": false,
                "max_days_between_password_change": 0,
                "min_days_between_password_change": 0,
                "password": "string",
                "roles": [
                    "string"
                ],
                "warn_days_before_password_expiration": 0
            }
        }
    },
    "authmgmt": {
        "global_permissions": [
            {
                "principal": {
                    "group": false,
                    "name": "string"
                },
                "propagate": false,
                "role_ids": [
                    0
                ]
            }
        ],
        "lockout_policy": {
            "failed_login_attempts": 0,
            "failure_interval": 0,
            "unlock_time": 0
        },
        "password_policy": {
            "adj_identical_chars": 0,
            "alpha_chars": 0,
            "lowercase_chars": 0,
            "max_length": 0,
            "max_life": 0,
            "min_length": 0,
            "numeric_chars": 0,
            "password_reuse": 0,
            "special_chars": 0,
            "uppercase_chars": 0
        },
        "privileges": [
            {
                "description": "string",
                "group": "string",
                "id": "string",
                "is_on_parent": false
            }
        ],
        "roles": [
            {
                "description": "string",
                "id": 0,
                "name": "string",
                "privilege_ids": [
                    "string"
                ]
            }
        ],
        "token_policy": {
            "bearer_refresh": 0,
            "clock_tolerance": 0,
            "hok_refresh": 0,
            "token_delegation": 0,
            "token_renewal": 0
        }
    },
    "inventory": {
        "clusters": [
            {
                "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"
                        }
                    ]
                }
            }
        ],
        "datacenters": [
            {
                "name": "string",
                "parent_path": "string",
                "permissions": [
                    {
                        "group": false,
                        "principal": "string",
                        "propagate": false,
                        "role_id": 0
                    }
                ],
                "standalone_hosts": [
                    "string"
                ]
            }
        ],
        "datastores": [
            {
                "name": "string",
                "parent_path": "string",
                "permissions": [
                    {
                        "group": false,
                        "principal": "string",
                        "propagate": false,
                        "role_id": 0
                    }
                ],
                "summary": {
                    "capacity": 0,
                    "maintenance_mode": "enum",
                    "multiple_host_access": false,
                    "type": "string"
                }
            }
        ],
        "folders": {
            "datacenter": [
                {
                    "name": "string",
                    "parent_path": "string",
                    "permissions": [
                        {
                            "group": false,
                            "principal": "string",
                            "propagate": false,
                            "role_id": 0
                        }
                    ]
                }
            ],
            "datastore": [
                {
                    "name": "string",
                    "parent_path": "string",
                    "permissions": [
                        {
                            "group": false,
                            "principal": "string",
                            "propagate": false,
                            "role_id": 0
                        }
                    ]
                }
            ],
            "host": [
                {
                    "name": "string",
                    "parent_path": "string",
                    "permissions": [
                        {
                            "group": false,
                            "principal": "string",
                            "propagate": false,
                            "role_id": 0
                        }
                    ]
                }
            ],
            "network": [
                {
                    "name": "string",
                    "parent_path": "string",
                    "permissions": [
                        {
                            "group": false,
                            "principal": "string",
                            "propagate": false,
                            "role_id": 0
                        }
                    ]
                }
            ],
            "vm": [
                {
                    "name": "string",
                    "parent_path": "string",
                    "permissions": [
                        {
                            "group": false,
                            "principal": "string",
                            "propagate": false,
                            "role_id": 0
                        }
                    ]
                }
            ]
        },
        "hosts": [
            {
                "name": "string",
                "parent_path": "string",
                "permissions": [
                    {
                        "group": false,
                        "principal": "string",
                        "propagate": false,
                        "role_id": 0
                    }
                ]
            }
        ],
        "networks": [
            {
                "name": "string",
                "parent_path": "string",
                "permissions": [
                    {
                        "group": false,
                        "principal": "string",
                        "propagate": false,
                        "role_id": 0
                    }
                ]
            }
        ],
        "storage_pods": [
            {
                "name": "string",
                "parent_path": "string",
                "permissions": [
                    {
                        "group": false,
                        "principal": "string",
                        "propagate": false,
                        "role_id": 0
                    }
                ],
                "pod_storage_drs_entry": {
                    "storage_drs_config": {
                        "pod_config": {
                            "enabled": false
                        }
                    }
                }
            }
        ]
    }
}
Feedback

Was this page helpful?