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

Subpackages

Submodules

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client module

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.ClusterConfigInfo(name=None, parent_path=None, ha=None, ha_vm_overrides=None, drs=None, drs_vm_overrides=None, rules=None, groups=None, proactive_ha=None, hosts=None, permissions=None, resource_pools=None)

Bases: VapiStruct

The ClusterConfigInfo class contains attributes describing the complete configuration of a cluster. It contains cluster-wide configurations of DRS, HA VSAN Cluster etc.

Tip

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

Parameters:
class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.cluster_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client module provides data types to manage the vCenter Server Inventory common configurations

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.OptionValue(key=None, value=None)

Bases: VapiStruct

Describes the key/value pair of a configured option.

Tip

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

Parameters:

  • key (str or None) – The name of the option using dot notation to reflect the option’s position in a hierarchy. For example, you might have an option called “Ethernet” and another option that is a child of that called “Connection”. In this case, the key for the latter could be defined as “Ethernet.Connection”

  • value (str or None) – The value of the option. The Any data object type enables you to define any value for the option. Typically, however, the value of an option is of type String or Integer.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission(principal=None, group=None, propagate=None, role_id=None)

Bases: VapiStruct

The Permission class contains spec to define permissions in vCenter Server.

Tip

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

Parameters:

  • principal (str) – User/Group name associated with the permission.

  • group (bool) – True if principal is a group.

  • propagate (bool) – True if permission can be propagated to child entities.

  • role_id (long) – Role associated with the permission.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory .datacenter module provides classes to manage the datacenter config.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.Datacenter(name=None, parent_path=None, permissions=None, standalone_hosts=None)

Bases: VapiStruct

The Datacenter class contains spec to define datacenter in vCenter Server.

Tip

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

Parameters:

  • name (str) – Name of the datacenter. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter. 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.vcenter.settings.v1.config.components.inventory.datacenter.

  • parent_path (str or None) – Absolute path of the inventory object’s parent. If None, then inventory object placed in root folder.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the datacenter. If None, then no permissions defined on this inventory object.

  • standalone_hosts (list of str or None) – Host configuration on the datacenter. If None, then no hosts present in the datacenter.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datacenter_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory .datastore module provides classes to manage the datastore and storagepod config.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Datastore(name=None, parent_path=None, summary=None, permissions=None)

Bases: VapiStruct

Datastore class defines the spec for datastore configurations in vCenter Server.

Tip

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

Parameters:

  • name (str) – The identifier of the datastore. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore. 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.vcenter.settings.v1.config.components.inventory.datastore.

  • parent_path (str) – Absolute path of the inventory object’s parent.

  • summary (Summary or None) – Summary of the datastore.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the datastore. If None, then no permissions defined on this inventory object.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.MaintenanceModeState(string)

Bases: Enum

The MaintenanceModeState class defines the maintenance mode states of the datastore.

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 MaintenanceModeState instance.

ENTERING_MAINTENANCE = MaintenanceModeState(string='ENTERING_MAINTENANCE')

Started entering maintenance mode, but not finished. This could happen when waiting for user input or for long-running vmotions to complete.

IN_MAINTENANCE = MaintenanceModeState(string='IN_MAINTENANCE')

Successfully entered maintenance mode.

NORMAL = MaintenanceModeState(string='NORMAL')

Default state.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.PodStorageDrsEntry(storage_drs_config=None)

Bases: VapiStruct

The PodStorageDrsEntry class contains spec to define storage DRS related attributes of the Storage Pod.

Tip

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

Parameters:

storage_drs_config (StorageDrsConfigInfo) – Storage DRS configuration.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsConfigInfo(pod_config=None)

Bases: VapiStruct

The StorageDrsConfigInfo class contains spec to define storage DRS configurations.

Tip

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

Parameters:

pod_config (StorageDrsPodConfigInfo) – Pod-wide configuration information for the storage DRS service.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StorageDrsPodConfigInfo(enabled=None)

Bases: VapiStruct

The StorageDrsConfigInfo class contains spec to define pod-wide configuration information for the storage DRS service.

