com.vmware.appliance.vcenter.settings.v1.config.components package¶
Submodules¶
com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client module¶
-
class
com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.
ApplianceManagement
(software_update_policy=None, backup_schedules=None, ssh=None, dcui=None, console_cli=None, shell=None, time_zone=None, time_sync=None, ntp=None, syslog=None, local_accounts_policy=None, root_local_account=None, smtp=None, network=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
orNone
) – Policy to update vCenter. Onlyset
if the SoftwareUpdatePolicy is set inside vCenter.backup_schedules (
list
ofBackupSchedule
orNone
) – Backup schedule of vCenter. Onlyset
if the Backup is schedule for vCenterssh (
Ssh
) – Get/Set enabled state of SSH-based controlled CLI.Ssh
class provides methodsdcui (
Dcui
) – Get/Set enabled of Direct Console User Interface (DCUI TTY2).Dcui
class provides methodsconsole_cli (
Consolecli
) – Get/Set enabled state of the console-based controlled CLI.Consolecli
class provides methodsshell (
Shell
) – Get/Set enabled state of BASH.Shell
class provides methodstime_zone (
Timezone
orNone
) – TheTimezone
class provides methods to get and set the appliance timezone. Onlyset
if the Timezone is set in vCentertime_sync (
Timesync
orNone
) –Timesync
class provides methods Performs time synchronization configuration. Onlyset
if the time sync mode is set in vCenterntp (
Ntp
orNone
) –Ntp
class provides methods Gets NTP configuration status and tests connection to ntp servers. Onlyset
if the ntp server are set in vCenter.syslog (
list
ofLogForwarding
orNone
) – Thesyslog
class provides methods to manage forwarding of log messages to remote logging servers. Onlyset
if log forwarding to remote server are set in vCenter.local_accounts_policy (
LocalAccountsPolicy
orNone
) – ThelocalAccountsPolicy
class provides methods to manage local user accounts. Onlyset
if Password Policy is set to manage local user accounts.root_local_account (
LocalAccounts
orNone
) – TheLocalAccounts
class provides methods to manage local user account.smtp (
Smtp
orNone
) – TheLocalAccounts
class provides methods to manage local user account.network (
ApplianceNetwork
orNone
) – Network configurations to be applied. Onlyset
if the network configurations 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)¶ 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
ofFirewallRulePolicy
orNone
) – List of Firewall Rules to be applied. Onlyset
if the FirewallRulePolicy is set in vCenter.dns_server_configuration (
DnsServerConfiguration
orNone
) – DNS configuration to be applied. Onlyset
if the DnsServerConfiguration is set in vCenter.proxy_configuration (
list
ofProxyConfiguration
orNone
) – Proxy configuration to be applied. Onlyset
if the Proxy server 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
ofstr
orNone
) – 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
orNone
) – 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
orNone
) – Username for the given location. If None authentication will not be used for the specified location.location_password (
str
orNone
) – Password for the given location. If None authentication will not be used for the specified location.enable (
bool
orNone
) – Enable or disable a schedule. If None the schedule will be enabled.recurrence_info (
RecurrenceInfo
orNone
) – Recurrence information for the schedule. If None backup job will not be scheduled. SeeRecurrenceInfo
retention_info (
RetentionInfo
orNone
) – Retention information for the schedule. If None all the completed backup jobs will be retained forever. SeeRetentionInfo
schedule_id (
str
) – Identifier of the schedule.
-
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 methodsTip
The arguments are used to initialize data attributes with the same names.
- Parameters
enabled (
bool
) – Set enabled state of the console-based controlled CLI (TTY1).
-
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 methodsTip
The arguments are used to initialize data attributes with the same names.
- Parameters
enabled (
bool
) – 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)¶ 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
ofstr
) – List of the currently used DNS servers. DNS server configuration.
-
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 theDNSServerMode
instance.
-
DHCP
= DNSServerMode(string='DHCP')¶ DNS address is automatically assigned by a DHCP server.
-
STATIC
= DNSServerMode(string='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
orNone
) – The interface to which this rule applies. An empty string indicates that the rule applies to all interfaces. Onlyset
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 thePolicy
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.
LocalAccounts
(fullname=None, roles=None, enabled=None, has_password=None, last_password_change=None, password_expires_at=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
orNone
) – Full name of the user If None, the value was never set.roles (
list
ofstr
orNone
) – User rolesenabled (
bool
) – Flag indicating if the account is enabledhas_password (
bool
) – Is the user password set.last_password_change (
datetime.datetime
orNone
) – Date and time password was changed. If None, the password was never set.password_expires_at (
datetime.datetime
orNone
) – Date when the account’s password will expire If None, the password never expires.min_days_between_password_change (
long
orNone
) – Minimum number of days between password change If None, pasword can be changed any time.max_days_between_password_change (
long
orNone
) – Maximum number of days between password change If None, password never expires.warn_days_before_password_expiration (
long
orNone
) – Number of days of warning before password expires If None, a user is never warned.password (
str
orNone
) – Password If None, value will not be changedemail (
str
orNone
) – 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
orNone
) – 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
orNone
) – 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
orNone
) – 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
) – FQDN or IP address of the logging server to which messages are forwarded.port (
long
) – The port on which the remote logging server is listening for forwarded log messages.protocol (
LogForwarding.Protocol
) – 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 theProtocol
instance.
-
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
ofstr
) – 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
) – URL of the proxy serverport (
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
orNone
) – Username for proxy server. Onlyset
if proxy requires username.password (
str
orNone
) – Password for proxy server. Onlyset
if proxy requires password.enabled (
bool
) – In the result of the#get
and#list
methods this attribute indicates whether proxying is enabled for a particular protocol. In the input to thetest
andset
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 theProtocol
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
ofRecurrenceInfo.DayOfWeek
orNone
) – 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. SeeRecurrenceInfo.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 theDayOfWeek
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
) – Enabled can be set to true or falsetimeout (
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
orNone
) – Mail server IP address. If None then the value will be ignored.relay_port (
str
orNone
) – Relay port number. If None then the value will be ignored.
-
class
com.vmware.appliance.vcenter.settings.v1.config.components.applmgmt_client.
SoftwareUpdatePolicy
(custom_url=None, default_url=None, auto_stage=None, check_schedule=None, username=None, password=None, certificate_check=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
custom_url (
str
orNone
) – Current appliance update repository URL. Enter “default” to reset the url to the default url. Onlyset
if custom URL requireddefault_url (
str
orNone
) – Default appliance update repository URL. Onlyset
if default URL requiredauto_stage (
SoftwareUpdatePolicy.AutoUpdateNotification
) – Check for update at the pre-configured repository URL.check_schedule (
Time
orNone
) – TheTime
class defines day and time the automatic check for new updates will be run. Onlyset
if Time required.username (
str
orNone
) – Username for the url update repository Onlyset
if SoftwareUpdatePolicy requires username.password (
str
orNone
) – Password for the url update repository Onlyset
if SoftwareUpdatePolicy requires password.certificate_check (
bool
) –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
classNote
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 theAutoUpdateNotification
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
) – 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 runTip
The arguments are used to initialize data attributes with the same names.
- Parameters
hour (
str
orNone
) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Onlyset
if hour is present in SoftwareUpdatePolicyminute (
str
orNone
) – Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Onlyset
if minute is present in SoftwareUpdatePolicyday (
Time.UpdateDay
orNone
) – Day to query for updates Onlyset
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 theUpdateDay
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 modesNote
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 theTimeSyncMode
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
orNone
) – Set time zone.
com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client module¶
-
class
com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.
AuthenticationManagement
(privileges_list=None, global_permission_list=None, role_list=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 (
list
ofPrivileges
) – List of Privileges.global_permission_list (
list
ofGlobalPermission
) – List of Global Permission.role_list (
list
ofRoles
) – List of Roles.password_policy (
PasswordPolicy
orNone
) – Password Policy.token_policy (
TokenPolicy
orNone
) – Token Policy.lockout_policy (
LockoutPolicy
orNone
) – Lockout Policy.
-
class
com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.
GlobalPermission
(principal=None, role_ids=None, propagate=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
GlobalPermissions
class This structure represents the configuration for Global PermissionsTip
The arguments are used to initialize data attributes with the same names.
- Parameters
principal (
Principal
) – Role identifier.role_ids (
list
oflong
) – Role Ids assigned to this Principalpropagate (
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.
Principal
(name=None, group=None)¶ Bases:
vmware.vapi.bindings.struct.VapiStruct
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.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
) – Privilege description.group (
str
) – Group to which the privilege belongs to.is_on_parent (
bool
) – Is on parent.
-
class
com.vmware.appliance.vcenter.settings.v1.config.components.authmanagement_client.
Roles
(id=None, name=None, description=None, privilege_id=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
id (
long
) – Role identifier.name (
str
) – Role name.description (
str
) – Role description.privilege_id (
list
ofstr
) – 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.