openstack/deb-python-pyvmomi
Code Issues Proposed changes

pyvmomi RST docs do not properly show lists

Browse Source 
Fixes RST documents to include list mark up when appropriate.

closes: https://github.com/vmware/pyvmomi/issues/76
This commit is contained in:
Shawn Hartsock 2014-08-13 14:25:37 -04:00
parent c77ad7aa7f
commit c83651f5be
457 changed files with 860 additions and 860 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/vim/AuthorizationDescription.rst
View File

@ -9,9 +9,9 @@ vim.AuthorizationDescription
:extends: vmodl.DynamicData_
Attributes:
privilege (`vim.ElementDescription`_):
privilege ([`vim.ElementDescription`_]):
Description of the privilege.
privilegeGroup (`vim.ElementDescription`_):
privilegeGroup ([`vim.ElementDescription`_]):
Description of a category of similar privileges, grouped together for convenience.

14
docs/vim/AuthorizationManager.rst
View File

@ -57,10 +57,10 @@ vim.AuthorizationManager
Attributes
----------
privilegeList (`vim.AuthorizationManager.Privilege`_):
privilegeList ([`vim.AuthorizationManager.Privilege`_]):
privilege: System.View
The list of system-defined privileges.
roleList (`vim.AuthorizationManager.Role`_):
roleList ([`vim.AuthorizationManager.Role`_]):
privilege: System.View
The currently defined roles in the system, including static system-defined roles.
description (`vim.AuthorizationDescription`_):
@ -244,7 +244,7 @@ RetrieveRolePermissions(roleId):
Returns:
`vim.AuthorizationManager.Permission`_:
[`vim.AuthorizationManager.Permission`_]:
Raises:
@ -272,7 +272,7 @@ RetrieveEntityPermissions(entity, inherited):
Returns:
`vim.AuthorizationManager.Permission`_:
[`vim.AuthorizationManager.Permission`_]:
Raises:
@ -294,7 +294,7 @@ RetrieveAllPermissions():
Returns:
`vim.AuthorizationManager.Permission`_:
[`vim.AuthorizationManager.Permission`_]:
@ -454,7 +454,7 @@ HasPrivilegeOnEntity(entity, sessionId, privId):
Returns:
`bool`_:
[`bool`_]:
a boolean value for each privilege indicating whether the session holds the privilege.
Raises:
@ -489,7 +489,7 @@ HasPrivilegeOnEntities(entity, sessionId, privId):
Returns:
`vim.AuthorizationManager.EntityPrivilege`_:
[`vim.AuthorizationManager.EntityPrivilege`_]:
The privilege check result.
Raises:

2
docs/vim/AuthorizationManager/EntityPrivilege.rst
View File

@ -17,6 +17,6 @@ Attributes:
entity (`vim.ManagedEntity`_):
The entity on which the privileges are checked.
privAvailability (`vim.AuthorizationManager.PrivilegeAvailability`_):
privAvailability ([`vim.AuthorizationManager.PrivilegeAvailability`_]):
whether a set of privileges are granted for the managed entity.

2
docs/vim/AuthorizationManager/Role.rst
View File

@ -27,6 +27,6 @@ Attributes:
info (`vim.Description`_):
Displayable role information.
privilege (`str`_, optional):
privilege ([`str`_], optional):
Privileges provided by this role, by privilege identifier.

2
docs/vim/Capability.rst
View File

@ -24,7 +24,7 @@ Attributes:
userShellAccessSupported (`bool`_):
Flag indicating whether host user accounts should have the option to be granted shell access
supportedEVCMode (`vim.EVCMode`_, optional):
supportedEVCMode ([`vim.EVCMode`_], optional):
All supported Enhanced VMotion Compatibility modes.
networkBackupAndRestoreSupported (`bool`_, optional):

12
docs/vim/ClusterComputeResource.rst
View File

@ -93,16 +93,16 @@ Attributes
----------
configuration (`vim.cluster.ConfigInfo`_):
Configuration of the cluster.
recommendation (`vim.cluster.Recommendation`_):
recommendation ([`vim.cluster.Recommendation`_]):
privilege: System.Read
List of recommended actions for the cluster. It is possible that the current set of recommendations may be empty, either due to not having any running dynamic recommendation generation module, or since there may be no recommended actions at this time.
drsRecommendation (`vim.cluster.DrsRecommendation`_):
drsRecommendation ([`vim.cluster.DrsRecommendation`_]):
If DRS is enabled, this returns the set of recommended migrations from the DRS module. The current set of recommendations may be empty, since there may be no recommended migrations at this time, or it is possible that DRS is not enabled.
migrationHistory (`vim.cluster.DrsMigration`_):
migrationHistory ([`vim.cluster.DrsMigration`_]):
The set of migration decisions that have recently been performed.This list is populated only when DRS is in automatic mode.
actionHistory (`vim.cluster.ActionHistory`_):
actionHistory ([`vim.cluster.ActionHistory`_]):
The set of actions that have been performed recently.
drsFault (`vim.cluster.DrsFaults`_):
drsFault ([`vim.cluster.DrsFaults`_]):
privilege: System.Read
A collection of the DRS faults generated in the last DRS invocation. Each element of the collection is the set of faults generated in one recommendation. DRS faults are generated when DRS tries to make recommendations for rule enforcement, power management, etc., and indexed in a tree structure with reason for recommendations and VM to migrate (optional) as the index keys. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
@ -215,7 +215,7 @@ RecommendHostsForVm(vm, pool):
Returns:
`vim.cluster.HostRecommendation`_:
[`vim.cluster.HostRecommendation`_]:
An array of HostRecommendation ordered by their rating.
Raises:

6
docs/vim/ComputeResource.rst
View File

@ -40,13 +40,13 @@ Attributes
resourcePool (`vim.ResourcePool`_):
privilege: System.View
Reference to root resource pool.
host (`vim.HostSystem`_):
host ([`vim.HostSystem`_]):
privilege: System.View
List of hosts that are part of this compute resource. If the compute resource is a standalone type, then this list contains just one element.
datastore (`vim.Datastore`_):
datastore ([`vim.Datastore`_]):
privilege: System.View
The datastore property is the subset of datastore objects in the datacenter available in this ComputeResource.This property is computed as the aggregate set of datastores available from all the hosts that are part of this compute resource.
network (`vim.Network`_):
network ([`vim.Network`_]):
privilege: System.View
The subset of network objects available in the datacenter that is available in this ComputeResource.This property is computed as the aggregate set of networks available from all the hosts that are part of this compute resource.
summary (`vim.ComputeResource.Summary`_):

2
docs/vim/CustomFieldsManager.rst
View File

@ -26,7 +26,7 @@ vim.CustomFieldsManager
Attributes
----------
field (`vim.CustomFieldsManager.FieldDef`_):
field ([`vim.CustomFieldsManager.FieldDef`_]):
privilege: System.View
List of custom fields defined on this server. The fields are sorted by name.

4
docs/vim/CustomizationSpecManager.rst
View File

@ -36,10 +36,10 @@ vim.CustomizationSpecManager
Attributes
----------
info (`vim.CustomizationSpecInfo`_):
info ([`vim.CustomizationSpecInfo`_]):
privilege: VirtualMachine.Provisioning.ReadCustSpecs
Gets a list of information on available specifications.
encryptionKey (`int`_):
encryptionKey ([`int`_]):
privilege: System.View
Gets a binary public encryption key that can be used to encrypt passwords in stored specifications.

6
docs/vim/Datacenter.rst
View File

@ -115,9 +115,9 @@ Attributes
networkFolder (`vim.Folder`_):
privilege: System.View
A reference to the folder hierarchy that contains the network entities for this datacenter. The folder can include `Network`_ , `DistributedVirtualSwitch`_ , and `DistributedVirtualPortgroup`_ objects.This folder is guaranteed to exist.
datastore (`vim.Datastore`_):
datastore ([`vim.Datastore`_]):
A collection of references to the datastore objects available in this datacenter.
network (`vim.Network`_):
network ([`vim.Network`_]):
A collection of references to the network objects available in this datacenter.
configuration (`vim.Datacenter.ConfigInfo`_):
privilege: System.View
@ -236,7 +236,7 @@ queryDatacenterConfigOptionDescriptor():
Returns:
`vim.vm.ConfigOptionDescriptor`_:
[`vim.vm.ConfigOptionDescriptor`_]:

4
docs/vim/Datastore.rst
View File

@ -81,9 +81,9 @@ Attributes
Specific information about the datastore.
summary (`vim.Datastore.Summary`_):
Global properties of the datastore.
host (`vim.Datastore.HostMount`_):
host ([`vim.Datastore.HostMount`_]):
Hosts attached to this datastore.
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
Virtual machines stored on this datastore.
browser (`vim.host.DatastoreBrowser`_):
DatastoreBrowser used to browse this datastore.

2
docs/vim/DiagnosticManager.rst
View File

@ -55,7 +55,7 @@ QueryDescriptions(host):
Returns:
`vim.DiagnosticManager.LogDescriptor`_:
[`vim.DiagnosticManager.LogDescriptor`_]:
Raises:

2
docs/vim/DiagnosticManager/LogHeader.rst
View File

@ -17,6 +17,6 @@ Attributes:
lineEnd (`int`_):
The last line of this log segment.
lineText (`str`_, optional):
lineText ([`str`_], optional):
Log entries, listed by line, for this log segment.

10
docs/vim/DistributedVirtualSwitch.rst
View File