Tip

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

Parameters:

enabled (bool) – Flag indicating whether or not storage DRS is enabled.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StoragePod(name=None, parent_path=None, pod_storage_drs_entry=None, permissions=None)

Bases: VapiStruct

The StoragePod class contains spec to define storage pod in vCenter Server.

Tip

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

Parameters:

  • name (str) – Identifier of the Storage Pod. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.storagepod. 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.vcenter.settings.v1.config.components.inventory.storagepod.

  • parent_path (str) – Absolute path of the inventory object’s parent.

  • pod_storage_drs_entry (PodStorageDrsEntry) – Storage DRS related attributes of the Storage Pod.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the Storage Pod. If None, then no permissions defined on this inventory object.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.datastore_client.Summary(capacity=None, multiple_host_access=None, type=None, maintenance_mode=None)

Bases: VapiStruct

Summary class defines the datastore summary properties.

Tip

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

Parameters:

  • capacity (long or None) – Maximum capacity of this datastore, in bytes. This value is updated periodically by the server. It can be explicitly refreshed with the Refresh operation.

  • multiple_host_access (bool or None) – More than one host in the datacenter has been configured with access to the datastore. This is only provided by VirtualCenter. If None, then the datastore not configured with access from more than one host.

  • type (str or None) – Type of file system volume, such as VMFS or NFS.

  • maintenance_mode (MaintenanceModeState or None) – The current maintenance mode state of the datastore. If None, then the current maintenance mode state of the datastore is set to normal.

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory .folder module provides classes to manage the folder config.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.Folder(datastore=None, datacenter=None, vm=None, network=None, host=None)

Bases: VapiStruct

The Folder class contains spec to define folder in vCenter Server.

Tip

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

Parameters:

  • datastore (list of FolderDetails or None) – List of datastore folders. If None. then there are no datastore folders.

  • datacenter (list of FolderDetails or None) – List of datacenter folders. If None. then there are no datacenter folders.

  • vm (list of FolderDetails or None) – List of vm folders. If None. then there are no vm folders.

  • network (list of FolderDetails or None) – List of network folders. If None. then there are no network folders.

  • host (list of FolderDetails or None) – List of host folders. If None. then there are no host folders.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.FolderDetails(name=None, parent_path=None, permissions=None)

Bases: VapiStruct

The FolderDetails class contains spec to define folder in vCenter Server.

Tip

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

Parameters:

  • name (str) – Name of the vCenter Server folder. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder. 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.vcenter.settings.v1.config.components.inventory.folder.

  • parent_path (str or None) – Absolute path of the inventory object’s parent. If None, then inventory object placed in root folder.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the folder. If None, then no permissions defined on this inventory object.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.folder_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client module

The com.vmware.appliance.vcenter.settings.v1.config.components inventory.host module provides classes to manage the ConfigManagement.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.HostConfig(name=None, permissions=None, parent_path=None)

Bases: VapiStruct

The HostConfig class contains attributes describing the configuration of a Stand alone host.

Tip

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

Parameters:
class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.host_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client module

The com.vmware.appliance.vcenter.settings.v1.config.components.inventory .network module provides classes to manage the network config.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.Network(name=None, parent_path=None, permissions=None)

Bases: VapiStruct

The Network class contains spec to define standard network in vCenter Server.

Tip

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

Parameters:

  • name (str) – Identifier of the network. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network. 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.vcenter.settings.v1.config.components.inventory.network.

  • parent_path (str) – Absolute path of the inventory object’s parent.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the network. If None, then no permissions defined on this inventory object.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.network_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client module

The com.vmware.appliance.vcenter.settings.v1.config.components inventory.resourcepool module provides classes to manage the ConfigManagement.

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

Bases: VapiStruct

The ResourceAllocationInfo class contains resource allocation information of a resource pool.

Tip

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

Parameters:

  • reservation (long) – Amount of resource that is guaranteed available to a resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB fo memory, and MHz for CPU.

  • expandable_reservation (bool) – In a resource pool with an expandable reservation, the reservation can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.

  • limit (long) – The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, and MHz for CPU.

  • shares (Shares) – Shares are used in case of resource contention.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePool(name=None, parent_path=None, child_resource_pools=None, vm=None, config=None, permissions=None)

