def __init__(
self,
version_source=None,
node_id=None,
node_ip=None,
build_version=None,
full_version=None,
node_type=None,
):
"""
:type version_source: :class:`str` or ``None``
:param version_source: Possible values are:
* :attr:`SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI`
* :attr:`SiteRecoveryNodeVersion.VERSION_SOURCE_LS`
:type node_id: :class:`str` or ``None``
:param node_id:
:type node_ip: :class:`str` or ``None``
:param node_ip:
:type build_version: :class:`BuildVersion` or ``None``
:param build_version:
:type full_version: :class:`str` or ``None``
:param full_version:
:type node_type: :class:`str` or ``None``
:param node_type: Possible values are:
* :attr:`SiteRecoveryNodeVersion.NODE_TYPE_VRMS`
* :attr:`SiteRecoveryNodeVersion.NODE_TYPE_SRM`
* :attr:`SiteRecoveryNodeVersion.NODE_TYPE_VRS`
"""
self.version_source = version_source
self.node_id = node_id
self.node_ip = node_ip
self.build_version = build_version
self.full_version = full_version
self.node_type = node_type
VapiStruct.__init__(self)
def __init__(
self,
compliant=None,
sets=None,
adds=None,
deletes=None,
):
"""
:type compliant: :class:`bool`
:param compliant: This boolean flag indicates whether the ESXi host is in compliance
with desired configuration.
:type sets: :class:`list` of :class:`ComplianceValue` or ``None``
:param sets: List of configuration drifts represented by
:class:`ComplianceValue`. Each describing a configuration whose
value on ESXi host is different to that in the desired document.
This field is None if the
:attr:`HostCheckComplianceResult.compliant` is set to true.
:type adds: :class:`list` of :class:`ComplianceValue` or ``None``
:param adds: List of configuration drifts represented by
:class:`ComplianceValue`. Each describing a configuration that is
present in the desired document but absent on the ESXi host.
This field is None if the
:attr:`HostCheckComplianceResult.compliant` is set to true or if
there are no additions required to make the ESXi host compliant.
:type deletes: :class:`list` of :class:`ComplianceValue` or ``None``
:param deletes: List of configuration drifts represented by
:class:`ComplianceValue`. Each describing a configuration that is
present on the ESXi host but absent in the desired document.
This field is None if the
:attr:`HostCheckComplianceResult.compliant` is set to true or if
there are no deletions required to make the ESXi host compliant.
"""
self.compliant = compliant
self.sets = sets
self.adds = adds
self.deletes = deletes
VapiStruct.__init__(self)
def __init__(
self,
status=None,
check_time=None,
policy=None,
failure_cause=None,
):
"""
:type status: :class:`Compliance.Status`
:param status: Status of the compliance operation. This attribute was added in
vSphere API 6.7
:type check_time: :class:`datetime.datetime`
:param check_time: Date and time of the most recent compliance check. This attribute
was added in vSphere API 6.7
:type policy: :class:`str` or ``None``
:param policy: Identifier of the storage policy associated with the virtual
machine. This attribute was added in vSphere API 6.7
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``. When methods return a value
of this class as a return value, the attribute will be an
identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``.
If None SPBM is unable to retrieve or determine the associated
policy, :attr:`Compliance.VmComplianceInfo.failure_cause` is set in
such casses.
:type failure_cause: :class:`list` of :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param failure_cause: The exception that caused the compliance check to fail. There can
be more than one cause, since a policy can contain capabilities
from multiple providers. If empty, it implies no failures while
retrieving compliance. This attribute was added in vSphere API 6.7
"""
self.status = status
self.check_time = check_time
self.policy = policy
self.failure_cause = failure_cause
VapiStruct.__init__(self)
def __init__(
self,
scheme_type=None,
session_manager=None,
scheme=None,
):
"""
:type scheme_type: :class:`AuthenticationInfo.SchemeType`
:param scheme_type: The type of the authentication scheme.
:type session_manager: :class:`str`
:param session_manager: In a session aware authentication scheme, a session manager is
required that supports ``create``, ``delete`` and ``keepAlive``
methods. The fully qualified class name of the session manager is
provided in :attr:`AuthenticationInfo.session_manager` attribute.
This class is responsible for handling sessions.
This attribute is optional and it is only relevant when the value
of ``schemeType`` is
:attr:`AuthenticationInfo.SchemeType.SESSION_AWARE`.
:type scheme: :class:`str`
:param scheme: String identifier of the authentication scheme.
Following are the supported authentication schemes by the
infrastructure:
* The identifier ``com.vmware.vapi.std.security.saml_hok_token``
for SAML holder of key token based authentication mechanism.
* The identifier ``com.vmware.vapi.std.security.bearer_token`` for
SAML bearer token based authentication mechanism.
* The identifier ``com.vmware.vapi.std.security.session_id`` for
session based authentication mechanism.
* The identifier ``com.vmware.vapi.std.security.user_pass`` for
username and password based authentication mechanism.
"""
self.scheme_type = scheme_type
self.session_manager = session_manager
self.scheme = scheme
VapiStruct.__init__(self)
def __init__(self,
version=None,
product=None,
build=None,
type=None,
summary=None,
releasedate=None,
install_time=None,
):
"""
:type version: :class:`str`
:param version: Appliance version.
:type product: :class:`str`
:param product: Appliance name.
:type build: :class:`str`
:param build: Appliance build number.
:type type: :class:`str`
:param type: Type of product. Same product can have different deployment
options, which is represented by type.
:type summary: :class:`str`
:param summary: Summary of patch (empty string, if the appliance has not been
patched)
:type releasedate: :class:`str`
:param releasedate: Release date of patch (empty string, if the appliance has not been
patched)
:type install_time: :class:`str`
:param install_time: Display the date and time when this system was first installed.
Value will not change on subsequent updates.
"""
self.version = version
self.product = product
self.build = build
self.type = type
self.summary = summary
self.releasedate = releasedate
self.install_time = install_time
VapiStruct.__init__(self)
def __init__(
self,
ip_addresses=None,
search_domains=None,
):
"""
:type ip_addresses: :class:`list` of :class:`str`
:param ip_addresses: The IP addresses of the DNS servers in order of use. IPv4 addresses
are specified using dotted decimal notation. For example,
"192.0.2.1". IPv6 addresses are 128-bit addresses represented as
eight fields of up to four hexadecimal digits. A colon separates
each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The
address can also consist of the symbol '::' to represent multiple
16-bit groups of contiguous 0's only once in an address as
described in RFC 2373. This attribute was added in vSphere API
7.0.0.
:type search_domains: :class:`list` of :class:`str`
:param search_domains: The domain in which to search for hosts, placed in order of
preference. These are the domain name portion of the DNS names.
This attribute was added in vSphere API 7.0.0.
"""
self.ip_addresses = ip_addresses
self.search_domains = search_domains
VapiStruct.__init__(self)
def __init__(
self,
domain=None,
username=None,
password=None,
):
"""
:type domain: :class:`str`
:param domain: The domain name of the Active Directory server to which the
migrated vCenter Server appliance should be joined. This attribute
was added in vSphere API 7.0.0.
:type username: :class:`str`
:param username: Active Directory user that has permission to join the Active
Directory after the vCenter Server is migrated to appliance. This
attribute was added in vSphere API 7.0.0.
:type password: :class:`str`
:param password: Active Directory user password that has permission to join the
Active Directory after the vCenter Server is migrated to appliance.
This attribute was added in vSphere API 7.0.0.
"""
self.domain = domain
self.username = username
self.password = password
VapiStruct.__init__(self)
def __init__(
self,
hostname=None,
username=None,
password=None,
https_port=None,
ssl_verify=None,
ssl_thumbprint=None,
):
"""
:type hostname: :class:`str`
:param hostname: The IP address or DNS resolvable name of the ESX/VC host. If a DNS
resolvable name is provided, it must be resolvable from the source
appliance.
:type username: :class:`str`
:param username: A username with administrative privileges on the ESX/VC host.
:type password: :class:`str`
:param password: The password of the :attr:`Connection.username` on the ESX/VC host.
:type https_port: :class:`long` or ``None``
:param https_port: The port number for the ESX/VC.
If None, defaults to 443
:type ssl_verify: :class:`bool` or ``None``
:param ssl_verify: A flag to indicate whether the ssl verification is required.
If ``sslThumbprint`` is provided, this field can be omitted If
None, defaults to True
:type ssl_thumbprint: :class:`str` or ``None``
:param ssl_thumbprint: Thumbprint for SSL verification.
If ``sslVerify`` if false, this field is not required
"""
self.hostname = hostname
self.username = username
self.password = password
self.https_port = https_port
self.ssl_verify = ssl_verify
self.ssl_thumbprint = ssl_thumbprint
VapiStruct.__init__(self)
def __init__(self,
mode=None,
address=None,
prefix=None,
default_gateway=None,
):
"""
:type mode: :class:`Ipv4.Mode`
:param mode: The Address assignment mode. This attribute was added in vSphere
API 6.7
:type address: :class:`str`
:param address: The IPv4 address, for example, "10.20.80.191". This attribute was
added in vSphere API 6.7
This attribute is optional and it is only relevant when the value
of ``mode`` is :attr:`Ipv4.Mode.STATIC`.
:type prefix: :class:`long`
:param prefix: The IPv4 CIDR prefix, for example, 24. See
http://www.oav.net/mirrors/cidr.html for netmask-to-prefix
conversion. This attribute was added in vSphere API 6.7
This attribute is optional and it is only relevant when the value
of ``mode`` is :attr:`Ipv4.Mode.STATIC`.
:type default_gateway: :class:`str` or ``None``
:param default_gateway: 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. This attribute was added in vSphere API 6.7
If None, the defaultGateway was never set.
"""
self.mode = mode
self.address = address
self.prefix = prefix
self.default_gateway = default_gateway
VapiStruct.__init__(self)
def __init__(self,
name_key=None,
description_key=None,
startup_type=None,
state=None,
health=None,
health_messages=None,
):
"""
:type name_key: :class:`str`
:param name_key: Service name key. Can be used to lookup resource bundle. This
attribute was added in vSphere API 6.7.
:type description_key: :class:`str`
:param description_key: Service description key. Can be used to lookup resource bundle.
This attribute was added in vSphere API 6.7.
:type startup_type: :class:`Service.StartupType`
:param startup_type: Startup Type. This attribute was added in vSphere API 6.7.
:type state: :class:`Service.State`
:param state: Running State. This attribute was added in vSphere API 6.7.
:type health: :class:`Service.Health`
:param health: Health of service. This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of ``state`` is :attr:`Service.State.STARTED`.
:type health_messages: :class:`list` of :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param health_messages: Localizable messages associated with the health of the service.
This attribute was added in vSphere API 6.7.
This attribute is optional and it is only relevant when the value
of ``state`` is :attr:`Service.State.STARTED`.
"""
self.name_key = name_key
self.description_key = description_key
self.startup_type = startup_type
self.state = state
self.health = health
self.health_messages = health_messages
VapiStruct.__init__(self)
def __init__(
self,
vm_home=None,
disks=None,
):
"""
:type vm_home: :class:`Policy.VmHomePolicySpec` or ``None``
:param vm_home: Storage policy to be used when reconfiguring the virtual machine
home. This attribute was added in vSphere API 6.7.
if None the current storage policy is retained.
:type disks: (:class:`dict` of :class:`str` and :class:`Policy.DiskPolicySpec`) or ``None``
:param disks: Storage policy or policies to be used when reconfiguring virtual
machine diks. This attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the key in
the attribute :class:`dict` must be an identifier for the resource
type: ``com.vmware.vcenter.vm.hardware.Disk``. When methods return
a value of this class as a return value, the key in the attribute
:class:`dict` will be an identifier for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``.
if None the current storage policy is retained.
"""
self.vm_home = vm_home
self.disks = disks
VapiStruct.__init__(self)
def __init__(self,
size=None,
reservation=None,
limit=None,
shares=None,
):
"""
:type size: :class:`long`
:param size: memory size in MB
:type reservation: :class:`long` or ``None``
:param reservation: memory reservation in MB
It is not required that memory reservation be specified.
:type limit: :class:`long` or ``None``
:param limit: memory limit in MB
It is not required that memory limit be specified.
:type shares: :class:`long` or ``None``
:param shares: memory shares
It is not required that memory shares be specified.
"""
self.size = size
self.reservation = reservation
self.limit = limit
self.shares = shares
VapiStruct.__init__(self)
def __init__(
self,
auth_type=None,
host_credential=None,
host=None,
):
"""
:type auth_type: :class:`Software.ConnectionSpec.AuthenticationType`
:param auth_type: Specifies what type of authentication (USERNAME_PASSWORD, EXISTING)
is to be used when connecting with the host. USERNAME_PASSWORD is
intended to be used when connecting to a host that is not currently
part of the vCenter inventory. EXISTING is intented for hosts that
are in vCenter inventory, in which case, HostServiceTicket will be
used to connect to the host.
:type host_credential: :class:`Software.HostCredentials`
:param host_credential: Specifies the host details to be used during the
:func:`Software.get` method
This attribute is optional and it is only relevant when the value
of ``authType`` is
:attr:`Software.ConnectionSpec.AuthenticationType.USERNAME_PASSWORD`.
:type host: :class:`str`
:param host: Specifies the host Managed Object ID to be used during the
:func:`Software.get` method
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``HostSystem``. When methods return a value of this class as a
return value, the attribute will be an identifier for the resource
type: ``HostSystem``.
This attribute is optional and it is only relevant when the value
of ``authType`` is
:attr:`Software.ConnectionSpec.AuthenticationType.EXISTING`.
"""
self.auth_type = auth_type
self.host_credential = host_credential
self.host = host
VapiStruct.__init__(self)
def __init__(
self,
version=None,
display_name=None,
components=None,
):
"""
:type version: :class:`str`
:param version: Version of the solution.
:type display_name: :class:`str`
:param display_name: Display name of the solution.
:type components: :class:`dict` of :class:`str` and :class:`ComponentInfo`
:param components: Components registered by the solution.
When clients pass a value of this class as a parameter, the key in
the attribute :class:`dict` must be an identifier for the resource
type: ``com.vmware.esx.hosts.component``. When methods return a
value of this class as a return value, the key in the attribute
:class:`dict` will be an identifier for the resource type:
``com.vmware.esx.hosts.component``.
"""
self.version = version
self.display_name = display_name
self.components = components
VapiStruct.__init__(self)
def __init__(self,
vm_home=None,
disks=None,
):
"""
:type vm_home: :class:`bool`
:param vm_home: Invoke compliance check on the virtual machine home directory if
set to true. This attribute was added in vSphere API 6.7.
:type disks: :class:`set` of :class:`str` or ``None``
:param disks: Identifiers of the virtual machine's virtual disks for which
compliance should be checked. This attribute was added in vSphere
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``. When methods return a
value of this class as a return value, the attribute will contain
identifiers for the resource type:
``com.vmware.vcenter.vm.hardware.Disk``.
If None or empty, compliance check is invoked on all the associated
disks.
"""
self.vm_home = vm_home
self.disks = disks
VapiStruct.__init__(self)
def __init__(
self,
status=None,
vms=None,
):
"""
:type status: :class:`set` of :class:`VM.Status`
:param status: Compliance Status that a virtual machine must have to match the
filter. Atleast one status must be specified. This attribute was
added in vSphere API 6.7.
:type vms: :class:`set` of :class:`str` or ``None``
:param vms: Identifiers of virtual machines that can match the filter. This
attribute was added in vSphere API 6.7.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``VirtualMachine``. When methods return a value of this class as a
return value, the attribute will contain identifiers for the
resource type: ``VirtualMachine``.
If None or empty, virtual machines with any identifier matches the
filter
"""
self.status = status
self.vms = vms
VapiStruct.__init__(self)
def __init__(
self,
address=None,
prefix=None,
policy=None,
interface_name=None,
):
"""
:type address: :class:`str`
:param address: IPv4 or IPv6 address.
:type prefix: :class:`long`
:param prefix: CIDR prefix used to mask address. For example, an IPv4 prefix of 24
ignores the low-order 8 bits of address.
:type policy: :class:`Inbound.FirewallRulePolicy`
:param policy: The allow or deny policy of this rule.
:type interface_name: :class:`str`
:param interface_name: The interface to which this rule applies. An empty string or
"\\\\*" indicates that the rule applies to all interfaces.
"""
self.address = address
self.prefix = prefix
self.policy = policy
self.interface_name = interface_name
VapiStruct.__init__(self)
def __init__(self,
name=None,
network_name=None,
mac_address=None,
start_connected=None,
):
"""
:type name: :class:`str`
:param name: Name of NIC
:type network_name: :class:`str` or ``None``
:param network_name: Name of the network that this NIC connects to
It is not required that network name be specified.
:type mac_address: :class:`str` or ``None``
:param mac_address: Mac address of this NIC
It is not required that MAC address be specified.
:type start_connected: :class:`bool` or ``None``
:param start_connected: True if this nic will be connected on start.
It is not required that whether the NIC is connected be specified.
"""
self.name = name
self.network_name = network_name
self.mac_address = mac_address
self.start_connected = start_connected
VapiStruct.__init__(self)
def __init__(
self,
result_type=None,
output=None,
error=None,
):
"""
:type result_type: :class:`InvocationResult.ResultType`
:param result_type: Type of the invocation result.
:type output: :class:`DataValue`
:param output: Normal result value.
This attribute is optional and it is only relevant when the value
of ``resultType`` is
:attr:`InvocationResult.ResultType.NORMAL_RESULT`.
:type error: :class:`vmware.vapi.struct.VapiStruct`
:param error: Error result value.
This attribute is optional and it is only relevant when the value
of ``resultType`` is
:attr:`InvocationResult.ResultType.ERROR_RESULT`.
"""
self.result_type = result_type
self.output = output
self.error = error
VapiStruct.__init__(self)
def __init__(self,
num_cpus=None,
reservation=None,
limit=None,
shares=None,
):
"""
:type num_cpus: :class:`long`
:param num_cpus: number of CPUs
:type reservation: :class:`long` or ``None``
:param reservation: reservation in MHz
It is optional to set a CPU reservation.
:type limit: :class:`long` or ``None``
:param limit: CPU limit in MHz
Is is optional to set a CPU limit.
:type shares: :class:`long` or ``None``
:param shares: CPU shares
It is optional to specify CPU shares.
"""
self.num_cpus = num_cpus
self.reservation = reservation
self.limit = limit
self.shares = shares
VapiStruct.__init__(self)
def __init__(
self,
id=None,
name=None,
units=None,
category=None,
instance=None,
description=None,
):
"""
:type id: :class:`str`
:param id: monitored item ID Ex: CPU, MEMORY
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.appliance.monitoring``. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: ``com.vmware.appliance.monitoring``.
:type name: :class:`str`
:param name: monitored item name Ex: "Network write speed"
:type units: :class:`str`
:param units: Y-axis label EX: "Mbps", "%"
:type category: :class:`str`
:param category: category Ex: network, storage etc
:type instance: :class:`str`
:param instance: instance name Ex: eth0
:type description: :class:`str`
:param description: monitored item description Ex:
com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0
"""
self.id = id
self.name = name
self.units = units
self.category = category
self.instance = instance
self.description = description
VapiStruct.__init__(self)
def __init__(self,
render_type=None,
video_ram_size=None,
graphics_memory_size=None,
enable3d=None,
num_displays=None,
use_auto_detect=None,
):
"""
:type render_type: :class:`str` or ``None``
:param render_type: Render type
A template is not required to specify the render type.
:type video_ram_size: :class:`long` or ``None``
:param video_ram_size: video RAM size in KB
A template is not required to specify the video RAM.
:type graphics_memory_size: :class:`long` or ``None``
:param graphics_memory_size: graphics memory size in KB
A template is not required to specify the amount of graphics
memory.
:type enable3d: :class:`bool` or ``None``
:param enable3d: True if 3D is enabled
A template is not required to specify if 3D is enabled.
:type num_displays: :class:`long` or ``None``
:param num_displays: number of displayes
A template is not required to specify the number of displays.
:type use_auto_detect: :class:`bool` or ``None``
:param use_auto_detect: True if use auto detect
A template is not required to specify use auto dectect.
"""
self.render_type = render_type
self.video_ram_size = video_ram_size
self.graphics_memory_size = graphics_memory_size
self.enable3d = enable3d
self.num_displays = num_displays
self.use_auto_detect = use_auto_detect
VapiStruct.__init__(self)
def __init__(self,
type=None,
policy=None,
):
"""
:type type: :class:`Policy.DiskPolicySpec.PolicyType`
:param type: Policy type to be used while performing update operation on the
virtual disks. This attribute was added in vSphere API 6.7.
:type policy: :class:`str`
:param policy: Storage Policy identification. This attribute was added in vSphere
API 6.7.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``. When methods return a value
of this class as a return value, the attribute will be an
identifier for the resource type:
``com.vmware.vcenter.StoragePolicy``.
This attribute is optional and it is only relevant when the value
of ``type`` is
:attr:`Policy.DiskPolicySpec.PolicyType.USE_SPECIFIED_POLICY`.
"""
self.type = type
self.policy = policy
VapiStruct.__init__(self)
def __init__(
self,
version=None,
metadata=None,
):
"""
:type version: :class:`str`
:param version: Version of the current ``MetadataInfo`` class. Property value
changes when the content of the ``MetadataInfo`` or referenced
classes changes. This enables class processing adjustments.
:type metadata: :class:`dict` of :class:`str` and :class:`ComponentInfo`
:param metadata: Component information of all available components. The key in the
:class:`dict` is the identifier of the component and the value is
the aggregated :class:`ComponentInfo`.
When clients pass a value of this class as a parameter, the key in
the attribute :class:`dict` must be an identifier for the resource
type: ``com.vmware.vapi.component``. When methods return a value of
this class as a return value, the key in the attribute
:class:`dict` will be an identifier for the resource type:
``com.vmware.vapi.component``.
"""
self.version = version
self.metadata = metadata
VapiStruct.__init__(self)
def __init__(
self,
id=None,
time=None,
message=None,
resolution=None,
):
"""
:type id: :class:`str`
:param id: The notification id.
:type time: :class:`datetime.datetime`
:param time: The time the notification was raised/found.
:type message: :class:`com.vmware.vapi.std_client.LocalizableMessage`
:param message: The notification message.
:type resolution: :class:`com.vmware.vapi.std_client.LocalizableMessage` or ``None``
:param resolution: The resolution message, if any.
Only :class:`set` if there is a resolution available for this
notification.
"""
self.id = id
self.time = time
self.message = message
self.resolution = resolution
VapiStruct.__init__(self)
def __init__(
self,
id=None,
principals=None,
issuer=None,
):
"""
:type id: :class:`set` of :class:`str` or ``None``
:param id: The unqiue identifier of a connection profile. This attribute was
added in vSphere API 7.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.esx.authentication.clientprofile``. When methods
return a value of this class as a return value, the attribute will
contain identifiers for the resource type:
``com.vmware.esx.authentication.clientprofile``.
If None, no filtration will be performed by ID.
:type principals: :class:`list` of :class:`com.vmware.vcenter.trusted_infrastructure_client.StsPrincipal` or ``None``
:param principals: The principal used by the vCenter to retrieve tokens. This
attribute was added in vSphere API 7.0.0.
If None, no filtration will be performed by principals.
:type issuer: :class:`set` of :class:`str` or ``None``
:param issuer: The service which created and signed the security token. This
attribute was added in vSphere API 7.0.0.
When clients pass a value of this class as a parameter, the
attribute must contain identifiers for the resource type:
``com.vmware.esx.authentication.trust.security-token-issuer``. When
methods return a value of this class as a return value, the
attribute will contain identifiers for the resource type:
``com.vmware.esx.authentication.trust.security-token-issuer``.
If None, no filtration will be performed by issuer.
"""
self.id = id
self.principals = principals
self.issuer = issuer
VapiStruct.__init__(self)
def __init__(
self,
operations=None,
):
"""
:type operations: :class:`dict` of :class:`str` and :class:`OperationInfo`
:param operations: Information about all operation elements contained in this service
element that contain privilege information. The key in the
:class:`dict` is the identifier of the operation element and the
value in the :class:`dict` is the privilege information for the
operation element.
For an explanation of containment of privilege information within
operation elements, see
:class:`com.vmware.vapi.metadata.privilege.service_client.Operation`.
When clients pass a value of this class as a parameter, the key in
the attribute :class:`dict` must be an identifier for the resource
type: ``com.vmware.vapi.operation``. When methods return a value of
this class as a return value, the key in the attribute
:class:`dict` will be an identifier for the resource type:
``com.vmware.vapi.operation``.
"""
self.operations = operations
VapiStruct.__init__(self)
def __init__(
self,
dhcp=None,
autoconf=None,
addresses=None,
default_gateway=None,
configurable=None,
):
"""
:type dhcp: :class:`bool`
:param dhcp: DHCP is on. This attribute was added in vSphere API 6.7.
:type autoconf: :class:`bool`
:param autoconf: Stateless Address Autoconfiguration (SLAAC) is on. This attribute
was added in vSphere API 6.7.
:type addresses: :class:`list` of :class:`Ipv6.AddressInfo`
:param addresses: List of addresses with their origins and statuses. This attribute
was added in vSphere API 6.7.
:type default_gateway: :class:`str`
:param default_gateway: 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. This attribute was
added in vSphere API 6.7.
:type configurable: :class:`bool`
:param configurable: Is NIC configurable or not. This attribute was added in vSphere API
6.7.
"""
self.dhcp = dhcp
self.autoconf = autoconf
self.addresses = addresses
self.default_gateway = default_gateway
self.configurable = configurable
VapiStruct.__init__(self)
def __init__(self,
property_path=None,
privileges=None,
):
"""
:type property_path: :class:`str`
:param property_path: The ``propertyPath`` points to an entity that is used in the
operation element. An entity can either be present in one of the
parameter elements or if a parameter is a structure element, it
could also be present in one of the field elements.
If the privilege is assigned to an entity used in the parameter,
``propertyPath`` will just contain the name of the parameter field.
If the privilege is assigned to an entity in one of the field
elements of a parameter element that is a structure element, then
``propertyPath`` will contain a path to the field element starting
from the parameter name.
:type privileges: :class:`list` of :class:`str`
:param privileges: List of privileges assigned to the entity that is being referred by
:attr:`PrivilegeInfo.property_path`.
"""
self.property_path = property_path
self.privileges = privileges
VapiStruct.__init__(self)
def __init__(
self,
report=None,
csv_report=None,
):
"""
:type report: :class:`InteropReport.Report`
:param report: The interoperability report.
:type csv_report: :class:`str` or ``None``
:param csv_report: The identifier of CSV formatted interopability report.
com.vmware.vcenter.lcm.report.Report#get provides location where
the CSV report can be downloaded from based on the ``csvReport``.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
``com.vmware.vcenter.lcm.report``. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: ``com.vmware.vcenter.lcm.report``.
None in case of ``errors`` reported in
:attr:`InteropReport.Report.issues`.
"""
self.report = report
self.csv_report = csv_report
VapiStruct.__init__(self)