@ -290,9 +290,9 @@ Attributes
Summary of the switch.
config (`vim.DistributedVirtualSwitch.ConfigInfo`_):
Switch configuration data.
networkResourcePool (`vim.dvs.NetworkResourcePool`_):
networkResourcePool ([`vim.dvs.NetworkResourcePool`_]):
Network resource pool information for the switch.
portgroup (`vim.dvs.DistributedVirtualPortgroup`_):
portgroup ([`vim.dvs.DistributedVirtualPortgroup`_]):
Portgroups that are defined on the switch.
runtime (`vim.DistributedVirtualSwitch.RuntimeInfo`_):
Runtime information of the distributed virtual switch.
@ -319,7 +319,7 @@ FetchDVPortKeys(criteria):
Returns:
`str`_:
[`str`_]:
@ -340,7 +340,7 @@ FetchDVPorts(criteria):
Returns:
`vim.dvs.DistributedVirtualPort`_:
[`vim.dvs.DistributedVirtualPort`_]:
@ -357,7 +357,7 @@ QueryUsedVlanIdInDvs():
Returns:
`int`_:
[`int`_]:

2
docs/vim/DistributedVirtualSwitch/Capability.rst
View File

@ -33,7 +33,7 @@ Attributes:
dvPortOperationSupported (`bool`_, optional):
Indicates whether this switch allows vCenter users to modify the switch configuration at the port level, except for host member, policy, and scope operations.
compatibleHostComponentProductInfo (`vim.dvs.HostProductSpec`_, optional):
compatibleHostComponentProductInfo ([`vim.dvs.HostProductSpec`_], optional):
List of host component product information that is compatible with the current switch implementation.
featuresSupported (`vim.DistributedVirtualSwitch.FeatureCapability`_, optional):

8
docs/vim/DistributedVirtualSwitch/ConfigInfo.rst
View File

@ -58,13 +58,13 @@ Attributes:
uplinkPortPolicy (`vim.DistributedVirtualSwitch.UplinkPortPolicy`_):
Uplink port policy.
uplinkPortgroup (`vim.dvs.DistributedVirtualPortgroup`_, optional):
uplinkPortgroup ([`vim.dvs.DistributedVirtualPortgroup`_], optional):
List of uplink portgroups. When adding host members, the server uses the `uplinkPortPolicy`_ to create a number of uplink ports for the host. If portgroups are shown here, those uplink ports will be added to the portgroups, with uplink ports evenly spread among the portgroups.
defaultPortConfig (`vim.dvs.DistributedVirtualPort.Setting`_):
Default configuration for the ports in the switch, if the port does not inherit configuration from the parent portgroup or has its own configuration.
host (`vim.dvs.HostMember`_, optional):
host ([`vim.dvs.HostMember`_], optional):
Hosts that join the switch.
productInfo (`vim.dvs.ProductSpec`_):
@ -76,7 +76,7 @@ Attributes:
extensionKey (`str`_, optional):
Key of the extension registered by the remote server that controls the switch.
vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional):
vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional):
Opaque binary blob that stores vendor specific configuration.
policy (`vim.DistributedVirtualSwitch.SwitchPolicy`_, optional):
@ -103,6 +103,6 @@ Attributes:
defaultProxySwitchMaxNumPorts (`int`_, optional):
Default host proxy switch maximum port number
healthCheckConfig (`vim.DistributedVirtualSwitch.HealthCheckConfig`_, optional):
healthCheckConfig ([`vim.DistributedVirtualSwitch.HealthCheckConfig`_], optional):
VDS health check configuration.

6
docs/vim/DistributedVirtualSwitch/ConfigSpec.rst
View File

@ -53,13 +53,13 @@ Attributes:
uplinkPortPolicy (`vim.DistributedVirtualSwitch.UplinkPortPolicy`_, optional):
The uplink port policy.
uplinkPortgroup (`vim.dvs.DistributedVirtualPortgroup`_, optional):
uplinkPortgroup ([`vim.dvs.DistributedVirtualPortgroup`_], optional):
The uplink portgroups.
defaultPortConfig (`vim.dvs.DistributedVirtualPort.Setting`_, optional):
The default configuration for ports.
host (`vim.dvs.HostMember.ConfigSpec`_, optional):
host ([`vim.dvs.HostMember.ConfigSpec`_], optional):
The host member specification. A particular host should have only one entry in this array. Duplicate entries for the same host will raise a fault. The host version should be compatible with the version of `DistributedVirtualSwitch`_ . Use `QueryDvsCheckCompatibility`_ to check for compatibility.
extensionKey (`str`_, optional):
@ -71,7 +71,7 @@ Attributes:
policy (`vim.DistributedVirtualSwitch.SwitchPolicy`_, optional):
The usage policy of the switch.
vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional):
vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional):
Set the opaque blob that stores vendor specific configuration.
contact (`vim.DistributedVirtualSwitch.ContactInfo`_, optional):

2
docs/vim/DistributedVirtualSwitch/FeatureCapability.rst
View File

@ -66,7 +66,7 @@ Attributes:
vmDirectPathGen2Supported (`bool`_):
Indicates whether VMDirectPath Gen 2 is supported on the distributed virtual switch. See `HostCapability`_ . `vmDirectPathGen2Supported`_ and `PhysicalNic`_ . `vmDirectPathGen2Supported`_ .For a third-party distributed switch implementation, you can specify this property during switch creation or when you call the `UpdateDvsCapability`_ method.VMDirectPath Gen 2 is supported in vSphere Distributed Switch Version 4.1 or later.
nicTeamingPolicy (`str`_, optional):
nicTeamingPolicy ([`str`_], optional):
The available teaming modes for the vSphere Distributed Switch. The value can be one or more of `DistributedVirtualSwitchNicTeamingPolicyMode`_ .
networkResourcePoolHighShareValue (`int`_, optional):

2
docs/vim/DistributedVirtualSwitch/NameArrayUplinkPortPolicy.rst
View File

@ -16,6 +16,6 @@ vim.DistributedVirtualSwitch.NameArrayUplinkPortPolicy
:since: `vSphere API 4.0`_
Attributes:
uplinkPortName (`str`_):
uplinkPortName ([`str`_]):
The uniform name of uplink ports on each host.

2
docs/vim/DistributedVirtualSwitch/RuntimeInfo.rst
View File

@ -14,6 +14,6 @@ vim.DistributedVirtualSwitch.RuntimeInfo
:since: `vSphere API 5.1`_
Attributes:
hostMemberRuntime (`vim.dvs.HostMember.RuntimeInfo`_, optional):
hostMemberRuntime ([`vim.dvs.HostMember.RuntimeInfo`_], optional):
Runtime information of the hosts that joined the switch.

8
docs/vim/DistributedVirtualSwitch/Summary.rst
View File

@ -34,16 +34,16 @@ Attributes:
productInfo (`vim.dvs.ProductSpec`_, optional):
The product information for the implementation of the switch.
hostMember (`vim.HostSystem`_, optional):
hostMember ([`vim.HostSystem`_], optional):
The names of the hosts that join the switch.
vm (`vim.VirtualMachine`_, optional):
vm ([`vim.VirtualMachine`_], optional):
The Virtual Machines with Virtual NICs that connect to the switch. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.
host (`vim.HostSystem`_, optional):
host ([`vim.HostSystem`_], optional):
The hosts with Virtual NICs that connect to the switch.
portgroupName (`str`_, optional):
portgroupName ([`str`_], optional):
The names of the portgroups that are defined on the switch.
description (`str`_, optional):

10
docs/vim/EVCMode.rst
View File