Bases: VapiStruct

The ResourcePool class contains information about resource pools present in the cluster.

Tip

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

Parameters:

  • name (str) – Name of the vCenter Server resource pool.

  • parent_path (str or None) – Parent name for the resource pool. If None, then inventory object placed in root folder.

  • child_resource_pools (list of str or None) – Identifiers of the child resource pools contained in this resource pool. If None or empty, the value is skipped.

  • vm (list of str or None) – Identifiers of the virtual machines contained in this resource pool. If None or empty, the value is skipped.

  • config (ResourcePoolSummary) – Summary of the Resource pools.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permission on the resourcepool. If None, then no permissions defined on this inventory object.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.ResourcePoolSummary(cpu_allocation=None, memory_allocation=None)

Bases: VapiStruct

The ResourcePoolSummary class provides summary of ResourcePool.

Tip

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

Parameters:
class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.Shares(level=None, shares=None)

Bases: VapiStruct

The Shares class provides specification of shares.

Shares are used to determine relative allocation between resource consumers. In general, a consumer with more shares gets proportionally more of the resource, subject to certain other constraints.

Tip

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

Parameters:

  • level (Shares.Level) – The allocation level. It maps to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as CUSTOM.

  • shares (long) –

    When Shares.level is set to CUSTOM, it is the number of shares allocated. Otherwise, this value is ignored.

    There is no unit for this value. It is a relative measure based on the settings for other resource pools.

class Level(string)

Bases: Enum

The Shares.Level class defines the possible values for the allocation level.

Note

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

Parameters:

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

CUSTOM = Level(string='CUSTOM')

If set, in case there is resource contention the server uses the shares value to determine the resource allocation.

HIGH = Level(string='HIGH')

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

LOW = Level(string='LOW')

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

NORMAL = Level(string='NORMAL')

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.resourcepool_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client module

The com.vmware.appliance.vcenter.settings.v1.config.components inventory.vm module provides classes to manage the ConfigManagement.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ConfigInfo(hardware=None, cpu_allocation=None, memory_allocation=None)

Bases: VapiStruct

The ConfigInfo class provides configuration of a VirtualMachine.

Tip

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

Parameters:
class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.ResourceAllocationInfo(reservation=None, limit=None)

Bases: VapiStruct

The ResourceAllocationInfo class provides resource allocation of VirtualMachine.

Tip

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

Parameters:

  • reservation (long or None) – Amount of resource that is guaranteed available. Units are MB for memory, MHz for CPU. If None, then there is no reservation.

  • limit (long or None) – The utilization will not exceed this limit, even if there are available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU. If None, then there is no limit.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

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

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualHardware(num_cpu=None, memory_mb=None)

Bases: VapiStruct

The VirtualHardware class provides the virtual hardware configuration of a VirtualMachine.

Tip

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

Parameters:

  • num_cpu (long) – Number of virtual CPUs.

  • memory_mb (long) – Memory size in MB.

class com.vmware.appliance.vcenter.settings.v1.config.components.inventory.vm_client.VirtualMachineConfig(name=None, parent_path=None, resource_pool=None, config=None, permissions=None)

Bases: VapiStruct

The VirtualMachineConfig class contains information about virtual machine configurations present in the cluster.

Tip

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

Parameters:

  • name (str) – Name of the vCenter Server virtual machine configuration.

  • parent_path (str or None) – Parent path for the virtual machine configuration. If None, then virtual machine placed in root folder.

  • resource_pool (str or None) – The identifier of current ResourcePool defining the resource allocation for this virtual machine. If None, this is a Template VM or current user session has no access to the resource pool.

  • config (ConfigInfo or None) – Configuration of the VirtualMachine. If None, then there is no configuration.

  • permissions (list of com.vmware.appliance.vcenter.settings.v1.config.components.inventory.common_client.Permission or None) – Permissions defined on the virtual machine. If None, then no permissions defined on this inventory object.