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.

JSON Example

{
    "appliance": {
        "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"
            }
        ],
        "console_cli": {
            "enabled": false
        },
        "dcui": {
            "enabled": false
        },
        "local_accounts_policy": {
            "max_days": 0,
            "min_days": 0,
            "warn_days": 0
        },
        "network": {
            "dns_server_configuration": {
                "mode": "enum",
                "servers": [
                    "string"
                ]
            },
            "firewall_rule_policies": [
                {
                    "address": "string",
                    "interface_name": "string",
                    "policy": "enum",
                    "prefix": 0
                }
            ],
            "proxy_configuration": [
                {
                    "enabled": false,
                    "password": "string",
                    "port": 0,
                    "protocol": "enum",
                    "server": "string",
                    "username": "string"
                }
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "root_local_account": {
            "email": "string",
            "enabled": false,
            "fullname": "string",
            "has_password": false,
            "last_password_change": "string",
            "max_days_between_password_change": 0,
            "min_days_between_password_change": 0,
            "password": "string",
            "password_expires_at": "string",
            "roles": [
                "string"
            ],
            "warn_days_before_password_expiration": 0
        },
        "shell": {
            "enabled": false,
            "timeout": 0
        },
        "smtp": {
            "mail_server": "string",
            "relay_port": "string"
        },
        "software_update_policy": {
            "auto_stage": "enum",
            "certificate_check": false,
            "check_schedule": {
                "day": "enum",
                "hour": "string",
                "minute": "string"
            },
            "custom_URL": "string",
            "default_URL": "string",
            "password": "string",
            "username": "string"
        },
        "ssh": {
            "enabled": false
        },
        "syslog": [
            {
                "hostname": "string",
                "port": 0,
                "protocol": "enum"
            }
        ],
        "time_sync": {
            "mode": "enum"
        },
        "time_zone": {
            "name": "string"
        }
    },
    "authmgmt": {
        "global_permission_list": [
            {
                "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_list": [
            {
                "description": "string",
                "group": "string",
                "id": "string",
                "is_on_parent": false
            }
        ],
        "role_list": [
            {
                "description": "string",
                "id": 0,
                "name": "string",
                "privilege_id": [
                    "string"
                ]
            }
        ],
        "token_policy": {
            "bearer_refresh": 0,
            "clock_tolerance": 0,
            "hok_refresh": 0,
            "token_delegation": 0,
            "token_renewal": 0
        }
    }
}
Feedback

Was this page helpful?