Navigation

com.vmware.appliance.techpreview package

Submodules

com.vmware.appliance.techpreview.localaccounts_client module

class com.vmware.appliance.techpreview.localaccounts_client.User(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

User class provides methods Perform operations on local user account.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class NewUserConfig(username=None, role=None, password=None, fullname=None, email=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

User.NewUserConfig class Structure that defines a new user configuration.

Tip

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

Parameters:
  • username (str) – User login name
  • role (User.UserRole or None) – User roles. The default role is operator. role Default role is operator
  • password (str) – User login password In Interactive mode, provide –password as part of the command, and enter the value on the prompt. When accessed remotely, provide –password value as part the command.
  • fullname (str or None) – User full name fullname Optional full name for a person
  • email (str or None) – Email address of the local account. email Optional email
class User.UserAccountStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

User.UserAccountStatus class Defines status of user accounts

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 UserAccountStatus instance.
disabled = UserAccountStatus(string=u'disabled')

The user account is disabled.

enabled = UserAccountStatus(string=u'enabled')

The user account is enabled.

class User.UserConfig(username=None, role=None, fullname=None, status=None, email=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

User.UserConfig class Structure that defines a new user configuration for CLI.

Tip

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

Parameters:
  • username (str) – User login name
  • role (User.UserRole) – User roles
  • fullname (str) – User full name
  • status (User.UserAccountStatus) – Enabled status of the local account
  • email (str) – email of the local account
class User.UserConfigGet(username=None, role=None, fullname=None, status=None, passwordstatus=None, email=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

User.UserConfigGet class Structure defines a user configuration for user.get API.

Tip

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

Parameters:
  • username (str) – User login name
  • role (User.UserRole) – User roles
  • fullname (str) – User full name
  • status (User.UserAccountStatus) – Shows whether the user account is enabled or disabled.
  • passwordstatus (User.UserPasswordStatus) – Shows whether the user account is still valid or expired.
  • email (str) – Email address of the local account.
class User.UserPasswordStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

User.UserPasswordStatus class Defines state of user password

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 UserPasswordStatus instance.
expired = UserPasswordStatus(string=u'expired')

The password has expired.

notset = UserPasswordStatus(string=u'notset')

No password has been set

valid = UserPasswordStatus(string=u'valid')

The password is still valid.

class User.UserRole(string)

Bases: vmware.vapi.bindings.enum.Enum

User.UserRole class Defines user roles for appliance

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 UserRole instance.
admin = UserRole(string=u'admin')

Able to configure the appliance.

operator = UserRole(string=u'operator')

Able to read the appliance configuration.

superAdmin = UserRole(string=u'superAdmin')

Able to configure the appliance, manage local accounts and use the BASH shell

User.add(config)

Create a new local user account.

Parameters:config (User.NewUserConfig) – User configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
User.delete(username)

Delete a local user account.

Parameters:username (str) – User login name.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
User.get(username)

Get the local user account information.

Parameters:username (str) – User login name.
Return type:User.UserConfigGet
Returns:local user account information
Raise:com.vmware.vapi.std.errors_client.Error Generic error
User.list()

List of local accounts

Return type:list of User.UserConfigGet
Returns:User configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
User.set(config)

Update local user account properties role, full name, enabled status and password

Parameters:config (User.UserConfig) – User configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error

com.vmware.appliance.techpreview.monitoring_client module

class com.vmware.appliance.techpreview.monitoring_client.Snmp(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Snmp class provides methods SNMP agent operations.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class SNMPAuthProto(string)

Bases: vmware.vapi.bindings.enum.Enum

Snmp.SNMPAuthProto class Defines SNMP authentication protocols

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 SNMPAuthProto instance.
MD5 = SNMPAuthProto(string=u'MD5')

MD5

SHA1 = SNMPAuthProto(string=u'SHA1')

SHA1

none = SNMPAuthProto(string=u'none')

NONE

class Snmp.SNMPConfig(authentication=None, communities=None, engineid=None, loglevel=None, notraps=None, port=None, privacy=None, remoteusers=None, syscontact=None, syslocation=None, targets=None, users=None, v3targets=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPConfig class Structure that defines the SNMP configuration, provided as input to set(), and never the result of get(). See SNMPConfigReadOnly. This structure is used to configure SNMP v1, v2c, and v3.

Tip

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

Parameters:
  • authentication (Snmp.SNMPAuthProto) – Set the default authentication protocol. Values can be none, MD5, or SHA1.
  • communities (list of str) – Set up to ten communities, each of no more than 64 characters long. The format is: community1[,community2,...]. This setting overwrites any previous settings.
  • engineid (str) – Set SNMPv3 engine ID. The engine ID must contain 5 to 32 hexadecimal characters. “0x” and colon (:) are removed from the ID.
  • loglevel (str) – System Agent syslog logging level: debug|info|warning|error.
  • notraps (list of str) – Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use ‘reset’ to clear the setting.
  • port (long) – Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
  • privacy (Snmp.SNMPPrivProto) – Set the default privacy protocol. Values: none or AES128.
  • remoteusers (list of str) – Set up to five inform user IDs. The format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,...]. Here, user must be maximum 32 characters long; auth-proto is none, MD5 or SHA1; priv-proto is none or AES; ‘-‘ indicates no hash; engine-id is a hexadecimal string ‘0x0-9a-f’ and must be up to 32 characters long.
  • syscontact (str) – System contact string as presented in sysContact.0. Up to 255 characters long.
  • syslocation (str) – System location string as presented in sysLocation.0. Up to 255 characters long.
  • targets (list of str) – Set up to three targets to which to send SNMPv1 traps. The format is: ip-or-hostname[\@port]/community[,...]. The default port is UDP 162. This setting overwrites any previous settings.
  • users (list of str) – Set up to five local users. The format is: user/-|auth-hash/-|priv-hash/model[,...]. Here user is maximum 32 characters long; ‘-‘ indicates no hash; model is one of none, auth or priv.
  • v3targets (list of str) – Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[\@port]/remote-user/security-level/trap|inform[,...].
class Snmp.SNMPConfigReadOnly(authentication=None, communities=None, enable=None, engineid=None, loglevel=None, notraps=None, port=None, privacy=None, syscontact=None, syslocation=None, targets=None, users=None, remoteusers=None, v3targets=None, pid=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPConfigReadOnly class Structure that defines the SNMP configuration, the result of get(), and never provided as input to set(). This structure differs from SNMPConfig because it contains localized keys (as defined in http://tools.ietf.org/html/rfc3826#section-1.2), instead of raw secret strings. This structure can be used to configure SNMP v1, v2c, and v3. Keep this structure in sync with vmw_snmp.py:_default_config(). Note that if a field if left empty, it is considered unset and will be ignored. Existing array elements below can be unset by sending an element with the string ‘reset’.

Tip

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

Parameters:
  • authentication (Snmp.SNMPAuthProto) – Set the default authentication protocol. Values can be none, MD5, or SHA1.
  • communities (list of str) – Set up to ten communities, each of no more than 64 characters long. The format is: community1[,community2,...]. This setting overwrites any previous settings.
  • enable (bool) – Set enable to true/false
  • engineid (str) – Set SNMPv3 engine ID.
  • loglevel (str) – System Agent syslog logging level: debug|info|warning|error.
  • notraps (list of str) – Comma-separated list of trap OIDs (object identifiers) for traps not to be sent by the agent. Use ‘reset’ to clear the setting.
  • port (long) – Set up a UDP port which the SNMP agent uses to listen on for polling requests. The default UDP port is 161.
  • privacy (Snmp.SNMPPrivProto) – Set the default privacy protocol.
  • syscontact (str) – System contact string as presented in sysContact.0. Up to 255 characters long.
  • syslocation (str) – System location string as presented in sysLocation.0. Up to 255 characters long.
  • targets (list of Snmp.SNMPv1TrapTarget) – Set up to three targets to which to send SNMPv1 traps.
  • users (list of Snmp.SNMPUser) – Set up to five local users.
  • remoteusers (list of Snmp.SNMPRemoteUser) – Set up remote users.
  • v3targets (list of Snmp.SNMPv3Target) – Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[\@port]/remote-user/security-level/trap|inform[,...].
  • pid (str) – Set up pid
class Snmp.SNMPHashConfig(auth_hash=None, priv_hash=None, raw_secret=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPHashConfig class Structure to provide up to two secrets to combine with the SNMPv3 engine ID and authentication or privacy protocol to form a localized hash. auth_hash is always required, priv_hash can be empty. By default arguments are paths on the local filesystem, raw_secret takes path to be the actual raw secret. First implementation was in ESXi: esxcli system snmp hash –help

Tip

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

Parameters:
  • auth_hash (str) – Provide filename to secret for authentication hash, use in set –users (required secret)
  • priv_hash (str) – Provide filename to secret for privacy hash, use in set –users (secret)
  • raw_secret (bool) – Make –auth_path and –priv_path flags read raw secret from command line instead of file.
class Snmp.SNMPHashResults(auth_key=None, priv_key=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPHashResults class Structure to provide operators diagnostics test results.

Tip

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

Parameters:
  • auth_key (str) – SNMP authentication key
  • priv_key (str) – SNMP privacy key
class Snmp.SNMPLimits(max_communities=None, max_trap_destinations_v1=None, max_destinations_v3=None, max_notification_filters=None, max_community_length=None, max_buffer_size=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPLimits class Structure that provides various limits of the SNMP agent.

Tip

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

Parameters:
  • max_communities (long) – Set up maximum communities limit
  • max_trap_destinations_v1 (long) – Set up max trap destinations limit
  • max_destinations_v3 (long) – Set up max destinations limit
  • max_notification_filters (long) – Set up max notification Filters
  • max_community_length (long) – Set up max community length
  • max_buffer_size (long) – Set up max buffer size
class Snmp.SNMPPrivProto(string)

Bases: vmware.vapi.bindings.enum.Enum

Snmp.SNMPPrivProto class Defines SNMP privacy protocols

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 SNMPPrivProto instance.
AES128 = SNMPPrivProto(string=u'AES128')

AES128

none = SNMPPrivProto(string=u'none')

NONE

class Snmp.SNMPRemoteUser(username=None, sec_level=None, authentication=None, auth_key=None, privacy=None, priv_key=None, engineid=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPRemoteUser class Structure that defines a user at particular remote SNMPv3 entity needed when using informs. auth_key and priv_key contained localized keys as defined in http://tools.ietf.org/html/rfc3826#section-1.2.

Tip

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

Parameters:
  • username (str) – SNMP Username
  • sec_level (Snmp.SNMPSecLevel) – SNMP security level
  • authentication (Snmp.SNMPAuthProto) – SNMP authorization protocol
  • auth_key (str) – SNMP authorization key
  • privacy (Snmp.SNMPPrivProto) – SNMP privacy protocol
  • priv_key (str) – SNMP privacy key
  • engineid (str) – SNMP v3 engine id
class Snmp.SNMPSecLevel(string)

Bases: vmware.vapi.bindings.enum.Enum

Snmp.SNMPSecLevel class Defines SNMP decurity levels

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 SNMPSecLevel instance.
auth = SNMPSecLevel(string=u'auth')

auth

none = SNMPSecLevel(string=u'none')

none

priv = SNMPSecLevel(string=u'priv')

priv

class Snmp.SNMPStats(sysuptime=None, worstrtimelast=None, avgresponsetime=None, worstresponsetime=None, inpkts=None, outpkts=None, usmstatsnotintimewindows=None, usmstatsunknownusernames=None, usmstatsunknownengineids=None, usmstatswrongdigests=None, usmstatsdecryptionerrors=None, inbadversions=None, inbadcommunitynames=None, inbadcommunityuses=None, inasnparseerrs=None, intoobigs=None, innosuchnames=None, inbadvalues=None, ingenerrs=None, outtoobigs=None, outnosuchnames=None, outbadvalues=None, outgenerrs=None, outtraps=None, silentdrops=None, avgvarbinds=None, maxvarbinds=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPStats class Structure to provide operators diagnostics on snmp agent itself.

Tip

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

Parameters:
  • sysuptime (str) – System uptime
  • worstrtimelast (str) – Last updated time
  • avgresponsetime (str) – Average response time
  • worstresponsetime (str) – Response time
  • inpkts (long) – No of input packets
  • outpkts (long) – No of output packets
  • usmstatsnotintimewindows (long) – No of stats not in time window
  • usmstatsunknownusernames (long) – No of usm stats unknown
  • usmstatsunknownengineids (long) – No of usm stats unknown engine ids
  • usmstatswrongdigests (long) – No of wrogn digests
  • usmstatsdecryptionerrors (long) – No. of decryption errors
  • inbadversions (long) – No of bad versions
  • inbadcommunitynames (long) – No of bad community names
  • inbadcommunityuses (long) – No of bad community uses
  • inasnparseerrs (long) – No of parse errors
  • intoobigs (long) – No of too bigs
  • innosuchnames (long) – No of no such names
  • inbadvalues (long) – No of bad values
  • ingenerrs (long) – No of gen errors
  • outtoobigs (long) – No out output too bigs
  • outnosuchnames (long) – No of no such names
  • outbadvalues (long) – No of bad values
  • outgenerrs (long) – No of gen errors
  • outtraps (long) – No of output traps
  • silentdrops (long) – No of silent drops
  • avgvarbinds (long) – No of ave:rage var binds
  • maxvarbinds (long) – No of max var binds
class Snmp.SNMPTestResults(success=None, message=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPTestResults class Structure to provide operators diagnostics test results.

Tip

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

Parameters:
  • success (bool) – Set success to true/false
  • message (str) – message
class Snmp.SNMPUser(username=None, sec_level=None, auth_key=None, priv_key=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPUser class Structure that defines information associated with an SNMP user. authKey and privKey are localized keys defined in http://tools.ietf.org/html/rfc3826#section-1.2.

Tip

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

Parameters:
  • username (str) – SNMP Username
  • sec_level (Snmp.SNMPSecLevel) – SNMP security level
  • auth_key (str) – SNMP authorization key
  • priv_key (str) – SNMP privacy key
class Snmp.SNMPv1TrapTarget(ip=None, port=None, community=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPv1TrapTarget class Structure that defines an SNMP v1/v2c trap target.

Tip

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

Parameters:
  • ip (str) – SNMP target ip
  • port (long) – SNMP target port
  • community (str) – SNMP target community
class Snmp.SNMPv3Notfication(string)

Bases: vmware.vapi.bindings.enum.Enum

Snmp.SNMPv3Notfication class Defines SNMP v3 notification types

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 SNMPv3Notfication instance.
inform = SNMPv3Notfication(string=u'inform')

inform

trap = SNMPv3Notfication(string=u'trap')

trap

class Snmp.SNMPv3Target(type=None, sec_level=None, ip=None, port=None, user=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Snmp.SNMPv3Target class Structure that defines an SNMP v3 inform or trap target.

Tip

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

Parameters:
Snmp.disable()

Stop an enabled SNMP agent.

Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.enable()

Start a disabled SNMP agent.

Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.get()

Return an SNMP agent configuration.

Return type:Snmp.SNMPConfigReadOnly
Returns:SNMP config structure
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.hash(config)

Generate localized keys for secure SNMPv3 communications.

Parameters:config (Snmp.SNMPHashConfig) – SNMP hash configuration.
Return type:Snmp.SNMPHashResults
Returns:SNMP hash result
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.limits()

Get SNMP limits information.

Return type:Snmp.SNMPLimits
Returns:SNMP limits structure
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.reset()

Restore settings to factory defaults.

Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.set(config)

Set SNMP configuration.

Parameters:config (Snmp.SNMPConfig) – SNMP configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.stats()

Generate diagnostics report for snmp agent.

Return type:Snmp.SNMPStats
Returns:SNMP stats
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Snmp.test()

Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).

Return type:Snmp.SNMPTestResults
Returns:SNMP test result
Raise:com.vmware.vapi.std.errors_client.Error Generic error

com.vmware.appliance.techpreview.networking_client module

class com.vmware.appliance.techpreview.networking_client.Ipv4(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Ipv4 class provides methods Performs IPV4 network configuration for interfaces.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class IPv4Config(interface_name=None, mode=None, address=None, prefix=None, default_gateway=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv4.IPv4Config class Structure that defines the IPv4 configuration state of a network interface.

Tip

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

Parameters:
  • interface_name (str) – Interface name, for example, “nic0”, “nic1”.
  • mode (Ipv4.IPv4Mode) – Address assignment mode.
  • address (str) – IPv4 address, for example, “10.20.80.191”. Set this argument to an empty string “”, if the mode is “unconfigured” or “dhcp”.
  • prefix (long) – IPv4 CIDR prefix, for example , 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. Set this argument to 0 if the mode is “unconfigured” or “dhcp”.
  • default_gateway (str) – IPv4 address of the default gateway. This default gateway value is used if the mode argument is set to “static” 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.
class Ipv4.IPv4ConfigReadOnly(interface_name=None, mode=None, address=None, prefix=None, default_gateway=None, updateable=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv4.IPv4ConfigReadOnly class Structure that defines the IPv4 configuration state of a network interface.

Tip

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

Parameters:
  • interface_name (str) – Interface name, for example, “nic0”, “nic1”.
  • mode (Ipv4.IPv4Mode) – Address assignment mode.
  • address (str) – IPv4 address, for example, “10.20.80.191”. Set this argument to an empty string “”, if the mode is “unconfigured” or “dhcp”.
  • prefix (long) – IPv4 CIDR prefix, for example , 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. Set this argument to 0 if the mode is “unconfigured” or “dhcp”.
  • default_gateway (str) – IPv4 address of the default gateway. This default gateway value is used if the mode argument is set to “static” 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.
  • updateable (bool) – This indicates if the network configuration can be updated for the interface.
class Ipv4.IPv4Mode(string)

Bases: vmware.vapi.bindings.enum.Enum

Ipv4.IPv4Mode class Defines different ipv4 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 IPv4Mode instance.
dhcp = IPv4Mode(string=u'dhcp')

IPv4 address is automatically assigned by a DHCP server.

is_static = IPv4Mode(string=u'is_static')

IPv4 address is static.

unconfigured = IPv4Mode(string=u'unconfigured')

The IPv4 protocol is not configured.

Ipv4.get(interfaces)

Get IPv4 network configuration for interfaces.

Parameters:interfaces (list of str) – Network interfaces to query, for example, “nic0”.
Return type:list of Ipv4.IPv4ConfigReadOnly
Returns:IPv4 configuration for each queried interface.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Ipv4.list()

Get IPv4 network configuration for all configured interfaces.

Return type:list of Ipv4.IPv4ConfigReadOnly
Returns:IPv4 configuration for each interface.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Ipv4.renew(interfaces)

Renew IPv4 network configuration on interfaces. If the interface is configured to use DHCP for IP address assignment, the lease of the interface is renewed.

Parameters:interfaces (list of str) – Interfaces to renew.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Ipv4.set(config)

Set IPv4 network configuration.

Parameters:config (list of Ipv4.IPv4Config) – List of IPv4 configurations.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
class com.vmware.appliance.techpreview.networking_client.Ipv6(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Ipv6 class provides methods Performs IPV4 network configuration for interfaces.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class IPv6Address(address=None, prefix=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv6.IPv6Address class Structure used to name an IPv6 address.

Tip

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

Parameters:
  • address (str) – IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
  • prefix (long) – IPv6 CIDR prefix, for example, 64.
class Ipv6.IPv6AddressOrigin(string)

Bases: vmware.vapi.bindings.enum.Enum

Ipv6.IPv6AddressOrigin 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 IPv6AddressOrigin instance.
dhcp = IPv6AddressOrigin(string=u'dhcp')

The IPv6 address is assigned by a DHCP server. See RFC 4293.

linklayer = IPv6AddressOrigin(string=u'linklayer')

The IPv6 address is assigned by IPv6 Stateless Address Auto-configuration (SLAAC). See RFC 4293.

manual = IPv6AddressOrigin(string=u'manual')

The IPv6 address was manually configured to a specified address, for, example, by user configuration. See RFC 4293.

other = IPv6AddressOrigin(string=u'other')

The IPv6 address is assigned by a mechanism other than manual, DHCP, SLAAC, or random. See RFC 4293.

random = IPv6AddressOrigin(string=u'random')

The IPv6 address is assigned randomly by the system. See RFC 4293.

class Ipv6.IPv6AddressReadOnly(address=None, prefix=None, origin=None, status=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv6.IPv6AddressReadOnly class Structure that you can use to get information about an IPv6 address along with its origin and status.

Tip

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

Parameters:
  • address (str) – IPv6 address, for example, fc00:10:20:83:20c:29ff:fe94:bb5a.
  • prefix (long) – IPv6 CIDR prefix, for example, 64.
  • origin (Ipv6.IPv6AddressOrigin) – Origin of the IPv6 address. For more information, see RFC 4293.
  • status (Ipv6.IPv6AddressStatus) – Status of the IPv6 address. For more information, see RFC 4293.
class Ipv6.IPv6AddressStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Ipv6.IPv6AddressStatus class Defines IPV6 address status 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 IPv6AddressStatus instance.
deprecated = IPv6AddressStatus(string=u'deprecated')

This is a valid but deprecated IPv6 address. Do not use this IPv6 address as a source address in new communications, although packets addressed to such an address are processed as expected. See RFC 4293.

duplicate = IPv6AddressStatus(string=u'duplicate')

This IPv6 address is not unique on the link. Do use this IPv6 address. See RFC 4293.

inaccessible = IPv6AddressStatus(string=u'inaccessible')

This IPv6 address is inaccessible because the interface to which this address is assigned is not operational. See RFC 4293.

invalid = IPv6AddressStatus(string=u'invalid')

This IPv6 address is not a valid address. It should not appear as the destination or source address of a packet. See RFC 4293.

optimistic = IPv6AddressStatus(string=u'optimistic')

This IPv6 address is available for use, subject to restrictions, while its uniqueness on a link is being verified. See RFC 4293.

preferred = IPv6AddressStatus(string=u'preferred')

This is a valid IPv6 address that can appear as the destination or source address of a packet. See RFC 4293.

tentative = IPv6AddressStatus(string=u'tentative')

This IPv6 address is in the process of being verified as unique. Do not use addresses in this state for general communication. You can use them to determine the uniqueness of the address. See RFC 4293.

unknown = IPv6AddressStatus(string=u'unknown')

The status of this address cannot be determined. See RFC 4293.

class Ipv6.IPv6Config(interface_name=None, dhcp=None, autoconf=None, addresses=None, default_gateway=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv6.IPv6Config class Structure that you can use to configure IPv6 on a particular interface. Because IPv6 permits multiple addresses per interface, addresses can be assigned by DHCP, SLAAC, and can also be statically assigned.

Tip

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

Parameters:
  • interface_name (str) – Network interface, for example, “nic0” to configure.
  • dhcp (bool) – Address assigned by a DHCP server.
  • autoconf (bool) – Address is assigned by Stateless Address Autoconfiguration (SLAAC).
  • addresses (list of Ipv6.IPv6Address) – A list of addresses to be statically assigned.
  • default_gateway (str) – 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 Ipv6.IPv6ConfigReadOnly(interface_name=None, dhcp=None, autoconf=None, addresses=None, default_gateway=None, updateable=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Ipv6.IPv6ConfigReadOnly class Structure that defines an existing IPv6 configuration on a particular interface. This structure is read only.

Tip

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

Parameters:
  • interface_name (str) – Network interface, for example, “nic0” queried.
  • dhcp (bool) – Address assigned by a DHCP server.
  • autoconf (bool) – Address is assigned by Stateless Address Autoconfiguration (SLAAC).
  • addresses (list of Ipv6.IPv6AddressReadOnly) – A list of all addresses assigned to this interface. The origin field of each address determines how the address was assigned, for example, statically, by DHCP, SLAAC.
  • default_gateway (str) – Default gateway. 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.
  • updateable (bool) – This indicates if the network configuration can be updated for the interface.
Ipv6.get(interfaces)

Get IPv6 network configuration for interfaces.

Parameters:interfaces (list of str) – Network interfaces to query, for example, “nic0”.
Return type:list of Ipv6.IPv6ConfigReadOnly
Returns:IPv6 configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Ipv6.list()

Get IPv6 network configuration for all configured interfaces.

Return type:list of Ipv6.IPv6ConfigReadOnly
Returns:IPv6 configuration for each interface.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Ipv6.set(config)

Set IPv6 network configuration.

Parameters:config (list of Ipv6.IPv6Config) – IPv6 configuration.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
class com.vmware.appliance.techpreview.networking_client.Proxy(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Proxy class provides methods Proxy configuration.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class Message(message=None, result=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Proxy.Message class Test result and message

Tip

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

Parameters:
class Proxy.MessageStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Proxy.MessageStatus class Individual test result

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 MessageStatus instance.
failure = MessageStatus(string=u'failure')

message indicates the test failed.

success = MessageStatus(string=u'success')

message indicates that the test was successful.

class Proxy.ProxyConfig(protocol=None, server=None, port=None, username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Proxy.ProxyConfig class Structure that defines proxy configuration.

Tip

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

Parameters:
  • protocol (Proxy.ProxyProtocol) – protocol being configured.
  • server (str) – hostname or ip of proxy server
  • port (long) – port to connect to the proxy server on. A value of -1 indicates that the default port is being used.
  • username (str) – username for proxy server.
  • password (str) – password for proxy server.
class Proxy.ProxyConfigMultiple(status=None, configlist=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Proxy.ProxyConfigMultiple class Structure representing multiple proxy configuration.

Tip

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

Parameters:
  • status (Proxy.ProxyStatus) – proxy enabled or disabled This sets whether the proxy configuration is used.
  • configlist (list of Proxy.ProxyConfig) – List of proxy configuration.
class Proxy.ProxyConfigTest(protocol=None, server=None, port=None, username=None, password=None, testhost=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Proxy.ProxyConfigTest class Structure that defines proxy configuration.

Tip

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

Parameters:
  • protocol (Proxy.ProxyProtocol) – protocol being configured.
  • server (str) – hostname or ip of proxy server
  • port (long) – port to connect to the proxy server on. A value of -1 indicates that the default port is being used.
  • username (str) – username for proxy server.
  • password (str) – password for proxy server.
  • testhost (str) – Verify that a hostname (www.vmware.com) or IPv4 or Ipv6 address of the testhost is accessible through proxy.
class Proxy.ProxyProtocol(string)

Bases: vmware.vapi.bindings.enum.Enum

Proxy.ProxyProtocol class Defines different proxy protocols

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 ProxyProtocol instance.
ftp = ProxyProtocol(string=u'ftp')

proxy configuration for ftp.

http = ProxyProtocol(string=u'http')

proxy configuration for http.

https = ProxyProtocol(string=u'https')

proxy configuration for https.

class Proxy.ProxyStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Proxy.ProxyStatus class Defines state of proxy

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 ProxyStatus instance.
disabled = ProxyStatus(string=u'disabled')

proxy configuration is disabled

enabled = ProxyStatus(string=u'enabled')

proxy configuration is enabled

class Proxy.TestStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Proxy.TestStatus class Health indicator

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 TestStatus instance.
green = TestStatus(string=u'green')

All tests were successful for given data

orange = TestStatus(string=u'orange')

In case data has more than one test, this indicates not all tests were successful

red = TestStatus(string=u'red')

All tests failed for given data

class Proxy.TestStatusInfo(status=None, messages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Proxy.TestStatusInfo class Overall test result

Tip

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

Parameters:
Proxy.delete(protocol)

Delete a Proxy configuration for a specific protocol.

Parameters:protocol (Proxy.ProxyProtocol) – Protocol to delete proxy of.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Proxy.get()

Get proxy configuration for all protocols.

Return type:Proxy.ProxyConfigMultiple
Returns:proxy configuration for all protocols.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Proxy.set(config)

Set Proxy configuration. In order for this configuration to take effect a logout is required.

Parameters:config (Proxy.ProxyConfigMultiple) – List of Proxy configurations to be set.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Proxy.test(config)

Test a Proxy configuration by testing the connection to the proxy server and test host.

Parameters:config (Proxy.ProxyConfigTest) – Proxy configuration to test
Return type:Proxy.TestStatusInfo
Returns:Status of proxy settings.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
class com.vmware.appliance.techpreview.networking_client.Routes(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Routes class provides methods Performs networking routes operations.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class Message(message=None, result=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Routes.Message class Test result and message

Tip

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

Parameters:
class Routes.MessageStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Routes.MessageStatus class Individual test result

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 MessageStatus instance.
failure = MessageStatus(string=u'failure')

message indicates the test failed.

success = MessageStatus(string=u'success')

message indicates that the test was successful.

class Routes.Route(destination=None, prefix=None, gateway=None, interface_name=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Routes.Route class Structure that describes how routing is performed for a particular destination and prefix. A destination/prefix of 0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway.

Tip

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

Parameters:
  • destination (str) – Destination address that defines this route.
  • prefix (long) – Destination CIDR prefix that defines this route. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.
  • gateway (str) – Gateway address.
  • interface_name (str) – Output device interface, for example, “nic0”.
class Routes.RouteReadOnly(destination=None, prefix=None, gateway=None, interface_name=None, is_static=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Routes.RouteReadOnly class Structure that describes how routing is performed for a particular destination and prefix. A destination/prefix of 0.0.0.0/0 ( for IPv4) or ::/0 (for IPv6) refers to the default gateway.

Tip

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

Parameters:
  • destination (str) – Destination address that defines this route.
  • prefix (long) – Destination CIDR prefix that defines this route. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.
  • gateway (str) – Gateway address.
  • interface_name (str) – Output device interface, for example, “nic0”.
  • is_static (bool) – Static provides information about installation of the route. True indicates the route was installed by the administrator. False indicates the route was autoconfigured
class Routes.TestStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Routes.TestStatus class Health indicator

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 TestStatus instance.
green = TestStatus(string=u'green')

All tests were successful for given data

orange = TestStatus(string=u'orange')

In case data has more than one test, this indicates not all tests were successful

red = TestStatus(string=u'red')

All tests failed for given data

class Routes.TestStatusInfo(status=None, messages=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Routes.TestStatusInfo class Overall test result

Tip

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

Parameters:
Routes.add(route)

Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.

Parameters:route (Routes.Route) – Static routing rule.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Routes.delete(route)

Delete static routing rules.

Parameters:route (Routes.Route) – Static routing rule.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Routes.list()

Get main routing table. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.

Return type:list of Routes.RouteReadOnly
Returns:Routing table.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Routes.set(routes)

Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.

Parameters:routes (list of Routes.Route) – Static routing rules.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Routes.test(gateways)

Test connection to a list of gateways

Parameters:gateways (list of str) – list of gateways.
Return type:Routes.TestStatusInfo
Returns:connection status
Raise:com.vmware.vapi.std.errors_client.Error Generic error

com.vmware.appliance.techpreview.ntp_client module

class com.vmware.appliance.techpreview.ntp_client.Server(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Server class provides methods Performs NTP configuration.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
add(servers)

Add NTP servers. This command adds NTP servers to the configuration. If the time synchronization is NTP-based, then NTP daemon is restarted to reload the new NTP servers. Otherwise, this command just adds servers to the NTP configuration.

Parameters:servers (list of str) – List of host names or IP addresses of NTP servers.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
delete(servers)

Delete NTP servers. This command deletes NTP servers from the configuration. If the time synchronization mode is NTP-based, the NTP daemon is restarted to reload the new NTP configuration. Otherwise, this command just deletes servers from the NTP configuration.

Parameters:servers (list of str) – List of host name or ip addresses of ntp servers.
Raise:com.vmware.vapi.std.errors_client.Error Generic error
set(servers)

Set NTP servers. This command deletes old NTP servers from the configuration and sets the input NTP servers in the configuration. If the time synchronization is NTP-based, the NTP daemon is restarted to reload the new NTP configuration. Otherwise, this command just replaces servers in the NTP configuration.

Parameters:servers (list of str) – List of host names or ip addresses of ntp servers.
Raise:com.vmware.vapi.std.errors_client.Error Generic error

com.vmware.appliance.techpreview.services_client module

class com.vmware.appliance.techpreview.services_client.Status(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Status class provides methods Get status of a service.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class ServiceStatus(string)

Bases: vmware.vapi.bindings.enum.Enum

Status.ServiceStatus class Defines service 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 ServiceStatus instance.
down = ServiceStatus(string=u'down')

Service is not running.

up = ServiceStatus(string=u'up')

Service is running.

Status.get(name, timeout)

Get status of a service.

Parameters:
  • name (str) – Name of a service.
  • timeout (long) – Timeout in seconds. Zero (0) means no timeout.
Return type:

Status.ServiceStatus
Returns:

Status of the service.
Raise:

com.vmware.vapi.std.errors_client.Error Generic error

com.vmware.appliance.techpreview.system_client module

class com.vmware.appliance.techpreview.system_client.Update(config)

Bases: vmware.vapi.bindings.stub.VapiInterface

Update class provides methods Performs update repository configuration.

Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
class AutoUpdateNotification(string)

Bases: vmware.vapi.bindings.enum.Enum

Update.AutoUpdateNotification class Defines state for automatic update notification

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=u'disabled')

Automatic update notification is disabled. Disable periodically query the configured url for updates.

enabled = AutoUpdateNotification(string=u'enabled')

Automatic update notification is enabled. Enable periodically query the configured url for updates.

class Update.UpdateDay(string)

Bases: vmware.vapi.bindings.enum.Enum

Update.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=u'Everyday')

query for updates everyday

Friday = UpdateDay(string=u'Friday')

query for updates on Friday

Monday = UpdateDay(string=u'Monday')

query for updates on Monday

Saturday = UpdateDay(string=u'Saturday')

query for updates on Saturday

Sunday = UpdateDay(string=u'Sunday')

query for updates on Sunday

Thursday = UpdateDay(string=u'Thursday')

query for updates on Thursday

Tuesday = UpdateDay(string=u'Tuesday')

query for updates on Tuesday

Wednesday = UpdateDay(string=u'Wednesday')

query for updates on Wednesday

class Update.UpdateStructGet(current_url=None, default_url=None, check_updates=None, time=None, day=None, latest_update_install_time=None, latest_update_query_time=None, username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Update.UpdateStructGet class Structure to get url update repository.

Tip

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

Parameters:
  • current_url (str) – Current appliance update repository URL.
  • default_url (str) – Default appliance update repository URL.
  • check_updates (Update.AutoUpdateNotification) – Check for update at the pre-configured repository URL.
  • time (str) – time to query for updates Format: HH:MM:SS Military (24 hour) Time Format
  • day (Update.UpdateDay) – day to query for updates
  • latest_update_install_time (str) – timestamp of latest update installation
  • latest_update_query_time (str) – timestamp of latest query to update repository
  • username (str) – username for the url update repository
  • password (str) – password for the url update repository
class Update.UpdateStructSet(current_url=None, check_updates=None, time=None, day=None, username=None, password=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Update.UpdateStructSet class Structure to set url update repository.

Tip

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

Parameters:
  • current_url (str) – Current appliance update repository URL. Enter “default” to reset the url to the default url.
  • check_updates (Update.AutoUpdateNotification) – Check for update at the pre-configured repository URL.
  • time (str) – time to query for updates Format: HH:MM:SS Military (24 hour) Time Format
  • day (Update.UpdateDay) – day to query for updates
  • username (str) – username for the url update repository
  • password (str) – password for the url update repository
Update.get()

Get update repository configuration.

Return type:Update.UpdateStructGet
Returns:update related configuration
Raise:com.vmware.vapi.std.errors_client.Error Generic error
Update.set(config)

Set update repository configuration.

Parameters:config (Update.UpdateStructSet) – update related configuration
Raise:com.vmware.vapi.std.errors_client.Error Generic error

Module contents

Table Of Contents

Previous topic

com.vmware.appliance.recovery package

Next topic

com.vmware.appliance.techpreview.networking package

This Page

Navigation

© Copyright 2014-2017, VMware, Inc. All rights reserved.