com.vmware.appliance.vcenter.settings.v1.config.components package¶

Subpackages¶

com.vmware.appliance.vcenter.settings.v1.config.components.inventory package

Submodules¶

com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.AccessSettings(ssh=None, dcui=None, console_cli=None, shell=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This AccessSettings class to set/get access settings.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

ssh (Ssh or None) – Get/Set enabled state of SSH-based controlled CLI. Ssh class provides methods
dcui (Dcui or None) – Get/Set enabled of Direct Console User Interface (DCUI TTY2). Dcui class provides methods
console_cli (Consolecli or None) – Get/Set enabled state of the console-based controlled CLI. Consolecli class provides methods
shell (Shell or None) – Get/Set enabled state of BASH. Shell class provides methods

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Address(address=None, origin=None, prefix=None, status=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Address class provides the structure used to name an IPv6 address.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

address (str or None) – The IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a. If set, the address was never set.
origin (Address.Origin or None) – The Origin of the IPv6 address. For more information, see RFC 4293. If set, the origin was never set.
prefix (long or None) – The IPv6 CIDR prefix, for example, 64. If set, the prefix was never set.
status (Address.Status or None) – The Status of the IPv6 address. For more information, see RFC 4293. If set, the status was never set.

class Origin(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Address.Origin class defines IPv6 address origin values.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Origin instance.

DHCP = Origin(string='DHCP')¶: The IPv6 address is assigned by a DHCP server. See RFC 4293.

LINKLAYER = Origin(string='LINKLAYER')¶: The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration (SLAAC). See RFC 4293.

MANUAL = Origin(string='MANUAL')¶: The IPv6 address was manually configured to a specified address, for example, by user configuration. See RFC 4293.

OTHER = Origin(string='OTHER')¶: The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC, or random. See RFC 4293.

RANDOM = Origin(string='RANDOM')¶: The IPv6 address is assigned randomly by the system. See RFC 4293.

class Status(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Address.Status class defines IPv6 address status values. See RFC 4293.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Status instance.

DEPRECATED = Status(string='DEPRECATED')¶: The is a valid but deprecated IPv6 address. This address cannot be used as a source address in new communications, although packets addressed to such an address are processed as expected.

DUPLICATE = Status(string='DUPLICATE')¶: The IPv6 address is not unique on the link and cannot be used.

INACCESSIBLE = Status(string='INACCESSIBLE')¶: The IPv6 address is inaccessible because the interface to which this address is assigned is not operational.

INVALID = Status(string='INVALID')¶: The IPv6 address is not a valid address. It should not appear as the destination or source address of a packet.

OPTIMISTIC = Status(string='OPTIMISTIC')¶: The IPv6 address is available for use, subject to restrictions, while its uniqueness on a link is being verified.

PREFERRED = Status(string='PREFERRED')¶: This is a valid IPv6 address that can appear as the destination or source address of a packet.

TENTATIVE = Status(string='TENTATIVE')¶: The IPv6 address is in the process of being verified as unique. An address in this state cannot be used for general communication. It can be used to determine the uniqueness of the address.

UNKNOWN = Status(string='UNKNOWN')¶: The status of this address cannot be determined.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceManagement(software_update_policy=None, backup_schedules=None, access_settings=None, datetime_config=None, syslog=None, user_account_settings=None, smtp=None, network=None, ceip=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

ApplianceManagement class This structure contains the Spec required for Appliance Management configurations.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

software_update_policy (SoftwareUpdatePolicy or None) – Policy to update vCenter. Only set if the SoftwareUpdatePolicy is set inside vCenter.
backup_schedules (list of BackupSchedule or None) – Backup schedule of vCenter. Only set if the Backup is schedule for vCenter
access_settings (AccessSettings or None) – AccessSettings of vCenter. if access settings are set for vCenter
datetime_config (DatetimeConfig or None) – Date Time Configuration of vCenter. Only set if access settings are set for vCenter
syslog (list of LogForwarding or None) – The syslog class provides methods to manage forwarding of log messages to remote logging servers. Only set if log forwarding to remote server are set in vCenter.
user_account_settings (UserAccountSettings or None) – User Account Settings of vCenter. if user account settings are set for vCenter
smtp (Smtp or None) – The LocalAccounts class provides methods to manage local user account.
network (ApplianceNetwork or None) – Network configurations to be applied. Only set if the network configurations are set in vCenter.
ceip (Ceip or None) – CEIP (Customer Experience Improvement Program) enabled state. Only set if ceip are set in vcenter.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ApplianceNetwork(firewall_rule_policies=None, dns_server_configuration=None, proxy_configuration=None, interfaces=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

ApplianceNetwork class This structure contains the Spec required for Appliance Network configurations.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

firewall_rule_policies (list of FirewallRulePolicy or None) – List of Firewall Rules to be applied. Only set if the FirewallRulePolicy is set in vCenter.
dns_server_configuration (DnsServerConfiguration or None) – DNS configuration to be applied. Only set if the DnsServerConfiguration is set in vCenter.
proxy_configuration (list of ProxyConfiguration or None) – Proxy configuration to be applied. Only set if the Proxy server configuration is set in vCenter.
interfaces (list of Interface or None) – Interfaces configuration to be applied. Only set if the Interfaces configuration is set in vCenter.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.BackupSchedule(parts=None, backup_password=None, location=None, location_user=None, location_password=None, enable=None, recurrence_info=None, retention_info=None, schedule_id=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The BackupSchedule class contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

parts (list of str or None) – List of optional parts to be backed up. Use the com.vmware.appliance.recovery.backup.Parts#list method to get information about the supported parts. If None all the optional parts will not be backed up.
backup_password (str or None) – Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). If None the backup piece will not be encrypted.
location (str) – URL of the backup location.
location_user (str or None) – Username for the given location. If None authentication will not be used for the specified location.
location_password (str or None) – Password for the given location. If None authentication will not be used for the specified location.
enable (bool or None) – Enable or disable a schedule. If None the schedule will be enabled.
recurrence_info (RecurrenceInfo or None) – Recurrence information for the schedule. If None backup job will not be scheduled. See RecurrenceInfo
retention_info (RetentionInfo or None) – Retention information for the schedule. If None all the completed backup jobs will be retained forever. See RetentionInfo
schedule_id (str) – Identifier of the schedule.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ceip(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ceip class provides methods to Get/Set enabled state of CEIP (Customer Experience Improvement Program) value.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: enabled (bool or None) – Set enabled state of the CEIP.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Consolecli(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Get/Set of the console-based controlled CLI. Consolecli class provides methods

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: enabled (bool or None) – Set enabled state of the console-based controlled CLI (TTY1).

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DatetimeConfig(time_zone=None, time_sync=None, ntp=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This DatetimeConfig class to set/get date time settings.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

time_zone (Timezone or None) – The Timezone class provides methods to get and set the appliance timezone. Only set if the Timezone is set in vCenter
time_sync (Timesync or None) – Timesync class provides methods Performs time synchronization configuration. Only set if the time sync mode is set in vCenter
ntp (Ntp or None) – Ntp class provides methods Gets NTP configuration status and tests connection to ntp servers. Only set if the ntp server are set in vCenter.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Dcui(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Get/Set enabled state of Direct Console User Interface (DCUI TTY2). Dcui class provides methods

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: enabled (bool or None) – Set enabled state of Direct Console User Interface (DCUI).

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.DnsServerConfiguration(mode=None, servers=None, domains=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

DnsServerConfiguration class This structure represents the configuration state used to determine DNS servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mode (DnsServerConfiguration.DNSServerMode) – Define how to determine the DNS servers. Leave the servers argument empty if the mode argument is “DHCP”. Set the servers argument to a comma-separated list of DNS servers if the mode argument is “static”. The DNS server are assigned from the specified list.
servers (list of str) – List of the currently used DNS servers. DNS server configuration.
domains (list of str or None) – List of the search domains. DNS Search Domains.

class DNSServerMode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

DnsServerConfiguration.DNSServerMode class Describes DNS Server source (DHCP,static).

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the DNSServerMode instance.

DHCP = DNSServerMode(string='DHCP')¶: DNS address is automatically assigned by a DHCP server.

IS_STATIC = DNSServerMode(string='IS_STATIC')¶: DNS address is static.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.FirewallRulePolicy(address=None, prefix=None, policy=None, interface_name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

FirewallRulePolicy class Structure that defines a single address-based firewall rule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

address (str) – IPv4 or IPv6 address.
prefix (long) – CIDR prefix used to mask address. For example, an IPv4 prefix of 24 ignores the low-order 8 bits of address.
policy (FirewallRulePolicy.Policy) – The allow or deny policy of this rule.
interface_name (str or None) – The interface to which this rule applies. An empty string indicates that the rule applies to all interfaces. Only set if interface name required

class Policy(string)¶

Bases: vmware.vapi.bindings.enum.Enum

FirewallRulePolicy.Policy class Defines firewall rule policies.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Policy instance.

ACCEPT = Policy(string='ACCEPT')¶: Allow packet with corresponding address.

IGNORE = Policy(string='IGNORE')¶: Drop packet with correpsonding address.

REJECT = Policy(string='REJECT')¶: Drop packet with corresponding address sending destination is not reachable.

RETURN = Policy(string='RETURN')¶: Apply default or port-specific rules to packet with corresponding address.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Interface(name=None, status=None, mac=None, ipv4=None, ipv6=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Interfaces class Provides information about network interface.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str or None) – Interface name, for example, “nic0”, “nic1”. If set, the name was never set
status (Interface.InterfaceStatus or None) – Interface status. If set, the name was never set
mac (str or None) – MAC address. For example 00:0C:29:94:BB:5A. If set, the mac was never set
ipv4 (Ipv4 or None) – IPv4 Address information. ipv4 This set IPv4 is not set.
ipv6 (Ipv6 or None) – IPv6 Address information. ipv6 This set IPv6 is not set.

class InterfaceStatus(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Interface.InterfaceStatus class Defines interface status

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the InterfaceStatus instance.

DOWN = InterfaceStatus(string='DOWN')¶: The interface is down.

UP = InterfaceStatus(string='UP')¶: The interface is up.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv4(mode=None, address=None, prefix=None, default_gateway=None, configurable=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The IPv4 class defines IPv4 configuration. to perform IPv4 network configuration for interfaces.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mode (Ipv4.Mode) – The Address assignment mode.
address (str) – The IPv4 address, for example, “10.20.80.191”.
prefix (long) – The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.
default_gateway (str or None) – The IPv4 address of the default gateway. This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. If set, the defaultGateway was never set.
configurable (bool or None) – The IPv4 is configured or not.

class Mode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Ipv4.Mode class defines different IPv4 address assignment modes.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Mode instance.

DHCP = Mode(string='DHCP')¶: The IPv4 address is automatically assigned by a DHCP server.

STATIC = Mode(string='STATIC')¶: The IPv4 address is static.

UNCONFIGURED = Mode(string='UNCONFIGURED')¶: The IPv4 protocol is not configured.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ipv6(dhcp=None, autoconf=None, configurable=None, addresses=None, default_gateway=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Ipv6 class defines Ipv6 configuration. to perform Ipv6 network configuration for interfaces.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

dhcp (bool) – An address will be assigned by a DHCP server.
autoconf (bool) – An address will be assigned by Stateless Address Autoconfiguration (SLAAC).
configurable (bool) – The IPv6 is configured or not.
addresses (list of Address or None) – The list of addresses to be statically assigned. If set, the addresses were never set.
default_gateway (str) – The default gateway for static IP address assignment. This configures the global IPv6 default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccounts(fullname=None, roles=None, enabled=None, has_password=None, min_days_between_password_change=None, max_days_between_password_change=None, warn_days_before_password_expiration=None, password=None, email=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LocalAccounts class provides methods to manage local user account.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

fullname (str or None) – Full name of the user If None, the value was never set.
roles (list of str or None) – User roles
enabled (bool or None) – Flag indicating if the account is enabled
has_password (bool or None) – Is the user password set.
min_days_between_password_change (long or None) – Minimum number of days between password change If None, pasword can be changed any time.
max_days_between_password_change (long or None) – Maximum number of days between password change If None, password never expires.
warn_days_before_password_expiration (long or None) – Number of days of warning before password expires If None, a user is never warned.
password (str or None) – Password If None, value will not be changed
email (str or None) – Email address of the local account If None, value will not be changed

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LocalAccountsPolicy(max_days=None, min_days=None, warn_days=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LocalAccountsPolicy class provides methods to manage local user accounts password lifecycle.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

max_days (long or None) – Maximum number of days a password may be used. If the password is older than this, a password change will be forced. If None then the restriction will be ignored.
min_days (long or None) – Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected. If None then the restriction will be ignored.
warn_days (long or None) – Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration. If None then no warning will be provided.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.LogForwarding(hostname=None, port=None, protocol=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The LogForwarding class provides methods to manage forwarding of log messages to remote logging servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

hostname (str or None) – FQDN or IP address of the logging server to which messages are forwarded.
port (long or None) – The port on which the remote logging server is listening for forwarded log messages.
protocol (LogForwarding.Protocol or None) – Transport protocol used to forward log messages.

class Protocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The LogForwarding.Protocol class defines transport protocols for outbound log messages.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Protocol instance.

RELP = Protocol(string='RELP')¶: Log messages will be forwarded to the remote host using the RELP protocol.

TCP = Protocol(string='TCP')¶: Log messages will be forwarded to the remote host using the TCP protocol.

TLS = Protocol(string='TLS')¶: Log messages will be forwarded to the remote host by using the TLS protocol.

UDP = Protocol(string='UDP')¶: Log messages will be forwarded to the remote host using the UDP protocol.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ntp(servers=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ntp class provides methods Get/Set NTP configuration status and tests connection to ntp servers.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: servers (list of str) – Set NTP servers. This variable updates old NTP servers from configuration and sets the input NTP servers in the configuration.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.ProxyConfiguration(protocol=None, server=None, port=None, username=None, password=None, enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ProxyConfiguration class defines proxy configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

protocol (ProxyConfiguration.Protocol) – The protocol for which proxy should be set.
server (str or None) – URL of the proxy server Only set if server set in ProxyConfiguration.
port (long) – Port to connect to the proxy server. In a ‘get’ call, indicates the port connected to the proxy server. In a ‘set’ call, specifies the port to connect to the proxy server. A value of -1 indicates the default port.
username (str or None) – Username for proxy server. Only set if proxy requires username.
password (str or None) – Password for proxy server. Only set if proxy requires password.
enabled (bool or None) – In the result of the #get and #list methods this attribute indicates whether proxying is enabled for a particular protocol. In the input to the test and set methods this attribute specifies whether proxying should be enabled for a particular protocol.

class Protocol(string)¶

Bases: vmware.vapi.bindings.enum.Enum

ProxyConfiguration.Protocol class defines the protocols for which proxying is supported.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Protocol instance.

FTP = Protocol(string='FTP')¶: Proxy configuration for ftp.

HTTP = Protocol(string='HTTP')¶: Proxy configuration for http.

HTTPS = Protocol(string='HTTPS')¶: Proxy configuration for https.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RecurrenceInfo(minute=None, hour=None, days=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The RecurrenceInfo class contains the recurrence information associated with a schedule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

minute (long) – Minute when backup should run.
hour (long) – Hour when backup should run. The hour should be specified in 24-hour clock format.
days (list of RecurrenceInfo.DayOfWeek or None) – Day of week when the backup should be run. Days can be specified as list of days. If None the backup will be run everyday.

class DayOfWeek(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The RecurrenceInfo.DayOfWeek class defines the set of days when backup can be scheduled. The days can be specified as a list of individual days. You specify the days when you set the recurrence for a schedule. See RecurrenceInfo.days.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the DayOfWeek instance.

FRIDAY = DayOfWeek(string='FRIDAY')¶: Friday

MONDAY = DayOfWeek(string='MONDAY')¶: Monday

SATURDAY = DayOfWeek(string='SATURDAY')¶: Saturday

SUNDAY = DayOfWeek(string='SUNDAY')¶: Sunday

THURSDAY = DayOfWeek(string='THURSDAY')¶: Thursday

TUESDAY = DayOfWeek(string='TUESDAY')¶: Tuesday

WEDNESDAY = DayOfWeek(string='WEDNESDAY')¶: Wednesday

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.RetentionInfo(max_count=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The RetentionInfo class contains retention information associated with a schedule.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: max_count (long) – Number of backups which should be retained. If retention is not set, all the backups will be retained forever.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Shell(enabled=None, timeout=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Get/Set enabled state of BASH, that is, access to BASH from within the controlled CLI. Shell class provides methods.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enabled (bool or None) – Enabled can be set to true or false
timeout (long) – The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day).

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Smtp(mail_server=None, relay_port=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Smtp class provides methods to manage send mail configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

mail_server (str or None) – Mail server IP address. If None then the value will be ignored.
relay_port (str or None) – Relay port number. If None then the value will be ignored.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.SoftwareUpdatePolicy(url=None, default_url=None, auto_stage=None, check_schedule=None, username=None, password=None, enable_ssl_cert_validation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This SoftwareUpdatePolicy class to set/get background check for the new updates.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

url (str or None) – Current appliance update repository URL. Enter “default” to reset the url to the default url. Only set if custom URL required
default_url (str or None) – Default appliance update repository URL. Only set if default URL required
auto_stage (bool or None) – Check for update at the pre-configured repository URL. Only set if auto stage is enable.
check_schedule (list of Time or None) – The Time class defines day and time the automatic check for new updates will be run. Only set if Time required.
username (str or None) – Username for the url update repository Only set if SoftwareUpdatePolicy requires username.
password (str or None) – Password for the url update repository Only set if SoftwareUpdatePolicy requires password.
enable_ssl_cert_validation (bool or None) –
Indicates whether certificates will be checked during patching.

Warning: If this attribute is set to false, an insecure connection is made to the update repository which can potentially put the appliance security at risk.

class AutoUpdateNotification(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Defines state for automatic update notification. SoftwareUpdatePolicy.AutoUpdateNotification class

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the AutoUpdateNotification instance.

DISABLED = AutoUpdateNotification(string='DISABLED')¶: Automatic update notification is disabled. Disable periodically query the configured url for updates.

ENABLED = AutoUpdateNotification(string='ENABLED')¶: Automatic update notification is enabled. Enable periodically query the configured url for updates.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Ssh(enabled=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Ssh class provides methods to Get/Set enabled state of SSH-based controlled CLI.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: enabled (bool or None) – Set enabled state of the SSH-based controlled CLI.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Time(hour=None, minute=None, day=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Time class defines weekday and time the automatic check for new updates will be run

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

hour (str or None) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Only set if hour is present in SoftwareUpdatePolicy
minute (str or None) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Only set if minute is present in SoftwareUpdatePolicy
day (Time.UpdateDay or None) – Day to query for updates Only set if minute is present in SoftwareUpdatePolicy

class UpdateDay(string)¶

Bases: vmware.vapi.bindings.enum.Enum

Time.UpdateDay class Defines days to query for updates.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the UpdateDay instance.

EVERYDAY = UpdateDay(string='EVERYDAY')¶: Query for updates everyday.

FRIDAY = UpdateDay(string='FRIDAY')¶: Query for updates on Friday.

MONDAY = UpdateDay(string='MONDAY')¶: Query for updates on Monday.

SATURDAY = UpdateDay(string='SATURDAY')¶: Query for updates on Saturday.

SUNDAY = UpdateDay(string='SUNDAY')¶: Query for updates on Sunday.

THURSDAY = UpdateDay(string='THURSDAY')¶: Query for updates on Thursday.

TUESDAY = UpdateDay(string='TUESDAY')¶: Query for updates on Tuesday.

WEDNESDAY = UpdateDay(string='WEDNESDAY')¶: Query for updates on Wednesday.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timesync(mode=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Timesync class provides methods Performs time synchronization configuration.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: mode (Timesync.TimeSyncMode) –

class TimeSyncMode(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Timesync.TimeSyncMode class defines time synchronization modes

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the TimeSyncMode instance.

DISABLED = TimeSyncMode(string='DISABLED')¶: Time synchronization is disabled.

HOST = TimeSyncMode(string='HOST')¶: VMware Tool-based time synchronization.

NTP = TimeSyncMode(string='NTP')¶: NTP-based time synchronization.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.Timezone(name=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Timezone class provides methods to get and set the appliance timezone.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: name (str or None) – Set time zone.

class com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.UserAccountSettings(local_accounts_policy=None, root_account_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

This UserAccountSettings class to set/get user account settings.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

local_accounts_policy (LocalAccountsPolicy or None) – The localAccountsPolicy class provides methods to manage local user accounts. Only set if Password Policy is set to manage local user accounts.
root_account_policy (LocalAccounts or None) – The LocalAccounts class provides methods to manage local user account.

com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal(name=None, group=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Principal class represents the configuration for a Principal.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str) – Principal name.
group (bool) – Is a Group

class com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.AuthenticationManagement(privileges=None, global_permissions=None, roles=None, password_policy=None, token_policy=None, lockout_policy=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

AuthenticationManagement class This structure contains the Spec required for Authentication Management configurations.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

privileges (list of Privileges) – List of Privileges.
global_permissions (list of GlobalPermission) – List of Global Permission.
roles (list of Roles) – List of Roles.
password_policy (PasswordPolicy or None) – Password Policy.
token_policy (TokenPolicy or None) – Token Policy.
lockout_policy (LockoutPolicy or None) – Lockout Policy.

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.GlobalPermission(principal=None, role_names=None, propagate=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

GlobalPermissions class This structure represents the configuration for Global Permissions

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

principal (com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal) – Principal with roles.
role_names (list of str) – Role Names assigned to this Principal
propagate (bool) – Propagating to child objects.

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.LockoutPolicy(failed_login_attempts=None, failure_interval=None, unlock_time=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

LockoutPolicy class This structure represents the configuration in Lockout Policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

failed_login_attempts (long) – Maximum number of failed login attempts.
failure_interval (long) – Time interval between failures.
unlock_time (long) – Unlock time.

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.PasswordPolicy(special_chars=None, alpha_chars=None, uppercase_chars=None, lowercase_chars=None, numeric_chars=None, adj_identical_chars=None, password_reuse=None, max_life=None, max_length=None, min_length=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

PasswordPolicy class This structure represents the configuration in Password Policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

special_chars (long) – Minimum special characters.
alpha_chars (long) – Minimum alphabetic characters.
uppercase_chars (long) – Minimum uppercase characters.
lowercase_chars (long) – Minimum lowercase characters.
numeric_chars (long) – Minimum numeric characters.
adj_identical_chars (long) – Maximum adjacent identical characters.
password_reuse (long) – Previous password reuse restriction.
max_life (long) – Maximum lifetime.
max_length (long) – Maximum length.
min_length (long) – Minimum length.

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Privileges(id=None, description=None, group=None, is_on_parent=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Privileges class This structure represents the configuration for Privileges.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

id (str) – Privilege identifier.
description (str or None) – Privilege description.
group (str) – Group to which the privilege belongs to.
is_on_parent (bool) – does this apply to the parent entity?

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.Roles(name=None, description=None, privilege_ids=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Roles class This structure represents the configuration for Roles.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str) – Role name which is unique across roles.
description (str or None) – Role description.
privilege_ids (list of str or None) – List of Privileges present in the Role.

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.TokenPolicy(clock_tolerance=None, token_renewal=None, token_delegation=None, bearer_refresh=None, hok_refresh=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

TokenPolicy class This structure represents the configuration in Token Policy.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

clock_tolerance (long) – Clock tolerance ms.
token_renewal (long) – Maximum token renewal count.
token_delegation (long) – Maximum token delegation count.
bearer_refresh (long) – Maximum Bearer RefreshToken lifetime.
hok_refresh (long) – Maximum HoK RefreshToken lifetime.

com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module¶

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client module provides classes to manage the vCenter Server Inventory configurations.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.InventoryManagement(folders=None, datacenters=None, clusters=None, storage_pods=None, datastores=None, networks=None, hosts=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The InventoryManagement class contains attributes describing the inventory of a vCenter Server.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

folders (com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder or None) – List of Folders.
datacenters (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter or None) – List of Datacenters.
clusters (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo or None) – List of ClusterConfigurations.
storage_pods (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod or None) – List of Datastore Clusters.
datastores (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore or None) – List of Datastores.
networks (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network or None) – List of standard networks.
hosts (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig or None) – List of Hosts.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.Settings(settings=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Settings class defines vCenter Server settings as key-value pairs.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters: settings (dict of str and str) –

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.InventoryAuthorization(version=None, service_provider_entities=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

InventoryAuthorization class contains the Spec required for InventoryAuthorizationPlugin configurations.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

version (str) – The version of the authorization model this configuration is applicable to.
service_provider_entities (ServiceProviderEntities or None) – Service provider managed entities configuration of the vCenter.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.Permission(entity=None, principal=None, role_name=None, propagate=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

Permission class represents a single inventory permission inside a container.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

entity (str) – Full path to the entity for which the permission is set. The entity must be either one of the service provider managed entities, or a child thereof.
principal (com.vmware.appliance.vcenter.settings.v1.config.components.authcommon_client.Principal) – The principal for which the permission is set.
role_name (str) – Name of a role in vCenter.
propagate (bool) – Whether this permission propagates to child objects.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.ServiceProviderEntities(entities=None, permissions=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

ServiceProviderEntities class contains the configuration for the service provider managed entities inside VCenter, together with explicit inventory permissions inside the container.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

entities (list of str) – List of full paths to the service provider managed entities inside the vCenter.
permissions (list of Permission) – List of the inventory permissions to set inside the container.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventoryauthorization_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.DrsConfig(enabled=None, automation_level=None, migration_threshold=None, virtual_machine_automation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The DrsConfig class contains attributes describing the DRS specific configurations of the management cluster. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enabled (bool) – Flag indicating whether or not DRS service is enabled. 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.
automation_level (DrsConfig.DrsBehaviorInfo or None) – Specifies the cluster-wide default DRS behavior for virtual machines. You can override the default behavior for a virtual machine. 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. If None or empty, the value is skipped.
migration_threshold (long or None) – Threshold for generated recommendations. DRS generates only those recommendations that are above the specified vmotionRate. Ratings vary from 1 to 5. 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. If None or empty, the value is skipped.
virtual_machine_automation (bool or None) – Flag that dictates whether DRS Behavior overrides for individual VMs. 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.

class DrsBehaviorInfo(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The DrsConfig.DrsBehaviorInfo class defines the automation levels that can be set on a DRS cluster. Warning: This enumeration 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.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the DrsBehaviorInfo instance.

FULLY_AUTOMATED = DrsBehaviorInfo(string='FULLY_AUTOMATED')¶: Specifies that VirtualCenter should automate both the migration of virtual machines and their placement with a host at power on. Warning: This class 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.

MANUAL = DrsBehaviorInfo(string='MANUAL')¶: Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should not implement the recommendations automatically. Warning: This class 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.

PARTIALLY_AUTOMATED = DrsBehaviorInfo(string='PARTIALLY_AUTOMATED')¶: Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should automatically implement only the placement at power on. Warning: This class 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementCluster(name=None, parent_path=None, drs=None, management_resourcepools=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ManagementCluster class contains attributes describing the configuration of the management cluster that hosts the management virtual machines. It contains the resource settings of the cluster and the management virtual machines running inside it. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str) – Name of the management cluster which hosts the management VMs. 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.
parent_path (str) – Absolute path from root folder to management cluster’s parent. 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.
drs (DrsConfig) – Cluster-wide configuration of the vSphere DRS service. 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.
management_resourcepools (list of ResourcePool) – The management cluster provides dedicated resource pools for running the management virtual machines. Management cluster can can run workload VMs outside this resource pools. 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ManagementVirtualMachine(name=None, vm_type=None, parent_path=None, resource_config=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ManagementVirtualMachine class contains information about the management virtual machine configurations present in the management cluster. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str) – Name of the management virtual machine configuration. 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.
vm_type (ManagementVirtualMachine.ManagementVMType) – Type of the management virtual machine. 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.
parent_path (str) – Absolute path from root folder to management virtual machine parent vm folder. 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.
resource_config (ResourceConfigSpec or None) – Configuration of the management virtual machine. 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. If None, then there is no configuration.

class ManagementVMType(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The ManagementVirtualMachine.ManagementVMType class defines the type of management virtual machine. Warning: This enumeration 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.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the ManagementVMType instance.

CLOUD_GATEWAY = ManagementVMType(string='CLOUD_GATEWAY')¶: The management virtual machine is of type Cloud Gateway. Warning: This class 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.

VCENTER = ManagementVMType(string='VCENTER')¶: The management virtual machine is of type vCenter. Warning: This class 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceAllocationInfo(reservation=None, expandable_reservation=None, limit=None, shares=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ResourceAllocationInfo class contains resource allocation information of a resource pool or management virtual machine. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

reservation (long) – Amount of resource that is guaranteed available to a resource pool or a virtual machine. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB fo memory, and MHz for CPU. 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.
expandable_reservation (bool) – In a resource pool with an expandable reservation, the reservation can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation. 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.
limit (long) – The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, and MHz for CPU. 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.
shares (Shares) – Shares are used in case of resource contention. 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourceConfigSpec(cpu_allocation=None, memory_allocation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ResourceConfigSpec class provides resource reserved for a resource pool or management virtual machine. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

cpu_allocation (ResourceAllocationInfo) – Resource allocation information for CPU. 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.
memory_allocation (ResourceAllocationInfo) – Resource allocation information for memory. 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.ResourcePool(name=None, parent_path=None, config=None, vm=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The ResourcePool class contains information about the management resource pools present in the cluster. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

name (str) – Name of the vCenter Server resource pool. 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.
parent_path (str) – Absolute path from root folder to resource pool’s parent. 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.
config (ResourceConfigSpec) – Summary of the resource pool containing the resource 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.
vm (list of ManagementVirtualMachine or None) – The management virtual machines contained in this resource pool. 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. If None or empty, no virtual machine is expected to run in this resource pool..

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.Shares(level=None, shares=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

The Shares class provides specification of shares.

Shares are used to determine relative allocation between resource consumers. In general, a consumer with more shares gets proportionally more of the resource, subject to certain other constraints.. Warning: This class 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.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

level (Shares.Level) – The allocation level. It maps to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as CUSTOM. 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.
shares (long) –
When Shares.level is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.

There is no unit for this value. It is a relative measure based on the settings for other resource pools.. 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.

class Level(string)¶

Bases: vmware.vapi.bindings.enum.Enum

The Shares.Level class defines the possible values for the allocation level. Warning: This enumeration 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.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters: string (str) – String value for the Level instance.

CUSTOM = Level(string='CUSTOM')¶: If set, in case there is resource contention the server uses the shares value to determine the resource allocation. Warning: This class 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.

HIGH = Level(string='HIGH')¶

For CPU: Shares = 2000 * nmumber of virtual CPUs.: For Memory: Shares = 20 * virtual machine memory size in MB.

. Warning: This class 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.

LOW = Level(string='LOW')¶

For CPU: Shares = 500 * number of virtual CPUs.: For Memory: Shares = 5 * virtual machine memory size in MB.

. Warning: This class 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.

NORMAL = Level(string='NORMAL')¶

For CPU: Shares = 1000 * number of virtual CPUs.: For Memory: Shares = 10 * virtual machine memory size in MB.

. Warning: This class 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.

class com.vmware.appliance.vcenter.settings.v1.config.components.managementcluster_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client module¶

class com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.StubFactory(stub_config)¶

Bases: vmware.vapi.bindings.stub.StubFactoryBase

Initialize StubFactoryBase

Parameters: stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.appliance.vcenter.settings.v1.config.components.vsphereuiconfiguration_client.VsphereUIConfiguration(enable_idp_configuration=None, enable_cloud_admin_role_protection=None, enable_deprecated_vc_alert=None, enable_intercom_chat=None, enable_file_browser_download_upload_from_vc=None, enable_hybrid_management=None, enable_ceip=None, help_url_pointing_to_aws=None, enable_ad_iwa_ids=None, enable_csp_oidc_federation=None)¶

Bases: vmware.vapi.bindings.struct.VapiStruct

VsphereUIConfiguration class This spec is used to configure the behavior of the vsphere-ui service.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters

enable_idp_configuration (bool or None) – Property to configure the IDPConfiguration view, with this enabled, user will be able to view and configure IDP
enable_cloud_admin_role_protection (bool or None) – Property to enable CloudAdminRoleProtection in the UI
enable_deprecated_vc_alert (bool or None) – Property to enable DeprecatedVcAlert in the UI
enable_intercom_chat (bool or None) – Property to enable Intercom Chat in the UI
enable_file_browser_download_upload_from_vc (bool or None) – Property to enable file browser download and upload from VC
enable_hybrid_management (bool or None) – Property to enable hybrid management view.
enable_ceip (bool or None) – Property to enable CEIP view from Administration -> Deployment.
help_url_pointing_to_aws (bool or None) – Property that indicates that Help url should point to url for AWS.
enable_ad_iwa_ids (bool or None) – Property that indicates Identity Source of type IWA should be enabled.
enable_csp_oidc_federation (bool or None) – Property that indicates CSP OIDC identity provider configured in vCenter.