@ -60,22 +60,22 @@ vim.EVCMode
:since: `vSphere API 4.0`_
Attributes:
guaranteedCPUFeatures (`vim.host.CpuIdInfo`_, optional):
guaranteedCPUFeatures ([`vim.host.CpuIdInfo`_], optional):
Describes the CPU feature baseline associated with the EVC mode. On the cluster where a particular EVC mode is configured, those CPU features are guaranteed, either because the host hardware naturally matches those features or because CPU feature override is used to mask out differences and enforce a match.
featureCapability (`vim.host.FeatureCapability`_, optional):
featureCapability ([`vim.host.FeatureCapability`_], optional):
Describes the feature capability baseline associated with the EVC mode. On the cluster where a particular EVC mode is configured, these features capabilities are guaranteed, either because the host hardware naturally matches those features or because feature masks are used to mask out differences and enforce a match.
featureMask (`vim.host.FeatureMask`_, optional):
featureMask ([`vim.host.FeatureMask`_], optional):
The masks (modifications to a host's feature capabilities) that limit a host's capabilities to that of the EVC mode baseline.
featureRequirement (`vim.vm.FeatureRequirement`_, optional):
featureRequirement ([`vim.vm.FeatureRequirement`_], optional):
The conditions that must be true of a host's feature capabilities in order for the host to meet the minimum requirements of the EVC mode baseline.
vendor (`str`_):
CPU hardware vendor required for this mode.
track (`str`_):
track ([`str`_]):
Identifiers for feature groups that are at least partially present in the `guaranteedCPUFeatures`_ array for this mode. Use this property to compare track values from two modes. Do not use this property to determine the presence or absence of specific features.
vendorTier (`int`_):

2
docs/vim/EnumDescription.rst
View File

@ -17,6 +17,6 @@ Attributes:
key (`str`_):
Type of enumeration being described.
tags (`vim.ElementDescription`_):
tags ([`vim.ElementDescription`_]):
Element descriptions of all the tags for that enumerated type.

2
docs/vim/EnvironmentBrowser.rst
View File

@ -59,7 +59,7 @@ QueryConfigOptionDescriptor():
Returns:
`vim.vm.ConfigOptionDescriptor`_:
[`vim.vm.ConfigOptionDescriptor`_]:

2
docs/vim/ExtendedDescription.rst
View File

@ -17,6 +17,6 @@ Attributes:
messageCatalogKeyPrefix (`str`_):
Key to the localized message string in the catalog. If the localized string contains parameters, values to the parameters will be provided in #messageArg. E.g: If the message in the catalog is "IP address is {address}", value for "address" will be provided by #messageArg. Both summary and label in Description will have a corresponding entry in the message catalog with the keys.summary and.label respectively. Description.summary and Description.label will contain the strings in server locale.
messageArg (`vmodl.KeyAnyValue`_, optional):
messageArg ([`vmodl.KeyAnyValue`_], optional):
Provides named arguments that can be used to localize the message in the catalog.

2
docs/vim/ExtendedElementDescription.rst
View File

@ -17,6 +17,6 @@ Attributes:
messageCatalogKeyPrefix (`str`_):
Key to the localized message string in the catalog. If the localized string contains parameters, values to the parameters will be provided in #messageArg. E.g: If the message in the catalog is "IP address is {address}", value for "address" will be provided by #messageArg. Both summary and label in ElementDescription will have a corresponding entry in the message catalog with the keys.summary and.label respectively. ElementDescription.summary and ElementDescription.label will contain the strings in server locale.
messageArg (`vmodl.KeyAnyValue`_, optional):
messageArg ([`vmodl.KeyAnyValue`_], optional):
Provides named arguments that can be used to localize the message in the catalog.

4
docs/vim/ExtensibleManagedObject.rst
View File

@ -26,10 +26,10 @@ vim.ExtensibleManagedObject
Attributes
----------
value (`vim.CustomFieldsManager.Value`_):
value ([`vim.CustomFieldsManager.Value`_]):
privilege: System.View
List of custom field values. Each value uses a key to associate an instance of a `CustomFieldStringValue`_ with a custom field definition.
availableField (`vim.CustomFieldsManager.FieldDef`_):
availableField ([`vim.CustomFieldsManager.FieldDef`_]):
privilege: System.View
List of custom field definitions that are valid for the object's type. The fields are sorted by `name`_ .

16
docs/vim/Extension.rst
View File

@ -65,25 +65,25 @@ Attributes:
subjectName (`str`_, optional):
Subject name from client certificate.
server (`vim.Extension.ServerInfo`_, optional):
server ([`vim.Extension.ServerInfo`_], optional):
Servers for this extension.
client (`vim.Extension.ClientInfo`_, optional):
client ([`vim.Extension.ClientInfo`_], optional):
Clients for this extension.
taskList (`vim.Extension.TaskTypeInfo`_, optional):
taskList ([`vim.Extension.TaskTypeInfo`_], optional):
Definitions of tasks defined by this extension.
eventList (`vim.Extension.EventTypeInfo`_, optional):
eventList ([`vim.Extension.EventTypeInfo`_], optional):
Definitions of events defined by this extension.
faultList (`vim.Extension.FaultTypeInfo`_, optional):
faultList ([`vim.Extension.FaultTypeInfo`_], optional):
Definitions of faults defined by this extension.
privilegeList (`vim.Extension.PrivilegeInfo`_, optional):
privilegeList ([`vim.Extension.PrivilegeInfo`_], optional):
Definitions privileges defined by this extension.
resourceList (`vim.Extension.ResourceInfo`_, optional):
resourceList ([`vim.Extension.ResourceInfo`_], optional):
Resource data for all locales
lastHeartbeatTime (`datetime`_):
@ -98,7 +98,7 @@ Attributes:
extendedProductInfo (`vim.ext.ExtendedProductInfo`_, optional):
Extended product information, such as URLs to vendor, product, etc.
managedEntityInfo (`vim.ext.ManagedEntityInfo`_, optional):
managedEntityInfo ([`vim.ext.ManagedEntityInfo`_], optional):
Information about entities managed by this extension. An extension can register virtual machines as managed by itself, by setting the `managedBy`_ property of the virtual machine.
shownInSolutionManager (`bool`_, optional):

2
docs/vim/Extension/OvfConsumerInfo.rst
View File

@ -15,6 +15,6 @@ Attributes:
callbackUrl (`str`_):
Callback url for the OVF consumer. This URL must point to a SOAP API implementing the OVF consumer interface.Example: https://extension-host:8081/This callback is for internal use only.
sectionType (`str`_):
sectionType ([`str`_]):
A list of fully qualified OVF section types that this consumer handles.Fully qualified means that each section type must be prefixed with its namespace enclosed in curly braces. See the examples below.An InvalidArgument error is thrown if there is overlap between OVF consumers, meaning that the same section type appears in the sectionType list of more than one OVF consumer.Example: [ "{http://www.vmware.com/schema/vServiceManager}vServiceDependency", "{http://www.vmware.com/schema/vServiceManager}vServiceBinding" ]

2
docs/vim/Extension/ResourceInfo.rst
View File

@ -19,5 +19,5 @@ Attributes:
module (`str`_):
Module for a resource type and other message or fault resources. Examples: "task" for task, "event" for event and "auth" for "privilege".
data (`vim.KeyValue`_):
data ([`vim.KeyValue`_]):

2
docs/vim/Extension/ServerInfo.rst
View File

@ -26,7 +26,7 @@ Attributes:
type (`str`_):
Type of server (examples may include SOAP, REST, HTTP, etc.).
adminEmail (`str`_):
adminEmail ([`str`_]):
Extension administrator email addresses.
serverThumbprint (`str`_, optional):

6
docs/vim/ExtensionManager.rst
View File

@ -37,7 +37,7 @@ vim.ExtensionManager
Attributes
----------
extensionList (`vim.Extension`_):
extensionList ([`vim.Extension`_]):
privilege: System.View
The list of currently registered extensions.
@ -250,7 +250,7 @@ QueryManagedBy(extensionKey):
Returns:
`vim.ManagedEntity`_:
[`vim.ManagedEntity`_]:
List of entities managed by the extension.
@ -272,7 +272,7 @@ QueryExtensionIpAllocationUsage(extensionKeys):
Returns:
`vim.ExtensionManager.IpAllocationUsage`_:
[`vim.ExtensionManager.IpAllocationUsage`_]:
List of IP allocation usage.

4
docs/vim/Folder.rst
View File

@ -184,7 +184,7 @@ vim.Folder
Attributes
----------
childType (`str`_):
childType ([`str`_]):
privilege: System.View
Specifies the object types a folder may contain. When you create a folder, it inherits its childType from the parent folder in which it is created. childType is an array of strings. Each array entry identifies a set of object types - Folder and one or more managed object types. The following list shows childType values for the different folders:
* { "vim.Folder", "vim.Datacenter" } - Identifies the root folder and its descendant folders. Data center folders can contain child data center folders and Datacenter managed objects. Datacenter objects contain virtual machine, compute resource, network entity, and datastore folders.
@ -192,7 +192,7 @@ Attributes
* { "vim.Folder", "vim.ComputeResource" } - Identifies a compute resource folder, which contains child compute resource folders and ComputeResource hierarchies.
* { "vim.Folder", "vim.Network" } - Identifies a network entity folder. Network entity folders on a vCenter Server can contain Network, DistributedVirtualSwitch, and DistributedVirtualPortgroup managed objects. Network entity folders on an ESXi host can contain only Network objects.
* { "vim.Folder", "vim.Datastore" } - Identifies a datastore folder. Datastore folders can contain child datastore folders and Datastore managed objects.
childEntity (`vim.ManagedEntity`_):
childEntity ([`vim.ManagedEntity`_]):
privilege: System.View
An array of managed object references. Each entry is a reference to a child entity.

6
docs/vim/HostSystem.rst
View File

@ -151,12 +151,12 @@ Attributes
Host configuration systems. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
config (`vim.host.ConfigInfo`_):
Host configuration information. This might not be available for a disconnected host.
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
List of virtual machines associated with this host.
datastore (`vim.Datastore`_):
datastore ([`vim.Datastore`_]):
privilege: System.View
A collection of references to the subset of datastore objects in the datacenter that are available in this HostSystem.
network (`vim.Network`_):
network ([`vim.Network`_]):
privilege: System.View
A collection of references to the subset of network objects in the datacenter that are available in this HostSystem.
datastoreBrowser (`vim.host.DatastoreBrowser`_):

2
docs/vim/HttpNfcLease.rst
View File

@ -60,7 +60,7 @@ HttpNfcLeaseGetManifest():
Returns:
`vim.HttpNfcLease.ManifestEntry`_:
[`vim.HttpNfcLease.ManifestEntry`_]:
Raises:

2
docs/vim/HttpNfcLease/DatastoreLeaseInfo.rst
View File

@ -17,6 +17,6 @@ Attributes:
datastoreKey (`str`_):
Datastore key.
hosts (`vim.HttpNfcLease.HostInfo`_):
hosts ([`vim.HttpNfcLease.HostInfo`_]):
List of hosts connected to this datastore and covered by this lease. The hosts in this list are multi-POST-capable, and any one of them can be used to transfer disks on this datastore.

4
docs/vim/HttpNfcLease/Info.rst
View File

@ -36,7 +36,7 @@ Attributes:
entity (`vim.ManagedEntity`_):
The `VirtualMachine`_ or `VirtualApp`_ this lease covers.
deviceUrl (`vim.HttpNfcLease.DeviceUrl`_, optional):
deviceUrl ([`vim.HttpNfcLease.DeviceUrl`_], optional):
The deviceUrl property contains a mapping from logical device keys to URLs.
totalDiskCapacityInKB (`long`_):
@ -45,6 +45,6 @@ Attributes:
leaseTimeout (`int`_):
Number of seconds before the lease times out. The client extends the lease by calling `HttpNfcLeaseProgress`_ before the timeout has expired.
hostMap (`vim.HttpNfcLease.DatastoreLeaseInfo`_, optional):
hostMap ([`vim.HttpNfcLease.DatastoreLeaseInfo`_], optional):
Map of URLs for leased hosts for a given datastore. This is used to look up multi-POST-capable hosts for a datastore.

4
docs/vim/IpPoolManager.rst
View File

@ -57,7 +57,7 @@ QueryIpPools(dc):
Returns:
`vim.vApp.IpPool`_:
[`vim.vApp.IpPool`_]:
The resulting list of pools.
@ -281,7 +281,7 @@ QueryIPAllocations(dc, poolId, extensionKey):
Returns:
`vim.IpPoolManager.IpAllocation`_:
[`vim.IpPoolManager.IpAllocation`_]:
The resulting list of
Raises:

2
docs/vim/LicenseAssignmentManager.rst
View File

@ -104,7 +104,7 @@ QueryAssignedLicenses(entityId):
Returns:
`vim.LicenseAssignmentManager.LicenseAssignment`_:
[`vim.LicenseAssignmentManager.LicenseAssignment`_]:

2
docs/vim/LicenseAssignmentManager/LicenseAssignment.rst
View File

@ -28,6 +28,6 @@ Attributes:
assignedLicense (`vim.LicenseManager.LicenseInfo`_):
License assigned to the entity
properties (`vmodl.KeyAnyValue`_, optional):
properties ([`vmodl.KeyAnyValue`_], optional):
Additional properties associated with this assignment Some of the properties are: "inUseFeatures" -- Features in the license key that are being used by the entity "ProductName" -- Name of the entity. Should match the product name of the assigned license. "ProductVersion" -- Version of the entity. Should match the product version of the assigned license. "Evaluation" -- EvaluationInfo object representing the evaluation left for the entity.

8
docs/vim/LicenseManager.rst
View File

@ -62,11 +62,11 @@ Attributes
Current state of the license source. License sources that are LocalSource are always available.
diagnostics (`vim.LicenseManager.DiagnosticInfo`_):
Return current diagnostic information.
featureInfo (`vim.LicenseManager.FeatureInfo`_):
featureInfo ([`vim.LicenseManager.FeatureInfo`_]):
The list of features that can be licensed.
licensedEdition (`str`_):
The product's license edition. The edition defines which product license the server requires. This, in turn, determines the core set of functionalities provided by the product and the additional features that can be licensed. If no edition is set the property is set to the empty string (""). To set the edition use `SetLicenseEdition`_ .
licenses (`vim.LicenseManager.LicenseInfo`_):
licenses ([`vim.LicenseManager.LicenseInfo`_]):
privilege: dynamic
Get information about all the licenses avaiable.
licenseAssignmentManager (`vim.LicenseAssignmentManager`_):
@ -99,7 +99,7 @@ QuerySupportedFeatures(host):
Returns:
`vim.LicenseManager.FeatureInfo`_:
[`vim.LicenseManager.FeatureInfo`_]:
@ -120,7 +120,7 @@ QueryLicenseSourceAvailability(host):
Returns:
`vim.LicenseManager.AvailabilityInfo`_:
[`vim.LicenseManager.AvailabilityInfo`_]:

2
docs/vim/LicenseManager/EvaluationInfo.rst
View File

@ -12,6 +12,6 @@ vim.LicenseManager.EvaluationInfo
:since: `vSphere API 4.0`_
Attributes:
properties (`vmodl.KeyAnyValue`_):
properties ([`vmodl.KeyAnyValue`_]):
Evaluation properties

2
docs/vim/LicenseManager/FeatureInfo.rst
View File

@ -37,7 +37,7 @@ Attributes:
sourceRestriction (`str`_, optional):
Describe any restriction on the source of a license for this feature.See `LicenseFeatureInfoSourceRestriction`_
dependentKey (`str`_, optional):
dependentKey ([`str`_], optional):
Report List of feature keys used by this edition.
edition (`bool`_, optional):

2
docs/vim/LicenseManager/LicensableResourceInfo.rst
View File

@ -12,6 +12,6 @@ vim.LicenseManager.LicensableResourceInfo
:since: `vSphere API 5.0`_
Attributes:
resource (`vmodl.KeyAnyValue`_):
resource ([`vmodl.KeyAnyValue`_]):
List of currently supported resources. The type of every value is long. The key can be one of ResourceKey or arbitrary string.NOTE: The values in this property may not be accurate for pre-5.0 hosts when returned by vCenter 5.0

4
docs/vim/LicenseManager/LicenseInfo.rst
View File

@ -36,9 +36,9 @@ Attributes:
costUnit (`str`_):
The cost unit for this license
properties (`vmodl.KeyAnyValue`_, optional):
properties ([`vmodl.KeyAnyValue`_], optional):
Additional properties associated with this license
labels (`vim.KeyValue`_, optional):
labels ([`vim.KeyValue`_], optional):
Key-value lables for this license

4
docs/vim/LicenseManager/LicenseUsageInfo.rst
View File

@ -25,9 +25,9 @@ Attributes:
sourceAvailable (`bool`_):
Returns whether or not the source is currently available.See `sourceAvailable`_
reservationInfo (`vim.LicenseManager.ReservationInfo`_, optional):
reservationInfo ([`vim.LicenseManager.ReservationInfo`_], optional):
A list of feature reservations.
featureInfo (`vim.LicenseManager.FeatureInfo`_, optional):
featureInfo ([`vim.LicenseManager.FeatureInfo`_], optional):
Includes all the features that are referenced in the reservation array.

2
docs/vim/LocalizationManager.rst
View File

@ -50,7 +50,7 @@ vim.LocalizationManager
Attributes
----------
catalog (`vim.LocalizationManager.MessageCatalog`_):
catalog ([`vim.LocalizationManager.MessageCatalog`_]):
privilege: System.View
Fetches the descriptions of all the client-side localization message catalogs available for the current session locale.

18
docs/vim/ManagedEntity.rst
View File

@ -138,7 +138,7 @@ Attributes
parent (`vim.ManagedEntity`_):
privilege: System.View
Parent of this entity.This value is null for the root object and for `VirtualMachine`_ objects that are part of a `VirtualApp`_ .
customValue (`vim.CustomFieldsManager.Value`_):
customValue ([`vim.CustomFieldsManager.Value`_]):
privilege: System.View
Custom field values.
overallStatus (`vim.ManagedEntity.Status`_):
@ -158,17 +158,17 @@ Attributes
* The
* `configIssue`_
* property contains a list of the problems that have been detected. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
configIssue (`vim.event.Event`_):
configIssue ([`vim.event.Event`_]):
Current configuration issues that have been detected for this entity. Typically, these issues have already been logged as events. The entity stores these events as long as they are still current. The `configStatus`_ property provides an overall status based on these events.
effectiveRole (`int`_):
effectiveRole ([`int`_]):
privilege: System.View
Access rights the current session has to this entity.
permission (`vim.AuthorizationManager.Permission`_):
permission ([`vim.AuthorizationManager.Permission`_]):
List of permissions defined for this entity.
name (`str`_):
privilege: System.View
Name of this entity, unique relative to its parent.Any / (slash), \ (backslash), character used in this name element will be escaped. Similarly, any % (percent) character used in this name element will be escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25.
disabledMethod (`str`_):
disabledMethod ([`str`_]):
List of operations that are disabled, given the current runtime state of the entity. For example, a power-on operation always fails if a virtual machine is already powered on. This list can be used by clients to enable or disable operations in a graphical user interface.Note: This list is determined by the current runtime state of an entity, not by its permissions.This list may include the following operations for a HostSystem:
* `EnterMaintenanceMode_Task`_
*
@ -268,18 +268,18 @@ Attributes
*
*
* In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
recentTask (`vim.Task`_):
recentTask ([`vim.Task`_]):
The set of recent tasks operating on this managed entity. This is a subset of `recentTask`_ belong to this entity. A task in this list could be in one of the four states: pending, running, success or error.This property can be used to deduce intermediate power states for a virtual machine entity. For example, if the current powerState is "poweredOn" and there is a running task performing the "suspend" operation, then the virtual machine's intermediate state might be described as "suspending."Most tasks (such as power operations) obtain exclusive access to the virtual machine, so it is unusual for this list to contain more than one running task. One exception, however, is the task of cloning a virtual machine. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
declaredAlarmState (`vim.alarm.AlarmState`_):
declaredAlarmState ([`vim.alarm.AlarmState`_]):
privilege: System.View
A set of alarm states for alarms that apply to this managed entity. The set includes alarms defined on this entity and alarms inherited from the parent entity, or from any ancestors in the inventory hierarchy.Alarms are inherited if they can be triggered by this entity or its descendants. This set does not include alarms that are defined on descendants of this entity.
triggeredAlarmState (`vim.alarm.AlarmState`_):
triggeredAlarmState ([`vim.alarm.AlarmState`_]):
privilege: System.View
A set of alarm states for alarms triggered by this entity or by its descendants.Triggered alarms are propagated up the inventory hierarchy so that a user can readily tell when a descendant has triggered an alarm. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
alarmActionsEnabled (`bool`_):
privilege: System.Read
Whether alarm actions are enabled for this entity. True if enabled; false otherwise.
tag (`vim.Tag`_):
tag ([`vim.Tag`_]):
privilege: System.View
The set of tags associated with this managed entity. Experimental. Subject to change.

4
docs/vim/Network.rst
View File

@ -36,9 +36,9 @@ Attributes
Name of this network.
summary (`vim.Network.Summary`_):
Properties of a network.
host (`vim.HostSystem`_):
host ([`vim.HostSystem`_]):
Hosts attached to this network.
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
Virtual machines using this network.

4
docs/vim/OvfConsumer/OstNode.rst
View File

@ -24,10 +24,10 @@ Attributes:
type (`str`_):
The type of the node. Possible values are defined in the OstNodeType enum.Since the OstNode tree structure mirrors the structure of the OVF descriptor, only one Envelope node is defined, and it is always the root of the tree.
section (`vim.OvfConsumer.OvfSection`_, optional):
section ([`vim.OvfConsumer.OvfSection`_], optional):
The list of sections on this node.
child (`vim.OvfConsumer.OstNode`_, optional):
child ([`vim.OvfConsumer.OstNode`_], optional):
The list of child nodes. As dictated by OVF, this list is subject to the following rules:
* The Envelope node must have exactly one child.

4
docs/vim/OvfManager.rst
View File

@ -67,10 +67,10 @@ vim.OvfManager
Attributes
----------
ovfImportOption (`vim.OvfManager.OvfOptionInfo`_):
ovfImportOption ([`vim.OvfManager.OvfOptionInfo`_]):
privilege: System.View
Returns an array of `OvfOptionInfo`_ object that specifies what options the server support for modifing/relaxing the OVF import process.
ovfExportOption (`vim.OvfManager.OvfOptionInfo`_):
ovfExportOption ([`vim.OvfManager.OvfOptionInfo`_]):
privilege: System.View
Returns an array of `OvfOptionInfo`_ object that specifies what options the server support for exporting an OVF descriptor.

4
docs/vim/OvfManager/CommonParams.rst
View File

@ -22,9 +22,9 @@ Attributes:
deploymentOption (`str`_):
The key of the chosen deployment option. If empty, the default option is chosen. The list of possible deployment options is returned in the result of parseDescriptor.
msgBundle (`vim.KeyValue`_, optional):
msgBundle ([`vim.KeyValue`_], optional):
An optional set of localization strings to be used. The server will use these message strings to localize information in the result and in error and warning messages.This argument allows a client to pass messages from external string bundles. The client is responsible for selecting the right string bundle (based on locale) and parsing the external string bundle. The passed in key/value pairs are looked up before any messages included in the OVF descriptor itself.
importOption (`str`_, optional):
importOption ([`str`_], optional):
An optional argument for modifing the OVF parsing. When the server parses an OVF descriptor a set of options can be used to modify the parsing. The argument is a list of keywords.To get a list of supported keywords see `ovfImportOption`_ . Unknown options will be ignored by the server.

4
docs/vim/OvfManager/CreateDescriptorParams.rst
View File

@ -20,7 +20,7 @@ vim.OvfManager.CreateDescriptorParams
:since: `vSphere API 4.0`_
Attributes:
ovfFiles (`vim.OvfManager.OvfFile`_, optional):
ovfFiles ([`vim.OvfManager.OvfFile`_], optional):
Contains information about the files of the entity, if they have already been downloaded. Needed to construct the References section of the descriptor.OvfFile is a positive list of files to include in the export. An Empty list will do no filtering.
name (`str`_, optional):
@ -32,7 +32,7 @@ Attributes:
includeImageFiles (`bool`_, optional):
Controls whether attached image files should be included in the descriptor. This applies to image files attached to VirtualCdrom and VirtualFloppy.
exportOption (`str`_, optional):
exportOption ([`str`_], optional):
An optional argument for modifying the export process. The option is used to control what extra information that will be included in the OVF descriptor.To get a list of supported keywords see `ovfExportOption`_ . Unknown options will be ignored by the server.
snapshot (`vim.vm.Snapshot`_, optional):

4
docs/vim/OvfManager/CreateDescriptorResult.rst
View File

@ -19,10 +19,10 @@ Attributes:
ovfDescriptor (`str`_):
The OVF descriptor for the entity.
error (`vmodl.LocalizedMethodFault`_, optional):
error ([`vmodl.LocalizedMethodFault`_], optional):
Errors that happened during processing.For example, unknown or unsupported devices could be found (in which case this array will contain one or more instances of Unsupported-/UnknownDevice).
warning (`vmodl.LocalizedMethodFault`_, optional):
warning ([`vmodl.LocalizedMethodFault`_], optional):
Non-fatal warnings from the processing.The result will be valid, but the user may choose to reject it based on these warnings.
includeImageFiles (`bool`_, optional):

6
docs/vim/OvfManager/CreateImportSpecParams.rst
View File

@ -52,7 +52,7 @@ Attributes:
hostSystem (`vim.HostSystem`_, optional):
The host to validate the OVF descriptor against, if it cannot be deduced from the resource pool.The privilege System.Read is required on the host.
networkMapping (`vim.OvfManager.NetworkMapping`_, optional):
networkMapping ([`vim.OvfManager.NetworkMapping`_], optional):
The mapping of network identifiers from the descriptor to networks in the VI infrastructure.The privilege Network.Assign is required on all networks in the list.
ipAllocationPolicy (`str`_, optional):
@ -61,10 +61,10 @@ Attributes:
ipProtocol (`str`_, optional):
The IP protocol chosen by the caller.See `VAppIPAssignmentInfo`_ .
propertyMapping (`vim.KeyValue`_, optional):
propertyMapping ([`vim.KeyValue`_], optional):
The assignment of values to the properties found in the descriptor. If no value is specified for an option, the default value from the descriptor is used.
resourceMapping (`vim.OvfManager.ResourceMap`_, optional):
resourceMapping ([`vim.OvfManager.ResourceMap`_], optional):
The resource configuration for the created vApp. This can be used to distribute a vApp across multiple resource pools (and create linked children).
diskProvisioning (`str`_, optional):

6
docs/vim/OvfManager/CreateImportSpecResult.rst
View File

@ -25,12 +25,12 @@ Attributes:
importSpec (`vim.ImportSpec`_, optional):
The ImportSpec contains information about which `VirtualMachine`_ s and `VirtualApp`_ s are present in the entity and how they relate to each other.
fileItem (`vim.OvfManager.FileItem`_, optional):
fileItem ([`vim.OvfManager.FileItem`_], optional):
The files that must be uploaded by the caller as part of importing the entity.The files must be uploaded in order, because some of them may be delta files that patch already-uploaded files.
warning (`vmodl.LocalizedMethodFault`_, optional):
warning ([`vmodl.LocalizedMethodFault`_], optional):
Non-fatal warnings from the processing. The ImportSpec will be valid, but the user may choose to reject it based on these warnings.
error (`vmodl.LocalizedMethodFault`_, optional):
error ([`vmodl.LocalizedMethodFault`_], optional):
Errors that happened during processing. Something will be wrong with the ImportSpec, or it is not present.

18
docs/vim/OvfManager/ParseDescriptorResult.rst
View File

@ -34,19 +34,19 @@ vim.OvfManager.ParseDescriptorResult
:since: `vSphere API 4.0`_
Attributes:
eula (`str`_, optional):
eula ([`str`_], optional):
The list of all EULAs contained in the OVF
network (`vim.OvfManager.NetworkInfo`_, optional):
network ([`vim.OvfManager.NetworkInfo`_], optional):
The list of networks required by the OVF
ipAllocationScheme (`str`_, optional):
ipAllocationScheme ([`str`_], optional):
The kind of IP allocation supported by the guest.See `VAppIPAssignmentInfo`_ .
ipProtocols (`str`_, optional):
ipProtocols ([`str`_], optional):
The IP protocols supported by the guest.See `VAppIPAssignmentInfo`_ .
property (`vim.vApp.PropertyInfo`_, optional):
property ([`vim.vApp.PropertyInfo`_], optional):
Metadata about the properties contained in the OVF
productInfo (`vim.vApp.ProductInfo`_, optional):
@ -70,21 +70,21 @@ Attributes:
virtualApp (`bool`_):
True if the OVF contains a vApp (containing one or more vApps and/or virtual machines), as opposed to a single virtual machine.
deploymentOption (`vim.OvfManager.DeploymentOption`_, optional):
deploymentOption ([`vim.OvfManager.DeploymentOption`_], optional):
The list of possible deployment options.
defaultDeploymentOption (`str`_):
The key of the default deployment option. Empty only if there are no deployment options.
entityName (`vim.KeyValue`_, optional):
entityName ([`vim.KeyValue`_], optional):
A list of the child entities contained in this package and their location in the vApp hierarchy. Each entry is a (key,value) pair, where the key is the display name, and the value is a unique path identifier for the entity in the vApp. The path is constructed by appending the id of each entity of the path down to the entity, separated by slashes. For example, the path for a child of the root entity with id = "vm1", would simply be "vm1". If the vm is the child of a VirtualSystemCollection called "webTier", then the path would be "webTier/vm".
annotatedOst (`vim.OvfConsumer.OstNode`_, optional):
The annotated OST for the OVF descriptor, generated by OVF consumers. See `OvfConsumer`_ for details.
error (`vmodl.LocalizedMethodFault`_, optional):
error ([`vmodl.LocalizedMethodFault`_], optional):
Errors that happened during processing. Something will be wrong with the result.For example, during export, devices could be missing (in which case this array will contain one or more instances of Unsupported-/UnknownDevice).
warning (`vmodl.LocalizedMethodFault`_, optional):
warning ([`vmodl.LocalizedMethodFault`_], optional):
Non-fatal warnings from the processing. The result will be valid, but the user may choose to reject it based on these warnings.

6
docs/vim/OvfManager/ValidateHostResult.rst
View File

@ -25,12 +25,12 @@ Attributes:
sparseDeploymentSize (`long`_, optional):
The total amount of space required to deploy the entity using sparse disks, if known.
error (`vmodl.LocalizedMethodFault`_, optional):
error ([`vmodl.LocalizedMethodFault`_], optional):
Errors that happened during validation. The presence of faults in this list indicates that the validation failed.
warning (`vmodl.LocalizedMethodFault`_, optional):
warning ([`vmodl.LocalizedMethodFault`_], optional):
Non-fatal warnings from the validation.
supportedDiskProvisioning (`str`_, optional):
supportedDiskProvisioning ([`str`_], optional):
An array of the disk provisioning type supported by the target host system.

4
docs/vim/PerformanceDescription.rst
View File

@ -11,9 +11,9 @@ vim.PerformanceDescription
:extends: vmodl.DynamicData_
Attributes:
counterType (`vim.ElementDescription`_):
counterType ([`vim.ElementDescription`_]):
Identifies the `type`_ of the counter.
statsType (`vim.ElementDescription`_):
statsType ([`vim.ElementDescription`_]):
Identifies the `type`_ of statistic.

12
docs/vim/PerformanceManager.rst
View File

@ -154,10 +154,10 @@ Attributes
description (`vim.PerformanceDescription`_):
privilege: System.View
The static description strings.
historicalInterval (`vim.HistoricalInterval`_):
historicalInterval ([`vim.HistoricalInterval`_]):
privilege: System.View
A list of `intervals`_ configured on the system.
perfCounter (`vim.PerformanceManager.CounterInfo`_):
perfCounter ([`vim.PerformanceManager.CounterInfo`_]):
privilege: System.View
A list of all supported performance counters in the system.
@ -226,7 +226,7 @@ QueryAvailablePerfMetric(entity, beginTime, endTime, intervalId):
Returns:
`vim.PerformanceManager.MetricId`_:
[`vim.PerformanceManager.MetricId`_]:
An array of metrics, each of which comprises a `counterId`_ and an `name`_ .
Raises:
@ -252,7 +252,7 @@ QueryPerfCounter(counterId):
Returns:
`vim.PerformanceManager.CounterInfo`_:
[`vim.PerformanceManager.CounterInfo`_]:
An array consisting of performance counter information for the specified counterIds.
Raises:
@ -279,7 +279,7 @@ QueryPerfCounterByLevel(level):
Returns:
`vim.PerformanceManager.CounterInfo`_:
[`vim.PerformanceManager.CounterInfo`_]:
An array of `PerfCounterInfo`_ objects that define the set of counters having the specified level number available for the entity.
Raises:
@ -305,7 +305,7 @@ QueryPerf(querySpec):
Returns:
`vim.PerformanceManager.EntityMetricBase`_:
[`vim.PerformanceManager.EntityMetricBase`_]:
The metric values for the specified entity or entities.
Raises:

2
docs/vim/PerformanceManager/CompositeEntityMetric.rst
View File

@ -18,6 +18,6 @@ Attributes:
entity (`vim.PerformanceManager.EntityMetricBase`_, optional):
The aggregated entity performance metrics. If it exists, the `PerfSampleInfo`_ list of the aggregate entity is a complete list of `PerfSampleInfo`_ that could be contained in `PerfSampleInfo`_ lists of child entities.
childEntity (`vim.PerformanceManager.EntityMetricBase`_, optional):
childEntity ([`vim.PerformanceManager.EntityMetricBase`_], optional):
A list of `metrics`_ of performance providers that comprise the aggregated entity. For example, Host is an aggregated entity for virtual machines and virtual machine Folders. ResourcePools are aggregate entities for virtual machines. Host, Folder, and Cluster are aggregate entities for hosts in the cluster or folder.

2
docs/vim/PerformanceManager/CounterInfo.rst
View File

@ -43,6 +43,6 @@ Attributes:
perDeviceLevel (`int`_, optional):
Minimum level at which the per device metrics of this type will be collected by vCenter Server. The value for this property for any performance counter is a number from 1 to 4. By default all per device metrics are calculated at level 3 or more. If a certain per device counter is collected at a certain level, the aggregate metric is also calculated at that level, i.e., perDeviceLevel is greater than or equal to level.
associatedCounterId (`int`_, optional):
associatedCounterId ([`int`_], optional):
The counter IDs associated with the same performance counter name for the same device type. For example, the rollup types for CPU Usage for a host are average, minimum, and maximumTherefore, their counter IDs are associated.

4
docs/vim/PerformanceManager/EntityMetric.rst
View File

@ -11,9 +11,9 @@ vim.PerformanceManager.EntityMetric
:extends: vim.PerformanceManager.EntityMetricBase_
Attributes:
sampleInfo (`vim.PerformanceManager.SampleInfo`_, optional):
sampleInfo ([`vim.PerformanceManager.SampleInfo`_], optional):
A list of objects containing information (an interval and a timestamp) about the samples collected.
value (`vim.PerformanceManager.MetricSeries`_, optional):
value ([`vim.PerformanceManager.MetricSeries`_], optional):
A list of values that corresponds to the samples collected.

2
docs/vim/PerformanceManager/EntityMetricCSV.rst
View File

@ -16,6 +16,6 @@ Attributes:
sampleInfoCSV (`str`_):
The `PerfSampleInfo`_ encoded in the following CSV format: [interval1], [date1], [interval2], [date2], and so on.
value (`vim.PerformanceManager.MetricSeriesCSV`_, optional):
value ([`vim.PerformanceManager.MetricSeriesCSV`_], optional):
Metric values corresponding to the samples collected in this list.

2
docs/vim/PerformanceManager/IntSeries.rst
View File

@ -15,6 +15,6 @@ vim.PerformanceManager.IntSeries
:extends: vim.PerformanceManager.MetricSeries_
Attributes:
value (`long`_, optional):
value ([`long`_], optional):
An array of 64-bit integer values. The size of the array matches the size as the `PerfSampleInfo`_ , because the values can only be interpreted in the context of the sample that generated the value.

2
docs/vim/PerformanceManager/QuerySpec.rst
View File

@ -59,7 +59,7 @@ Attributes:
maxSample (`int`_, optional):
Limits the number of samples returned. Defaults to the most recent sample (or samples), unless a time range is specified. Use this property only in conjunction with the `intervalId`_ to obtain real-time statistics (set the `intervalId`_ to the `refreshRate`_ . This property is ignored for historical statistics, and is not valid for the `QueryPerfComposite`_ operation.
metricId (`vim.PerformanceManager.MetricId`_, optional):
metricId ([`vim.PerformanceManager.MetricId`_], optional):
The performance metrics to be retrieved. This property is required for the `QueryPerfComposite`_ operation.
intervalId (`int`_, optional):

2
docs/vim/ResourcePlanningManager/PerfStatsDescription.rst
View File

@ -12,6 +12,6 @@ vim.ResourcePlanningManager.PerfStatsDescription
:since: `vSphere API 4.0`_
Attributes:
intervals (`vim.HistoricalInterval`_, optional):
intervals ([`vim.HistoricalInterval`_], optional):
Historic interval setting. Default value is the same as the historic interval settings of the current instance of running VC.

6
docs/vim/ResourcePool.rst
View File

@ -135,15 +135,15 @@ Attributes
owner (`vim.ComputeResource`_):
privilege: System.View
The ComputeResource to which this set of one or more nested resource pools belong.
resourcePool (`vim.ResourcePool`_):
resourcePool ([`vim.ResourcePool`_]):
privilege: System.View
The set of child resource pools.
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
privilege: System.View
The set of virtual machines associated with this resource pool.
config (`vim.ResourceConfigSpec`_):
Configuration of this resource pool.
childConfiguration (`vim.ResourceConfigSpec`_):
childConfiguration ([`vim.ResourceConfigSpec`_]):
The resource configuration of all direct children (VirtualMachine and ResourcePool) of this resource group.

6
docs/vim/SearchIndex.rst
View File

@ -237,7 +237,7 @@ FindAllByUuid(datacenter, uuid, vmSearch, instanceUuid):
Returns:
`vim.ManagedEntity`_:
[`vim.ManagedEntity`_]:
The list of all virtual machines or hosts that are matching with the given UUID. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned.
@ -267,7 +267,7 @@ FindAllByDnsName(datacenter, dnsName, vmSearch):
Returns:
`vim.ManagedEntity`_:
[`vim.ManagedEntity`_]:
The list of all virtual machines or hosts that are found. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned.
@ -297,7 +297,7 @@ FindAllByIp(datacenter, ip, vmSearch):
Returns:
`vim.ManagedEntity`_:
[`vim.ManagedEntity`_]:
The list of all virtual machines or hosts that are found. If no managed entities are found, an empty list is returned. If there are multiple matches, all matching entities are returned.

6
docs/vim/ServiceInstance.rst
View File

@ -194,7 +194,7 @@ ValidateMigration(vm, state, testType, pool, host):
Returns:
`vim.event.Event`_:
[`vim.event.Event`_]:
A set of events that describe the warnings or errors that would apply if the proposed set of migrations were executed.
Raises:
@ -237,7 +237,7 @@ QueryVMotionCompatibility(vm, host, compatibility):
Returns:
`vim.ServiceInstance.HostVMotionCompatibility`_:
[`vim.ServiceInstance.HostVMotionCompatibility`_]:
An array where each element, associated with one of the input hosts, specifies which of the requested compatibility types applies to that host. If an input host has never been connected and therefore has no information available for determining its compatibility, it is omitted from the return list.
@ -255,7 +255,7 @@ RetrieveProductComponents():
Returns:
`vim.ServiceInstance.ProductComponentInfo`_:
[`vim.ServiceInstance.ProductComponentInfo`_]:

2
docs/vim/ServiceInstance/HostVMotionCompatibility.rst
View File

@ -14,6 +14,6 @@ Attributes:
host (`vim.HostSystem`_):
The prospective host for the virtual machine.
compatibility (`str`_, optional):
compatibility ([`str`_], optional):
Ways in which the host is compatible with the designated virtual machine that is a candidate for VMotion. This array will be a subset of the set of VMotionCompatibilityType strings that were input to queryVMotionCompatibility.

4
docs/vim/ServiceManager.rst
View File

@ -19,7 +19,7 @@ vim.ServiceManager
Attributes
----------
service (`vim.ServiceManager.ServiceInfo`_):
service ([`vim.ServiceManager.ServiceInfo`_]):
privilege: Global.ServiceManagers
The full list of services available in this directory.
@ -49,7 +49,7 @@ QueryServiceList(serviceName, location):
Returns:
`vim.ServiceManager.ServiceInfo`_:
[`vim.ServiceManager.ServiceInfo`_]:
Raises:

2
docs/vim/ServiceManager/ServiceInfo.rst
View File

@ -14,7 +14,7 @@ Attributes:
serviceName (`str`_):
A service name. Each service is expected to create a unique name for itself that can be used to locate the service. This name does not need to be unique across hosts or other such locations though.
location (`str`_, optional):
location ([`str`_], optional):
A list of data that can be used to uniquely identify a particular instance of a service. Multiple instances of a service can exist across different domains (for instance, a service that is associated with a particular virtual machine or a particular host). In such cases, the service name is insufficient to identify the service and location data can be used to identify the instance of interest. A service may publish as much location data as is needed to identify it (e.g, vmware.host.or vmware.vm.or both). The particular choice of locations have to be agreed upon by the client and the service.
service (`vmodl.ManagedObject`_):

6
docs/vim/SessionManager.rst
View File

@ -70,7 +70,7 @@ vim.SessionManager
Attributes
----------
sessionList (`vim.UserSession`_):
sessionList ([`vim.UserSession`_]):
privilege: Sessions.TerminateSession
The list of currently active sessions.
currentSession (`vim.UserSession`_):
@ -79,10 +79,10 @@ Attributes
message (`str`_):
privilege: System.View
The system global message from the server.
messageLocaleList (`str`_):
messageLocaleList ([`str`_]):
privilege: System.Anonymous
Provides the list of locales for which the server has localized messages.
supportedLocaleList (`str`_):
supportedLocaleList ([`str`_]):
privilege: System.Anonymous
Provides the list of locales that the server supports. Listing a locale ensures that some standardized information such as dates appear in the appropriate format. Other localized information, such as error messages, are displayed, if available. If localized information is not available, the message is returned using the system locale.
defaultLocale (`str`_):

2
docs/vim/StorageResourceManager.rst
View File

@ -146,7 +146,7 @@ QueryDatastorePerformanceSummary(datastore):
Returns:
`vim.StorageResourceManager.StoragePerformanceSummary`_:
[`vim.StorageResourceManager.StoragePerformanceSummary`_]:
Summary performance statistics for the datastore. The summary contains latency, throughput, and SIOC activity.
Raises:

6
docs/vim/StorageResourceManager/PodStorageDrsEntry.rst
View File

@ -23,12 +23,12 @@ Attributes:
storageDrsConfig (`vim.storageDrs.ConfigInfo`_):
Storage DRS configuration.
recommendation (`vim.cluster.Recommendation`_, optional):
recommendation ([`vim.cluster.Recommendation`_], optional):
List of recommended actions for the Storage Pod. It is possible that the current set of recommendations may be empty, either due to not having any running dynamic recommendation generation module, or since there may be no recommended actions at this time.
drsFault (`vim.cluster.DrsFaults`_, optional):
drsFault ([`vim.cluster.DrsFaults`_], optional):
A collection of the DRS faults generated in the last Storage DRS invocation. Each element of the collection is the set of faults generated in one recommendation.
actionHistory (`vim.cluster.ActionHistory`_, optional):
actionHistory ([`vim.cluster.ActionHistory`_], optional):
The set of actions that have been performed recently.

12
docs/vim/StorageResourceManager/StoragePerformanceSummary.rst
View File

@ -17,22 +17,22 @@ Attributes:
interval (`int`_):
Time period over which statistics are aggregated The reported time unit is in seconds
percentile (`int`_):
percentile ([`int`_]):
Metric percentile specification. A percentile is a value between 1 and 100. The metric value reported in the aggregated statistics corresponds with the percentile values in this field. For example, if the value of percentile[0] is P, and the value of the datastoreReadLatency[0] is L, then P% of all the read IOs performed during observation interval is less than L milliseconds.
datastoreReadLatency (`double`_):
datastoreReadLatency ([`double`_]):
Aggregated datastore latency in milliseconds for read operations
datastoreWriteLatency (`double`_):
datastoreWriteLatency ([`double`_]):
Aggregated datastore latency in milliseconds for write operations
datastoreVmLatency (`double`_):
datastoreVmLatency ([`double`_]):
Aggregated datastore latency as observed by Vms using the datastore The reported latency is in milliseconds.
datastoreReadIops (`double`_):
datastoreReadIops ([`double`_]):
Aggregated datastore Read IO rate (Reads/second)
datastoreWriteIops (`double`_):
datastoreWriteIops ([`double`_]):
Aggregated datastore Write IO rate (Writes/second)
siocActivityDuration (`int`_):

6
docs/vim/TaskDescription.rst
View File

@ -13,12 +13,12 @@ vim.TaskDescription
:extends: vmodl.DynamicData_
Attributes:
methodInfo (`vim.ElementDescription`_):
methodInfo ([`vim.ElementDescription`_]):
Display label and summary for all tasks
state (`vim.ElementDescription`_):
state ([`vim.ElementDescription`_]):
`TaskInfo State enum`_
reason (`vim.TypeDescription`_):
reason ([`vim.TypeDescription`_]):
Kind of entity responsible for creating this task.

10
docs/vim/TaskFilterSpec.rst
View File

@ -40,7 +40,7 @@ Attributes:
userName (`vim.TaskFilterSpec.ByUsername`_, optional):
The filter specification for retrieving tasks by user name. If not provided, then the tasks belonging to any user are collected.
state (`vim.TaskInfo.State`_, optional):
state ([`vim.TaskInfo.State`_], optional):
This property, if provided, limits the set of collected tasks by their states. Task states are enumerated in `State`_ . If not provided, tasks are collected regardless of their state.
alarm (`vim.alarm.Alarm`_, optional):
@ -49,15 +49,15 @@ Attributes:
scheduledTask (`vim.scheduler.ScheduledTask`_, optional):
This property, if provided, limits the set of collected tasks to those associated with the specified scheduled task. If not provided, tasks are collected regardless of their association with any scheduled task.
eventChainId (`int`_, optional):
eventChainId ([`int`_], optional):
The filter specification for retrieving tasks by chain ID. If it is set, tasks not with the given `eventChainId`_ will be filtered out. If the property is not set, tasks' chain ID is disregarded for filtering purposes.
tag (`str`_, optional):
tag ([`str`_], optional):
The filter specification for retrieving tasks by `tag`_ . If it is set, tasks not with the given tag(s) will be filtered out. If the property is not set, tasks' tag is disregarded for filtering purposes. If it is set, and includes an empty string, tasks without a tag will be returned.
parentTaskKey (`str`_, optional):
parentTaskKey ([`str`_], optional):
The filter specification for retrieving tasks by `parentTaskKey`_ . If it is set, tasks not with the given parentTaskKey(s) will be filtered out. If the property is not set, tasks' parentTaskKey is disregarded for filtering purposes.
rootTaskKey (`str`_, optional):
rootTaskKey ([`str`_], optional):
The filter specification for retrieving tasks by `rootTaskKey`_ . If it is set, tasks not with the given rootTaskKey(s) will be filtered out. If the property is not set, tasks' rootTaskKey is disregarded for filtering purposes.

2
docs/vim/TaskFilterSpec/ByUsername.rst
View File

@ -14,6 +14,6 @@ Attributes:
systemUser (`bool`_):
Whether or not to filter by system user. If set to true, filters for system user event.
userList (`str`_, optional):
userList ([`str`_], optional):
Specifies the username list to use in the filter. If not set, then all regular user tasks are collected.

6
docs/vim/TaskHistoryCollector.rst
View File

@ -23,7 +23,7 @@ vim.TaskHistoryCollector
Attributes
----------
latestPage (`vim.TaskInfo`_):
latestPage ([`vim.TaskInfo`_]):
The items in the 'viewable latest page'. As new tasks that match the collector's `TaskFilterSpec`_ are created, they are added to this page, and the oldest tasks are removed from the collector to keep the size of the page to that allowed by `SetCollectorPageSize`_ .The "oldest task" is the one with the oldest creation time. The tasks in the returned page are unordered.
@ -47,7 +47,7 @@ ReadNextTasks(maxCount):
Returns:
`vim.TaskInfo`_:
[`vim.TaskInfo`_]:
Raises:
@ -72,7 +72,7 @@ ReadPreviousTasks(maxCount):
Returns:
`vim.TaskInfo`_:
[`vim.TaskInfo`_]:
Raises:

2
docs/vim/TaskInfo.rst
View File

@ -50,7 +50,7 @@ Attributes:
entityName (`str`_, optional):
The name of the managed entity, locale-specific, retained for the history collector database.
locked (`vim.ManagedEntity`_, optional):
locked ([`vim.ManagedEntity`_], optional):
If the state of the task is "running", then this property is a list of managed entities that the operation has locked, with a shared lock.
state (`vim.TaskInfo.State`_):

2
docs/vim/TaskManager.rst
View File

@ -46,7 +46,7 @@ vim.TaskManager
Attributes
----------
recentTask (`vim.Task`_):
recentTask ([`vim.Task`_]):
privilege: System.View
A list of `Task`_ managed objects that completed recently, that are currently running, or that are queued to run.The list contains only `Task`_ objects that the client has permission to access, which is determined by having permission to access the `Task`_ object's managed `entity`_ .The completed `Task`_ objects by default include only `Task`_ objects that completed within the past 10 minutes. When connected to vCenter Server, there is an additional default limitation that each of the completed `Task`_ objects in this list is one of the last 200 completed `Task`_ objects.This property should not be used for tracking `Task`_ completion. Generally, a `ListView`_ is a better way to monitor a specific set of `Task`_ objects. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated.
description (`vim.TaskDescription`_):

2
docs/vim/UpdateVirtualMachineFilesResult.rst
View File

@ -14,6 +14,6 @@ vim.UpdateVirtualMachineFilesResult
:since: `vSphere API 4.1`_
Attributes:
failedVmFile (`vim.UpdateVirtualMachineFilesResult.FailedVmFileInfo`_, optional):
failedVmFile ([`vim.UpdateVirtualMachineFilesResult.FailedVmFileInfo`_], optional):
The list of virtual machines files the server has attempted to update but failed to update.

4
docs/vim/UserDirectory.rst
View File

@ -29,7 +29,7 @@ vim.UserDirectory
Attributes
----------
domainList (`str`_):
domainList ([`str`_]):
privilege: System.View
List of Windows domains available for user searches, if the underlying system supports windows domain membership.
@ -88,7 +88,7 @@ RetrieveUserGroups(domain, searchStr, belongsToGroup, belongsToUser, exactMatch,
Returns:
`vim.UserSearchResult`_:
[`vim.UserSearchResult`_]:
Raises:

6
docs/vim/VirtualApp.rst
View File

@ -96,10 +96,10 @@ Attributes
parentFolder (`vim.Folder`_):
privilege: System.View
A reference to the parent folder in the VM and Template folder hierarchy. This is only set for a root vApp. A root vApp is a vApp that is not a child of another vApp.
datastore (`vim.Datastore`_):
datastore ([`vim.Datastore`_]):
privilege: System.View
A collection of references to the subset of datastore objects used by this vApp.
network (`vim.Network`_):
network ([`vim.Network`_]):
privilege: System.View
A collection of references to the subset of network objects that is used by this virtual machine.
vAppConfig (`vim.vApp.VAppConfigInfo`_):
@ -107,7 +107,7 @@ Attributes
Configuration of this package.
parentVApp (`vim.ManagedEntity`_):
Reference to the parent vApp.
childLink (`vim.VirtualApp.LinkInfo`_):
childLink ([`vim.VirtualApp.LinkInfo`_]):
List of linked children.

2
docs/vim/VirtualDiskManager/FileBackedVirtualDiskSpec.rst
View File

@ -17,6 +17,6 @@ Attributes:
capacityKb (`long`_):
Specify the capacity of the virtual disk in Kb.
profile (`vim.vm.ProfileSpec`_, optional):
profile ([`vim.vm.ProfileSpec`_], optional):
Virtual Disk Profile requirement. Profiles are solution specifics. Profile Based Storage Management is a vSphere server extension. The API users who want to provision VMs using Storage Profiles, need to interact with it. This is an optional parameter and if user doesn't specify profile, the default behavior will apply.

10
docs/vim/VirtualMachine.rst
View File

@ -245,10 +245,10 @@ Attributes
* basic configuration
* alarms
* performance information
datastore (`vim.Datastore`_):
datastore ([`vim.Datastore`_]):
privilege: System.View
A collection of references to the subset of datastore objects in the datacenter that is used by this virtual machine.
network (`vim.Network`_):
network ([`vim.Network`_]):
privilege: System.View
A collection of references to the subset of network objects in the datacenter that is used by this virtual machine.
snapshot (`vim.vm.SnapshotInfo`_):
@ -258,7 +258,7 @@ Attributes
* `RemoveSnapshot_Task`_
* `RevertToSnapshot_Task`_
* `RemoveAllSnapshots_Task`_
rootSnapshot (`vim.vm.Snapshot`_):
rootSnapshot ([`vim.vm.Snapshot`_]):
The roots of all snapshot trees for the virtual machine.
guestHeartbeatStatus (`vim.ManagedEntity.Status`_):
The guest heartbeat. The heartbeat status is classified as:
@ -2135,7 +2135,7 @@ QueryUnownedFiles():
Returns:
`str`_:
[`str`_]:
The list of file paths for vm files whose ownership is not correct. Use `FileManager.ChangeOwner`_ to set the file ownership.
@ -2197,7 +2197,7 @@ QueryFaultToleranceCompatibility():
Returns:
`vmodl.MethodFault`_:
[`vmodl.MethodFault`_]:
Raises:

2
docs/vim/VirtualMachine/DiskChangeInfo.rst
View File

@ -22,6 +22,6 @@ Attributes:
length (`long`_):
Length (in bytes) of disk area described by this data structure.
changedArea (`vim.VirtualMachine.DiskChangeInfo.DiskChangeExtent`_, optional):
changedArea ([`vim.VirtualMachine.DiskChangeInfo.DiskChangeExtent`_], optional):
Modified disk areas. Might be empty if no parts of the disk between startOffset and startOffset + length were modified.

2
docs/vim/action/MethodAction.rst
View File

@ -14,6 +14,6 @@ Attributes:
name (`str`_):
Name of the operation.
argument (`vim.action.MethodActionArgument`_, optional):
argument ([`vim.action.MethodActionArgument`_], optional):
An array consisting of the arguments for the operation.

20
docs/vim/alarm/AlarmDescription.rst
View File

@ -29,33 +29,33 @@ vim.alarm.AlarmDescription
:extends: vmodl.DynamicData_
Attributes:
expr (`vim.TypeDescription`_):
expr ([`vim.TypeDescription`_]):
Descriptions of expression types for a trigger.
stateOperator (`vim.ElementDescription`_):
stateOperator ([`vim.ElementDescription`_]):
`State Operator enum description`_
metricOperator (`vim.ElementDescription`_):
metricOperator ([`vim.ElementDescription`_]):
`MetricAlarmExpression Metric Operator enum description`_
hostSystemConnectionState (`vim.ElementDescription`_):
hostSystemConnectionState ([`vim.ElementDescription`_]):
`Host System Connection State enum description`_
virtualMachinePowerState (`vim.ElementDescription`_):
virtualMachinePowerState ([`vim.ElementDescription`_]):
`Virtual Machine Power State enum description`_
datastoreConnectionState (`vim.ElementDescription`_):
datastoreConnectionState ([`vim.ElementDescription`_]):
`accessible`_ and `description`_
hostSystemPowerState (`vim.ElementDescription`_):
hostSystemPowerState ([`vim.ElementDescription`_]):
`Host System Power State enum description`_
virtualMachineGuestHeartbeatStatus (`vim.ElementDescription`_):
virtualMachineGuestHeartbeatStatus ([`vim.ElementDescription`_]):
`Guest Heartbeat Status enum description`_
entityStatus (`vim.ElementDescription`_):
entityStatus ([`vim.ElementDescription`_]):
`ManagedEntity Status enum description`_
action (`vim.TypeDescription`_):
action ([`vim.TypeDescription`_]):
Action class descriptions for an alarm.

6
docs/vim/alarm/AlarmManager.rst
View File

@ -36,7 +36,7 @@ vim.alarm.AlarmManager
Attributes
----------
defaultExpression (`vim.alarm.AlarmExpression`_):
defaultExpression ([`vim.alarm.AlarmExpression`_]):
privilege: System.View
The default setting for each alarm expression, used to populate the initial client wizard screen.
description (`vim.alarm.AlarmDescription`_):
@ -100,7 +100,7 @@ GetAlarm(entity):
Returns:
`vim.alarm.Alarm`_:
[`vim.alarm.Alarm`_]:
A reference to the Alarm objects returned by the operation.
@ -166,7 +166,7 @@ GetAlarmState(entity):
Returns:
`vim.alarm.AlarmState`_:
[`vim.alarm.AlarmState`_]:
The state of instantiated alarms.
Raises:

2
docs/vim/alarm/AlarmTriggeringAction.rst
View File

@ -16,7 +16,7 @@ Attributes:
action (`vim.action.Action`_):
The action to be done when the alarm is triggered.
transitionSpecs (`vim.alarm.AlarmTriggeringAction.TransitionSpec`_, optional):
transitionSpecs ([`vim.alarm.AlarmTriggeringAction.TransitionSpec`_], optional):
Indicates on which transitions this action executes and repeats. This is optional only for backwards compatibility.
green2yellow (`bool`_):

2
docs/vim/alarm/AndAlarmExpression.rst
View File

@ -7,7 +7,7 @@ vim.alarm.AndAlarmExpression
:extends: vim.alarm.AlarmExpression_
Attributes:
expression (`vim.alarm.AlarmExpression`_):
expression ([`vim.alarm.AlarmExpression`_]):
List of alarm expressions that define the overall status of the alarm.
* The state of the alarm expression is gray if all subexpressions are gray. Otherwise, gray subexpressions are ignored.

2
docs/vim/alarm/EventAlarmExpression.rst
View File

@ -38,7 +38,7 @@ vim.alarm.EventAlarmExpression
:since: `VI API 2.5`_
Attributes:
comparisons (`vim.alarm.EventAlarmExpression.Comparison`_, optional):
comparisons ([`vim.alarm.EventAlarmExpression.Comparison`_], optional):
The attributes/values to compare.
eventType (`str`_):

2
docs/vim/alarm/GroupAlarmAction.rst
View File

@ -7,6 +7,6 @@ vim.alarm.GroupAlarmAction
:extends: vim.alarm.AlarmAction_
Attributes:
action (`vim.alarm.AlarmAction`_):
action ([`vim.alarm.AlarmAction`_]):
The list of alarm actions that occur when the alarm is triggered.

2
docs/vim/alarm/OrAlarmExpression.rst
View File

@ -7,7 +7,7 @@ vim.alarm.OrAlarmExpression
:extends: vim.alarm.AlarmExpression_
Attributes:
expression (`vim.alarm.AlarmExpression`_):
expression ([`vim.alarm.AlarmExpression`_]):
List of alarm expressions that define the overall status of the alarm.
* The state of the alarm expression is gray if all subexpressions are gray. Otherwise, gray subexpressions are ignored.

2
docs/vim/cluster/AffinityRuleSpec.rst
View File

@ -11,6 +11,6 @@ vim.cluster.AffinityRuleSpec
:extends: vim.cluster.RuleInfo_
Attributes:
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
List of virtual machine references.

2
docs/vim/cluster/AntiAffinityRuleSpec.rst
View File

@ -11,6 +11,6 @@ vim.cluster.AntiAffinityRuleSpec
:extends: vim.cluster.RuleInfo_
Attributes:
vm (`vim.VirtualMachine`_):
vm ([`vim.VirtualMachine`_]):
List of virtual machine references.

6
docs/vim/cluster/ConfigInfo.rst
View File

@ -22,15 +22,15 @@ Attributes:
dasConfig (`vim.cluster.DasConfigInfo`_):
Cluster-wide configuration of the vSphere HA service.
dasVmConfig (`vim.cluster.DasVmConfigInfo`_, optional):
dasVmConfig ([`vim.cluster.DasVmConfigInfo`_], optional):
List of virtual machine configurations for the vSphere HA service. Each entry applies to one virtual machine.If a virtual machine is not specified in this array, the service uses the default settings for that virtual machine.
drsConfig (`vim.cluster.DrsConfigInfo`_):
Cluster-wide configuration of the VMware DRS service.
drsVmConfig (`vim.cluster.DrsVmConfigInfo`_, optional):
drsVmConfig ([`vim.cluster.DrsVmConfigInfo`_], optional):
List of virtual machine configurations for the VMware DRS service. Each entry applies to one virtual machine.If a virtual machine is not specified in this array, the service uses the default settings for that virtual machine.
rule (`vim.cluster.RuleInfo`_, optional):
rule ([`vim.cluster.RuleInfo`_], optional):
Cluster-wide rules.

Some files were not shown because too many files have changed in this diff Show More