diff --git a/docs/vim/AuthorizationDescription.rst b/docs/vim/AuthorizationDescription.rst index d2039fb..27b6935 100644 --- a/docs/vim/AuthorizationDescription.rst +++ b/docs/vim/AuthorizationDescription.rst @@ -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. diff --git a/docs/vim/AuthorizationManager.rst b/docs/vim/AuthorizationManager.rst index b868846..015900f 100644 --- a/docs/vim/AuthorizationManager.rst +++ b/docs/vim/AuthorizationManager.rst @@ -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: diff --git a/docs/vim/AuthorizationManager/EntityPrivilege.rst b/docs/vim/AuthorizationManager/EntityPrivilege.rst index a8f8c2e..43305b4 100644 --- a/docs/vim/AuthorizationManager/EntityPrivilege.rst +++ b/docs/vim/AuthorizationManager/EntityPrivilege.rst @@ -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. diff --git a/docs/vim/AuthorizationManager/Role.rst b/docs/vim/AuthorizationManager/Role.rst index 5eef920..16f982e 100644 --- a/docs/vim/AuthorizationManager/Role.rst +++ b/docs/vim/AuthorizationManager/Role.rst @@ -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. diff --git a/docs/vim/Capability.rst b/docs/vim/Capability.rst index 1a75f3e..bb3d9f3 100644 --- a/docs/vim/Capability.rst +++ b/docs/vim/Capability.rst @@ -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): diff --git a/docs/vim/ClusterComputeResource.rst b/docs/vim/ClusterComputeResource.rst index 121f11f..32f5c30 100644 --- a/docs/vim/ClusterComputeResource.rst +++ b/docs/vim/ClusterComputeResource.rst @@ -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: diff --git a/docs/vim/ComputeResource.rst b/docs/vim/ComputeResource.rst index 734a3bb..d4322d1 100644 --- a/docs/vim/ComputeResource.rst +++ b/docs/vim/ComputeResource.rst @@ -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`_): diff --git a/docs/vim/CustomFieldsManager.rst b/docs/vim/CustomFieldsManager.rst index 43a1190..262ff92 100644 --- a/docs/vim/CustomFieldsManager.rst +++ b/docs/vim/CustomFieldsManager.rst @@ -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. diff --git a/docs/vim/CustomizationSpecManager.rst b/docs/vim/CustomizationSpecManager.rst index 5fe0e35..a603f57 100644 --- a/docs/vim/CustomizationSpecManager.rst +++ b/docs/vim/CustomizationSpecManager.rst @@ -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. diff --git a/docs/vim/Datacenter.rst b/docs/vim/Datacenter.rst index 5c9d349..f8c96cf 100644 --- a/docs/vim/Datacenter.rst +++ b/docs/vim/Datacenter.rst @@ -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`_]: diff --git a/docs/vim/Datastore.rst b/docs/vim/Datastore.rst index 71e2fe1..27dcf56 100644 --- a/docs/vim/Datastore.rst +++ b/docs/vim/Datastore.rst @@ -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. diff --git a/docs/vim/DiagnosticManager.rst b/docs/vim/DiagnosticManager.rst index 4c38fbd..c0834ac 100644 --- a/docs/vim/DiagnosticManager.rst +++ b/docs/vim/DiagnosticManager.rst @@ -55,7 +55,7 @@ QueryDescriptions(host): Returns: - `vim.DiagnosticManager.LogDescriptor`_: + [`vim.DiagnosticManager.LogDescriptor`_]: Raises: diff --git a/docs/vim/DiagnosticManager/LogHeader.rst b/docs/vim/DiagnosticManager/LogHeader.rst index ed5df32..3d43495 100644 --- a/docs/vim/DiagnosticManager/LogHeader.rst +++ b/docs/vim/DiagnosticManager/LogHeader.rst @@ -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. diff --git a/docs/vim/DistributedVirtualSwitch.rst b/docs/vim/DistributedVirtualSwitch.rst index 5933a8f..290bcd3 100644 --- a/docs/vim/DistributedVirtualSwitch.rst +++ b/docs/vim/DistributedVirtualSwitch.rst @@ -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`_]: diff --git a/docs/vim/DistributedVirtualSwitch/Capability.rst b/docs/vim/DistributedVirtualSwitch/Capability.rst index d229f6f..baa38b7 100644 --- a/docs/vim/DistributedVirtualSwitch/Capability.rst +++ b/docs/vim/DistributedVirtualSwitch/Capability.rst @@ -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): diff --git a/docs/vim/DistributedVirtualSwitch/ConfigInfo.rst b/docs/vim/DistributedVirtualSwitch/ConfigInfo.rst index 6e43d5a..6c80ba4 100644 --- a/docs/vim/DistributedVirtualSwitch/ConfigInfo.rst +++ b/docs/vim/DistributedVirtualSwitch/ConfigInfo.rst @@ -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. diff --git a/docs/vim/DistributedVirtualSwitch/ConfigSpec.rst b/docs/vim/DistributedVirtualSwitch/ConfigSpec.rst index 266f44e..6640e1b 100644 --- a/docs/vim/DistributedVirtualSwitch/ConfigSpec.rst +++ b/docs/vim/DistributedVirtualSwitch/ConfigSpec.rst @@ -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): diff --git a/docs/vim/DistributedVirtualSwitch/FeatureCapability.rst b/docs/vim/DistributedVirtualSwitch/FeatureCapability.rst index ed1abf6..1ce7299 100644 --- a/docs/vim/DistributedVirtualSwitch/FeatureCapability.rst +++ b/docs/vim/DistributedVirtualSwitch/FeatureCapability.rst @@ -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): diff --git a/docs/vim/DistributedVirtualSwitch/NameArrayUplinkPortPolicy.rst b/docs/vim/DistributedVirtualSwitch/NameArrayUplinkPortPolicy.rst index c475218..278758f 100644 --- a/docs/vim/DistributedVirtualSwitch/NameArrayUplinkPortPolicy.rst +++ b/docs/vim/DistributedVirtualSwitch/NameArrayUplinkPortPolicy.rst @@ -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. diff --git a/docs/vim/DistributedVirtualSwitch/RuntimeInfo.rst b/docs/vim/DistributedVirtualSwitch/RuntimeInfo.rst index 3b9edea..8750f33 100644 --- a/docs/vim/DistributedVirtualSwitch/RuntimeInfo.rst +++ b/docs/vim/DistributedVirtualSwitch/RuntimeInfo.rst @@ -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. diff --git a/docs/vim/DistributedVirtualSwitch/Summary.rst b/docs/vim/DistributedVirtualSwitch/Summary.rst index b83e82a..53e3252 100644 --- a/docs/vim/DistributedVirtualSwitch/Summary.rst +++ b/docs/vim/DistributedVirtualSwitch/Summary.rst @@ -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): diff --git a/docs/vim/EVCMode.rst b/docs/vim/EVCMode.rst index 3b12414..1a80466 100644 --- a/docs/vim/EVCMode.rst +++ b/docs/vim/EVCMode.rst @@ -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`_): diff --git a/docs/vim/EnumDescription.rst b/docs/vim/EnumDescription.rst index 0ef2053..4502a7b 100644 --- a/docs/vim/EnumDescription.rst +++ b/docs/vim/EnumDescription.rst @@ -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. diff --git a/docs/vim/EnvironmentBrowser.rst b/docs/vim/EnvironmentBrowser.rst index 3d07a73..578fe58 100644 --- a/docs/vim/EnvironmentBrowser.rst +++ b/docs/vim/EnvironmentBrowser.rst @@ -59,7 +59,7 @@ QueryConfigOptionDescriptor(): Returns: - `vim.vm.ConfigOptionDescriptor`_: + [`vim.vm.ConfigOptionDescriptor`_]: diff --git a/docs/vim/ExtendedDescription.rst b/docs/vim/ExtendedDescription.rst index 3bcffe5..cc838fe 100644 --- a/docs/vim/ExtendedDescription.rst +++ b/docs/vim/ExtendedDescription.rst @@ -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. diff --git a/docs/vim/ExtendedElementDescription.rst b/docs/vim/ExtendedElementDescription.rst index 1268b73..cb816a5 100644 --- a/docs/vim/ExtendedElementDescription.rst +++ b/docs/vim/ExtendedElementDescription.rst @@ -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. diff --git a/docs/vim/ExtensibleManagedObject.rst b/docs/vim/ExtensibleManagedObject.rst index 2ac4c3d..bb03d99 100644 --- a/docs/vim/ExtensibleManagedObject.rst +++ b/docs/vim/ExtensibleManagedObject.rst @@ -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`_ . diff --git a/docs/vim/Extension.rst b/docs/vim/Extension.rst index 22769d0..3b20b6c 100644 --- a/docs/vim/Extension.rst +++ b/docs/vim/Extension.rst @@ -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): diff --git a/docs/vim/Extension/OvfConsumerInfo.rst b/docs/vim/Extension/OvfConsumerInfo.rst index f86e890..4d86a09 100644 --- a/docs/vim/Extension/OvfConsumerInfo.rst +++ b/docs/vim/Extension/OvfConsumerInfo.rst @@ -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" ] diff --git a/docs/vim/Extension/ResourceInfo.rst b/docs/vim/Extension/ResourceInfo.rst index a761182..09bfbd7 100644 --- a/docs/vim/Extension/ResourceInfo.rst +++ b/docs/vim/Extension/ResourceInfo.rst @@ -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`_]): diff --git a/docs/vim/Extension/ServerInfo.rst b/docs/vim/Extension/ServerInfo.rst index bf212fe..4072aaf 100644 --- a/docs/vim/Extension/ServerInfo.rst +++ b/docs/vim/Extension/ServerInfo.rst @@ -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): diff --git a/docs/vim/ExtensionManager.rst b/docs/vim/ExtensionManager.rst index b41a631..aa48668 100644 --- a/docs/vim/ExtensionManager.rst +++ b/docs/vim/ExtensionManager.rst @@ -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. diff --git a/docs/vim/Folder.rst b/docs/vim/Folder.rst index 4653f14..734d51f 100644 --- a/docs/vim/Folder.rst +++ b/docs/vim/Folder.rst @@ -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. diff --git a/docs/vim/HostSystem.rst b/docs/vim/HostSystem.rst index 38bf4e7..3fb13ec 100644 --- a/docs/vim/HostSystem.rst +++ b/docs/vim/HostSystem.rst @@ -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`_): diff --git a/docs/vim/HttpNfcLease.rst b/docs/vim/HttpNfcLease.rst index a1e8c60..5a253a4 100644 --- a/docs/vim/HttpNfcLease.rst +++ b/docs/vim/HttpNfcLease.rst @@ -60,7 +60,7 @@ HttpNfcLeaseGetManifest(): Returns: - `vim.HttpNfcLease.ManifestEntry`_: + [`vim.HttpNfcLease.ManifestEntry`_]: Raises: diff --git a/docs/vim/HttpNfcLease/DatastoreLeaseInfo.rst b/docs/vim/HttpNfcLease/DatastoreLeaseInfo.rst index 6af6272..ed8b441 100644 --- a/docs/vim/HttpNfcLease/DatastoreLeaseInfo.rst +++ b/docs/vim/HttpNfcLease/DatastoreLeaseInfo.rst @@ -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. diff --git a/docs/vim/HttpNfcLease/Info.rst b/docs/vim/HttpNfcLease/Info.rst index 2b336e8..c41ae56 100644 --- a/docs/vim/HttpNfcLease/Info.rst +++ b/docs/vim/HttpNfcLease/Info.rst @@ -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. diff --git a/docs/vim/IpPoolManager.rst b/docs/vim/IpPoolManager.rst index b588a5e..5473878 100644 --- a/docs/vim/IpPoolManager.rst +++ b/docs/vim/IpPoolManager.rst @@ -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: diff --git a/docs/vim/LicenseAssignmentManager.rst b/docs/vim/LicenseAssignmentManager.rst index 090e585..a85339a 100644 --- a/docs/vim/LicenseAssignmentManager.rst +++ b/docs/vim/LicenseAssignmentManager.rst @@ -104,7 +104,7 @@ QueryAssignedLicenses(entityId): Returns: - `vim.LicenseAssignmentManager.LicenseAssignment`_: + [`vim.LicenseAssignmentManager.LicenseAssignment`_]: diff --git a/docs/vim/LicenseAssignmentManager/LicenseAssignment.rst b/docs/vim/LicenseAssignmentManager/LicenseAssignment.rst index efae134..fb3fd12 100644 --- a/docs/vim/LicenseAssignmentManager/LicenseAssignment.rst +++ b/docs/vim/LicenseAssignmentManager/LicenseAssignment.rst @@ -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. diff --git a/docs/vim/LicenseManager.rst b/docs/vim/LicenseManager.rst index f7c9f52..9ecdc67 100644 --- a/docs/vim/LicenseManager.rst +++ b/docs/vim/LicenseManager.rst @@ -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`_]: diff --git a/docs/vim/LicenseManager/EvaluationInfo.rst b/docs/vim/LicenseManager/EvaluationInfo.rst index 0623c3c..370aa6e 100644 --- a/docs/vim/LicenseManager/EvaluationInfo.rst +++ b/docs/vim/LicenseManager/EvaluationInfo.rst @@ -12,6 +12,6 @@ vim.LicenseManager.EvaluationInfo :since: `vSphere API 4.0`_ Attributes: - properties (`vmodl.KeyAnyValue`_): + properties ([`vmodl.KeyAnyValue`_]): Evaluation properties diff --git a/docs/vim/LicenseManager/FeatureInfo.rst b/docs/vim/LicenseManager/FeatureInfo.rst index 1f55924..792470d 100644 --- a/docs/vim/LicenseManager/FeatureInfo.rst +++ b/docs/vim/LicenseManager/FeatureInfo.rst @@ -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): diff --git a/docs/vim/LicenseManager/LicensableResourceInfo.rst b/docs/vim/LicenseManager/LicensableResourceInfo.rst index 93479cc..392c5c7 100644 --- a/docs/vim/LicenseManager/LicensableResourceInfo.rst +++ b/docs/vim/LicenseManager/LicensableResourceInfo.rst @@ -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 diff --git a/docs/vim/LicenseManager/LicenseInfo.rst b/docs/vim/LicenseManager/LicenseInfo.rst index e084aca..c482b38 100644 --- a/docs/vim/LicenseManager/LicenseInfo.rst +++ b/docs/vim/LicenseManager/LicenseInfo.rst @@ -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 diff --git a/docs/vim/LicenseManager/LicenseUsageInfo.rst b/docs/vim/LicenseManager/LicenseUsageInfo.rst index ec04ab3..0f53f34 100644 --- a/docs/vim/LicenseManager/LicenseUsageInfo.rst +++ b/docs/vim/LicenseManager/LicenseUsageInfo.rst @@ -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. diff --git a/docs/vim/LocalizationManager.rst b/docs/vim/LocalizationManager.rst index d2fe1ff..70b3273 100644 --- a/docs/vim/LocalizationManager.rst +++ b/docs/vim/LocalizationManager.rst @@ -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. diff --git a/docs/vim/ManagedEntity.rst b/docs/vim/ManagedEntity.rst index b166776..fa69b14 100644 --- a/docs/vim/ManagedEntity.rst +++ b/docs/vim/ManagedEntity.rst @@ -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. diff --git a/docs/vim/Network.rst b/docs/vim/Network.rst index 250fbfc..7f8c1ed 100644 --- a/docs/vim/Network.rst +++ b/docs/vim/Network.rst @@ -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. diff --git a/docs/vim/OvfConsumer/OstNode.rst b/docs/vim/OvfConsumer/OstNode.rst index 94f6a7f..14d3aa3 100644 --- a/docs/vim/OvfConsumer/OstNode.rst +++ b/docs/vim/OvfConsumer/OstNode.rst @@ -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. diff --git a/docs/vim/OvfManager.rst b/docs/vim/OvfManager.rst index 36c0228..13f7dd7 100644 --- a/docs/vim/OvfManager.rst +++ b/docs/vim/OvfManager.rst @@ -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. diff --git a/docs/vim/OvfManager/CommonParams.rst b/docs/vim/OvfManager/CommonParams.rst index e94add1..a30e0eb 100644 --- a/docs/vim/OvfManager/CommonParams.rst +++ b/docs/vim/OvfManager/CommonParams.rst @@ -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. diff --git a/docs/vim/OvfManager/CreateDescriptorParams.rst b/docs/vim/OvfManager/CreateDescriptorParams.rst index e26dc92..0b44616 100644 --- a/docs/vim/OvfManager/CreateDescriptorParams.rst +++ b/docs/vim/OvfManager/CreateDescriptorParams.rst @@ -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): diff --git a/docs/vim/OvfManager/CreateDescriptorResult.rst b/docs/vim/OvfManager/CreateDescriptorResult.rst index f787229..d6e1c45 100644 --- a/docs/vim/OvfManager/CreateDescriptorResult.rst +++ b/docs/vim/OvfManager/CreateDescriptorResult.rst @@ -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): diff --git a/docs/vim/OvfManager/CreateImportSpecParams.rst b/docs/vim/OvfManager/CreateImportSpecParams.rst index e8408ed..65890e8 100644 --- a/docs/vim/OvfManager/CreateImportSpecParams.rst +++ b/docs/vim/OvfManager/CreateImportSpecParams.rst @@ -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): diff --git a/docs/vim/OvfManager/CreateImportSpecResult.rst b/docs/vim/OvfManager/CreateImportSpecResult.rst index 6663675..219a237 100644 --- a/docs/vim/OvfManager/CreateImportSpecResult.rst +++ b/docs/vim/OvfManager/CreateImportSpecResult.rst @@ -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. diff --git a/docs/vim/OvfManager/ParseDescriptorResult.rst b/docs/vim/OvfManager/ParseDescriptorResult.rst index dddce94..15a829e 100644 --- a/docs/vim/OvfManager/ParseDescriptorResult.rst +++ b/docs/vim/OvfManager/ParseDescriptorResult.rst @@ -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. diff --git a/docs/vim/OvfManager/ValidateHostResult.rst b/docs/vim/OvfManager/ValidateHostResult.rst index ff0ba04..7de04b4 100644 --- a/docs/vim/OvfManager/ValidateHostResult.rst +++ b/docs/vim/OvfManager/ValidateHostResult.rst @@ -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. diff --git a/docs/vim/PerformanceDescription.rst b/docs/vim/PerformanceDescription.rst index 97f0c2c..d3a50e3 100644 --- a/docs/vim/PerformanceDescription.rst +++ b/docs/vim/PerformanceDescription.rst @@ -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. diff --git a/docs/vim/PerformanceManager.rst b/docs/vim/PerformanceManager.rst index 9176a95..c56f4b1 100644 --- a/docs/vim/PerformanceManager.rst +++ b/docs/vim/PerformanceManager.rst @@ -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: diff --git a/docs/vim/PerformanceManager/CompositeEntityMetric.rst b/docs/vim/PerformanceManager/CompositeEntityMetric.rst index b368803..b638205 100644 --- a/docs/vim/PerformanceManager/CompositeEntityMetric.rst +++ b/docs/vim/PerformanceManager/CompositeEntityMetric.rst @@ -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. diff --git a/docs/vim/PerformanceManager/CounterInfo.rst b/docs/vim/PerformanceManager/CounterInfo.rst index ed184d0..c901e32 100644 --- a/docs/vim/PerformanceManager/CounterInfo.rst +++ b/docs/vim/PerformanceManager/CounterInfo.rst @@ -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. diff --git a/docs/vim/PerformanceManager/EntityMetric.rst b/docs/vim/PerformanceManager/EntityMetric.rst index 9a304af..f11bdc6 100644 --- a/docs/vim/PerformanceManager/EntityMetric.rst +++ b/docs/vim/PerformanceManager/EntityMetric.rst @@ -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. diff --git a/docs/vim/PerformanceManager/EntityMetricCSV.rst b/docs/vim/PerformanceManager/EntityMetricCSV.rst index 5dfa098..8793e7c 100644 --- a/docs/vim/PerformanceManager/EntityMetricCSV.rst +++ b/docs/vim/PerformanceManager/EntityMetricCSV.rst @@ -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. diff --git a/docs/vim/PerformanceManager/IntSeries.rst b/docs/vim/PerformanceManager/IntSeries.rst index 21f6eb3..6178bba 100644 --- a/docs/vim/PerformanceManager/IntSeries.rst +++ b/docs/vim/PerformanceManager/IntSeries.rst @@ -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. diff --git a/docs/vim/PerformanceManager/QuerySpec.rst b/docs/vim/PerformanceManager/QuerySpec.rst index c634e35..74e7675 100644 --- a/docs/vim/PerformanceManager/QuerySpec.rst +++ b/docs/vim/PerformanceManager/QuerySpec.rst @@ -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): diff --git a/docs/vim/ResourcePlanningManager/PerfStatsDescription.rst b/docs/vim/ResourcePlanningManager/PerfStatsDescription.rst index 5ba6ab5..816bd87 100644 --- a/docs/vim/ResourcePlanningManager/PerfStatsDescription.rst +++ b/docs/vim/ResourcePlanningManager/PerfStatsDescription.rst @@ -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. diff --git a/docs/vim/ResourcePool.rst b/docs/vim/ResourcePool.rst index db1b0b7..500c443 100644 --- a/docs/vim/ResourcePool.rst +++ b/docs/vim/ResourcePool.rst @@ -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. diff --git a/docs/vim/SearchIndex.rst b/docs/vim/SearchIndex.rst index 6de2976..411e988 100644 --- a/docs/vim/SearchIndex.rst +++ b/docs/vim/SearchIndex.rst @@ -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. diff --git a/docs/vim/ServiceInstance.rst b/docs/vim/ServiceInstance.rst index 702d96f..3cff19c 100644 --- a/docs/vim/ServiceInstance.rst +++ b/docs/vim/ServiceInstance.rst @@ -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`_]: diff --git a/docs/vim/ServiceInstance/HostVMotionCompatibility.rst b/docs/vim/ServiceInstance/HostVMotionCompatibility.rst index b00ec5e..0de4d39 100644 --- a/docs/vim/ServiceInstance/HostVMotionCompatibility.rst +++ b/docs/vim/ServiceInstance/HostVMotionCompatibility.rst @@ -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. diff --git a/docs/vim/ServiceManager.rst b/docs/vim/ServiceManager.rst index 11f0349..ccd93f7 100644 --- a/docs/vim/ServiceManager.rst +++ b/docs/vim/ServiceManager.rst @@ -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: diff --git a/docs/vim/ServiceManager/ServiceInfo.rst b/docs/vim/ServiceManager/ServiceInfo.rst index 9006b66..f9ca4e3 100644 --- a/docs/vim/ServiceManager/ServiceInfo.rst +++ b/docs/vim/ServiceManager/ServiceInfo.rst @@ -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`_): diff --git a/docs/vim/SessionManager.rst b/docs/vim/SessionManager.rst index 57f91bb..53ca61b 100644 --- a/docs/vim/SessionManager.rst +++ b/docs/vim/SessionManager.rst @@ -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`_): diff --git a/docs/vim/StorageResourceManager.rst b/docs/vim/StorageResourceManager.rst index cec5d41..b7c3287 100644 --- a/docs/vim/StorageResourceManager.rst +++ b/docs/vim/StorageResourceManager.rst @@ -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: diff --git a/docs/vim/StorageResourceManager/PodStorageDrsEntry.rst b/docs/vim/StorageResourceManager/PodStorageDrsEntry.rst index 09cd57d..8e6d544 100644 --- a/docs/vim/StorageResourceManager/PodStorageDrsEntry.rst +++ b/docs/vim/StorageResourceManager/PodStorageDrsEntry.rst @@ -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. diff --git a/docs/vim/StorageResourceManager/StoragePerformanceSummary.rst b/docs/vim/StorageResourceManager/StoragePerformanceSummary.rst index 1354e42..5769514 100644 --- a/docs/vim/StorageResourceManager/StoragePerformanceSummary.rst +++ b/docs/vim/StorageResourceManager/StoragePerformanceSummary.rst @@ -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`_): diff --git a/docs/vim/TaskDescription.rst b/docs/vim/TaskDescription.rst index 8fa72f7..ad8ab2f 100644 --- a/docs/vim/TaskDescription.rst +++ b/docs/vim/TaskDescription.rst @@ -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. diff --git a/docs/vim/TaskFilterSpec.rst b/docs/vim/TaskFilterSpec.rst index 1f2cc56..5a517e1 100644 --- a/docs/vim/TaskFilterSpec.rst +++ b/docs/vim/TaskFilterSpec.rst @@ -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. diff --git a/docs/vim/TaskFilterSpec/ByUsername.rst b/docs/vim/TaskFilterSpec/ByUsername.rst index 1dc6cba..d99d424 100644 --- a/docs/vim/TaskFilterSpec/ByUsername.rst +++ b/docs/vim/TaskFilterSpec/ByUsername.rst @@ -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. diff --git a/docs/vim/TaskHistoryCollector.rst b/docs/vim/TaskHistoryCollector.rst index 1e68a1a..c99dde7 100644 --- a/docs/vim/TaskHistoryCollector.rst +++ b/docs/vim/TaskHistoryCollector.rst @@ -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: diff --git a/docs/vim/TaskInfo.rst b/docs/vim/TaskInfo.rst index 25c8b99..1823e67 100644 --- a/docs/vim/TaskInfo.rst +++ b/docs/vim/TaskInfo.rst @@ -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`_): diff --git a/docs/vim/TaskManager.rst b/docs/vim/TaskManager.rst index 62d224c..eb11677 100644 --- a/docs/vim/TaskManager.rst +++ b/docs/vim/TaskManager.rst @@ -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`_): diff --git a/docs/vim/UpdateVirtualMachineFilesResult.rst b/docs/vim/UpdateVirtualMachineFilesResult.rst index 1343f99..b040f13 100644 --- a/docs/vim/UpdateVirtualMachineFilesResult.rst +++ b/docs/vim/UpdateVirtualMachineFilesResult.rst @@ -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. diff --git a/docs/vim/UserDirectory.rst b/docs/vim/UserDirectory.rst index bb39657..4856990 100644 --- a/docs/vim/UserDirectory.rst +++ b/docs/vim/UserDirectory.rst @@ -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: diff --git a/docs/vim/VirtualApp.rst b/docs/vim/VirtualApp.rst index fa42989..3bd3a4d 100644 --- a/docs/vim/VirtualApp.rst +++ b/docs/vim/VirtualApp.rst @@ -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. diff --git a/docs/vim/VirtualDiskManager/FileBackedVirtualDiskSpec.rst b/docs/vim/VirtualDiskManager/FileBackedVirtualDiskSpec.rst index ab6b2a0..f273437 100644 --- a/docs/vim/VirtualDiskManager/FileBackedVirtualDiskSpec.rst +++ b/docs/vim/VirtualDiskManager/FileBackedVirtualDiskSpec.rst @@ -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. diff --git a/docs/vim/VirtualMachine.rst b/docs/vim/VirtualMachine.rst index e163632..35bfbf5 100644 --- a/docs/vim/VirtualMachine.rst +++ b/docs/vim/VirtualMachine.rst @@ -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: diff --git a/docs/vim/VirtualMachine/DiskChangeInfo.rst b/docs/vim/VirtualMachine/DiskChangeInfo.rst index bbda006..d86faf6 100644 --- a/docs/vim/VirtualMachine/DiskChangeInfo.rst +++ b/docs/vim/VirtualMachine/DiskChangeInfo.rst @@ -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. diff --git a/docs/vim/action/MethodAction.rst b/docs/vim/action/MethodAction.rst index 3eaf7e3..48aaee2 100644 --- a/docs/vim/action/MethodAction.rst +++ b/docs/vim/action/MethodAction.rst @@ -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. diff --git a/docs/vim/alarm/AlarmDescription.rst b/docs/vim/alarm/AlarmDescription.rst index 4dc5440..1eedee5 100644 --- a/docs/vim/alarm/AlarmDescription.rst +++ b/docs/vim/alarm/AlarmDescription.rst @@ -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. diff --git a/docs/vim/alarm/AlarmManager.rst b/docs/vim/alarm/AlarmManager.rst index d2fb580..c4e11eb 100644 --- a/docs/vim/alarm/AlarmManager.rst +++ b/docs/vim/alarm/AlarmManager.rst @@ -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: diff --git a/docs/vim/alarm/AlarmTriggeringAction.rst b/docs/vim/alarm/AlarmTriggeringAction.rst index cd95aff..ecf6ead 100644 --- a/docs/vim/alarm/AlarmTriggeringAction.rst +++ b/docs/vim/alarm/AlarmTriggeringAction.rst @@ -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`_): diff --git a/docs/vim/alarm/AndAlarmExpression.rst b/docs/vim/alarm/AndAlarmExpression.rst index f70bbd4..423cd01 100644 --- a/docs/vim/alarm/AndAlarmExpression.rst +++ b/docs/vim/alarm/AndAlarmExpression.rst @@ -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. diff --git a/docs/vim/alarm/EventAlarmExpression.rst b/docs/vim/alarm/EventAlarmExpression.rst index ccbce9c..190879d 100644 --- a/docs/vim/alarm/EventAlarmExpression.rst +++ b/docs/vim/alarm/EventAlarmExpression.rst @@ -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`_): diff --git a/docs/vim/alarm/GroupAlarmAction.rst b/docs/vim/alarm/GroupAlarmAction.rst index 6f9cc4a..7bf92dd 100644 --- a/docs/vim/alarm/GroupAlarmAction.rst +++ b/docs/vim/alarm/GroupAlarmAction.rst @@ -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. diff --git a/docs/vim/alarm/OrAlarmExpression.rst b/docs/vim/alarm/OrAlarmExpression.rst index 28c37cd..e260211 100644 --- a/docs/vim/alarm/OrAlarmExpression.rst +++ b/docs/vim/alarm/OrAlarmExpression.rst @@ -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. diff --git a/docs/vim/cluster/AffinityRuleSpec.rst b/docs/vim/cluster/AffinityRuleSpec.rst index f7225a3..be8e152 100644 --- a/docs/vim/cluster/AffinityRuleSpec.rst +++ b/docs/vim/cluster/AffinityRuleSpec.rst @@ -11,6 +11,6 @@ vim.cluster.AffinityRuleSpec :extends: vim.cluster.RuleInfo_ Attributes: - vm (`vim.VirtualMachine`_): + vm ([`vim.VirtualMachine`_]): List of virtual machine references. diff --git a/docs/vim/cluster/AntiAffinityRuleSpec.rst b/docs/vim/cluster/AntiAffinityRuleSpec.rst index 4a1abc4..53e61af 100644 --- a/docs/vim/cluster/AntiAffinityRuleSpec.rst +++ b/docs/vim/cluster/AntiAffinityRuleSpec.rst @@ -11,6 +11,6 @@ vim.cluster.AntiAffinityRuleSpec :extends: vim.cluster.RuleInfo_ Attributes: - vm (`vim.VirtualMachine`_): + vm ([`vim.VirtualMachine`_]): List of virtual machine references. diff --git a/docs/vim/cluster/ConfigInfo.rst b/docs/vim/cluster/ConfigInfo.rst index 3588c48..104a294 100644 --- a/docs/vim/cluster/ConfigInfo.rst +++ b/docs/vim/cluster/ConfigInfo.rst @@ -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. diff --git a/docs/vim/cluster/ConfigInfoEx.rst b/docs/vim/cluster/ConfigInfoEx.rst index 5aab6b7..256719d 100644 --- a/docs/vim/cluster/ConfigInfoEx.rst +++ b/docs/vim/cluster/ConfigInfoEx.rst @@ -37,30 +37,30 @@ 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. dpmConfigInfo (`vim.cluster.DpmConfigInfo`_, optional): Cluster-wide configuration of the VMware DPM service. - dpmHostConfig (`vim.cluster.DpmHostConfigInfo`_, optional): + dpmHostConfig ([`vim.cluster.DpmHostConfigInfo`_], optional): List of host configurations for the VMware DPM service. Each entry applies to one host.If a host is not specified in this array, the service uses the cluster default settings for that host. vsanConfigInfo (`vim.vsan.cluster.ConfigInfo`_, optional): Cluster-wide configuration of the VMware VSAN service. - vsanHostConfig (`vim.vsan.host.ConfigInfo`_, optional): + vsanHostConfig ([`vim.vsan.host.ConfigInfo`_], optional): List of host configurations for the VMware VSAN service. Each entry applies to one host.If a host is not specified in this array, the service uses the cluster default settings for that host. - group (`vim.cluster.GroupInfo`_, optional): + group ([`vim.cluster.GroupInfo`_], optional): Cluster-wide groups. diff --git a/docs/vim/cluster/ConfigSpec.rst b/docs/vim/cluster/ConfigSpec.rst index 1a478c0..017d215 100644 --- a/docs/vim/cluster/ConfigSpec.rst +++ b/docs/vim/cluster/ConfigSpec.rst @@ -22,15 +22,15 @@ Attributes: dasConfig (`vim.cluster.DasConfigInfo`_, optional): Changes to the configuration of vSphere HA. - dasVmConfigSpec (`vim.cluster.DasVmConfigSpec`_, optional): + dasVmConfigSpec ([`vim.cluster.DasVmConfigSpec`_], optional): Changes to the per-virtual-machine vSphere HA settings. drsConfig (`vim.cluster.DrsConfigInfo`_, optional): Changes to the configuration of the VMware DRS service. - drsVmConfigSpec (`vim.cluster.DrsVmConfigSpec`_, optional): + drsVmConfigSpec ([`vim.cluster.DrsVmConfigSpec`_], optional): Changes to the per-virtual-machine DRS settings. - rulesSpec (`vim.cluster.RuleSpec`_, optional): + rulesSpec ([`vim.cluster.RuleSpec`_], optional): Changes to the set of rules. diff --git a/docs/vim/cluster/ConfigSpecEx.rst b/docs/vim/cluster/ConfigSpecEx.rst index d8afa23..1377f5c 100644 --- a/docs/vim/cluster/ConfigSpecEx.rst +++ b/docs/vim/cluster/ConfigSpecEx.rst @@ -176,30 +176,30 @@ Attributes: dasConfig (`vim.cluster.DasConfigInfo`_, optional): HA configuration; includes default settings for virtual machines. - dasVmConfigSpec (`vim.cluster.DasVmConfigSpec`_, optional): + dasVmConfigSpec ([`vim.cluster.DasVmConfigSpec`_], optional): HA configuration for individual virtual machines. The entries in this array override the cluster default settings ( `ClusterDasConfigInfo`_ . `defaultVmSettings`_ ). You cannot specify an HA override for a secondary FT virtual machine. The secondary virtual machine will inherit whatever settings apply to its primary virtual machine. If you include an entry for a secondary, the reconfigure method will throw the fault `CannotChangeHaSettingsForFtSecondary`_ . drsConfig (`vim.cluster.DrsConfigInfo`_, optional): DRS configuration; includes default settings for virtual machines. - drsVmConfigSpec (`vim.cluster.DrsVmConfigSpec`_, optional): + drsVmConfigSpec ([`vim.cluster.DrsVmConfigSpec`_], optional): DRS configuration for individual virtual machines. The entries in this array override the cluster default settings ( `ClusterDrsConfigInfo`_ . `defaultVmBehavior`_ ). You cannot specify a DRS override for a secondary FT virtual machine. The secondary virtual machine will inherit whatever setting applies to its primary virtual machine. If you include an entry for a secondary, the reconfigure method will throw the fault `CannotChangeDrsBehaviorForFtSecondary`_ . - rulesSpec (`vim.cluster.RuleSpec`_, optional): + rulesSpec ([`vim.cluster.RuleSpec`_], optional): Cluster affinity and anti-affinity rule configuration. dpmConfig (`vim.cluster.DpmConfigInfo`_, optional): DPM configuration; includes default settings for hosts. - dpmHostConfigSpec (`vim.cluster.DpmHostConfigSpec`_, optional): + dpmHostConfigSpec ([`vim.cluster.DpmHostConfigSpec`_], optional): DPM configuration for individual hosts. The entries in this array override the cluster default settings ( `ClusterDpmConfigInfo`_ . `defaultDpmBehavior`_ ). vsanConfig (`vim.vsan.cluster.ConfigInfo`_, optional): VSAN configuration; includes default settings for hosts. - vsanHostConfigSpec (`vim.vsan.host.ConfigInfo`_, optional): + vsanHostConfigSpec ([`vim.vsan.host.ConfigInfo`_], optional): VSAN configuration for individual hosts. The entries in this array override the cluster default settings as specified in `VsanClusterConfigInfo`_ . - groupSpec (`vim.cluster.GroupSpec`_, optional): + groupSpec ([`vim.cluster.GroupSpec`_], optional): Cluster-wide group configuration. The array contains one or more group specification objects. A group specification object contains a virtual machine group ( `ClusterVmGroup`_ ) or a host group ( `ClusterHostGroup`_ ). Groups can be related; see `ClusterVmHostRuleInfo`_ . diff --git a/docs/vim/cluster/DasAamHostInfo.rst b/docs/vim/cluster/DasAamHostInfo.rst index 282ef48..fba072e 100644 --- a/docs/vim/cluster/DasAamHostInfo.rst +++ b/docs/vim/cluster/DasAamHostInfo.rst @@ -24,9 +24,9 @@ vim.cluster.DasAamHostInfo Attributes: - hostDasState (`vim.cluster.DasAamNodeState`_, optional): + hostDasState ([`vim.cluster.DasAamNodeState`_], optional): The state of HA on the hosts. - primaryHosts (`str`_, optional): + primaryHosts ([`str`_], optional): The list of primary hosts. diff --git a/docs/vim/cluster/DasAdvancedRuntimeInfo.rst b/docs/vim/cluster/DasAdvancedRuntimeInfo.rst index 18070d5..03678ae 100644 --- a/docs/vim/cluster/DasAdvancedRuntimeInfo.rst +++ b/docs/vim/cluster/DasAdvancedRuntimeInfo.rst @@ -17,6 +17,6 @@ Attributes: dasHostInfo (`vim.cluster.DasHostInfo`_, optional): The information pertaining to the HA agents on the hosts - heartbeatDatastoreInfo (`vim.cluster.DasAdvancedRuntimeInfo.HeartbeatDatastoreInfo`_, optional): + heartbeatDatastoreInfo ([`vim.cluster.DasAdvancedRuntimeInfo.HeartbeatDatastoreInfo`_], optional): The map of a datastore to the set of hosts that are using the datastore for storage heartbeating. diff --git a/docs/vim/cluster/DasAdvancedRuntimeInfo/HeartbeatDatastoreInfo.rst b/docs/vim/cluster/DasAdvancedRuntimeInfo/HeartbeatDatastoreInfo.rst index dc5628b..12b9f18 100644 --- a/docs/vim/cluster/DasAdvancedRuntimeInfo/HeartbeatDatastoreInfo.rst +++ b/docs/vim/cluster/DasAdvancedRuntimeInfo/HeartbeatDatastoreInfo.rst @@ -16,5 +16,5 @@ vim.cluster.DasAdvancedRuntimeInfo.HeartbeatDatastoreInfo Attributes: datastore (`vim.Datastore`_): - hosts (`vim.HostSystem`_): + hosts ([`vim.HostSystem`_]): diff --git a/docs/vim/cluster/DasConfigInfo.rst b/docs/vim/cluster/DasConfigInfo.rst index 290815c..aae6736 100644 --- a/docs/vim/cluster/DasConfigInfo.rst +++ b/docs/vim/cluster/DasConfigInfo.rst @@ -97,10 +97,10 @@ Attributes: defaultVmSettings (`vim.cluster.DasVmSettings`_, optional): Cluster-wide defaults for virtual machine HA settings. When a virtual machine has no HA configuration ( `ClusterDasVmConfigSpec`_ ), it uses the values specified here. - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Advanced settings. - heartbeatDatastore (`vim.Datastore`_, optional): + heartbeatDatastore ([`vim.Datastore`_], optional): The list of preferred datastores to use for storage heartbeating. Each of the specified datastores should be active and mounted by more than one host. There is no limit on the number of specified datastores and no priority among them. The specified datastores will replace those previously specified and an empty list will delete all such earlier specified ones.vCenter Server chooses the heartbeat datastores for a host from the set specified by `hBDatastoreCandidatePolicy`_ . The choice is made based on datastore connectivity and storage array redundancy (in case of VMFS).The final set of selected heartbeat datastores is reported via `heartbeatDatastoreInfo`_ . hBDatastoreCandidatePolicy (`str`_, optional): diff --git a/docs/vim/cluster/DasFailoverLevelAdvancedRuntimeInfo.rst b/docs/vim/cluster/DasFailoverLevelAdvancedRuntimeInfo.rst index 6ab68cd..947dbb9 100644 --- a/docs/vim/cluster/DasFailoverLevelAdvancedRuntimeInfo.rst +++ b/docs/vim/cluster/DasFailoverLevelAdvancedRuntimeInfo.rst @@ -45,8 +45,8 @@ Attributes: totalGoodHosts (`int`_): The total number of connected hosts that are not in maintance mode and that do not have any DAS-related config issues on them. - hostSlots (`vim.cluster.DasFailoverLevelAdvancedRuntimeInfo.HostSlots`_, optional): + hostSlots ([`vim.cluster.DasFailoverLevelAdvancedRuntimeInfo.HostSlots`_], optional): - vmsRequiringMultipleSlots (`vim.cluster.DasFailoverLevelAdvancedRuntimeInfo.VmSlots`_, optional): + vmsRequiringMultipleSlots ([`vim.cluster.DasFailoverLevelAdvancedRuntimeInfo.VmSlots`_], optional): The list of virtual machines whose reservations and memory overhead are not satisfied by a single slot. diff --git a/docs/vim/cluster/DpmConfigInfo.rst b/docs/vim/cluster/DpmConfigInfo.rst index b72d33a..0dbf6df 100644 --- a/docs/vim/cluster/DpmConfigInfo.rst +++ b/docs/vim/cluster/DpmConfigInfo.rst @@ -29,6 +29,6 @@ Attributes: hostPowerActionRate (`int`_, optional): DPM generates only those recommendations that are above the specified rating. Ratings vary from 1 to 5. This setting applies to both manual and automated (@link DpmBehavior) DPM clusters. - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Advanced settings. diff --git a/docs/vim/cluster/DrsConfigInfo.rst b/docs/vim/cluster/DrsConfigInfo.rst index 2cd9fad..79635bf 100644 --- a/docs/vim/cluster/DrsConfigInfo.rst +++ b/docs/vim/cluster/DrsConfigInfo.rst @@ -43,6 +43,6 @@ Attributes: vmotionRate (`int`_, optional): Threshold for generated `ClusterRecommendation`_ s. DRS generates only those recommendations that are above the specified vmotionRate. Ratings vary from 1 to 5. This setting applies to manual, partiallyAutomated, and fullyAutomated DRS clusters. See `DrsBehavior`_ . - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Advanced settings. diff --git a/docs/vim/cluster/DrsFaults.rst b/docs/vim/cluster/DrsFaults.rst index 11bab05..185f286 100644 --- a/docs/vim/cluster/DrsFaults.rst +++ b/docs/vim/cluster/DrsFaults.rst @@ -17,6 +17,6 @@ Attributes: reason (`str`_): A reason code explaining why this set of recommendations were attempted by DRS when it generated the faults. - faultsByVm (`vim.cluster.DrsFaults.FaultsByVm`_): + faultsByVm ([`vim.cluster.DrsFaults.FaultsByVm`_]): The faults grouped by VMs that DRS was trying to migrate. diff --git a/docs/vim/cluster/DrsFaults/FaultsByVm.rst b/docs/vim/cluster/DrsFaults/FaultsByVm.rst index b632c91..586fb19 100644 --- a/docs/vim/cluster/DrsFaults/FaultsByVm.rst +++ b/docs/vim/cluster/DrsFaults/FaultsByVm.rst @@ -17,6 +17,6 @@ Attributes: vm (`vim.VirtualMachine`_, optional): The VM that DRS was trying to migrate when it generated the faults. If this property is NULL, the fault is not associated with a particular VM. - fault (`vmodl.LocalizedMethodFault`_): + fault ([`vmodl.LocalizedMethodFault`_]): The faults generated by DRS when it was trying to move the given VM. diff --git a/docs/vim/cluster/DrsRecommendation.rst b/docs/vim/cluster/DrsRecommendation.rst index fb199b5..70bfc93 100644 --- a/docs/vim/cluster/DrsRecommendation.rst +++ b/docs/vim/cluster/DrsRecommendation.rst @@ -27,5 +27,5 @@ Attributes: reasonText (`str`_): Text that provides more information about the reason code for the suggested set of migrations. - migrationList (`vim.cluster.DrsMigration`_): + migrationList ([`vim.cluster.DrsMigration`_]): diff --git a/docs/vim/cluster/EnterMaintenanceResult.rst b/docs/vim/cluster/EnterMaintenanceResult.rst index 90a3f55..64ceae6 100644 --- a/docs/vim/cluster/EnterMaintenanceResult.rst +++ b/docs/vim/cluster/EnterMaintenanceResult.rst @@ -20,7 +20,7 @@ vim.cluster.EnterMaintenanceResult :since: `vSphere API 5.0`_ Attributes: - recommendations (`vim.cluster.Recommendation`_, optional): + recommendations ([`vim.cluster.Recommendation`_], optional): The list of recommendations for hosts that Virtual Center will be able to evacuate. Each recommendation consists of a host maintenance action `ClusterAction`_ for a host, along with zero or more vmotions for evacuation. Application of the recommendations is not supported currently. The client will have to put the hosts into maintenance mode by calling the separate method `EnterMaintenanceMode_Task`_ . fault (`vim.cluster.DrsFaults`_, optional): diff --git a/docs/vim/cluster/FailoverHostAdmissionControlInfo.rst b/docs/vim/cluster/FailoverHostAdmissionControlInfo.rst index b7d6667..2ae525c 100644 --- a/docs/vim/cluster/FailoverHostAdmissionControlInfo.rst +++ b/docs/vim/cluster/FailoverHostAdmissionControlInfo.rst @@ -12,6 +12,6 @@ vim.cluster.FailoverHostAdmissionControlInfo :since: `vSphere API 4.0`_ Attributes: - hostStatus (`vim.cluster.FailoverHostAdmissionControlInfo.HostStatus`_, optional): + hostStatus ([`vim.cluster.FailoverHostAdmissionControlInfo.HostStatus`_], optional): Status of the failover hosts in the cluster. diff --git a/docs/vim/cluster/FailoverHostAdmissionControlPolicy.rst b/docs/vim/cluster/FailoverHostAdmissionControlPolicy.rst index fe5e231..cdfc92e 100644 --- a/docs/vim/cluster/FailoverHostAdmissionControlPolicy.rst +++ b/docs/vim/cluster/FailoverHostAdmissionControlPolicy.rst @@ -20,6 +20,6 @@ vim.cluster.FailoverHostAdmissionControlPolicy :since: `vSphere API 4.0`_ Attributes: - failoverHosts (`vim.HostSystem`_, optional): + failoverHosts ([`vim.HostSystem`_], optional): List of managed object references to failover hosts. diff --git a/docs/vim/cluster/HostGroup.rst b/docs/vim/cluster/HostGroup.rst index 04839c2..b570093 100644 --- a/docs/vim/cluster/HostGroup.rst +++ b/docs/vim/cluster/HostGroup.rst @@ -16,6 +16,6 @@ vim.cluster.HostGroup :since: `vSphere API 4.1`_ Attributes: - host (`vim.HostSystem`_, optional): + host ([`vim.HostSystem`_], optional): List of hosts that are part of this group. A host group can contain zero or more hosts. diff --git a/docs/vim/cluster/PowerOnVmResult.rst b/docs/vim/cluster/PowerOnVmResult.rst index 95ad34c..ee809f3 100644 --- a/docs/vim/cluster/PowerOnVmResult.rst +++ b/docs/vim/cluster/PowerOnVmResult.rst @@ -18,12 +18,12 @@ vim.cluster.PowerOnVmResult :since: `VI API 2.5`_ Attributes: - attempted (`vim.cluster.AttemptedVmInfo`_, optional): + attempted ([`vim.cluster.AttemptedVmInfo`_], optional): The list of virtual machines the Virtual Center has attempted to power on. For a virtual machine not managed by DRS, a task ID is also returned. - notAttempted (`vim.cluster.NotAttemptedVmInfo`_, optional): + notAttempted ([`vim.cluster.NotAttemptedVmInfo`_], optional): The list of virtual machines DRS can not find suitable hosts for powering on. There is one fault associated with each virtual machine. - recommendations (`vim.cluster.Recommendation`_, optional): + recommendations ([`vim.cluster.Recommendation`_], optional): The list of recommendations that need the client to approve manually. diff --git a/docs/vim/cluster/Recommendation.rst b/docs/vim/cluster/Recommendation.rst index 01331c6..b40f121 100644 --- a/docs/vim/cluster/Recommendation.rst +++ b/docs/vim/cluster/Recommendation.rst @@ -38,10 +38,10 @@ Attributes: reasonText (`str`_): Text that provides more information about the reason code for the suggested set of migrations. - prerequisite (`str`_, optional): + prerequisite ([`str`_], optional): This recommendation may depend on some other recommendations. The prerequisite recommendations are listed by their keys. - action (`vim.cluster.Action`_, optional): + action ([`vim.cluster.Action`_], optional): List of actions that are executed as part of this recommendation target (`vmodl.ManagedObject`_, optional): diff --git a/docs/vim/cluster/VmGroup.rst b/docs/vim/cluster/VmGroup.rst index 3c08ddf..68cba1c 100644 --- a/docs/vim/cluster/VmGroup.rst +++ b/docs/vim/cluster/VmGroup.rst @@ -16,6 +16,6 @@ vim.cluster.VmGroup :since: `vSphere API 4.1`_ Attributes: - vm (`vim.VirtualMachine`_, optional): + vm ([`vim.VirtualMachine`_], optional): List of virtual machines that are part of this group. A virtual machine group can contain zero or more virtual machines. diff --git a/docs/vim/dvs/DistributedVirtualPort/ConfigInfo.rst b/docs/vim/dvs/DistributedVirtualPort/ConfigInfo.rst index 63fe25f..0178f41 100644 --- a/docs/vim/dvs/DistributedVirtualPort/ConfigInfo.rst +++ b/docs/vim/dvs/DistributedVirtualPort/ConfigInfo.rst @@ -19,7 +19,7 @@ Attributes: name (`str`_, optional): The name of the port. - scope (`vim.ManagedEntity`_, optional): + scope ([`vim.ManagedEntity`_], optional): The eligible entities that can connect to the port. If unset, there is no restriction on which entity can connect to the port. If set, only the entities in the specified list or their child entities are allowed to connect to the port. If scopes are defined at both port and portgroup level, they are taken as an "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception. description (`str`_, optional): diff --git a/docs/vim/dvs/DistributedVirtualPort/ConfigSpec.rst b/docs/vim/dvs/DistributedVirtualPort/ConfigSpec.rst index 6dc4503..6d7dfaf 100644 --- a/docs/vim/dvs/DistributedVirtualPort/ConfigSpec.rst +++ b/docs/vim/dvs/DistributedVirtualPort/ConfigSpec.rst @@ -35,7 +35,7 @@ Attributes: name (`str`_, optional): The name of the port. - scope (`vim.ManagedEntity`_, optional): + scope ([`vim.ManagedEntity`_], optional): The eligible entities that can connect to the port, for detail see `scope`_ . description (`str`_, optional): diff --git a/docs/vim/dvs/DistributedVirtualPort/FilterParameter.rst b/docs/vim/dvs/DistributedVirtualPort/FilterParameter.rst index 84ea958..c5f0e45 100644 --- a/docs/vim/dvs/DistributedVirtualPort/FilterParameter.rst +++ b/docs/vim/dvs/DistributedVirtualPort/FilterParameter.rst @@ -12,6 +12,6 @@ vim.dvs.DistributedVirtualPort.FilterParameter :since: `vSphere API 5.5`_ Attributes: - parameters (`str`_, optional): + parameters ([`str`_], optional): List of parameters for a Network Filter. diff --git a/docs/vim/dvs/DistributedVirtualPort/FilterPolicy.rst b/docs/vim/dvs/DistributedVirtualPort/FilterPolicy.rst index cd72f4d..9fcfb51 100644 --- a/docs/vim/dvs/DistributedVirtualPort/FilterPolicy.rst +++ b/docs/vim/dvs/DistributedVirtualPort/FilterPolicy.rst @@ -18,6 +18,6 @@ vim.dvs.DistributedVirtualPort.FilterPolicy :since: `vSphere API 5.5`_ Attributes: - filterConfig (`vim.dvs.DistributedVirtualPort.FilterConfig`_, optional): + filterConfig ([`vim.dvs.DistributedVirtualPort.FilterConfig`_], optional): List of Network Filter Configurations. In an update operation, the array can contain all `DvsTrafficFilterConfigSpec`_ objects or all `DvsFilterConfig`_ and `DvsTrafficFilterConfig`_ object, but not mixed of Config and Spec objects. If array of FilterConfigSpec and TrafficFilterConfigSpec is used for updating Network Filter then only the Network Filters matching `key`_ / `key`_ is updated. If array of `DvsFilterConfig`_ and `DvsTrafficFilterConfig`_ is used for updating port settings, the Network Filter settings will be overridden with the new array specified. The specified array should only contain FilterConfig and TrafficFilterConfig objects with FilterConfig#inherited / TrafficFilterConfig#inherited set to false. FilterConfig/TrafficFilterConfig objects with FilterConfig#inherited/TrafficFilterConfig#inherited as true in the specified array will be ignored. The updated result will include FilterConfig/TrafficFilterConfig objects inherited from parent, if any. diff --git a/docs/vim/dvs/DistributedVirtualPort/RuntimeInfo.rst b/docs/vim/dvs/DistributedVirtualPort/RuntimeInfo.rst index e006532..5d80485 100644 --- a/docs/vim/dvs/DistributedVirtualPort/RuntimeInfo.rst +++ b/docs/vim/dvs/DistributedVirtualPort/RuntimeInfo.rst @@ -46,7 +46,7 @@ Attributes: blocked (`bool`_): Indicates whether the port is blocked by switch implementation. - vlanIds (`vim.NumericRange`_, optional): + vlanIds ([`vim.NumericRange`_], optional): VLAN ID of the port. trunkingMode (`bool`_, optional): @@ -67,10 +67,10 @@ Attributes: vmDirectPathGen2Active (`bool`_, optional): Indicates whether VMDirectPath Gen 2 is active on this port. If false, the reason(s) for inactivity will be provided in one or more of `vmDirectPathGen2InactiveReasonNetwork`_ , `vmDirectPathGen2InactiveReasonOther`_ , and `vmDirectPathGen2InactiveReasonExtended`_ .If the host software is not capable of VMDirectPath Gen 2, this property will be unset. See `HostCapability`_ . `vmDirectPathGen2Supported`_ . - vmDirectPathGen2InactiveReasonNetwork (`str`_, optional): + vmDirectPathGen2InactiveReasonNetwork ([`str`_], optional): If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are related to network state or configuration. The reasons are chosen from the `DVPortStatusVmDirectPathGen2InactiveReasonNetwork`_ values.Other reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonOther`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive. - vmDirectPathGen2InactiveReasonOther (`str`_, optional): + vmDirectPathGen2InactiveReasonOther ([`str`_], optional): If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are not related to network state or configuration. The reasons are chosen from the `DVPortStatusVmDirectPathGen2InactiveReasonOther`_ values.Network-related reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonNetwork`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive.See `vmDirectPathGen2Supported`_ vmDirectPathGen2InactiveReasonExtended (`str`_, optional): diff --git a/docs/vim/dvs/DistributedVirtualPort/State.rst b/docs/vim/dvs/DistributedVirtualPort/State.rst index 018eff4..61a9012 100644 --- a/docs/vim/dvs/DistributedVirtualPort/State.rst +++ b/docs/vim/dvs/DistributedVirtualPort/State.rst @@ -22,6 +22,6 @@ Attributes: stats (`vim.dvs.PortStatistics`_): Statistics of the port. - vendorSpecificState (`vim.dvs.KeyedOpaqueBlob`_, optional): + vendorSpecificState ([`vim.dvs.KeyedOpaqueBlob`_], optional): Opaque binary blob that stores vendor-specific runtime state data. diff --git a/docs/vim/dvs/DistributedVirtualPort/VendorSpecificConfig.rst b/docs/vim/dvs/DistributedVirtualPort/VendorSpecificConfig.rst index c256d9d..d9f5194 100644 --- a/docs/vim/dvs/DistributedVirtualPort/VendorSpecificConfig.rst +++ b/docs/vim/dvs/DistributedVirtualPort/VendorSpecificConfig.rst @@ -12,6 +12,6 @@ vim.dvs.DistributedVirtualPort.VendorSpecificConfig :since: `vSphere API 4.0`_ Attributes: - keyValue (`vim.dvs.KeyedOpaqueBlob`_, optional): + keyValue ([`vim.dvs.KeyedOpaqueBlob`_], optional): An opaque binary blob that stores vendor specific configuration. diff --git a/docs/vim/dvs/DistributedVirtualPortgroup.rst b/docs/vim/dvs/DistributedVirtualPortgroup.rst index 2adfc35..802d98e 100644 --- a/docs/vim/dvs/DistributedVirtualPortgroup.rst +++ b/docs/vim/dvs/DistributedVirtualPortgroup.rst @@ -68,7 +68,7 @@ Attributes Generated UUID of the portgroup. config (`vim.dvs.DistributedVirtualPortgroup.ConfigInfo`_): Configuration of the portgroup. - portKeys (`str`_): + portKeys ([`str`_]): Port keys for the set of ports in the portgroup. diff --git a/docs/vim/dvs/DistributedVirtualPortgroup/ConfigInfo.rst b/docs/vim/dvs/DistributedVirtualPortgroup/ConfigInfo.rst index 0855854..bf5fbd8 100644 --- a/docs/vim/dvs/DistributedVirtualPortgroup/ConfigInfo.rst +++ b/docs/vim/dvs/DistributedVirtualPortgroup/ConfigInfo.rst @@ -61,10 +61,10 @@ Attributes: portNameFormat (`str`_, optional): If set, a name will be automatically generated based on this format string for a port when it is created in or moved into the portgroup. The format string can contain meta tags that will be resolved to the corresponding values in generating a name, if applicable for the port at the time of name generation.To insert a meta tag in the format string, enclose the names defined as meta tag names inside angle brackets. See `DistributedVirtualPortgroupMetaTagName`_ for a list of currently available meta tags. For example, "redNetwork-portIndex" and "dvsName-pnicportIndex" result in generated port names like "redNetwork-2" and "switch-pnic3".If a meta tag is recognized, but there is no applicable value, the tag will be expanded to empty string. If an arbitrary name appears inside a "" pair and is not recognized as one of the defined meta tags, the substring is treated as-is and appear unchanged in the generated name.To prevent a meta tag from being expanded, prefix the meta tag with a '\' (backslash). For example, the format string "abc\portIndexdef" results in the generated port name "abcportIndexdef". - scope (`vim.ManagedEntity`_, optional): + scope ([`vim.ManagedEntity`_], optional): Eligible entities that can connect to the portgroup. If unset, there is no restriction on which entity can connect to the portgroup. If set, only the entities in the specified list or their child entities are allowed to connect to the portgroup. If scopes are defined at both port and portgroup level, they are taken as an "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception. - vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional): + vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional): Opaque binary blob that stores vendor specific configuration. configVersion (`str`_, optional): diff --git a/docs/vim/dvs/DistributedVirtualPortgroup/ConfigSpec.rst b/docs/vim/dvs/DistributedVirtualPortgroup/ConfigSpec.rst index da8b6ce..f6f6f4a 100644 --- a/docs/vim/dvs/DistributedVirtualPortgroup/ConfigSpec.rst +++ b/docs/vim/dvs/DistributedVirtualPortgroup/ConfigSpec.rst @@ -61,13 +61,13 @@ Attributes: type (`str`_, optional): Type of portgroup. See `DistributedVirtualPortgroup`_ . `DistributedVirtualPortgroupPortgroupType`_ for possible values. - scope (`vim.ManagedEntity`_, optional): + scope ([`vim.ManagedEntity`_], optional): Eligible entities that can connect to the port. See `DVPortgroupConfigInfo`_ . `scope`_ . policy (`vim.dvs.DistributedVirtualPortgroup.PortgroupPolicy`_, optional): Portgroup policy. - vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional): + vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional): Opaque binary blob that stores vendor specific configuration. autoExpand (`bool`_, optional): diff --git a/docs/vim/dvs/DistributedVirtualPortgroupSelection.rst b/docs/vim/dvs/DistributedVirtualPortgroupSelection.rst index 41671f2..097d95b 100644 --- a/docs/vim/dvs/DistributedVirtualPortgroupSelection.rst +++ b/docs/vim/dvs/DistributedVirtualPortgroupSelection.rst @@ -15,6 +15,6 @@ Attributes: dvsUuid (`str`_): vSphere Distributed Switch uuid - portgroupKey (`str`_): + portgroupKey ([`str`_]): List of vNetwork Distributed Portgroup keys diff --git a/docs/vim/dvs/DistributedVirtualSwitchManager.rst b/docs/vim/dvs/DistributedVirtualSwitchManager.rst index b92c961..ed349f7 100644 --- a/docs/vim/dvs/DistributedVirtualSwitchManager.rst +++ b/docs/vim/dvs/DistributedVirtualSwitchManager.rst @@ -100,7 +100,7 @@ QueryAvailableDvsSpec(): Returns: - `vim.dvs.ProductSpec`_: + [`vim.dvs.ProductSpec`_]: @@ -129,7 +129,7 @@ QueryCompatibleHostForNewDvs(container, recursive, switchProductSpec): Returns: - `vim.HostSystem`_: + [`vim.HostSystem`_]: Raises: @@ -163,7 +163,7 @@ QueryCompatibleHostForExistingDvs(container, recursive, dvs): Returns: - `vim.HostSystem`_: + [`vim.HostSystem`_]: Raises: @@ -189,7 +189,7 @@ QueryDvsCompatibleHostSpec(switchProductSpec): Returns: - `vim.dvs.HostProductSpec`_: + [`vim.dvs.HostProductSpec`_]: Raises: @@ -304,7 +304,7 @@ QueryDvsCheckCompatibility(hostContainer, dvsProductSpec, hostFilterSpec): Returns: - `vim.dvs.DistributedVirtualSwitchManager.CompatibilityResult`_: + [`vim.dvs.DistributedVirtualSwitchManager.CompatibilityResult`_]: Raises: diff --git a/docs/vim/dvs/DistributedVirtualSwitchManager/CompatibilityResult.rst b/docs/vim/dvs/DistributedVirtualSwitchManager/CompatibilityResult.rst index 1046b8e..ac7902f 100644 --- a/docs/vim/dvs/DistributedVirtualSwitchManager/CompatibilityResult.rst +++ b/docs/vim/dvs/DistributedVirtualSwitchManager/CompatibilityResult.rst @@ -17,6 +17,6 @@ Attributes: host (`vim.HostSystem`_): The host for which results are annotated. The whole object will be filtered out if the caller did not have view permissions on the host entity. - error (`vmodl.LocalizedMethodFault`_, optional): + error ([`vmodl.LocalizedMethodFault`_], optional): This property contains the faults that makes the host not compatible with a given DvsProductSpec. For example, a host might not be compatible because it's an older version of ESX that doesn't support DVS. diff --git a/docs/vim/dvs/DistributedVirtualSwitchManager/DvsConfigTarget.rst b/docs/vim/dvs/DistributedVirtualSwitchManager/DvsConfigTarget.rst index aa55c74..fb5fad2 100644 --- a/docs/vim/dvs/DistributedVirtualSwitchManager/DvsConfigTarget.rst +++ b/docs/vim/dvs/DistributedVirtualSwitchManager/DvsConfigTarget.rst @@ -14,9 +14,9 @@ vim.dvs.DistributedVirtualSwitchManager.DvsConfigTarget :since: `vSphere API 4.0`_ Attributes: - distributedVirtualPortgroup (`vim.dvs.DistributedVirtualPortgroupInfo`_, optional): + distributedVirtualPortgroup ([`vim.dvs.DistributedVirtualPortgroupInfo`_], optional): List of any DistributedVirtualPortgroup available for host Virtual NIC connection. - distributedVirtualSwitch (`vim.dvs.DistributedVirtualSwitchInfo`_, optional): + distributedVirtualSwitch ([`vim.dvs.DistributedVirtualSwitchInfo`_], optional): List of any DistributedVirtualSwitch available for host Virtual NIC connection. diff --git a/docs/vim/dvs/DistributedVirtualSwitchManager/HostArrayFilter.rst b/docs/vim/dvs/DistributedVirtualSwitchManager/HostArrayFilter.rst index 009a084..6d34b10 100644 --- a/docs/vim/dvs/DistributedVirtualSwitchManager/HostArrayFilter.rst +++ b/docs/vim/dvs/DistributedVirtualSwitchManager/HostArrayFilter.rst @@ -12,6 +12,6 @@ vim.dvs.DistributedVirtualSwitchManager.HostArrayFilter :since: `vSphere API 4.1`_ Attributes: - host (`vim.HostSystem`_): + host ([`vim.HostSystem`_]): List of hosts to consider. diff --git a/docs/vim/dvs/DistributedVirtualSwitchManager/ImportResult.rst b/docs/vim/dvs/DistributedVirtualSwitchManager/ImportResult.rst index 3e87d56..ff36835 100644 --- a/docs/vim/dvs/DistributedVirtualSwitchManager/ImportResult.rst +++ b/docs/vim/dvs/DistributedVirtualSwitchManager/ImportResult.rst @@ -20,12 +20,12 @@ vim.dvs.DistributedVirtualSwitchManager.ImportResult :since: `vSphere API 5.1`_ Attributes: - distributedVirtualSwitch (`vim.DistributedVirtualSwitch`_, optional): + distributedVirtualSwitch ([`vim.DistributedVirtualSwitch`_], optional): List of distributed virtual switches. - distributedVirtualPortgroup (`vim.dvs.DistributedVirtualPortgroup`_, optional): + distributedVirtualPortgroup ([`vim.dvs.DistributedVirtualPortgroup`_], optional): List of distributed virtual portgroups. - importFault (`vim.fault.ImportOperationBulkFault.FaultOnImport`_, optional): + importFault ([`vim.fault.ImportOperationBulkFault.FaultOnImport`_], optional): Faults that occurred on the entities during the import operation. diff --git a/docs/vim/dvs/HostMember.rst b/docs/vim/dvs/HostMember.rst index a236830..20599d5 100644 --- a/docs/vim/dvs/HostMember.rst +++ b/docs/vim/dvs/HostMember.rst @@ -37,7 +37,7 @@ Attributes: productInfo (`vim.dvs.ProductSpec`_, optional): Vendor, product and version information for the proxy switch module. - uplinkPortKey (`str`_, optional): + uplinkPortKey ([`str`_], optional): Port keys of the uplink ports created for the host member. These ports will be deleted after the host leaves the switch. status (`str`_): diff --git a/docs/vim/dvs/HostMember/ConfigInfo.rst b/docs/vim/dvs/HostMember/ConfigInfo.rst index 419c35d..27d106a 100644 --- a/docs/vim/dvs/HostMember/ConfigInfo.rst +++ b/docs/vim/dvs/HostMember/ConfigInfo.rst @@ -26,7 +26,7 @@ Attributes: maxProxySwitchPorts (`int`_): Maximum number of ports than can be created in the proxy switch.ESXi 5.0 and earlier hosts: If you change the maximum number of ports, you must reboot the host for the new value to take effect. - vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional): + vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional): Opaque binary blob that stores vendor specific configuration. backing (`vim.dvs.HostMember.Backing`_): diff --git a/docs/vim/dvs/HostMember/ConfigSpec.rst b/docs/vim/dvs/HostMember/ConfigSpec.rst index 565b3ef..c84edca 100644 --- a/docs/vim/dvs/HostMember/ConfigSpec.rst +++ b/docs/vim/dvs/HostMember/ConfigSpec.rst @@ -42,6 +42,6 @@ Attributes: maxProxySwitchPorts (`int`_, optional): Maximum number of ports allowed in the `HostProxySwitch`_ .ESXi 5.0 and earlier hosts: If you are reconfiguring an existing host membership, that is, the proxy switch already exists, you must reboot the host for the new setting to take effect. - vendorSpecificConfig (`vim.dvs.KeyedOpaqueBlob`_, optional): + vendorSpecificConfig ([`vim.dvs.KeyedOpaqueBlob`_], optional): Opaque binary blob that stores vendor specific configuration. diff --git a/docs/vim/dvs/HostMember/PnicBacking.rst b/docs/vim/dvs/HostMember/PnicBacking.rst index d70b789..99912b9 100644 --- a/docs/vim/dvs/HostMember/PnicBacking.rst +++ b/docs/vim/dvs/HostMember/PnicBacking.rst @@ -18,6 +18,6 @@ vim.dvs.HostMember.PnicBacking :since: `vSphere API 4.0`_ Attributes: - pnicSpec (`vim.dvs.HostMember.PnicSpec`_, optional): + pnicSpec ([`vim.dvs.HostMember.PnicSpec`_], optional): List of physical NIC specifications. Each entry identifies a pNIC to the proxy switch and optionally specifies uplink portgroup and port connections for the pNIC. diff --git a/docs/vim/dvs/HostMember/RuntimeInfo.rst b/docs/vim/dvs/HostMember/RuntimeInfo.rst index 6f0ec50..2003289 100644 --- a/docs/vim/dvs/HostMember/RuntimeInfo.rst +++ b/docs/vim/dvs/HostMember/RuntimeInfo.rst @@ -35,6 +35,6 @@ Attributes: statusDetail (`str`_, optional): Additional information regarding the current membership status of the host. This property replaces the deprecated `DistributedVirtualSwitchHostMember`_ . `statusDetail`_ . - healthCheckResult (`vim.dvs.HostMember.HealthCheckResult`_, optional): + healthCheckResult ([`vim.dvs.HostMember.HealthCheckResult`_], optional): Health check result for the host that joined the distributed virtual switch. diff --git a/docs/vim/dvs/PortCriteria.rst b/docs/vim/dvs/PortCriteria.rst index 23c8b4f..12afa22 100644 --- a/docs/vim/dvs/PortCriteria.rst +++ b/docs/vim/dvs/PortCriteria.rst @@ -32,12 +32,12 @@ Attributes: scope (`vim.ManagedEntity`_, optional): If set, only the ports of which the scope covers the entity are qualified. - portgroupKey (`str`_, optional): + portgroupKey ([`str`_], optional): The keys of the portgroup that is used for the scope of `inside`_ . If this property is unset, it means any portgroup. If `inside`_ is unset, this property is ignored. inside (`bool`_, optional): If unset, all ports in the switch are qualified. If set to true, only ports inside `portgroupKey`_ or any portgroup, if not set, are qualified. If set to false, only ports outside `portgroupKey`_ or any portgroup, if not set, are qualified. - portKey (`str`_, optional): + portKey ([`str`_], optional): If set, only the ports of which the key is in the array are qualified. diff --git a/docs/vim/dvs/TrafficRule.rst b/docs/vim/dvs/TrafficRule.rst index e670886..3a3e764 100644 --- a/docs/vim/dvs/TrafficRule.rst +++ b/docs/vim/dvs/TrafficRule.rst @@ -41,7 +41,7 @@ Attributes: sequence (`int`_, optional): Sequence of this rule. i.e, the order in which this rule appears in the ruleset. - qualifier (`vim.dvs.TrafficRule.Qualifier`_, optional): + qualifier ([`vim.dvs.TrafficRule.Qualifier`_], optional): List of Network rule qualifiers. 'AND' of this array of network rule qualifiers is applied as one network traffic rule. If the TrafficRule belongs to `DvsFilterPolicy`_ : There can be a maximum of 1 `DvsIpNetworkRuleQualifier`_ , 1 `DvsMacNetworkRuleQualifier`_ and 1 `DvsSystemTrafficNetworkRuleQualifier`_ for a total of 3 `qualifier`_ If the TrafficRule belongs to `DvsStatefulFirewallPolicy`_ : There can be only 1 `DvsNetworkRuleQualifier`_ in `qualifier`_ action (`vim.dvs.TrafficRule.Action`_, optional): diff --git a/docs/vim/dvs/TrafficRuleset.rst b/docs/vim/dvs/TrafficRuleset.rst index 839208b..44147fc 100644 --- a/docs/vim/dvs/TrafficRuleset.rst +++ b/docs/vim/dvs/TrafficRuleset.rst @@ -27,6 +27,6 @@ Attributes: precedence (`int`_, optional): Precedence of the ruleset. Rulesets for a port will be executed in the order of their precedence. - rules (`vim.dvs.TrafficRule`_, optional): + rules ([`vim.dvs.TrafficRule`_], optional): List of rules belonging to this ruleset. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigInfo.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigInfo.rst index 31413c3..5463d67 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigInfo.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigInfo.rst @@ -28,10 +28,10 @@ vim.dvs.VmwareDistributedVirtualSwitch.ConfigInfo :since: `vSphere API 4.0`_ Attributes: - vspanSession (`vim.dvs.VmwareDistributedVirtualSwitch.VspanSession`_, optional): + vspanSession ([`vim.dvs.VmwareDistributedVirtualSwitch.VspanSession`_], optional): The Distributed Port Mirroring sessions in the switch. - pvlanConfig (`vim.dvs.VmwareDistributedVirtualSwitch.PvlanMapEntry`_, optional): + pvlanConfig ([`vim.dvs.VmwareDistributedVirtualSwitch.PvlanMapEntry`_], optional): The PVLAN configured in the switch. maxMtu (`int`_): @@ -43,7 +43,7 @@ Attributes: ipfixConfig (`vim.dvs.VmwareDistributedVirtualSwitch.IpfixConfig`_, optional): Configuration for ipfix monitoring of the switch traffic. This must be set before ipfix monitoring can be enabled for the switch, or for any portgroup or port of the switch.See `ipfixEnabled`_ - lacpGroupConfig (`vim.dvs.VmwareDistributedVirtualSwitch.LacpGroupConfig`_, optional): + lacpGroupConfig ([`vim.dvs.VmwareDistributedVirtualSwitch.LacpGroupConfig`_], optional): The Link Aggregation Control Protocol groups in the switch. lacpApiVersion (`str`_, optional): diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigSpec.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigSpec.rst index ca668e8..ed620f5 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigSpec.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/ConfigSpec.rst @@ -40,10 +40,10 @@ vim.dvs.VmwareDistributedVirtualSwitch.ConfigSpec :since: `vSphere API 4.0`_ Attributes: - pvlanConfigSpec (`vim.dvs.VmwareDistributedVirtualSwitch.PvlanConfigSpec`_, optional): + pvlanConfigSpec ([`vim.dvs.VmwareDistributedVirtualSwitch.PvlanConfigSpec`_], optional): The PVLAN configuration specification.A `VMwareDVSPvlanMapEntry`_ that has the same value for `primaryVlanId`_ and `secondaryVlanId`_ is referred to as a primary PVLAN entry. Otherwise, the `VMwareDVSPvlanMapEntry`_ is referred to as a secondary PVLAN entry.The `pvlanType`_ of a primary PVLAN entry must be `promiscuous`_ . A secondary PVLAN entry can have a `pvlanType`_ of either `community`_ or `isolated`_ .Primary PVLAN entries must be explicitly added. If there is no primary PVLAN entry corresponding to the `primaryVlanId`_ of a secondary PVLAN entry, a fault is thrown.While deleting a primary PVLAN entry, any associated secondary PVLAN entries must be explicitly deleted. - vspanConfigSpec (`vim.dvs.VmwareDistributedVirtualSwitch.VspanConfigSpec`_, optional): + vspanConfigSpec ([`vim.dvs.VmwareDistributedVirtualSwitch.VspanConfigSpec`_], optional): The Distributed Port Mirroring configuration specification. The VSPAN sessions in the array cannot be of the same key. maxMtu (`int`_, optional): diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/LacpGroupConfig.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/LacpGroupConfig.rst index d4d9491..ddda166 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/LacpGroupConfig.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/LacpGroupConfig.rst @@ -39,9 +39,9 @@ Attributes: ipfix (`vim.dvs.VmwareDistributedVirtualSwitch.LagIpfixConfig`_, optional): Ipfix configuration of the Link Aggregation Control Protocol group. - uplinkName (`str`_, optional): + uplinkName ([`str`_], optional): Names for the Uplink Ports in the group. This property is ignored in an update operation. - uplinkPortKey (`str`_, optional): + uplinkPortKey ([`str`_], optional): Keys for the Uplink Ports in the group. This property is ignored in an update operation. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/LagVlanConfig.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/LagVlanConfig.rst index 68bfe02..be9a974 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/LagVlanConfig.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/LagVlanConfig.rst @@ -14,6 +14,6 @@ vim.dvs.VmwareDistributedVirtualSwitch.LagVlanConfig :since: `vSphere API 5.5`_ Attributes: - vlanId (`vim.NumericRange`_, optional): + vlanId ([`vim.NumericRange`_], optional): The VlanId range for the Uplink Ports in the Link Aggregation Control Protocol group. The valid VlanId range is from 0 to 4094. Overlapping ranges are allowed. If set, this property will override the VLAN configuration of Uplink Ports in the Link Aggregation Control Protocol group. Thus they are no longer inheriting VLAN configuration from their Uplink Port Group. Setting this property would require `vlanOverrideAllowed`_ of all the Uplink Port Groups to be true, otherwise ConflictingConfiguration fault will be raised. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/MtuHealthCheckResult.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/MtuHealthCheckResult.rst index 3e78f51..7de6a0d 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/MtuHealthCheckResult.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/MtuHealthCheckResult.rst @@ -21,9 +21,9 @@ Attributes: mtuMismatch (`bool`_): True if the MTU configured in the vSphere Distributed Switch is different from the value configured in the Physical NIC, else false. If it is true, MTU health check is stopped. In this case, `vlanSupportSwitchMtu`_ and `vlanNotSupportSwitchMtu`_ will not have values. - vlanSupportSwitchMtu (`vim.NumericRange`_, optional): + vlanSupportSwitchMtu ([`vim.NumericRange`_], optional): The vlan's MTU setting on physical switch allows vSphere Distributed Switch max MTU size packets passing. If the vlan is not a range, but a single Id, both start and end have the same value with the single vlan Id. - vlanNotSupportSwitchMtu (`vim.NumericRange`_, optional): + vlanNotSupportSwitchMtu ([`vim.NumericRange`_], optional): The vlan's MTU setting on physical switch does not allow vSphere Distributed Switch max MTU size packets passing. If the vlan is not a range, but a single Id, both start and end have the same value with the single vlan Id. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/TrunkVlanSpec.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/TrunkVlanSpec.rst index 03493d2..d7396b1 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/TrunkVlanSpec.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/TrunkVlanSpec.rst @@ -12,6 +12,6 @@ vim.dvs.VmwareDistributedVirtualSwitch.TrunkVlanSpec :since: `vSphere API 4.0`_ Attributes: - vlanId (`vim.NumericRange`_): + vlanId ([`vim.NumericRange`_]): The VlanId range for the trunk port. The valid VlanId range is from 0 to 4094. Overlapping ranges are allowed. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/UplinkPortOrderPolicy.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/UplinkPortOrderPolicy.rst index 7e1f5d4..dfb53aa 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/UplinkPortOrderPolicy.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/UplinkPortOrderPolicy.rst @@ -12,9 +12,9 @@ vim.dvs.VmwareDistributedVirtualSwitch.UplinkPortOrderPolicy :since: `vSphere API 4.0`_ Attributes: - activeUplinkPort (`str`_, optional): + activeUplinkPort ([`str`_], optional): List of active uplink ports used for load balancing. - standbyUplinkPort (`str`_, optional): + standbyUplinkPort ([`str`_], optional): Standby uplink ports used for failover. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/VlanHealthCheckResult.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/VlanHealthCheckResult.rst index 71bc625..0dd89ed 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/VlanHealthCheckResult.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/VlanHealthCheckResult.rst @@ -12,9 +12,9 @@ vim.dvs.VmwareDistributedVirtualSwitch.VlanHealthCheckResult :since: `vSphere API 5.1`_ Attributes: - trunkedVlan (`vim.NumericRange`_, optional): + trunkedVlan ([`vim.NumericRange`_], optional): The vlans which are trunked by the physical switch connected to the uplink port. If the vlan is not a range, but a single Id, both start and end have the same value with the single vlan Id. - untrunkedVlan (`vim.NumericRange`_, optional): + untrunkedVlan ([`vim.NumericRange`_], optional): The vlans which are not trunked by the physical switch connected to the uplink port. If the vlan is not a range, but a single Id, both start and end have the same value with the single vlan Id. diff --git a/docs/vim/dvs/VmwareDistributedVirtualSwitch/VspanPorts.rst b/docs/vim/dvs/VmwareDistributedVirtualSwitch/VspanPorts.rst index 3421cce..f05167b 100644 --- a/docs/vim/dvs/VmwareDistributedVirtualSwitch/VspanPorts.rst +++ b/docs/vim/dvs/VmwareDistributedVirtualSwitch/VspanPorts.rst @@ -16,18 +16,18 @@ vim.dvs.VmwareDistributedVirtualSwitch.VspanPorts :since: `vSphere API 5.0`_ Attributes: - portKey (`str`_, optional): + portKey ([`str`_], optional): Individual ports to participate in the Distributed Port Mirroring session. - uplinkPortName (`str`_, optional): + uplinkPortName ([`str`_], optional): Uplink ports used as destination ports to participate in the Distributed Port Mirroring session. A fault will be raised if uplinkPortName is used as source ports in any Distributed Port Mirroring session. - wildcardPortConnecteeType (`str`_, optional): + wildcardPortConnecteeType ([`str`_], optional): Wild card specification for source ports participating in the Distributed Port Mirroring session. See `DistributedVirtualSwitchPortConnecteeConnecteeType`_ for valid values. Any port that has a connectee of the specified type has its receive traffic mirrored. A fault will be raised if wildcards are specified as destination ports or source ports mirroring traffic on the transmit side. It is to be not used. - vlans (`int`_, optional): + vlans ([`int`_], optional): Vlan Ids for ingress source of Remote Mirror destination session. - ipAddress (`str`_, optional): + ipAddress ([`str`_], optional): IP address for the destination of encapsulated remote mirror source session, IPv4 address is specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. diff --git a/docs/vim/event/DvsOutOfSyncHostArgument.rst b/docs/vim/event/DvsOutOfSyncHostArgument.rst index 89a5467..c824e05 100644 --- a/docs/vim/event/DvsOutOfSyncHostArgument.rst +++ b/docs/vim/event/DvsOutOfSyncHostArgument.rst @@ -17,6 +17,6 @@ Attributes: outOfSyncHost (`vim.event.HostEventArgument`_): The host. - configParamters (`str`_): + configParamters ([`str`_]): The DVS configuration parameters that are different between Virtual Center server and the host. diff --git a/docs/vim/event/DvsPortCreatedEvent.rst b/docs/vim/event/DvsPortCreatedEvent.rst index 4f067ef..757d0bc 100644 --- a/docs/vim/event/DvsPortCreatedEvent.rst +++ b/docs/vim/event/DvsPortCreatedEvent.rst @@ -12,6 +12,6 @@ vim.event.DvsPortCreatedEvent :since: `vSphere API 4.0`_ Attributes: - portKey (`str`_): + portKey ([`str`_]): The key of the ports that are created. diff --git a/docs/vim/event/DvsPortDeletedEvent.rst b/docs/vim/event/DvsPortDeletedEvent.rst index 7c8232f..4b6f15f 100644 --- a/docs/vim/event/DvsPortDeletedEvent.rst +++ b/docs/vim/event/DvsPortDeletedEvent.rst @@ -12,6 +12,6 @@ vim.event.DvsPortDeletedEvent :since: `vSphere API 4.0`_ Attributes: - portKey (`str`_): + portKey ([`str`_]): The key of the ports that are deleted. diff --git a/docs/vim/event/DvsPortReconfiguredEvent.rst b/docs/vim/event/DvsPortReconfiguredEvent.rst index 66dd965..32e204d 100644 --- a/docs/vim/event/DvsPortReconfiguredEvent.rst +++ b/docs/vim/event/DvsPortReconfiguredEvent.rst @@ -12,6 +12,6 @@ vim.event.DvsPortReconfiguredEvent :since: `vSphere API 4.0`_ Attributes: - portKey (`str`_): + portKey ([`str`_]): The key of the ports that are reconfigured. diff --git a/docs/vim/event/EventDescription.rst b/docs/vim/event/EventDescription.rst index ff4b136..5a3222f 100644 --- a/docs/vim/event/EventDescription.rst +++ b/docs/vim/event/EventDescription.rst @@ -15,12 +15,12 @@ vim.event.EventDescription :extends: vmodl.DynamicData_ Attributes: - category (`vim.ElementDescription`_): + category ([`vim.ElementDescription`_]): `Event Category enum`_ - eventInfo (`vim.event.EventDescription.EventDetail`_): + eventInfo ([`vim.event.EventDescription.EventDetail`_]): The event class description details. - enumeratedTypes (`vim.EnumDescription`_, optional): + enumeratedTypes ([`vim.EnumDescription`_], optional): Localized descriptions of all enumerated types that are used for member declarations in event classes. diff --git a/docs/vim/event/EventEx.rst b/docs/vim/event/EventEx.rst index 4f9a0e0..52267ee 100644 --- a/docs/vim/event/EventEx.rst +++ b/docs/vim/event/EventEx.rst @@ -27,7 +27,7 @@ Attributes: message (`str`_, optional): An arbitrary message string, not localized. - arguments (`vmodl.KeyAnyValue`_, optional): + arguments ([`vmodl.KeyAnyValue`_], optional): The event arguments associated with the event objectId (`str`_, optional): diff --git a/docs/vim/event/EventFilterSpec.rst b/docs/vim/event/EventFilterSpec.rst index 541369f..a905783 100644 --- a/docs/vim/event/EventFilterSpec.rst +++ b/docs/vim/event/EventFilterSpec.rst @@ -54,16 +54,16 @@ Attributes: disableFullMessage (`bool`_, optional): Flag to specify whether or not to prepare the full formatted message for each event. If the property is not set, the collected events do not include the full formatted message. - category (`str`_, optional): + category ([`str`_], optional): This property, if set, limits the set of collected events to those associated with the specified category. If the property is not set, events are collected regardless of their association with any category. "category" here is the same as Event.severity. - type (`str`_, optional): + type ([`str`_], optional): This property, if set, limits the set of collected events to those specified types. If the property is not set, events are collected regardless of their types. - tag (`str`_, optional): + tag ([`str`_], optional): This property, if set, limits the set of filtered events to those that have it. If not set, or the size of it 0, the tag of an event is disregarded. A blank string indicates events without tags. - eventTypeId (`str`_, optional): + eventTypeId ([`str`_], optional): This property, if set, limits the set of collected events to those specified types.Note: if both `eventTypeId`_ and `type`_ are specified, an exception may be thrown by `CreateCollectorForEvents`_ .The semantics of how eventTypeId matching is done is as follows: * If the event being collected is of type diff --git a/docs/vim/event/EventFilterSpec/ByUsername.rst b/docs/vim/event/EventFilterSpec/ByUsername.rst index dcba209..4ac5251 100644 --- a/docs/vim/event/EventFilterSpec/ByUsername.rst +++ b/docs/vim/event/EventFilterSpec/ByUsername.rst @@ -14,6 +14,6 @@ Attributes: systemUser (`bool`_): filter by system user true for system user event - userList (`str`_, optional): + userList ([`str`_], optional): all interested username list If this property is not set, then all regular user events are collected diff --git a/docs/vim/event/EventHistoryCollector.rst b/docs/vim/event/EventHistoryCollector.rst index a76cc09..3582317 100644 --- a/docs/vim/event/EventHistoryCollector.rst +++ b/docs/vim/event/EventHistoryCollector.rst @@ -21,7 +21,7 @@ vim.event.EventHistoryCollector Attributes ---------- - latestPage (`vim.event.Event`_): + latestPage ([`vim.event.Event`_]): The items in the 'viewable latest page'. As new events that match the collector's `EventFilterSpec`_ are created, they are added to this page, and the oldest events are removed from the collector to keep the size of the page to that allowed by HistoryCollector#setLatestPageSize.The "oldest event" is the one with the smallest key (event ID). The events in the returned page are unordered. @@ -45,7 +45,7 @@ ReadNextEvents(maxCount): Returns: - `vim.event.Event`_: + [`vim.event.Event`_]: Raises: @@ -70,7 +70,7 @@ ReadPreviousEvents(maxCount): Returns: - `vim.event.Event`_: + [`vim.event.Event`_]: Raises: diff --git a/docs/vim/event/EventManager.rst b/docs/vim/event/EventManager.rst index 02c0c25..c5a6bed 100644 --- a/docs/vim/event/EventManager.rst +++ b/docs/vim/event/EventManager.rst @@ -78,7 +78,7 @@ RetrieveArgumentDescription(eventTypeId): Returns: - `vim.event.EventDescription.EventArgDesc`_: + [`vim.event.EventDescription.EventArgDesc`_]: @@ -157,7 +157,7 @@ QueryEvents(filter): Returns: - `vim.event.Event`_: + [`vim.event.Event`_]: The events matching the filter. Raises: diff --git a/docs/vim/event/ExtendedEvent.rst b/docs/vim/event/ExtendedEvent.rst index fefd8f5..a3c6ff1 100644 --- a/docs/vim/event/ExtendedEvent.rst +++ b/docs/vim/event/ExtendedEvent.rst @@ -22,6 +22,6 @@ Attributes: managedObject (`vmodl.ManagedObject`_): The object on which the event was logged. - data (`vim.event.ExtendedEvent.Pair`_, optional): + data ([`vim.event.ExtendedEvent.Pair`_], optional): Key/value pairs associated with event. diff --git a/docs/vim/event/GhostDvsProxySwitchDetectedEvent.rst b/docs/vim/event/GhostDvsProxySwitchDetectedEvent.rst index 52588e5..ad4704a 100644 --- a/docs/vim/event/GhostDvsProxySwitchDetectedEvent.rst +++ b/docs/vim/event/GhostDvsProxySwitchDetectedEvent.rst @@ -12,6 +12,6 @@ vim.event.GhostDvsProxySwitchDetectedEvent :since: `vSphere API 4.0`_ Attributes: - switchUuid (`str`_): + switchUuid ([`str`_]): The list of ghost DVS proxy switch uuids that were found. diff --git a/docs/vim/event/GhostDvsProxySwitchRemovedEvent.rst b/docs/vim/event/GhostDvsProxySwitchRemovedEvent.rst index 37d331b..9aa5210 100644 --- a/docs/vim/event/GhostDvsProxySwitchRemovedEvent.rst +++ b/docs/vim/event/GhostDvsProxySwitchRemovedEvent.rst @@ -12,6 +12,6 @@ vim.event.GhostDvsProxySwitchRemovedEvent :since: `vSphere API 4.0`_ Attributes: - switchUuid (`str`_): + switchUuid ([`str`_]): The list of ghost DVS proxy switch uuid that were removed. diff --git a/docs/vim/event/HostEnableAdminFailedEvent.rst b/docs/vim/event/HostEnableAdminFailedEvent.rst index 9a9f9e6..d2082e0 100644 --- a/docs/vim/event/HostEnableAdminFailedEvent.rst +++ b/docs/vim/event/HostEnableAdminFailedEvent.rst @@ -12,5 +12,5 @@ vim.event.HostEnableAdminFailedEvent :since: `VI API 2.5`_ Attributes: - permissions (`vim.AuthorizationManager.Permission`_): + permissions ([`vim.AuthorizationManager.Permission`_]): diff --git a/docs/vim/event/HostWwnChangedEvent.rst b/docs/vim/event/HostWwnChangedEvent.rst index e6a58df..58ed084 100644 --- a/docs/vim/event/HostWwnChangedEvent.rst +++ b/docs/vim/event/HostWwnChangedEvent.rst @@ -12,15 +12,15 @@ vim.event.HostWwnChangedEvent :since: `VI API 2.5`_ Attributes: - oldNodeWwns (`long`_, optional): + oldNodeWwns ([`long`_], optional): The old node WWN. - oldPortWwns (`long`_, optional): + oldPortWwns ([`long`_], optional): The old port WWN. - newNodeWwns (`long`_, optional): + newNodeWwns ([`long`_], optional): The new node WWN. - newPortWwns (`long`_, optional): + newPortWwns ([`long`_], optional): The new port WWN. diff --git a/docs/vim/event/HostWwnConflictEvent.rst b/docs/vim/event/HostWwnConflictEvent.rst index 8161980..041051a 100644 --- a/docs/vim/event/HostWwnConflictEvent.rst +++ b/docs/vim/event/HostWwnConflictEvent.rst @@ -16,10 +16,10 @@ vim.event.HostWwnConflictEvent :since: `VI API 2.5`_ Attributes: - conflictedVms (`vim.event.VmEventArgument`_, optional): + conflictedVms ([`vim.event.VmEventArgument`_], optional): The virtual machine whose WWN conflicts with the current host's WWN. - conflictedHosts (`vim.event.HostEventArgument`_, optional): + conflictedHosts ([`vim.event.HostEventArgument`_], optional): The host whose physical WWN conflicts with the current host's WWN. wwn (`long`_): diff --git a/docs/vim/event/OutOfSyncDvsHost.rst b/docs/vim/event/OutOfSyncDvsHost.rst index 30c4dea..55f0317 100644 --- a/docs/vim/event/OutOfSyncDvsHost.rst +++ b/docs/vim/event/OutOfSyncDvsHost.rst @@ -12,6 +12,6 @@ vim.event.OutOfSyncDvsHost :since: `vSphere API 4.0`_ Attributes: - hostOutOfSync (`vim.event.DvsOutOfSyncHostArgument`_): + hostOutOfSync ([`vim.event.DvsOutOfSyncHostArgument`_]): The host that went out of sync. diff --git a/docs/vim/event/RoleAddedEvent.rst b/docs/vim/event/RoleAddedEvent.rst index 5f52614..708fbbe 100644 --- a/docs/vim/event/RoleAddedEvent.rst +++ b/docs/vim/event/RoleAddedEvent.rst @@ -9,6 +9,6 @@ vim.event.RoleAddedEvent :extends: vim.event.RoleEvent_ Attributes: - privilegeList (`str`_, optional): + privilegeList ([`str`_], optional): The privileges granted to the role. diff --git a/docs/vim/event/RoleUpdatedEvent.rst b/docs/vim/event/RoleUpdatedEvent.rst index 2eec161..d958f1f 100644 --- a/docs/vim/event/RoleUpdatedEvent.rst +++ b/docs/vim/event/RoleUpdatedEvent.rst @@ -9,6 +9,6 @@ vim.event.RoleUpdatedEvent :extends: vim.event.RoleEvent_ Attributes: - privilegeList (`str`_, optional): + privilegeList ([`str`_], optional): The privileges granted to the role. diff --git a/docs/vim/event/VmMessageErrorEvent.rst b/docs/vim/event/VmMessageErrorEvent.rst index c61aab8..a64ebef 100644 --- a/docs/vim/event/VmMessageErrorEvent.rst +++ b/docs/vim/event/VmMessageErrorEvent.rst @@ -17,5 +17,5 @@ Attributes: message (`str`_): A raw message returned by the virtualization platform. - messageInfo (`vim.vm.Message`_, optional): + messageInfo ([`vim.vm.Message`_], optional): diff --git a/docs/vim/event/VmMessageEvent.rst b/docs/vim/event/VmMessageEvent.rst index 0d70fe2..a65d8d6 100644 --- a/docs/vim/event/VmMessageEvent.rst +++ b/docs/vim/event/VmMessageEvent.rst @@ -14,5 +14,5 @@ Attributes: message (`str`_): A raw message returned by the virtualization platform. - messageInfo (`vim.vm.Message`_, optional): + messageInfo ([`vim.vm.Message`_], optional): diff --git a/docs/vim/event/VmMessageWarningEvent.rst b/docs/vim/event/VmMessageWarningEvent.rst index 22292b7..85c9279 100644 --- a/docs/vim/event/VmMessageWarningEvent.rst +++ b/docs/vim/event/VmMessageWarningEvent.rst @@ -17,5 +17,5 @@ Attributes: message (`str`_): A raw message returned by the virtualization platform. - messageInfo (`vim.vm.Message`_, optional): + messageInfo ([`vim.vm.Message`_], optional): diff --git a/docs/vim/event/VmPoweringOnWithCustomizedDVPortEvent.rst b/docs/vim/event/VmPoweringOnWithCustomizedDVPortEvent.rst index c67b827..0abbbd8 100644 --- a/docs/vim/event/VmPoweringOnWithCustomizedDVPortEvent.rst +++ b/docs/vim/event/VmPoweringOnWithCustomizedDVPortEvent.rst @@ -12,6 +12,6 @@ vim.event.VmPoweringOnWithCustomizedDVPortEvent :since: `vSphere API 4.0`_ Attributes: - vnic (`vim.event.VnicPortArgument`_): + vnic ([`vim.event.VnicPortArgument`_]): The list of Virtual NIC that were using the DVports. diff --git a/docs/vim/event/VmWwnAssignedEvent.rst b/docs/vim/event/VmWwnAssignedEvent.rst index 9aff321..44e4daf 100644 --- a/docs/vim/event/VmWwnAssignedEvent.rst +++ b/docs/vim/event/VmWwnAssignedEvent.rst @@ -12,9 +12,9 @@ vim.event.VmWwnAssignedEvent :since: `VI API 2.5`_ Attributes: - nodeWwns (`long`_): + nodeWwns ([`long`_]): The new node WWN. - portWwns (`long`_): + portWwns ([`long`_]): The new port WWN. diff --git a/docs/vim/event/VmWwnChangedEvent.rst b/docs/vim/event/VmWwnChangedEvent.rst index 582dfb4..a9a7d75 100644 --- a/docs/vim/event/VmWwnChangedEvent.rst +++ b/docs/vim/event/VmWwnChangedEvent.rst @@ -12,15 +12,15 @@ vim.event.VmWwnChangedEvent :since: `VI API 2.5`_ Attributes: - oldNodeWwns (`long`_, optional): + oldNodeWwns ([`long`_], optional): The old node WWN. - oldPortWwns (`long`_, optional): + oldPortWwns ([`long`_], optional): The old port WWN. - newNodeWwns (`long`_, optional): + newNodeWwns ([`long`_], optional): The new node WWN. - newPortWwns (`long`_, optional): + newPortWwns ([`long`_], optional): The new port WWN. diff --git a/docs/vim/event/VmWwnConflictEvent.rst b/docs/vim/event/VmWwnConflictEvent.rst index 383d814..758edd5 100644 --- a/docs/vim/event/VmWwnConflictEvent.rst +++ b/docs/vim/event/VmWwnConflictEvent.rst @@ -16,10 +16,10 @@ vim.event.VmWwnConflictEvent :since: `VI API 2.5`_ Attributes: - conflictedVms (`vim.event.VmEventArgument`_, optional): + conflictedVms ([`vim.event.VmEventArgument`_], optional): The virtual machine whose WWN conflicts with the current virtual machine's WWN. - conflictedHosts (`vim.event.HostEventArgument`_, optional): + conflictedHosts ([`vim.event.HostEventArgument`_], optional): The host whose physical WWN conflicts with the current virtual machine's WWN. wwn (`long`_): diff --git a/docs/vim/ext/SolutionManagerInfo.rst b/docs/vim/ext/SolutionManagerInfo.rst index 286ac2b..9f912c1 100644 --- a/docs/vim/ext/SolutionManagerInfo.rst +++ b/docs/vim/ext/SolutionManagerInfo.rst @@ -14,7 +14,7 @@ vim.ext.SolutionManagerInfo :since: `vSphere API 5.0`_ Attributes: - tab (`vim.ext.SolutionManagerInfo.TabInfo`_, optional): + tab ([`vim.ext.SolutionManagerInfo.TabInfo`_], optional): List of tabs that must be shown in the Solution Manager for this extension. Tabs are shown ordered by their position in this array. smallIconUrl (`str`_, optional): diff --git a/docs/vim/host/ActiveDirectoryInfo.rst b/docs/vim/host/ActiveDirectoryInfo.rst index 5c5fc64..b4fefbd 100644 --- a/docs/vim/host/ActiveDirectoryInfo.rst +++ b/docs/vim/host/ActiveDirectoryInfo.rst @@ -23,7 +23,7 @@ Attributes: joinedDomain (`str`_, optional): The domain that this host joined. - trustedDomain (`str`_, optional): + trustedDomain ([`str`_], optional): List of domains with which thejoinedDomainhas a trust. ThejoinedDomainis not included in thetrustedDomainlist. domainMembershipStatus (`str`_, optional): diff --git a/docs/vim/host/AuthenticationManager.rst b/docs/vim/host/AuthenticationManager.rst index cf60539..83d295d 100644 --- a/docs/vim/host/AuthenticationManager.rst +++ b/docs/vim/host/AuthenticationManager.rst @@ -40,7 +40,7 @@ Attributes ---------- info (`vim.host.AuthenticationManagerInfo`_): Information about Active Directory membership. - supportedStore (`vim.host.AuthenticationStore`_): + supportedStore ([`vim.host.AuthenticationStore`_]): An array that can contain managed object references to local and Active Directory authentication managed objects.supportedStoredata implies a connection to a system that stores information about accounts. ThesupportedStorearray can include the following objects: * * `HostLocalAuthentication`_ diff --git a/docs/vim/host/AuthenticationManagerInfo.rst b/docs/vim/host/AuthenticationManagerInfo.rst index c9ab0b6..9f698ea 100644 --- a/docs/vim/host/AuthenticationManagerInfo.rst +++ b/docs/vim/host/AuthenticationManagerInfo.rst @@ -18,7 +18,7 @@ vim.host.AuthenticationManagerInfo :since: `vSphere API 4.1`_ Attributes: - authConfig (`vim.host.AuthenticationStoreInfo`_): + authConfig ([`vim.host.AuthenticationStoreInfo`_]): An array containing entries for local authentication and host Active Directory authentication. * `HostLocalAuthenticationInfo`_ diff --git a/docs/vim/host/AutoStartManager/Config.rst b/docs/vim/host/AutoStartManager/Config.rst index ca9e808..b2f0d94 100644 --- a/docs/vim/host/AutoStartManager/Config.rst +++ b/docs/vim/host/AutoStartManager/Config.rst @@ -14,6 +14,6 @@ Attributes: defaults (`vim.host.AutoStartManager.SystemDefaults`_, optional): System defaults for auto-start/auto-stop. - powerInfo (`vim.host.AutoStartManager.AutoPowerInfo`_, optional): + powerInfo ([`vim.host.AutoStartManager.AutoPowerInfo`_], optional): Lists the auto-start/auto-stop configuration. If a virtual machine is not mentioned in this array, it does not participate in auto-start/auto-stop operations. diff --git a/docs/vim/host/BootDeviceInfo.rst b/docs/vim/host/BootDeviceInfo.rst index 8c346b8..48914cf 100644 --- a/docs/vim/host/BootDeviceInfo.rst +++ b/docs/vim/host/BootDeviceInfo.rst @@ -14,7 +14,7 @@ vim.host.BootDeviceInfo :since: `VI API 2.5`_ Attributes: - bootDevices (`vim.host.BootDeviceSystem.BootDevice`_, optional): + bootDevices ([`vim.host.BootDeviceSystem.BootDevice`_], optional): The list of boot devices present on the host currentBootDeviceKey (`str`_, optional): diff --git a/docs/vim/host/CacheConfigurationManager.rst b/docs/vim/host/CacheConfigurationManager.rst index 142c462..e3c44ab 100644 --- a/docs/vim/host/CacheConfigurationManager.rst +++ b/docs/vim/host/CacheConfigurationManager.rst @@ -21,7 +21,7 @@ vim.host.CacheConfigurationManager Attributes ---------- - cacheConfigurationInfo (`vim.host.CacheConfigurationManager.CacheConfigurationInfo`_): + cacheConfigurationInfo ([`vim.host.CacheConfigurationManager.CacheConfigurationInfo`_]): privilege: Host.Config.AdvancedConfig The swap performance configuration for the ESX host. This includes configuration information for each datastore enabled for this purpose. diff --git a/docs/vim/host/Capability.rst b/docs/vim/host/Capability.rst index ebdb32c..7cab1c3 100644 --- a/docs/vim/host/Capability.rst +++ b/docs/vim/host/Capability.rst @@ -165,10 +165,10 @@ Attributes: replayUnsupportedReason (`str`_, optional): For a host whose CPU doesn't support replay, indicates the reason for the incompatibility. `HostReplayUnsupportedReason`_ represents the set of possible values. - replayCompatibilityIssues (`str`_, optional): + replayCompatibilityIssues ([`str`_], optional): For a host which doesn't support replay, indicates all the reasons for the incompatibility. `HostReplayUnsupportedReason`_ lists the set of possible values. - ftCompatibilityIssues (`str`_, optional): + ftCompatibilityIssues ([`str`_], optional): For a host which doesn't support Fault Tolerance, indicates all the reasons for the incompatibility. `HostCapabilityFtUnsupportedReason`_ lists the set of possible values. loginBySSLThumbprintSupported (`bool`_, optional): @@ -186,7 +186,7 @@ Attributes: tpmSupported (`bool`_): Flag indicating whether this host supports the integrity measurement using a TPM device. - supportedCpuFeature (`vim.host.CpuIdInfo`_, optional): + supportedCpuFeature ([`vim.host.CpuIdInfo`_], optional): CPU feature set that is supported by the virtualization platform. This feature set may reflect characteristics of the product capabilities and licensing. For any feature marked '-', reference the `cpuFeature`_ array of the host's HardwareInfo to determine the correct value. virtualExecUsageSupported (`bool`_): @@ -198,13 +198,13 @@ Attributes: vmDirectPathGen2Supported (`bool`_): Indicates whether the host supports network passthrough using VMDirectPath Gen 2. Note that this is a general capability for the host and is independent of support by a given physical NIC. If false, the reason(s) for lack of support will be provided in `vmDirectPathGen2UnsupportedReason`_ and/or in `vmDirectPathGen2UnsupportedReasonExtended`_ .See `vmDirectPathGen2Supported`_ - vmDirectPathGen2UnsupportedReason (`str`_, optional): + vmDirectPathGen2UnsupportedReason ([`str`_], optional): If `vmDirectPathGen2Supported`_ is false, this array will be populated with reasons for the lack of support (chosen from VmDirectPathGen2UnsupportedReason). If there is a reason for the lack of support that cannot be described by the available constants, `vmDirectPathGen2UnsupportedReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive.If the reason "hostNptIncompatibleProduct" is provided, then that will be the only provided reason, as the host software is incapable of providing additional information. vmDirectPathGen2UnsupportedReasonExtended (`str`_, optional): If `vmDirectPathGen2Supported`_ is false, this property may contain an explanation provided by the platform, beyond the reasons (if any) enumerated in `vmDirectPathGen2UnsupportedReason`_ . - supportedVmfsMajorVersion (`int`_, optional): + supportedVmfsMajorVersion ([`int`_], optional): List of VMFS major versions supported by the host. vStorageCapable (`bool`_): diff --git a/docs/vim/host/ConfigInfo.rst b/docs/vim/host/ConfigInfo.rst index 1443e2f..92ddb21 100644 --- a/docs/vim/host/ConfigInfo.rst +++ b/docs/vim/host/ConfigInfo.rst @@ -127,7 +127,7 @@ Attributes: fileSystemVolume (`vim.host.FileSystemVolumeInfo`_, optional): Storage system file system volume information. - systemFile (`str`_, optional): + systemFile ([`str`_], optional): Datastore paths of files used by the host system on mounted volumes, for instance, the COS vmdk file of the host. For information on datastore paths, see `Datastore`_ . network (`vim.host.NetworkInfo`_, optional): @@ -160,10 +160,10 @@ Attributes: activeDiagnosticPartition (`vim.host.DiagnosticPartition`_, optional): The diagnostic partition that will be set as the current diagnostic partition on the host. - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Host configuration options as defined by the `OptionValue`_ data object type. - optionDef (`vim.option.OptionDef`_, optional): + optionDef ([`vim.option.OptionDef`_], optional): A list of supported options. datastorePrincipal (`str`_, optional): @@ -193,19 +193,19 @@ Attributes: sslThumbprintInfo (`vim.host.SslThumbprintInfo`_, optional): SSL Thumbprint info for hosts registered on this host. - sslThumbprintData (`vim.host.SslThumbprintInfo`_, optional): + sslThumbprintData ([`vim.host.SslThumbprintInfo`_], optional): SSL Thumbprints registered on this host. - certificate (`int`_, optional): + certificate ([`int`_], optional): Full Host Certificate in PEM format, if known - pciPassthruInfo (`vim.host.PciPassthruInfo`_, optional): + pciPassthruInfo ([`vim.host.PciPassthruInfo`_], optional): PCI passthrough information. authenticationManagerInfo (`vim.host.AuthenticationManagerInfo`_, optional): Current authentication configuration. - featureVersion (`vim.host.FeatureVersionInfo`_, optional): + featureVersion ([`vim.host.FeatureVersionInfo`_], optional): List of feature-specific version information. Each element refers to the version information for a specific feature. powerSystemCapability (`vim.host.PowerSystem.Capability`_, optional): @@ -214,16 +214,16 @@ Attributes: powerSystemInfo (`vim.host.PowerSystem.Info`_, optional): Host power management information. - cacheConfigurationInfo (`vim.host.CacheConfigurationManager.CacheConfigurationInfo`_, optional): + cacheConfigurationInfo ([`vim.host.CacheConfigurationManager.CacheConfigurationInfo`_], optional): Host solid stats drive cache configuration information. wakeOnLanCapable (`bool`_, optional): Indicates if a host is wake on lan capable. A host is deemed wake on lan capable if there exists at least one physical network card that is both backing the vmotion interface and is itself wake on lan capable. - featureCapability (`vim.host.FeatureCapability`_, optional): + featureCapability ([`vim.host.FeatureCapability`_], optional): Array of the feature capabilities that the host has. This is not expected to change after the host boots. It may change between reboots in the case BIOS options are changed, or hardware, or firmware is changed or upgraded. - maskedFeatureCapability (`vim.host.FeatureCapability`_, optional): + maskedFeatureCapability ([`vim.host.FeatureCapability`_], optional): Array of the feature capabilities that the host has after the mask has been applied. vFlashConfigInfo (`vim.host.VFlashManager.VFlashConfigInfo`_, optional): @@ -232,6 +232,6 @@ Attributes: vsanHostConfig (`vim.vsan.host.ConfigInfo`_, optional): VSAN configuration for a host. - graphicsInfo (`vim.host.GraphicsInfo`_, optional): + graphicsInfo ([`vim.host.GraphicsInfo`_], optional): The list of graphics devices available on this host. diff --git a/docs/vim/host/ConfigSpec.rst b/docs/vim/host/ConfigSpec.rst index ed8da28..5027803 100644 --- a/docs/vim/host/ConfigSpec.rst +++ b/docs/vim/host/ConfigSpec.rst @@ -44,22 +44,22 @@ vim.host.ConfigSpec :since: `vSphere API 4.0`_ Attributes: - nasDatastore (`vim.host.NasVolume.Config`_, optional): + nasDatastore ([`vim.host.NasVolume.Config`_], optional): Configurations to create NAS datastores. network (`vim.host.NetworkConfig`_, optional): Network system information. - nicTypeSelection (`vim.host.VirtualNicManager.NicTypeSelection`_, optional): + nicTypeSelection ([`vim.host.VirtualNicManager.NicTypeSelection`_], optional): Type selection for different VirtualNics. - service (`vim.host.ServiceConfig`_, optional): + service ([`vim.host.ServiceConfig`_], optional): Host service configuration. firewall (`vim.host.FirewallConfig`_, optional): Firewall configuration. - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Host configuration options as defined by the `OptionValue`_ data object type. datastorePrincipal (`str`_, optional): @@ -80,18 +80,18 @@ Attributes: security (`vim.host.SecuritySpec`_, optional): Security specification. - userAccount (`vim.host.LocalAccountManager.AccountSpecification`_, optional): + userAccount ([`vim.host.LocalAccountManager.AccountSpecification`_], optional): List of users to create/update with new password. - usergroupAccount (`vim.host.LocalAccountManager.AccountSpecification`_, optional): + usergroupAccount ([`vim.host.LocalAccountManager.AccountSpecification`_], optional): List of users to create/update with new password. memory (`vim.host.MemorySpec`_, optional): Memory configuration for the host. - activeDirectory (`vim.host.ActiveDirectorySpec`_, optional): + activeDirectory ([`vim.host.ActiveDirectorySpec`_], optional): Active Directory configuration change. - genericConfig (`vmodl.KeyAnyValue`_, optional): + genericConfig ([`vmodl.KeyAnyValue`_], optional): Advanced configuration. diff --git a/docs/vim/host/ConnectInfo.rst b/docs/vim/host/ConnectInfo.rst index 4f77f79..ddb607a 100644 --- a/docs/vim/host/ConnectInfo.rst +++ b/docs/vim/host/ConnectInfo.rst @@ -30,7 +30,7 @@ Attributes: host (`vim.host.Summary`_): Summary information about the host. The status fields and managed object reference is not set when an object of this type is created. These fields and references are typically set later when these objects are associated with a host. - vm (`vim.vm.Summary`_, optional): + vm ([`vim.vm.Summary`_], optional): The list of virtual machines on the host. vimAccountNameRequired (`bool`_, optional): @@ -39,10 +39,10 @@ Attributes: clusterSupported (`bool`_, optional): Whether or not the host supports clustering capabilities such as HA or DRS and therefore can be added to a cluster. If false, the host must be added as a standalone host. - network (`vim.host.ConnectInfo.NetworkInfo`_, optional): + network ([`vim.host.ConnectInfo.NetworkInfo`_], optional): The list of network information for networks configured on this host. - datastore (`vim.host.ConnectInfo.DatastoreInfo`_, optional): + datastore ([`vim.host.ConnectInfo.DatastoreInfo`_], optional): The list of datastores on the host. license (`vim.host.ConnectInfo.LicenseInfo`_, optional): diff --git a/docs/vim/host/CpuPackage.rst b/docs/vim/host/CpuPackage.rst index 2f74680..538af4d 100644 --- a/docs/vim/host/CpuPackage.rst +++ b/docs/vim/host/CpuPackage.rst @@ -30,9 +30,9 @@ Attributes: description (`str`_): String summary description of CPU (for display purposes). - threadId (`short`_): + threadId ([`short`_]): The logical CPU threads on this package. - cpuFeature (`vim.host.CpuIdInfo`_, optional): + cpuFeature ([`vim.host.CpuIdInfo`_], optional): The CPU feature bit on this particular CPU. This is independent of the product and licensing capabilities. diff --git a/docs/vim/host/DatastoreBrowser.rst b/docs/vim/host/DatastoreBrowser.rst index fe9cb22..10eeba7 100644 --- a/docs/vim/host/DatastoreBrowser.rst +++ b/docs/vim/host/DatastoreBrowser.rst @@ -53,10 +53,10 @@ vim.host.DatastoreBrowser Attributes ---------- - datastore (`vim.Datastore`_): + datastore ([`vim.Datastore`_]): privilege: System.View Set of datastores that can be searched on this DatastoreBrowser.The list of datastores available to browse on this DatastoreBrowser is contextual information that depends on the object being browsed. If the host is being browsed, the host's datastores are used. If the Datacenter is being browsed, the Datacenter's list of datastores is used. - supportedType (`vim.host.DatastoreBrowser.Query`_): + supportedType ([`vim.host.DatastoreBrowser.Query`_]): The list of supported file types. The supported file types are represented as items in this list. For each supported file type, there is an object in the list whose dynamic type is one of the types derived from the `FileQuery`_ data object type. In general, the properties in this query type are not set.Use the Query of the desired file type in the SearchSpec.query to indicate the desired file types.This property is used by clients to determine what kinds of file types are supported. Clients should consult this list to avoid querying for types of virtual machine components that are not supported. diff --git a/docs/vim/host/DatastoreBrowser/SearchResults.rst b/docs/vim/host/DatastoreBrowser/SearchResults.rst index 35cfc3c..5167cef 100644 --- a/docs/vim/host/DatastoreBrowser/SearchResults.rst +++ b/docs/vim/host/DatastoreBrowser/SearchResults.rst @@ -19,6 +19,6 @@ Attributes: folderPath (`str`_, optional): Relative path to the top-level folder. - file (`vim.host.DatastoreBrowser.FileInfo`_, optional): + file ([`vim.host.DatastoreBrowser.FileInfo`_], optional): Set of matching files, if any. diff --git a/docs/vim/host/DatastoreBrowser/SearchSpec.rst b/docs/vim/host/DatastoreBrowser/SearchSpec.rst index d0bb38f..0114444 100644 --- a/docs/vim/host/DatastoreBrowser/SearchSpec.rst +++ b/docs/vim/host/DatastoreBrowser/SearchSpec.rst @@ -15,7 +15,7 @@ vim.host.DatastoreBrowser.SearchSpec :extends: vmodl.DynamicData_ Attributes: - query (`vim.host.DatastoreBrowser.Query`_, optional): + query ([`vim.host.DatastoreBrowser.Query`_], optional): The set of file types to match, search criteria specific to the file type, and the amount of detail for a file. These search parameters are specific to a file type, meaning that they can be specified only if the file type to which they are associated is in the set. A file type cannot appear more than once in the set.If this query object is not present, then all files providing only file level details are matched. details (`vim.host.DatastoreBrowser.FileInfo.Details`_, optional): @@ -24,7 +24,7 @@ Attributes: searchCaseInsensitive (`bool`_, optional): This flag indicates whether or not to search using a case insensitive match on type. In general the algorithm used to match file types relies on file extensions. Although the specific file extensions used are encapsulated by this API, clients are still allowed to modify the filtering behavior.By default, the DatastoreBrowser uses a platform-consistent algorithm to determine if a file is of a type. Specifically on Linux, where case is important, the search is case sensitive. On Windows, case is not important, so the search is case insensitive.In an environment with heterogenous platforms, being platform-consistent may not be desirable. As a result, the default behavior can be overridden by setting this optional flag. - matchPattern (`str`_, optional): + matchPattern ([`str`_], optional): Specifies a list of file patterns that must match for a file to be returned. This search property is a filter that applies globally so that only files matching the specified patterns are returned, regardless of the other search parameters. sortFoldersFirst (`bool`_, optional): diff --git a/docs/vim/host/DatastoreBrowser/VmConfigQuery/Filter.rst b/docs/vim/host/DatastoreBrowser/VmConfigQuery/Filter.rst index 47a6362..b0e2b90 100644 --- a/docs/vim/host/DatastoreBrowser/VmConfigQuery/Filter.rst +++ b/docs/vim/host/DatastoreBrowser/VmConfigQuery/Filter.rst @@ -9,6 +9,6 @@ vim.host.DatastoreBrowser.VmConfigQuery.Filter :extends: vmodl.DynamicData_ Attributes: - matchConfigVersion (`int`_, optional): + matchConfigVersion ([`int`_], optional): If this property is set, only the virtual machine configuration files that match one of the specified configuration versions are selected. If no versions are specified, this search criteria is ignored. diff --git a/docs/vim/host/DatastoreBrowser/VmDiskInfo.rst b/docs/vim/host/DatastoreBrowser/VmDiskInfo.rst index 0042509..35e47a9 100644 --- a/docs/vim/host/DatastoreBrowser/VmDiskInfo.rst +++ b/docs/vim/host/DatastoreBrowser/VmDiskInfo.rst @@ -29,7 +29,7 @@ Attributes: controllerType (`str`_, optional): The controller type suitable for this virtual disk. - diskExtents (`str`_, optional): + diskExtents ([`str`_], optional): The extents of this virtual disk specified in absolute DS paths thin (`bool`_, optional): diff --git a/docs/vim/host/DatastoreBrowser/VmDiskQuery/Filter.rst b/docs/vim/host/DatastoreBrowser/VmDiskQuery/Filter.rst index 5e4fe11..071eefe 100644 --- a/docs/vim/host/DatastoreBrowser/VmDiskQuery/Filter.rst +++ b/docs/vim/host/DatastoreBrowser/VmDiskQuery/Filter.rst @@ -19,13 +19,13 @@ vim.host.DatastoreBrowser.VmDiskQuery.Filter :extends: vmodl.DynamicData_ Attributes: - diskType (`str`_, optional): + diskType ([`str`_], optional): If this optional property is set, only the virtual disk primary files that match one of the specified disk types are selected. If no disk types are specified, this search criteria is ignored.The specified disk type is one of the backing information types for a virtual disk.See `VirtualDisk`_ - matchHardwareVersion (`int`_, optional): + matchHardwareVersion ([`int`_], optional): If this optional property is set, only virtual disk primary files that match one of the specified hardware versions are selected. If no versions are specified, this search criteria is ignored. - controllerType (`str`_, optional): + controllerType ([`str`_], optional): If this optional property is set, only virtual disk files that have a controller type that matches one of the controller types specified are returned. If no controller types are specified, this search criteria is ignored.The specified controller type is one of the controller types for a virtual disk.See `VirtualIDEController`_ See `VirtualSCSIController`_ thin (`bool`_, optional): diff --git a/docs/vim/host/DatastoreSystem.rst b/docs/vim/host/DatastoreSystem.rst index b49a4ae..22bd5ce 100644 --- a/docs/vim/host/DatastoreSystem.rst +++ b/docs/vim/host/DatastoreSystem.rst @@ -76,7 +76,7 @@ vim.host.DatastoreSystem Attributes ---------- - datastore (`vim.Datastore`_): + datastore ([`vim.Datastore`_]): privilege: System.View List of datastores on this host. capabilities (`vim.host.DatastoreSystem.Capabilities`_): @@ -137,7 +137,7 @@ QueryAvailableDisksForVmfs(datastore): Returns: - `vim.host.ScsiDisk`_: + [`vim.host.ScsiDisk`_]: An array of data objects describing SCSI disks. Raises: @@ -176,7 +176,7 @@ QueryVmfsDatastoreCreateOptions(devicePath, vmfsMajorVersion): Returns: - `vim.host.VmfsDatastoreOption`_: + [`vim.host.VmfsDatastoreOption`_]: An array of VMFS datastore provisioning options that can be applied on a disk. Raises: @@ -251,7 +251,7 @@ QueryVmfsDatastoreExtendOptions(datastore, devicePath, suppressExpandCandidates) Returns: - `vim.host.VmfsDatastoreOption`_: + [`vim.host.VmfsDatastoreOption`_]: An array of VMFS datastore provisioning options that can be applied on a disk. Raises: @@ -284,7 +284,7 @@ QueryVmfsDatastoreExpandOptions(datastore): Returns: - `vim.host.VmfsDatastoreOption`_: + [`vim.host.VmfsDatastoreOption`_]: An array of VMFS datastore expansion options that can be applied. Raises: @@ -537,7 +537,7 @@ QueryUnresolvedVmfsVolumes(): Returns: - `vim.host.UnresolvedVmfsVolume`_: + [`vim.host.UnresolvedVmfsVolume`_]: An array of unbound VMFS datastore diff --git a/docs/vim/host/DateTimeSystem.rst b/docs/vim/host/DateTimeSystem.rst index a537923..36a3e66 100644 --- a/docs/vim/host/DateTimeSystem.rst +++ b/docs/vim/host/DateTimeSystem.rst @@ -71,7 +71,7 @@ QueryAvailableTimeZones(): Returns: - `vim.host.DateTimeSystem.TimeZone`_: + [`vim.host.DateTimeSystem.TimeZone`_]: List of available timezones on the host. diff --git a/docs/vim/host/DiagnosticSystem.rst b/docs/vim/host/DiagnosticSystem.rst index a662ef7..681e1c7 100644 --- a/docs/vim/host/DiagnosticSystem.rst +++ b/docs/vim/host/DiagnosticSystem.rst @@ -58,7 +58,7 @@ QueryAvailablePartition(): Returns: - `vim.host.DiagnosticPartition`_: + [`vim.host.DiagnosticPartition`_]: Raises: @@ -123,7 +123,7 @@ QueryPartitionCreateOptions(storageType, diagnosticType): Returns: - `vim.host.DiagnosticPartition.CreateOption`_: + [`vim.host.DiagnosticPartition.CreateOption`_]: Raises: diff --git a/docs/vim/host/DigestInfo.rst b/docs/vim/host/DigestInfo.rst index 12f9bcd..f9a854f 100644 --- a/docs/vim/host/DigestInfo.rst +++ b/docs/vim/host/DigestInfo.rst @@ -19,7 +19,7 @@ Attributes: digestMethod (`str`_): Method in which the digest value is calculated. The set of possible values is described in `HostDigestInfoDigestMethodType`_ . - digestValue (`int`_): + digestValue ([`int`_]): The variable length byte array containing the digest value calculated by the specified digestMethod. objectName (`str`_, optional): diff --git a/docs/vim/host/DiskPartitionInfo/Layout.rst b/docs/vim/host/DiskPartitionInfo/Layout.rst index 6f16574..c6484fc 100644 --- a/docs/vim/host/DiskPartitionInfo/Layout.rst +++ b/docs/vim/host/DiskPartitionInfo/Layout.rst @@ -14,6 +14,6 @@ Attributes: total (`vim.host.DiskDimensions.Lba`_, optional): Total number of blocks on a disk. - partition (`vim.host.DiskPartitionInfo.BlockRange`_): + partition ([`vim.host.DiskPartitionInfo.BlockRange`_]): List of block ranges on the disk. diff --git a/docs/vim/host/DiskPartitionInfo/Specification.rst b/docs/vim/host/DiskPartitionInfo/Specification.rst index 94709ab..56b9cf9 100644 --- a/docs/vim/host/DiskPartitionInfo/Specification.rst +++ b/docs/vim/host/DiskPartitionInfo/Specification.rst @@ -24,6 +24,6 @@ Attributes: totalSectors (`long`_, optional): Disk dimensions expressed in total number of 512-byte sectors. - partition (`vim.host.DiskPartitionInfo.Partition`_, optional): + partition ([`vim.host.DiskPartitionInfo.Partition`_], optional): List of partitions on the disk. diff --git a/docs/vim/host/DnsConfig.rst b/docs/vim/host/DnsConfig.rst index c0c1b59..b51b04e 100644 --- a/docs/vim/host/DnsConfig.rst +++ b/docs/vim/host/DnsConfig.rst @@ -25,9 +25,9 @@ Attributes: domainName (`str`_): The domain name portion of the DNS name. For example, "vmware.com".Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set. - address (`str`_, optional): + address ([`str`_], optional): The IP addresses of the DNS servers, placed in order of preference.Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set. - searchDomain (`str`_, optional): + searchDomain ([`str`_], optional): The domain in which to search for hosts, placed in order of preference.Note: When DHCP is not enabled, the property can be set explicitly. When DHCP is enabled, the property reflects the current DNS configuration, but cannot be set. diff --git a/docs/vim/host/FcoeConfig.rst b/docs/vim/host/FcoeConfig.rst index f2882aa..38d8756 100644 --- a/docs/vim/host/FcoeConfig.rst +++ b/docs/vim/host/FcoeConfig.rst @@ -26,7 +26,7 @@ Attributes: sourceMac (`str`_): Source MAC address used for FCoE traffic. This MAC address is associated with the logical construct that is a physical NIC's associated underlying FCoE Controller, as defined in the FC-BB-5 standard. This MAC address should be of the form "xx:xx:xx:xx:xx:xx", where 'x' is a hexadecimal digit. Valid MAC addresses are unicast addresses. - vlanRange (`vim.host.FcoeConfig.VlanRange`_): + vlanRange ([`vim.host.FcoeConfig.VlanRange`_]): VLAN ranges associated with this FcoeConfig. capabilities (`vim.host.FcoeConfig.FcoeCapabilities`_): diff --git a/docs/vim/host/FcoeConfig/FcoeSpecification.rst b/docs/vim/host/FcoeConfig/FcoeSpecification.rst index 3c79df6..7e8bf67 100644 --- a/docs/vim/host/FcoeConfig/FcoeSpecification.rst +++ b/docs/vim/host/FcoeConfig/FcoeSpecification.rst @@ -25,6 +25,6 @@ Attributes: sourceMac (`str`_, optional): Source MAC address to use for FCoE traffic. This MAC address is associated with the logical construct that is a physical NIC's associated underlying FCoE Controller, as defined in the FC-BB-5 standard. This MAC address should be of the form "xx:xx:xx:xx:xx:xx", where 'x' is a hexadecimal digit. Valid MAC addresses are unicast addresses. - vlanRange (`vim.host.FcoeConfig.VlanRange`_, optional): + vlanRange ([`vim.host.FcoeConfig.VlanRange`_], optional): VLAN ranges to use for FCoE traffic. diff --git a/docs/vim/host/FileSystemVolumeInfo.rst b/docs/vim/host/FileSystemVolumeInfo.rst index c0dbb5a..637867a 100644 --- a/docs/vim/host/FileSystemVolumeInfo.rst +++ b/docs/vim/host/FileSystemVolumeInfo.rst @@ -13,9 +13,9 @@ vim.host.FileSystemVolumeInfo :extends: vmodl.DynamicData_ Attributes: - volumeTypeList (`str`_, optional): + volumeTypeList ([`str`_], optional): The list of supported file system volume types. - mountInfo (`vim.host.FileSystemMountInfo`_, optional): + mountInfo ([`vim.host.FileSystemMountInfo`_], optional): The list of file system volumes mounted on the host. diff --git a/docs/vim/host/FirewallConfig.rst b/docs/vim/host/FirewallConfig.rst index 680fa5a..b54f25d 100644 --- a/docs/vim/host/FirewallConfig.rst +++ b/docs/vim/host/FirewallConfig.rst @@ -14,7 +14,7 @@ vim.host.FirewallConfig :since: `vSphere API 4.0`_ Attributes: - rule (`vim.host.FirewallConfig.RuleSetConfig`_, optional): + rule ([`vim.host.FirewallConfig.RuleSetConfig`_], optional): Rules determining firewall settings. defaultBlockingPolicy (`vim.host.FirewallInfo.DefaultPolicy`_): diff --git a/docs/vim/host/FirewallInfo.rst b/docs/vim/host/FirewallInfo.rst index 92877b8..f31f45b 100644 --- a/docs/vim/host/FirewallInfo.rst +++ b/docs/vim/host/FirewallInfo.rst @@ -14,6 +14,6 @@ Attributes: defaultPolicy (`vim.host.FirewallInfo.DefaultPolicy`_): Default firewall policy. - ruleset (`vim.host.Ruleset`_, optional): + ruleset ([`vim.host.Ruleset`_], optional): List of configured rulesets. diff --git a/docs/vim/host/GraphicsInfo.rst b/docs/vim/host/GraphicsInfo.rst index 18ad7ee..4c2d23f 100644 --- a/docs/vim/host/GraphicsInfo.rst +++ b/docs/vim/host/GraphicsInfo.rst @@ -31,6 +31,6 @@ Attributes: memorySizeInKB (`long`_): Memory capacity of graphics device or zero if not available. - vm (`vim.VirtualMachine`_, optional): + vm ([`vim.VirtualMachine`_], optional): Virtual machines using this graphics device. diff --git a/docs/vim/host/GraphicsManager.rst b/docs/vim/host/GraphicsManager.rst index baa81ca..5c4df2b 100644 --- a/docs/vim/host/GraphicsManager.rst +++ b/docs/vim/host/GraphicsManager.rst @@ -20,7 +20,7 @@ vim.host.GraphicsManager Attributes ---------- - graphicsInfo (`vim.host.GraphicsInfo`_): + graphicsInfo ([`vim.host.GraphicsInfo`_]): privilege: System.Read Array of graphics information diff --git a/docs/vim/host/HardwareInfo.rst b/docs/vim/host/HardwareInfo.rst index ba98788..9e76235 100644 --- a/docs/vim/host/HardwareInfo.rst +++ b/docs/vim/host/HardwareInfo.rst @@ -39,7 +39,7 @@ Attributes: cpuInfo (`vim.host.CpuInfo`_): Overall CPU information. - cpuPkg (`vim.host.CpuPackage`_): + cpuPkg ([`vim.host.CpuPackage`_]): Information about each of the physical CPU packages on the host. memorySize (`long`_): @@ -51,10 +51,10 @@ Attributes: smcPresent (`bool`_): Presence of System Management Controller, indicates the host is Apple hardware, and thus capable of running Mac OS guest as VM. - pciDevice (`vim.host.PciDevice`_, optional): + pciDevice ([`vim.host.PciDevice`_], optional): The list of Peripheral Component Interconnect (PCI) devices available on this host. - cpuFeature (`vim.host.CpuIdInfo`_, optional): + cpuFeature ([`vim.host.CpuIdInfo`_], optional): CPU feature set that is supported by the hardware. This is the intersection of the feature sets supported by the individual CPU packages. This feature set is modified by the `supportedCpuFeature`_ array in the host capabilities to obtain the feature set supported by the virtualization platform. biosInfo (`vim.host.BIOSInfo`_, optional): diff --git a/docs/vim/host/HardwareStatusInfo.rst b/docs/vim/host/HardwareStatusInfo.rst index c9a111c..3ee40b1 100644 --- a/docs/vim/host/HardwareStatusInfo.rst +++ b/docs/vim/host/HardwareStatusInfo.rst @@ -14,12 +14,12 @@ vim.host.HardwareStatusInfo :since: `VI API 2.5`_ Attributes: - memoryStatusInfo (`vim.host.HardwareStatusInfo.HardwareElementInfo`_, optional): + memoryStatusInfo ([`vim.host.HardwareStatusInfo.HardwareElementInfo`_], optional): Status of the physical memory - cpuStatusInfo (`vim.host.HardwareStatusInfo.HardwareElementInfo`_, optional): + cpuStatusInfo ([`vim.host.HardwareStatusInfo.HardwareElementInfo`_], optional): Status of the CPU packages - storageStatusInfo (`vim.host.HardwareStatusInfo.StorageStatusInfo`_, optional): + storageStatusInfo ([`vim.host.HardwareStatusInfo.StorageStatusInfo`_], optional): Status of the physical storage system diff --git a/docs/vim/host/HardwareStatusInfo/StorageStatusInfo.rst b/docs/vim/host/HardwareStatusInfo/StorageStatusInfo.rst index c9ab7f7..c1b20d2 100644 --- a/docs/vim/host/HardwareStatusInfo/StorageStatusInfo.rst +++ b/docs/vim/host/HardwareStatusInfo/StorageStatusInfo.rst @@ -12,6 +12,6 @@ vim.host.HardwareStatusInfo.StorageStatusInfo :since: `VI API 2.5`_ Attributes: - operationalInfo (`vim.host.HardwareStatusInfo.StorageStatusInfo.OperationalInfo`_, optional): + operationalInfo ([`vim.host.HardwareStatusInfo.StorageStatusInfo.OperationalInfo`_], optional): Other information regarding the operational state of the storage element. diff --git a/docs/vim/host/HostProxySwitch.rst b/docs/vim/host/HostProxySwitch.rst index 02c0eb5..6501590 100644 --- a/docs/vim/host/HostProxySwitch.rst +++ b/docs/vim/host/HostProxySwitch.rst @@ -42,19 +42,19 @@ Attributes: numPortsAvailable (`int`_): The number of ports that are available on this virtual switch. - uplinkPort (`vim.KeyValue`_, optional): + uplinkPort ([`vim.KeyValue`_], optional): The list of ports that can be potentially used by physical nics. This property contains the keys and names of such ports. mtu (`int`_, optional): The maximum transmission unit (MTU) associated with this switch in bytes. - pnic (`vim.host.PhysicalNic`_, optional): + pnic ([`vim.host.PhysicalNic`_], optional): The set of physical network adapters associated with this switch. spec (`vim.host.HostProxySwitch.Specification`_): The specification of the switch. - hostLag (`vim.host.HostProxySwitch.HostLagConfig`_, optional): + hostLag ([`vim.host.HostProxySwitch.HostLagConfig`_], optional): The Link Aggregation Control Protocol group and Uplink ports in the group. networkReservationSupported (`bool`_, optional): diff --git a/docs/vim/host/HostProxySwitch/HostLagConfig.rst b/docs/vim/host/HostProxySwitch/HostLagConfig.rst index 07542a1..b867eac 100644 --- a/docs/vim/host/HostProxySwitch/HostLagConfig.rst +++ b/docs/vim/host/HostProxySwitch/HostLagConfig.rst @@ -18,6 +18,6 @@ Attributes: lagName (`str`_, optional): - uplinkPort (`vim.KeyValue`_, optional): + uplinkPort ([`vim.KeyValue`_], optional): The list of Uplink Ports in the Link Aggregation Control Protocol group. This property contains the keys and names of such ports. diff --git a/docs/vim/host/InternetScsiHba.rst b/docs/vim/host/InternetScsiHba.rst index 1f6b693..a338cf9 100644 --- a/docs/vim/host/InternetScsiHba.rst +++ b/docs/vim/host/InternetScsiHba.rst @@ -72,10 +72,10 @@ Attributes: ipProperties (`vim.host.InternetScsiHba.IPProperties`_): The IP settings for this host bus adapter. - supportedAdvancedOptions (`vim.option.OptionDef`_, optional): + supportedAdvancedOptions ([`vim.option.OptionDef`_], optional): A list of supported key/value pair advanced options for the host bus adapter including their type information. - advancedOptions (`vim.host.InternetScsiHba.ParamValue`_, optional): + advancedOptions ([`vim.host.InternetScsiHba.ParamValue`_], optional): A list of the current options settings for the host bus adapter. iScsiName (`str`_): @@ -84,10 +84,10 @@ Attributes: iScsiAlias (`str`_, optional): The iSCSI alias of this host bus adapter. - configuredSendTarget (`vim.host.InternetScsiHba.SendTarget`_, optional): + configuredSendTarget ([`vim.host.InternetScsiHba.SendTarget`_], optional): The configured iSCSI send target entries. - configuredStaticTarget (`vim.host.InternetScsiHba.StaticTarget`_, optional): + configuredStaticTarget ([`vim.host.InternetScsiHba.StaticTarget`_], optional): The configured iSCSI static target entries. maxSpeedMb (`int`_, optional): diff --git a/docs/vim/host/InternetScsiHba/SendTarget.rst b/docs/vim/host/InternetScsiHba/SendTarget.rst index ea1cf86..3c841f8 100644 --- a/docs/vim/host/InternetScsiHba/SendTarget.rst +++ b/docs/vim/host/InternetScsiHba/SendTarget.rst @@ -31,10 +31,10 @@ Attributes: digestProperties (`vim.host.InternetScsiHba.DigestProperties`_, optional): The digest settings for this discovery target. All static targets discovered via this target will inherit the use of these settings unless the static target's digest settings are explicitly set. - supportedAdvancedOptions (`vim.option.OptionDef`_, optional): + supportedAdvancedOptions ([`vim.option.OptionDef`_], optional): A list of supported key/value pair advanced options for the host bus adapter including their type information. - advancedOptions (`vim.host.InternetScsiHba.ParamValue`_, optional): + advancedOptions ([`vim.host.InternetScsiHba.ParamValue`_], optional): A list of the current options settings for the host bus adapter. parent (`str`_, optional): diff --git a/docs/vim/host/InternetScsiHba/StaticTarget.rst b/docs/vim/host/InternetScsiHba/StaticTarget.rst index 0c01f0c..65252ec 100644 --- a/docs/vim/host/InternetScsiHba/StaticTarget.rst +++ b/docs/vim/host/InternetScsiHba/StaticTarget.rst @@ -37,10 +37,10 @@ Attributes: digestProperties (`vim.host.InternetScsiHba.DigestProperties`_, optional): The digest settings for this target. - supportedAdvancedOptions (`vim.option.OptionDef`_, optional): + supportedAdvancedOptions ([`vim.option.OptionDef`_], optional): A list of supported key/value pair advanced options for the host bus adapter including their type information. - advancedOptions (`vim.host.InternetScsiHba.ParamValue`_, optional): + advancedOptions ([`vim.host.InternetScsiHba.ParamValue`_], optional): A list of the current options settings for the host bus adapter. parent (`str`_, optional): diff --git a/docs/vim/host/InternetScsiHba/TargetSet.rst b/docs/vim/host/InternetScsiHba/TargetSet.rst index aed1cae..646de5c 100644 --- a/docs/vim/host/InternetScsiHba/TargetSet.rst +++ b/docs/vim/host/InternetScsiHba/TargetSet.rst @@ -14,7 +14,7 @@ vim.host.InternetScsiHba.TargetSet :since: `vSphere API 4.0`_ Attributes: - staticTargets (`vim.host.InternetScsiHba.StaticTarget`_, optional): + staticTargets ([`vim.host.InternetScsiHba.StaticTarget`_], optional): - sendTargets (`vim.host.InternetScsiHba.SendTarget`_, optional): + sendTargets ([`vim.host.InternetScsiHba.SendTarget`_], optional): diff --git a/docs/vim/host/InternetScsiTargetTransport.rst b/docs/vim/host/InternetScsiTargetTransport.rst index 4308c7d..3d1f031 100644 --- a/docs/vim/host/InternetScsiTargetTransport.rst +++ b/docs/vim/host/InternetScsiTargetTransport.rst @@ -15,6 +15,6 @@ Attributes: iScsiAlias (`str`_): The iSCSI alias of the target. - address (`str`_, optional): + address ([`str`_], optional): The IP addresses through which the target may be reached. diff --git a/docs/vim/host/IpConfig/IpV6AddressConfiguration.rst b/docs/vim/host/IpConfig/IpV6AddressConfiguration.rst index e71a7d7..f7b4852 100644 --- a/docs/vim/host/IpConfig/IpV6AddressConfiguration.rst +++ b/docs/vim/host/IpConfig/IpV6AddressConfiguration.rst @@ -16,7 +16,7 @@ vim.host.IpConfig.IpV6AddressConfiguration :since: `vSphere API 4.0`_ Attributes: - ipV6Address (`vim.host.IpConfig.IpV6Address`_, optional): + ipV6Address ([`vim.host.IpConfig.IpV6Address`_], optional): Ipv6 adrresses configured on the interface. The global addresses can be configured through DHCP, stateless or manual configuration. Link local addresses can be only configured with the origin set to `other`_ . autoConfigurationEnabled (`bool`_, optional): diff --git a/docs/vim/host/IpRouteTableConfig.rst b/docs/vim/host/IpRouteTableConfig.rst index c60c300..5443f85 100644 --- a/docs/vim/host/IpRouteTableConfig.rst +++ b/docs/vim/host/IpRouteTableConfig.rst @@ -12,8 +12,8 @@ vim.host.IpRouteTableConfig :since: `vSphere API 4.0`_ Attributes: - ipRoute (`vim.host.IpRouteOp`_, optional): + ipRoute ([`vim.host.IpRouteOp`_], optional): The array of Routing ops (routes to be added/removed) - ipv6Route (`vim.host.IpRouteOp`_, optional): + ipv6Route ([`vim.host.IpRouteOp`_], optional): diff --git a/docs/vim/host/IpRouteTableInfo.rst b/docs/vim/host/IpRouteTableInfo.rst index b026a47..fce74bd 100644 --- a/docs/vim/host/IpRouteTableInfo.rst +++ b/docs/vim/host/IpRouteTableInfo.rst @@ -12,8 +12,8 @@ vim.host.IpRouteTableInfo :since: `vSphere API 4.0`_ Attributes: - ipRoute (`vim.host.IpRouteEntry`_, optional): + ipRoute ([`vim.host.IpRouteEntry`_], optional): The array of IpRouteEntry - ipv6Route (`vim.host.IpRouteEntry`_, optional): + ipv6Route ([`vim.host.IpRouteEntry`_], optional): diff --git a/docs/vim/host/IscsiManager.rst b/docs/vim/host/IscsiManager.rst index e4ccc21..cc4aa82 100644 --- a/docs/vim/host/IscsiManager.rst +++ b/docs/vim/host/IscsiManager.rst @@ -127,7 +127,7 @@ QueryBoundVnics(iScsiHbaName): Returns: - `vim.host.IscsiManager.IscsiPortInfo`_: + [`vim.host.IscsiManager.IscsiPortInfo`_]: An array of IscsiPortInfo containing detailed information on the list of Virtual NICs bound to the adapter Raises: @@ -156,7 +156,7 @@ QueryCandidateNics(iScsiHbaName): Returns: - `vim.host.IscsiManager.IscsiPortInfo`_: + [`vim.host.IscsiManager.IscsiPortInfo`_]: Array of IscsiPortInfo containing detailed information on list of eligible Virtual NICs that can be bound to the adapter. This list will also include details on the eligible Physical NICs that are not associated with any Virtual NICs. Raises: diff --git a/docs/vim/host/IscsiManager/IscsiMigrationDependency.rst b/docs/vim/host/IscsiManager/IscsiMigrationDependency.rst index e8d41b2..e515900 100644 --- a/docs/vim/host/IscsiManager/IscsiMigrationDependency.rst +++ b/docs/vim/host/IscsiManager/IscsiMigrationDependency.rst @@ -22,6 +22,6 @@ Attributes: disallowReason (`vim.host.IscsiManager.IscsiStatus`_, optional): Reasons for not allowing migration. Unset if migrationAllowed is true. - dependency (`vim.host.IscsiManager.IscsiDependencyEntity`_, optional): + dependency ([`vim.host.IscsiManager.IscsiDependencyEntity`_], optional): Details of all the resources affected by migration. diff --git a/docs/vim/host/IscsiManager/IscsiStatus.rst b/docs/vim/host/IscsiManager/IscsiStatus.rst index 32d4336..bc2f9a4 100644 --- a/docs/vim/host/IscsiManager/IscsiStatus.rst +++ b/docs/vim/host/IscsiManager/IscsiStatus.rst @@ -14,6 +14,6 @@ vim.host.IscsiManager.IscsiStatus :since: `vSphere API 5.0`_ Attributes: - reason (`vmodl.LocalizedMethodFault`_, optional): + reason ([`vmodl.LocalizedMethodFault`_], optional): List of failure reason and associated remedy. An array of fault codes associated with the failure. The fault itself will provide an indication of the actual failure code and `faultMessage`_ will indicate the remedy that needs to be taken to correct the failure. diff --git a/docs/vim/host/KernelModuleSystem.rst b/docs/vim/host/KernelModuleSystem.rst index 54fbd8a..4a3677c 100644 --- a/docs/vim/host/KernelModuleSystem.rst +++ b/docs/vim/host/KernelModuleSystem.rst @@ -41,7 +41,7 @@ QueryModules(): Returns: - `vim.host.KernelModuleSystem.ModuleInfo`_: + [`vim.host.KernelModuleSystem.ModuleInfo`_]: diff --git a/docs/vim/host/LicenseSpec.rst b/docs/vim/host/LicenseSpec.rst index 837f8a3..524c822 100644 --- a/docs/vim/host/LicenseSpec.rst +++ b/docs/vim/host/LicenseSpec.rst @@ -20,9 +20,9 @@ Attributes: editionKey (`str`_, optional): License edition to use - disabledFeatureKey (`str`_, optional): + disabledFeatureKey ([`str`_], optional): Disabled features. When an edition is set, all the features in it are enabled by default. The following parameter gives a finer control on which features are disabled. - enabledFeatureKey (`str`_, optional): + enabledFeatureKey ([`str`_], optional): Enabled features diff --git a/docs/vim/host/LowLevelProvisioningManager/SnapshotLayoutSpec.rst b/docs/vim/host/LowLevelProvisioningManager/SnapshotLayoutSpec.rst index 7b5d804..3cb8df8 100644 --- a/docs/vim/host/LowLevelProvisioningManager/SnapshotLayoutSpec.rst +++ b/docs/vim/host/LowLevelProvisioningManager/SnapshotLayoutSpec.rst @@ -25,6 +25,6 @@ Attributes: dstFilename (`str`_): Name of the destination snapshot file in datastore path. - disk (`vim.host.LowLevelProvisioningManager.DiskLayoutSpec`_, optional): + disk ([`vim.host.LowLevelProvisioningManager.DiskLayoutSpec`_], optional): Layout of each virtual disk of the virtual machine when the snapshot was taken. diff --git a/docs/vim/host/MultipathInfo.rst b/docs/vim/host/MultipathInfo.rst index a8bda69..c73d86a 100644 --- a/docs/vim/host/MultipathInfo.rst +++ b/docs/vim/host/MultipathInfo.rst @@ -15,6 +15,6 @@ vim.host.MultipathInfo :extends: vmodl.DynamicData_ Attributes: - lun (`vim.host.MultipathInfo.LogicalUnit`_, optional): + lun ([`vim.host.MultipathInfo.LogicalUnit`_], optional): List of logical units that can be configured for multipathing. diff --git a/docs/vim/host/MultipathInfo/LogicalUnit.rst b/docs/vim/host/MultipathInfo/LogicalUnit.rst index ab52802..c9045ac 100644 --- a/docs/vim/host/MultipathInfo/LogicalUnit.rst +++ b/docs/vim/host/MultipathInfo/LogicalUnit.rst @@ -30,7 +30,7 @@ Attributes: lun (`vim.host.ScsiLun`_): SCSI device corresponding to logical unit. - path (`vim.host.MultipathInfo.Path`_): + path ([`vim.host.MultipathInfo.Path`_]): Array of paths available to access this LogicalUnit. policy (`vim.host.MultipathInfo.LogicalUnitPolicy`_): diff --git a/docs/vim/host/MultipathStateInfo.rst b/docs/vim/host/MultipathStateInfo.rst index 23f9298..f370413 100644 --- a/docs/vim/host/MultipathStateInfo.rst +++ b/docs/vim/host/MultipathStateInfo.rst @@ -12,6 +12,6 @@ vim.host.MultipathStateInfo :since: `vSphere API 4.0`_ Attributes: - path (`vim.host.MultipathStateInfo.Path`_, optional): + path ([`vim.host.MultipathStateInfo.Path`_], optional): List of paths on the system and their path states. diff --git a/docs/vim/host/NatService/NameServiceSpec.rst b/docs/vim/host/NatService/NameServiceSpec.rst index 41b8bd2..a13ac2e 100644 --- a/docs/vim/host/NatService/NameServiceSpec.rst +++ b/docs/vim/host/NatService/NameServiceSpec.rst @@ -28,7 +28,7 @@ Attributes: dnsTimeout (`int`_): The time (in seconds) before retrying a DNS request to an external network. - dnsNameServer (`str`_, optional): + dnsNameServer ([`str`_], optional): The list of DNS servers. nbdsTimeout (`int`_): diff --git a/docs/vim/host/NatService/Specification.rst b/docs/vim/host/NatService/Specification.rst index e2a938a..6ac6823 100644 --- a/docs/vim/host/NatService/Specification.rst +++ b/docs/vim/host/NatService/Specification.rst @@ -38,7 +38,7 @@ Attributes: udpTimeout (`int`_): The time allotted for UDP packets. - portForward (`vim.host.NatService.PortForwardSpecification`_, optional): + portForward ([`vim.host.NatService.PortForwardSpecification`_], optional): The port forwarding specifications to allow network connections to be initiated from outside the firewall. nameService (`vim.host.NatService.NameServiceSpec`_, optional): diff --git a/docs/vim/host/NetCapabilities.rst b/docs/vim/host/NetCapabilities.rst index 17f8f3c..20e4e61 100644 --- a/docs/vim/host/NetCapabilities.rst +++ b/docs/vim/host/NetCapabilities.rst @@ -19,7 +19,7 @@ Attributes: supportsNicTeaming (`bool`_): The flag to indicate whether or not network adapter teaming is available. Multiple network adapters can be bridged to a virtual switch through a BondBridge. Also, network adapter teaming policies such as failover order and detection are enabled. - nicTeamingPolicy (`str`_, optional): + nicTeamingPolicy ([`str`_], optional): The available teaming policies if the platform supports network adapter teaming. supportsVlan (`bool`_): diff --git a/docs/vim/host/NetworkConfig.rst b/docs/vim/host/NetworkConfig.rst index ebde978..a2ba6f1 100644 --- a/docs/vim/host/NetworkConfig.rst +++ b/docs/vim/host/NetworkConfig.rst @@ -35,22 +35,22 @@ vim.host.NetworkConfig :extends: vmodl.DynamicData_ Attributes: - vswitch (`vim.host.VirtualSwitch.Config`_, optional): + vswitch ([`vim.host.VirtualSwitch.Config`_], optional): Virtual switches configured on the host. - proxySwitch (`vim.host.HostProxySwitch.Config`_, optional): + proxySwitch ([`vim.host.HostProxySwitch.Config`_], optional): Host proxy switches configured on the host. - portgroup (`vim.host.PortGroup.Config`_, optional): + portgroup ([`vim.host.PortGroup.Config`_], optional): Port groups configured on the host. - pnic (`vim.host.PhysicalNic.Config`_, optional): + pnic ([`vim.host.PhysicalNic.Config`_], optional): Physical network adapters as seen by the primary operating system. - vnic (`vim.host.VirtualNic.Config`_, optional): + vnic ([`vim.host.VirtualNic.Config`_], optional): Virtual network adapters configured for use by the host operating system network adapter. - consoleVnic (`vim.host.VirtualNic.Config`_, optional): + consoleVnic ([`vim.host.VirtualNic.Config`_], optional): Virtual network adapters configured for use by the Service Console. dnsConfig (`vim.host.DnsConfig`_, optional): @@ -65,15 +65,15 @@ Attributes: routeTableConfig (`vim.host.IpRouteTableConfig`_, optional): IP routing table configuration of the host. - dhcp (`vim.host.DhcpService.Config`_, optional): + dhcp ([`vim.host.DhcpService.Config`_], optional): Dynamic Host Control Protocol (DHCP) Service instances configured on the host. - nat (`vim.host.NatService.Config`_, optional): + nat ([`vim.host.NatService.Config`_], optional): Network address translation (NAT) Service instances configured on the host. ipV6Enabled (`bool`_, optional): Enable or disable IPv6 protocol on this system. This property must be set by itself, no other property can accompany this change. Following the successful change, the system should be rebooted to have the change take effect. - netStackSpec (`vim.host.NetworkConfig.NetStackSpec`_, optional): + netStackSpec ([`vim.host.NetworkConfig.NetStackSpec`_], optional): The list of network stack instance spec diff --git a/docs/vim/host/NetworkConfig/Result.rst b/docs/vim/host/NetworkConfig/Result.rst index 2c5bfe0..419d6f0 100644 --- a/docs/vim/host/NetworkConfig/Result.rst +++ b/docs/vim/host/NetworkConfig/Result.rst @@ -11,9 +11,9 @@ vim.host.NetworkConfig.Result :extends: vmodl.DynamicData_ Attributes: - vnicDevice (`str`_, optional): + vnicDevice ([`str`_], optional): Virtual network adapter keys. - consoleVnicDevice (`str`_, optional): + consoleVnicDevice ([`str`_], optional): Service console virtual network adapter keys. diff --git a/docs/vim/host/NetworkInfo.rst b/docs/vim/host/NetworkInfo.rst index 635951f..3198a93 100644 --- a/docs/vim/host/NetworkInfo.rst +++ b/docs/vim/host/NetworkInfo.rst @@ -35,22 +35,22 @@ vim.host.NetworkInfo :extends: vmodl.DynamicData_ Attributes: - vswitch (`vim.host.VirtualSwitch`_, optional): + vswitch ([`vim.host.VirtualSwitch`_], optional): Virtual switches configured on the host. - proxySwitch (`vim.host.HostProxySwitch`_, optional): + proxySwitch ([`vim.host.HostProxySwitch`_], optional): Proxy switches configured on the host. - portgroup (`vim.host.PortGroup`_, optional): + portgroup ([`vim.host.PortGroup`_], optional): Port groups configured on the host. - pnic (`vim.host.PhysicalNic`_, optional): + pnic ([`vim.host.PhysicalNic`_], optional): Physical network adapters as seen by the primary operating system. - vnic (`vim.host.VirtualNic`_, optional): + vnic ([`vim.host.VirtualNic`_], optional): Virtual network adapters configured on the host (hosted products) or the vmkernel. In the hosted architecture, these network adapters are used by the host to communicate with the virtual machines running on that host. In the VMkernel architecture, these virtual network adapters provide the ESX Server with external network access through a virtual switch that is bridged to a physical network adapter. The VMkernel uses these network adapters for features such as VMotion, NAS, iSCSI, and remote MKS connections. - consoleVnic (`vim.host.VirtualNic`_, optional): + consoleVnic ([`vim.host.VirtualNic`_], optional): Virtual network adapters configured for use by the service console. The service console uses this network access for system management and bootstrapping services like network boot. The two sets of virtual network adapters are mutually exclusive. A virtual network adapter in this list cannot be used for things like VMotion. Likewise, a virtual network adapter in the other list cannot be used by the service console. dnsConfig (`vim.host.DnsConfig`_, optional): @@ -65,10 +65,10 @@ Attributes: routeTableInfo (`vim.host.IpRouteTableInfo`_, optional): IP routing table - dhcp (`vim.host.DhcpService`_, optional): + dhcp ([`vim.host.DhcpService`_], optional): DHCP Service instances configured on the host. - nat (`vim.host.NatService`_, optional): + nat ([`vim.host.NatService`_], optional): NAT service instances configured on the host. ipV6Enabled (`bool`_, optional): @@ -77,12 +77,12 @@ Attributes: atBootIpV6Enabled (`bool`_, optional): If true then dual IPv4/IPv6 stack enabled else IPv4 only. - netStackInstance (`vim.host.NetStackInstance`_, optional): + netStackInstance ([`vim.host.NetStackInstance`_], optional): List of NetStackInstances - opaqueSwitch (`vim.host.OpaqueSwitch`_, optional): + opaqueSwitch ([`vim.host.OpaqueSwitch`_], optional): List of opaque switches configured on the host. - opaqueNetwork (`vim.host.OpaqueNetworkInfo`_, optional): + opaqueNetwork ([`vim.host.OpaqueNetworkInfo`_], optional): List of opaque networks diff --git a/docs/vim/host/NetworkPolicy/NicOrderPolicy.rst b/docs/vim/host/NetworkPolicy/NicOrderPolicy.rst index 7b3780e..e597328 100644 --- a/docs/vim/host/NetworkPolicy/NicOrderPolicy.rst +++ b/docs/vim/host/NetworkPolicy/NicOrderPolicy.rst @@ -9,9 +9,9 @@ vim.host.NetworkPolicy.NicOrderPolicy :extends: vmodl.DynamicData_ Attributes: - activeNic (`str`_, optional): + activeNic ([`str`_], optional): List of active network adapters used for load balancing. - standbyNic (`str`_, optional): + standbyNic ([`str`_], optional): Standby network adapters used for failover. diff --git a/docs/vim/host/NetworkSystem.rst b/docs/vim/host/NetworkSystem.rst index 9445046..05cac20 100644 --- a/docs/vim/host/NetworkSystem.rst +++ b/docs/vim/host/NetworkSystem.rst @@ -546,7 +546,7 @@ QueryNetworkHint(device): Returns: - `vim.host.PhysicalNic.NetworkHint`_: + [`vim.host.PhysicalNic.NetworkHint`_]: Raises: diff --git a/docs/vim/host/NtpConfig.rst b/docs/vim/host/NtpConfig.rst index 5dcedd3..c7db513 100644 --- a/docs/vim/host/NtpConfig.rst +++ b/docs/vim/host/NtpConfig.rst @@ -12,6 +12,6 @@ vim.host.NtpConfig :since: `VI API 2.5`_ Attributes: - server (`str`_, optional): + server ([`str`_], optional): List of time servers, specified as either IP addresses or fully qualified domain names (FQDNs). diff --git a/docs/vim/host/NumaInfo.rst b/docs/vim/host/NumaInfo.rst index 764676a..73dd06f 100644 --- a/docs/vim/host/NumaInfo.rst +++ b/docs/vim/host/NumaInfo.rst @@ -19,6 +19,6 @@ Attributes: numNodes (`int`_): The number of NUMA nodes on the host. The value is 0 if the host is not NUMA-capable. - numaNode (`vim.host.NumaNode`_, optional): + numaNode ([`vim.host.NumaNode`_], optional): Information about each of the NUMA nodes on the host. The array is empty if the host is not NUMA-capable. diff --git a/docs/vim/host/NumaNode.rst b/docs/vim/host/NumaNode.rst index cb6f627..57918c8 100644 --- a/docs/vim/host/NumaNode.rst +++ b/docs/vim/host/NumaNode.rst @@ -16,7 +16,7 @@ Attributes: typeId (`int`_): Zero-based NUMA ID for the node. - cpuID (`short`_): + cpuID ([`short`_]): Information about each of the CPUs associated with the node. memoryRangeBegin (`long`_): diff --git a/docs/vim/host/OpaqueSwitch.rst b/docs/vim/host/OpaqueSwitch.rst index 59c645a..32b8380 100644 --- a/docs/vim/host/OpaqueSwitch.rst +++ b/docs/vim/host/OpaqueSwitch.rst @@ -20,6 +20,6 @@ Attributes: name (`str`_, optional): The opaque switch name. - pnic (`vim.host.PhysicalNic`_, optional): + pnic ([`vim.host.PhysicalNic`_], optional): The set of physical network adapters associated with this switch. diff --git a/docs/vim/host/PatchManager/Result.rst b/docs/vim/host/PatchManager/Result.rst index 3969efd..18aee44 100644 --- a/docs/vim/host/PatchManager/Result.rst +++ b/docs/vim/host/PatchManager/Result.rst @@ -17,7 +17,7 @@ Attributes: version (`str`_): The version of the scan result schema. - status (`vim.host.PatchManager.Status`_, optional): + status ([`vim.host.PatchManager.Status`_], optional): The scan results for each patch. xmlResult (`str`_, optional): diff --git a/docs/vim/host/PatchManager/Status.rst b/docs/vim/host/PatchManager/Status.rst index eae0c2e..617e71a 100644 --- a/docs/vim/host/PatchManager/Status.rst +++ b/docs/vim/host/PatchManager/Status.rst @@ -27,7 +27,7 @@ Attributes: applicable (`bool`_): Whether or not this update is applicable to this host. An update may not be applicable to the ESX host for many reasons--for example, it is obsolete, it conflicts with other installed patches or libraries, and so on. The `reason`_ shows some of the reasons why the update is not applicable. An update could be inapplicable with no reason listed. This is because the prerequisite install state is not correct. For example, update A is one of the prerequisites of update B. B not only requires A to be installed, but also requires the host is rebooted after A is installed. When A is installed and the host has not been restarted after the installation, B will not be applicable. In such a case, the scan on both updates A and B would yield a whole picture of the update applicable status. - reason (`str`_, optional): + reason ([`str`_], optional): Possible reasons why an update is not applicable to the ESX host.See `HostPatchManagerReason`_ integrity (`str`_, optional): @@ -36,10 +36,10 @@ Attributes: installed (`bool`_): Whether the update is installed on the server. - installState (`str`_, optional): + installState ([`str`_], optional): The installation state of the update. Unset if the update is not installed on the server.See `HostPatchManagerInstallState`_ - prerequisitePatch (`vim.host.PatchManager.Status.PrerequisitePatch`_, optional): + prerequisitePatch ([`vim.host.PatchManager.Status.PrerequisitePatch`_], optional): Prerequisite update. restartRequired (`bool`_): @@ -51,6 +51,6 @@ Attributes: vmOffRequired (`bool`_): Whether or not this update requires the host in maintenance mode. - supersededPatchIds (`str`_, optional): + supersededPatchIds ([`str`_], optional): Patches that are superseded by this update. diff --git a/docs/vim/host/PatchManager/Status/PrerequisitePatch.rst b/docs/vim/host/PatchManager/Status/PrerequisitePatch.rst index b05e950..23d7d86 100644 --- a/docs/vim/host/PatchManager/Status/PrerequisitePatch.rst +++ b/docs/vim/host/PatchManager/Status/PrerequisitePatch.rst @@ -14,6 +14,6 @@ Attributes: id (`str`_): Unique identifier of the prerequisite update. - installState (`str`_, optional): + installState ([`str`_], optional): The requirement on the server or services running on the server pertaining to the prerequisite update. For example, this update could require the server to be rebooted after the prerequisite update is installed. Unset if there is no additional requirement on the prerequisite update.See `HostPatchManagerInstallState`_ diff --git a/docs/vim/host/PciPassthruSystem.rst b/docs/vim/host/PciPassthruSystem.rst index b61f5fa..65043db 100644 --- a/docs/vim/host/PciPassthruSystem.rst +++ b/docs/vim/host/PciPassthruSystem.rst @@ -22,7 +22,7 @@ vim.host.PciPassthruSystem Attributes ---------- - pciPassthruInfo (`vim.host.PciPassthruInfo`_): + pciPassthruInfo ([`vim.host.PciPassthruInfo`_]): privilege: System.Read Array of PciPassthru information diff --git a/docs/vim/host/PhysicalNic.rst b/docs/vim/host/PhysicalNic.rst index 92d45ca..cec58bd 100644 --- a/docs/vim/host/PhysicalNic.rst +++ b/docs/vim/host/PhysicalNic.rst @@ -42,7 +42,7 @@ Attributes: linkSpeed (`vim.host.PhysicalNic.LinkSpeedDuplex`_, optional): The current link state of the physical network adapter. If this object is not set, then the link is down. - validLinkSpecification (`vim.host.PhysicalNic.LinkSpeedDuplex`_, optional): + validLinkSpecification ([`vim.host.PhysicalNic.LinkSpeedDuplex`_], optional): The valid combinations of speed and duplexity for this physical network adapter. The speed and the duplex settings usually must be configured as a pair. This array lists all the valid combinations available for a physical network adapter.Autonegotiate is not listed as one of the combinations supported. If is implicitly supported by the physical network adapter unless `autoNegotiateSupported`_ is set to false. spec (`vim.host.PhysicalNic.Specification`_): @@ -66,7 +66,7 @@ Attributes: resourcePoolSchedulerAllowed (`bool`_, optional): Flag indicating whether the NIC allows resource pool based scheduling for network I/O control. - resourcePoolSchedulerDisallowedReason (`str`_, optional): + resourcePoolSchedulerDisallowedReason ([`str`_], optional): If `resourcePoolSchedulerAllowed`_ is false, this property advertises the reason for disallowing resource scheduling on this NIC. The reasons may be one of `PhysicalNicResourcePoolSchedulerDisallowedReason`_ autoNegotiateSupported (`bool`_, optional): diff --git a/docs/vim/host/PhysicalNic/LldpInfo.rst b/docs/vim/host/PhysicalNic/LldpInfo.rst index d28fd63..f9c9c9f 100644 --- a/docs/vim/host/PhysicalNic/LldpInfo.rst +++ b/docs/vim/host/PhysicalNic/LldpInfo.rst @@ -25,6 +25,6 @@ Attributes: timeToLive (`int`_): It is the duration of time in seconds for which information contained in the received LLDP frame shall be valid. If a value of zero is sent it can also identify a device that has shut down or is no longer transmitting, prompting deletion of the record from the local database. - parameter (`vmodl.KeyAnyValue`_, optional): + parameter ([`vmodl.KeyAnyValue`_], optional): LLDP parameters diff --git a/docs/vim/host/PhysicalNic/NetworkHint.rst b/docs/vim/host/PhysicalNic/NetworkHint.rst index 398f531..65b5d69 100644 --- a/docs/vim/host/PhysicalNic/NetworkHint.rst +++ b/docs/vim/host/PhysicalNic/NetworkHint.rst @@ -22,10 +22,10 @@ Attributes: device (`str`_): The physical network adapter device to which this hint applies. - subnet (`vim.host.PhysicalNic.NetworkHint.IpNetwork`_, optional): + subnet ([`vim.host.PhysicalNic.NetworkHint.IpNetwork`_], optional): The list of subnets that were detected on this physical network adapter. - network (`vim.host.PhysicalNic.NetworkHint.NamedNetwork`_, optional): + network ([`vim.host.PhysicalNic.NetworkHint.NamedNetwork`_], optional): The list of network names that were detected on this physical network adapter. connectedSwitchPort (`vim.host.PhysicalNic.CdpInfo`_, optional): diff --git a/docs/vim/host/PlugStoreTopology.rst b/docs/vim/host/PlugStoreTopology.rst index c851ab5..214930d 100644 --- a/docs/vim/host/PlugStoreTopology.rst +++ b/docs/vim/host/PlugStoreTopology.rst @@ -26,18 +26,18 @@ vim.host.PlugStoreTopology :since: `vSphere API 4.0`_ Attributes: - adapter (`vim.host.PlugStoreTopology.Adapter`_, optional): + adapter ([`vim.host.PlugStoreTopology.Adapter`_], optional): List of host bus adapters in the plug store inventory. - path (`vim.host.PlugStoreTopology.Path`_, optional): + path ([`vim.host.PlugStoreTopology.Path`_], optional): List of paths in the plug store inventory. - target (`vim.host.PlugStoreTopology.Target`_, optional): + target ([`vim.host.PlugStoreTopology.Target`_], optional): Partial list of targets as seen by the host. The list of targets may not be exhaustive on the host. - device (`vim.host.PlugStoreTopology.Device`_, optional): + device ([`vim.host.PlugStoreTopology.Device`_], optional): List of devices in the plug store inventory. - plugin (`vim.host.PlugStoreTopology.Plugin`_, optional): + plugin ([`vim.host.PlugStoreTopology.Plugin`_], optional): List of plugins in the plug store inventory. diff --git a/docs/vim/host/PlugStoreTopology/Adapter.rst b/docs/vim/host/PlugStoreTopology/Adapter.rst index a255fd2..97289ea 100644 --- a/docs/vim/host/PlugStoreTopology/Adapter.rst +++ b/docs/vim/host/PlugStoreTopology/Adapter.rst @@ -22,6 +22,6 @@ Attributes: adapter (`vim.host.HostBusAdapter`_): The link to the host bus adapter for this inebtrface. - path (`vim.host.PlugStoreTopology.Path`_, optional): + path ([`vim.host.PlugStoreTopology.Path`_], optional): The list of paths to which the host bus adapter is associated. diff --git a/docs/vim/host/PlugStoreTopology/Device.rst b/docs/vim/host/PlugStoreTopology/Device.rst index 3f05a64..4a41286 100644 --- a/docs/vim/host/PlugStoreTopology/Device.rst +++ b/docs/vim/host/PlugStoreTopology/Device.rst @@ -22,6 +22,6 @@ Attributes: lun (`vim.host.ScsiLun`_): The SCSI device corresponding to logical unit. - path (`vim.host.PlugStoreTopology.Path`_, optional): + path ([`vim.host.PlugStoreTopology.Path`_], optional): The array of paths available to access this LogicalUnit. diff --git a/docs/vim/host/PlugStoreTopology/Plugin.rst b/docs/vim/host/PlugStoreTopology/Plugin.rst index 63b46c9..0e206be 100644 --- a/docs/vim/host/PlugStoreTopology/Plugin.rst +++ b/docs/vim/host/PlugStoreTopology/Plugin.rst @@ -22,9 +22,9 @@ Attributes: name (`str`_): The name of the plugin. - device (`vim.host.PlugStoreTopology.Device`_, optional): + device ([`vim.host.PlugStoreTopology.Device`_], optional): The set of devices formed by this plugin. - claimedPath (`vim.host.PlugStoreTopology.Path`_, optional): + claimedPath ([`vim.host.PlugStoreTopology.Path`_], optional): The set of paths claimed by this plugin. Not every claimed path will necessarily appear as part of a Device. Claimed paths will only appear under Devices if the device identifier of the path matches up with the device identifier exposed by the Device. diff --git a/docs/vim/host/PortGroup.rst b/docs/vim/host/PortGroup.rst index 75a8389..ca01718 100644 --- a/docs/vim/host/PortGroup.rst +++ b/docs/vim/host/PortGroup.rst @@ -22,7 +22,7 @@ Attributes: key (`str`_, optional): The linkable identifier. - port (`vim.host.PortGroup.Port`_, optional): + port ([`vim.host.PortGroup.Port`_], optional): The ports that currently exist and are used on this port group. vswitch (`vim.host.VirtualSwitch`_, optional): diff --git a/docs/vim/host/PortGroup/Port.rst b/docs/vim/host/PortGroup/Port.rst index 03a8a8e..9b08639 100644 --- a/docs/vim/host/PortGroup/Port.rst +++ b/docs/vim/host/PortGroup/Port.rst @@ -14,7 +14,7 @@ Attributes: key (`str`_, optional): The linkable identifier. - mac (`str`_, optional): + mac ([`str`_], optional): The Media Access Control (MAC) address of network service of the virtual machine connected on this port. type (`str`_): diff --git a/docs/vim/host/PowerSystem/Capability.rst b/docs/vim/host/PowerSystem/Capability.rst index 36595e5..6160dd7 100644 --- a/docs/vim/host/PowerSystem/Capability.rst +++ b/docs/vim/host/PowerSystem/Capability.rst @@ -12,6 +12,6 @@ vim.host.PowerSystem.Capability :since: `vSphere API 4.1`_ Attributes: - availablePolicy (`vim.host.PowerSystem.PowerPolicy`_): + availablePolicy ([`vim.host.PowerSystem.PowerPolicy`_]): List of available host power policies. diff --git a/docs/vim/host/ResignatureRescanResult.rst b/docs/vim/host/ResignatureRescanResult.rst index 1995312..a4e0c5e 100644 --- a/docs/vim/host/ResignatureRescanResult.rst +++ b/docs/vim/host/ResignatureRescanResult.rst @@ -18,7 +18,7 @@ vim.host.ResignatureRescanResult :since: `vSphere API 4.0`_ Attributes: - rescan (`vim.host.VmfsRescanResult`_, optional): + rescan ([`vim.host.VmfsRescanResult`_], optional): List of VMFS Rescan operation results. result (`vim.Datastore`_): diff --git a/docs/vim/host/Ruleset.rst b/docs/vim/host/Ruleset.rst index 83e9cbd..68e4b83 100644 --- a/docs/vim/host/Ruleset.rst +++ b/docs/vim/host/Ruleset.rst @@ -28,7 +28,7 @@ Attributes: required (`bool`_): Flag indicating whether the ruleset is required and cannot be disabled. - rule (`vim.host.Ruleset.Rule`_): + rule ([`vim.host.Ruleset.Rule`_]): List of rules within the ruleset. service (`str`_, optional): diff --git a/docs/vim/host/Ruleset/IpList.rst b/docs/vim/host/Ruleset/IpList.rst index a6b4ace..3948968 100644 --- a/docs/vim/host/Ruleset/IpList.rst +++ b/docs/vim/host/Ruleset/IpList.rst @@ -16,10 +16,10 @@ vim.host.Ruleset.IpList :since: `vSphere API 5.0`_ Attributes: - ipAddress (`str`_, optional): + ipAddress ([`str`_], optional): The list of ipAddresses. All IPv4 addresses are specified as strings using dotted decimal format. For example, "192.0.20.10". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373. - ipNetwork (`vim.host.Ruleset.IpNetwork`_, optional): + ipNetwork ([`vim.host.Ruleset.IpNetwork`_], optional): The list of networks allIp (`bool`_): diff --git a/docs/vim/host/RuntimeInfo.rst b/docs/vim/host/RuntimeInfo.rst index 11deea8..2c7ccaa 100644 --- a/docs/vim/host/RuntimeInfo.rst +++ b/docs/vim/host/RuntimeInfo.rst @@ -64,7 +64,7 @@ Attributes: dasHostState (`vim.cluster.DasFdmHostState`_, optional): The availability state of an active host in a vSphere HA enabled cluster. A host is inactive if it is in maintenance or standby mode, or it has been disconnected from vCenter Server. The active hosts in a cluster form a vSphere HA fault domain.The property is unset if vSphere HA is disabled, the host is in maintenance or standby mode, or the host is disconnected from vCenter Server. - tpmPcrValues (`vim.host.TpmDigestInfo`_, optional): + tpmPcrValues ([`vim.host.TpmDigestInfo`_], optional): The array of PCR digest values stored in the TPM device since the last host boot time. vsanRuntimeInfo (`vim.vsan.host.VsanRuntimeInfo`_, optional): diff --git a/docs/vim/host/RuntimeInfo/NetStackInstanceRuntimeInfo.rst b/docs/vim/host/RuntimeInfo/NetStackInstanceRuntimeInfo.rst index d0c4467..f17fa50 100644 --- a/docs/vim/host/RuntimeInfo/NetStackInstanceRuntimeInfo.rst +++ b/docs/vim/host/RuntimeInfo/NetStackInstanceRuntimeInfo.rst @@ -22,7 +22,7 @@ Attributes: state (`str`_, optional): State of the instance See State for valid values. - vmknicKeys (`str`_, optional): + vmknicKeys ([`str`_], optional): The keys of vmknics that are using this stack maxNumberOfConnections (`int`_, optional): diff --git a/docs/vim/host/RuntimeInfo/NetworkRuntimeInfo.rst b/docs/vim/host/RuntimeInfo/NetworkRuntimeInfo.rst index 1752d38..abcaf92 100644 --- a/docs/vim/host/RuntimeInfo/NetworkRuntimeInfo.rst +++ b/docs/vim/host/RuntimeInfo/NetworkRuntimeInfo.rst @@ -12,6 +12,6 @@ vim.host.RuntimeInfo.NetworkRuntimeInfo :since: `vSphere API 5.5`_ Attributes: - netStackInstanceRuntimeInfo (`vim.host.RuntimeInfo.NetStackInstanceRuntimeInfo`_, optional): + netStackInstanceRuntimeInfo ([`vim.host.RuntimeInfo.NetStackInstanceRuntimeInfo`_], optional): The list of network stack runtime info diff --git a/docs/vim/host/ScsiLun.rst b/docs/vim/host/ScsiLun.rst index 6b18bec..0dadfd9 100644 --- a/docs/vim/host/ScsiLun.rst +++ b/docs/vim/host/ScsiLun.rst @@ -77,7 +77,7 @@ Attributes: uuid (`str`_): Universally unique identifier for the LUN used to identify ScsiLun across multiple servers.This identifier can be used to identify analogous objects in other views such as `HostMultipathInfoLogicalUnit`_ and `HostScsiTopologyLun`_ .See `HostMultipathInfoLogicalUnit`_ See `HostScsiTopologyLun`_ - descriptor (`vim.host.ScsiLun.Descriptor`_, optional): + descriptor ([`vim.host.ScsiLun.Descriptor`_], optional): List of descriptors that can be used to identify the LUN object. The uuid will also appear as a descriptor.The id field in the descriptor is a string that can be used to correlate the ScsiLun across multiple servers. A ScsiLun may have multiple descriptors. The choice and order of these descriptors may be different on different servers.Not all descriptors are suitable for correlation. Some descriptors are only sufficient to identify the ScsiLun within a single host. Each descriptor contains a quality property that indicates whether or not the descriptor is suitable for correlation. canonicalName (`str`_, optional): @@ -107,16 +107,16 @@ Attributes: durableName (`vim.host.ScsiLun.DurableName`_, optional): The durable name of the SCSI device. For a SCSI-3 compliant device this property is derived from the payloads of pages 80h and 83h of the Vital Product Data (VPD) as defined by the T10 and SMI standards. For devices that do not provide this information, this property is not defined. - alternateName (`vim.host.ScsiLun.DurableName`_, optional): + alternateName ([`vim.host.ScsiLun.DurableName`_], optional): Alternate durable names. Records all available durable names derived from page 80h of the Vital Product Data (VPD) and the Identification Vital Product Data (VPD) page 83h as defined by the SCSI-3 Primary Commands. For devices that are not SCSI-3 compliant this property is not defined. - standardInquiry (`int`_, optional): + standardInquiry ([`int`_], optional): Standard Inquiry payload. For a SCSI-3 compliant device this property is derived from the standard inquiry data. For devices that are not SCSI-3 compliant this property is not defined. queueDepth (`int`_, optional): The queue depth of SCSI device. - operationalState (`str`_): + operationalState ([`str`_]): The operational states of the LUN. When more than one item is present in the array, the first state should be considered the primary state. For example, a LUN may be "ok" and "degraded" indicating I/O is still possible to the LUN, but it is operating in a degraded mode.See `ScsiLunState`_ capabilities (`vim.host.ScsiLun.Capabilities`_, optional): diff --git a/docs/vim/host/ScsiLun/DurableName.rst b/docs/vim/host/ScsiLun/DurableName.rst index c762ed1..273e1e1 100644 --- a/docs/vim/host/ScsiLun/DurableName.rst +++ b/docs/vim/host/ScsiLun/DurableName.rst @@ -17,6 +17,6 @@ Attributes: namespaceId (`int`_): The byte used by the ESX Server product to represent the namespace. - data (`int`_, optional): + data ([`int`_], optional): The variable length byte array containing the namespace-specific data. For a SCSI-3 compliant device this field is the descriptor header along with the payload for data obtained from page 83h, and is the payload for data obtained from page 80h of the Vital Product Data (VPD). diff --git a/docs/vim/host/ScsiTopology.rst b/docs/vim/host/ScsiTopology.rst index 36a3ed6..b83961c 100644 --- a/docs/vim/host/ScsiTopology.rst +++ b/docs/vim/host/ScsiTopology.rst @@ -13,6 +13,6 @@ vim.host.ScsiTopology :extends: vmodl.DynamicData_ Attributes: - adapter (`vim.host.ScsiTopology.Interface`_, optional): + adapter ([`vim.host.ScsiTopology.Interface`_], optional): The list of SCSI interfaces. diff --git a/docs/vim/host/ScsiTopology/Interface.rst b/docs/vim/host/ScsiTopology/Interface.rst index 3eaa3e8..1788f55 100644 --- a/docs/vim/host/ScsiTopology/Interface.rst +++ b/docs/vim/host/ScsiTopology/Interface.rst @@ -19,6 +19,6 @@ Attributes: adapter (`vim.host.HostBusAdapter`_): The link to data for this SCSI interface. - target (`vim.host.ScsiTopology.Target`_, optional): + target ([`vim.host.ScsiTopology.Target`_], optional): The list of targets to which the SCSI interface is associated. diff --git a/docs/vim/host/ScsiTopology/Target.rst b/docs/vim/host/ScsiTopology/Target.rst index df3a173..c15c711 100644 --- a/docs/vim/host/ScsiTopology/Target.rst +++ b/docs/vim/host/ScsiTopology/Target.rst @@ -21,7 +21,7 @@ Attributes: target (`int`_): The target identifier. - lun (`vim.host.ScsiTopology.Lun`_, optional): + lun ([`vim.host.ScsiTopology.Lun`_], optional): The list of SCSI logical units with which a target is associated. transport (`vim.host.TargetTransport`_, optional): diff --git a/docs/vim/host/SecuritySpec.rst b/docs/vim/host/SecuritySpec.rst index cc329f5..0caca68 100644 --- a/docs/vim/host/SecuritySpec.rst +++ b/docs/vim/host/SecuritySpec.rst @@ -17,9 +17,9 @@ Attributes: adminPassword (`str`_, optional): Administrator password to configure - removePermission (`vim.AuthorizationManager.Permission`_, optional): + removePermission ([`vim.AuthorizationManager.Permission`_], optional): Permissions to remove - addPermission (`vim.AuthorizationManager.Permission`_, optional): + addPermission ([`vim.AuthorizationManager.Permission`_], optional): Permissions to add diff --git a/docs/vim/host/Service.rst b/docs/vim/host/Service.rst index a84c41c..ecb772d 100644 --- a/docs/vim/host/Service.rst +++ b/docs/vim/host/Service.rst @@ -30,7 +30,7 @@ Attributes: running (`bool`_): Flag indicating whether the service is currently running. - ruleset (`str`_, optional): + ruleset ([`str`_], optional): List of firewall rulesets used by this service. Must come from the list of rulesets in `ruleset`_ . policy (`str`_): diff --git a/docs/vim/host/ServiceInfo.rst b/docs/vim/host/ServiceInfo.rst index 22d7623..895b990 100644 --- a/docs/vim/host/ServiceInfo.rst +++ b/docs/vim/host/ServiceInfo.rst @@ -9,6 +9,6 @@ vim.host.ServiceInfo :extends: vmodl.DynamicData_ Attributes: - service (`vim.host.Service`_, optional): + service ([`vim.host.Service`_], optional): List of configured services. diff --git a/docs/vim/host/SnmpSystem/SnmpConfigSpec.rst b/docs/vim/host/SnmpSystem/SnmpConfigSpec.rst index 477a7ce..a708c87 100644 --- a/docs/vim/host/SnmpSystem/SnmpConfigSpec.rst +++ b/docs/vim/host/SnmpSystem/SnmpConfigSpec.rst @@ -24,9 +24,9 @@ Attributes: port (`int`_, optional): - readOnlyCommunities (`str`_, optional): + readOnlyCommunities ([`str`_], optional): - trapTargets (`vim.host.SnmpSystem.SnmpConfigSpec.Destination`_, optional): + trapTargets ([`vim.host.SnmpSystem.SnmpConfigSpec.Destination`_], optional): - option (`vim.KeyValue`_, optional): + option ([`vim.KeyValue`_], optional): diff --git a/docs/vim/host/SslThumbprintInfo.rst b/docs/vim/host/SslThumbprintInfo.rst index 49dc6e4..55bfb08 100644 --- a/docs/vim/host/SslThumbprintInfo.rst +++ b/docs/vim/host/SslThumbprintInfo.rst @@ -18,6 +18,6 @@ Attributes: ownerTag (`str`_): The tag associated with this registration. Owner tags allow multiple entities to register the same thumbprint without interfering with each other on the life cycle of the thumbprint with their unique tags. Each solution should use a unique tag to identify itself. - sslThumbprints (`str`_, optional): + sslThumbprints ([`str`_], optional): Specify the SSL thumbprints to register on the host. diff --git a/docs/vim/host/StorageDeviceInfo.rst b/docs/vim/host/StorageDeviceInfo.rst index a277fbf..ca4d167 100644 --- a/docs/vim/host/StorageDeviceInfo.rst +++ b/docs/vim/host/StorageDeviceInfo.rst @@ -21,10 +21,10 @@ vim.host.StorageDeviceInfo :extends: vmodl.DynamicData_ Attributes: - hostBusAdapter (`vim.host.HostBusAdapter`_, optional): + hostBusAdapter ([`vim.host.HostBusAdapter`_], optional): The list of host bus adapters available on the host. - scsiLun (`vim.host.ScsiLun`_, optional): + scsiLun ([`vim.host.ScsiLun`_], optional): The list of SCSI logical units available on the host. scsiTopology (`vim.host.ScsiTopology`_, optional): diff --git a/docs/vim/host/StorageSystem.rst b/docs/vim/host/StorageSystem.rst index d62081a..37aa999 100644 --- a/docs/vim/host/StorageSystem.rst +++ b/docs/vim/host/StorageSystem.rst @@ -171,7 +171,7 @@ Attributes Host storage information up to the device level. fileSystemVolumeInfo (`vim.host.FileSystemVolumeInfo`_): File system volume information for the host. See the `FileSystemVolumeInfo`_ data object type for more information. - systemFile (`str`_): + systemFile ([`str`_]): Datastore paths of files used by the host system on mounted volumes, for instance, the COS vmdk file of the host. For information on datastore paths, see `Datastore`_ . multipathStateInfo (`vim.host.MultipathStateInfo`_): Runtime information about the state of a multipath path. A null value will be returned if path state information is not available for this system.In systems prior to the plug-store architecture, the state of a path may be accessible on the `HostMultipathInfo`_ data object of the `storageDeviceInfo`_ property. @@ -198,7 +198,7 @@ RetrieveDiskPartitionInfo(devicePath): Returns: - `vim.host.DiskPartitionInfo`_: + [`vim.host.DiskPartitionInfo`_]: An array of information about the partitions. @@ -617,7 +617,7 @@ QueryUnresolvedVmfsVolume(): Returns: - `vim.host.UnresolvedVmfsVolume`_: + [`vim.host.UnresolvedVmfsVolume`_]: An array of unbound VMFS volumes. @@ -639,7 +639,7 @@ ResolveMultipleUnresolvedVmfsVolumes(resolutionSpec): Returns: - `vim.host.UnresolvedVmfsResolutionResult`_: + [`vim.host.UnresolvedVmfsResolutionResult`_]: A data object that represents the VMFS file system and return status value. Raises: @@ -1285,7 +1285,7 @@ QueryPathSelectionPolicyOptions(): Returns: - `vim.host.PathSelectionPolicyOption`_: + [`vim.host.PathSelectionPolicyOption`_]: The list of path selection policy descriptions that match the search criteria. Details about the policies will also be provided in accordance to the query specification. Raises: @@ -1308,7 +1308,7 @@ QueryStorageArrayTypePolicyOptions(): Returns: - `vim.host.StorageArrayTypePolicyOption`_: + [`vim.host.StorageArrayTypePolicyOption`_]: The list of storage array type policy descriptions. Raises: @@ -1828,7 +1828,7 @@ QueryAvailableSsds(vffsPath): Returns: - `vim.host.ScsiDisk`_: + [`vim.host.ScsiDisk`_]: An array of data objects descrbing SSD disks. Raises: diff --git a/docs/vim/host/Summary.rst b/docs/vim/host/Summary.rst index 2b858d4..3397630 100644 --- a/docs/vim/host/Summary.rst +++ b/docs/vim/host/Summary.rst @@ -48,7 +48,7 @@ Attributes: rebootRequired (`bool`_): Indicates whether or not the host requires a reboot due to a configuration change. - customValue (`vim.CustomFieldsManager.Value`_, optional): + customValue ([`vim.CustomFieldsManager.Value`_], optional): The customized field values. managementServerIp (`str`_, optional): diff --git a/docs/vim/host/Summary/ConfigSummary.rst b/docs/vim/host/Summary/ConfigSummary.rst index dac4409..bd6fc3c 100644 --- a/docs/vim/host/Summary/ConfigSummary.rst +++ b/docs/vim/host/Summary/ConfigSummary.rst @@ -39,7 +39,7 @@ Attributes: faultToleranceEnabled (`bool`_): The flag to indicate whether or not Fault Tolerance logging is enabled on this host. - featureVersion (`vim.host.FeatureVersionInfo`_, optional): + featureVersion ([`vim.host.FeatureVersionInfo`_], optional): List of feature-specific version information. Each element refers to the version information for a specific feature. agentVmDatastore (`vim.Datastore`_, optional): diff --git a/docs/vim/host/Summary/HardwareSummary.rst b/docs/vim/host/Summary/HardwareSummary.rst index ad198ae..4c04793 100644 --- a/docs/vim/host/Summary/HardwareSummary.rst +++ b/docs/vim/host/Summary/HardwareSummary.rst @@ -26,7 +26,7 @@ Attributes: uuid (`str`_): The hardware BIOS identification. - otherIdentifyingInfo (`vim.host.SystemIdentificationInfo`_, optional): + otherIdentifyingInfo ([`vim.host.SystemIdentificationInfo`_], optional): Other identification information. This information may be vendor specific. memorySize (`long`_): diff --git a/docs/vim/host/SystemHealthInfo.rst b/docs/vim/host/SystemHealthInfo.rst index 1eecdcf..0b5c993 100644 --- a/docs/vim/host/SystemHealthInfo.rst +++ b/docs/vim/host/SystemHealthInfo.rst @@ -12,6 +12,6 @@ vim.host.SystemHealthInfo :since: `VI API 2.5`_ Attributes: - numericSensorInfo (`vim.host.NumericSensorInfo`_, optional): + numericSensorInfo ([`vim.host.NumericSensorInfo`_], optional): Health information provided by the power probes. diff --git a/docs/vim/host/SystemInfo.rst b/docs/vim/host/SystemInfo.rst index 7cac361..48108b6 100644 --- a/docs/vim/host/SystemInfo.rst +++ b/docs/vim/host/SystemInfo.rst @@ -20,6 +20,6 @@ Attributes: uuid (`str`_): Hardware BIOS identification. - otherIdentifyingInfo (`vim.host.SystemIdentificationInfo`_, optional): + otherIdentifyingInfo ([`vim.host.SystemIdentificationInfo`_], optional): Other System identification information. This information may be vendor specific diff --git a/docs/vim/host/SystemResourceInfo.rst b/docs/vim/host/SystemResourceInfo.rst index eaa2050..9ae3294 100644 --- a/docs/vim/host/SystemResourceInfo.rst +++ b/docs/vim/host/SystemResourceInfo.rst @@ -21,6 +21,6 @@ Attributes: config (`vim.ResourceConfigSpec`_, optional): Configuration of this system resource group. - child (`vim.host.SystemResourceInfo`_, optional): + child ([`vim.host.SystemResourceInfo`_], optional): List of child resource groups. diff --git a/docs/vim/host/SystemSwapConfiguration.rst b/docs/vim/host/SystemSwapConfiguration.rst index c82ecd4..b35ec81 100644 --- a/docs/vim/host/SystemSwapConfiguration.rst +++ b/docs/vim/host/SystemSwapConfiguration.rst @@ -18,6 +18,6 @@ vim.host.SystemSwapConfiguration :since: `vSphere API 5.1`_ Attributes: - option (`vim.host.SystemSwapConfiguration.SystemSwapOption`_, optional): + option ([`vim.host.SystemSwapConfiguration.SystemSwapOption`_], optional): The currently enabled options. When this property contains only one value and this value is `HostSystemSwapConfigurationDisabledOption`_ , this indicates that the system swap is disabled.If the `HostSystemSwapConfigurationDisabledOption`_ option is used toghether with some other option in call to `UpdateSystemSwapConfiguration`_ , a `InvalidArgument`_ is thrown.It is not allowed to have duplicate values in this array. If so a `InvalidArgument`_ is thrown. diff --git a/docs/vim/host/TpmAttestationReport.rst b/docs/vim/host/TpmAttestationReport.rst index 50a5f5f..44be10b 100644 --- a/docs/vim/host/TpmAttestationReport.rst +++ b/docs/vim/host/TpmAttestationReport.rst @@ -16,10 +16,10 @@ vim.host.TpmAttestationReport :since: `vSphere API 5.1`_ Attributes: - tpmPcrValues (`vim.host.TpmDigestInfo`_): + tpmPcrValues ([`vim.host.TpmDigestInfo`_]): The array of PCR digest values stored in the TPM device since the last host boot time. - tpmEvents (`vim.host.TpmEventLogEntry`_): + tpmEvents ([`vim.host.TpmEventLogEntry`_]): Log of TPM software stack attestation events. tpmLogReliable (`bool`_): diff --git a/docs/vim/host/TpmEventDetails.rst b/docs/vim/host/TpmEventDetails.rst index c15b7d9..c60adf0 100644 --- a/docs/vim/host/TpmEventDetails.rst +++ b/docs/vim/host/TpmEventDetails.rst @@ -12,6 +12,6 @@ vim.host.TpmEventDetails :since: `vSphere API 5.1`_ Attributes: - dataHash (`int`_): + dataHash ([`int`_]): Value of the Platform Configuration Register (PCR) for this event. diff --git a/docs/vim/host/TpmOptionEventDetails.rst b/docs/vim/host/TpmOptionEventDetails.rst index 26dfe15..4ed8d4c 100644 --- a/docs/vim/host/TpmOptionEventDetails.rst +++ b/docs/vim/host/TpmOptionEventDetails.rst @@ -17,6 +17,6 @@ Attributes: optionsFileName (`str`_): Name of the file containing the boot options. - bootOptions (`int`_, optional): + bootOptions ([`int`_], optional): Options set by the boot option package.This array exposes the raw contents of the settings file (or files) that were passed to kernel during the boot up process, and, therefore, should be treated accordingly. diff --git a/docs/vim/host/UnresolvedVmfsResignatureSpec.rst b/docs/vim/host/UnresolvedVmfsResignatureSpec.rst index 83c2674..13c2d56 100644 --- a/docs/vim/host/UnresolvedVmfsResignatureSpec.rst +++ b/docs/vim/host/UnresolvedVmfsResignatureSpec.rst @@ -12,6 +12,6 @@ vim.host.UnresolvedVmfsResignatureSpec :since: `vSphere API 4.0`_ Attributes: - extentDevicePath (`str`_): + extentDevicePath ([`str`_]): List of device path each specifying VMFS extents. diff --git a/docs/vim/host/UnresolvedVmfsResolutionSpec.rst b/docs/vim/host/UnresolvedVmfsResolutionSpec.rst index 50222fb..c843b35 100644 --- a/docs/vim/host/UnresolvedVmfsResolutionSpec.rst +++ b/docs/vim/host/UnresolvedVmfsResolutionSpec.rst @@ -12,7 +12,7 @@ vim.host.UnresolvedVmfsResolutionSpec :since: `vSphere API 4.0`_ Attributes: - extentDevicePath (`str`_): + extentDevicePath ([`str`_]): List of device paths each specifying a VMFS extent.One extent must be specified. This property is represented as a list to enable future enhancements to the interface. uuidResolution (`str`_): diff --git a/docs/vim/host/UnresolvedVmfsVolume.rst b/docs/vim/host/UnresolvedVmfsVolume.rst index 707cc84..85e8f6d 100644 --- a/docs/vim/host/UnresolvedVmfsVolume.rst +++ b/docs/vim/host/UnresolvedVmfsVolume.rst @@ -20,7 +20,7 @@ vim.host.UnresolvedVmfsVolume :since: `vSphere API 4.0`_ Attributes: - extent (`vim.host.UnresolvedVmfsExtent`_): + extent ([`vim.host.UnresolvedVmfsExtent`_]): List of detected copies of VMFS extents. vmfsLabel (`str`_): diff --git a/docs/vim/host/VFlashManager/VFlashCacheConfigInfo.rst b/docs/vim/host/VFlashManager/VFlashCacheConfigInfo.rst index 477ed24..e0c1dce 100644 --- a/docs/vim/host/VFlashManager/VFlashCacheConfigInfo.rst +++ b/docs/vim/host/VFlashManager/VFlashCacheConfigInfo.rst @@ -18,7 +18,7 @@ vim.host.VFlashManager.VFlashCacheConfigInfo :since: `vSphere API 5.5`_ Attributes: - vFlashModuleConfigOption (`vim.host.VFlashManager.VFlashCacheConfigInfo.VFlashModuleConfigOption`_, optional): + vFlashModuleConfigOption ([`vim.host.VFlashManager.VFlashCacheConfigInfo.VFlashModuleConfigOption`_], optional): Cache configuration options for the supported vFlash modules. defaultVFlashModule (`str`_, optional): diff --git a/docs/vim/host/VFlashResourceConfigurationResult.rst b/docs/vim/host/VFlashResourceConfigurationResult.rst index 4ade010..11f68d3 100644 --- a/docs/vim/host/VFlashResourceConfigurationResult.rst +++ b/docs/vim/host/VFlashResourceConfigurationResult.rst @@ -16,12 +16,12 @@ vim.host.VFlashResourceConfigurationResult :since: `vSphere API 5.5`_ Attributes: - devicePath (`str`_, optional): + devicePath ([`str`_], optional): The original array of device path which user had specified vffs (`vim.host.VffsVolume`_, optional): Newly configured VffsVolume - diskConfigurationResult (`vim.host.DiskConfigurationResult`_, optional): + diskConfigurationResult ([`vim.host.DiskConfigurationResult`_], optional): Array of device operation results. diff --git a/docs/vim/host/VMotionSystem/NetConfig.rst b/docs/vim/host/VMotionSystem/NetConfig.rst index 16ecb03..8500de9 100644 --- a/docs/vim/host/VMotionSystem/NetConfig.rst +++ b/docs/vim/host/VMotionSystem/NetConfig.rst @@ -11,7 +11,7 @@ vim.host.VMotionSystem.NetConfig :extends: vmodl.DynamicData_ Attributes: - candidateVnic (`vim.host.VirtualNic`_, optional): + candidateVnic ([`vim.host.VirtualNic`_], optional): List of VirtualNic objects that may be used for VMotion. This will be a subset of the list of VirtualNics in `vnic`_ . selectedVnic (`vim.host.VirtualNic`_, optional): diff --git a/docs/vim/host/VffsVolume.rst b/docs/vim/host/VffsVolume.rst index c9e6280..7de78d3 100644 --- a/docs/vim/host/VffsVolume.rst +++ b/docs/vim/host/VffsVolume.rst @@ -25,6 +25,6 @@ Attributes: uuid (`str`_): The universally unique identifier assigned to VFFS. - extent (`vim.host.ScsiDisk.Partition`_): + extent ([`vim.host.ScsiDisk.Partition`_]): The list of partition names that comprise this disk's VFFS extents. diff --git a/docs/vim/host/VirtualNicManager/NetConfig.rst b/docs/vim/host/VirtualNicManager/NetConfig.rst index 1d7f439..26df448 100644 --- a/docs/vim/host/VirtualNicManager/NetConfig.rst +++ b/docs/vim/host/VirtualNicManager/NetConfig.rst @@ -24,9 +24,9 @@ Attributes: multiSelectAllowed (`bool`_): Whether multiple nics can be selected for this nicType. - candidateVnic (`vim.host.VirtualNic`_, optional): + candidateVnic ([`vim.host.VirtualNic`_], optional): List of VirtualNic objects that may be used. This will be a subset of the list of VirtualNics in `vnic`_ . - selectedVnic (`vim.host.VirtualNic`_, optional): + selectedVnic ([`vim.host.VirtualNic`_], optional): List of VirtualNic objects that are selected for use. diff --git a/docs/vim/host/VirtualNicManager/NicTypeSelection.rst b/docs/vim/host/VirtualNicManager/NicTypeSelection.rst index 634f070..94a732a 100644 --- a/docs/vim/host/VirtualNicManager/NicTypeSelection.rst +++ b/docs/vim/host/VirtualNicManager/NicTypeSelection.rst @@ -19,5 +19,5 @@ Attributes: vnic (`vim.host.VirtualNicConnection`_): VirtualNic for the selection is being made - nicType (`str`_, optional): + nicType ([`str`_], optional): diff --git a/docs/vim/host/VirtualNicManagerInfo.rst b/docs/vim/host/VirtualNicManagerInfo.rst index 6b50fc0..b9a4294 100644 --- a/docs/vim/host/VirtualNicManagerInfo.rst +++ b/docs/vim/host/VirtualNicManagerInfo.rst @@ -14,6 +14,6 @@ vim.host.VirtualNicManagerInfo :since: `vSphere API 4.0`_ Attributes: - netConfig (`vim.host.VirtualNicManager.NetConfig`_, optional): + netConfig ([`vim.host.VirtualNicManager.NetConfig`_], optional): List of VirtualNicManager network configuration.See `VirtualNicManagerNetConfig`_ diff --git a/docs/vim/host/VirtualSwitch.rst b/docs/vim/host/VirtualSwitch.rst index 7743742..fd2e71e 100644 --- a/docs/vim/host/VirtualSwitch.rst +++ b/docs/vim/host/VirtualSwitch.rst @@ -32,10 +32,10 @@ Attributes: mtu (`int`_, optional): The maximum transmission unit (MTU) associated with this virtual switch in bytes. - portgroup (`vim.host.PortGroup`_, optional): + portgroup ([`vim.host.PortGroup`_], optional): The list of port groups configured for this virtual switch. - pnic (`vim.host.PhysicalNic`_, optional): + pnic ([`vim.host.PhysicalNic`_], optional): The set of physical network adapters associated with this bridge. spec (`vim.host.VirtualSwitch.Specification`_): diff --git a/docs/vim/host/VirtualSwitch/AutoBridge.rst b/docs/vim/host/VirtualSwitch/AutoBridge.rst index e52aa5b..2eb0dc1 100644 --- a/docs/vim/host/VirtualSwitch/AutoBridge.rst +++ b/docs/vim/host/VirtualSwitch/AutoBridge.rst @@ -9,6 +9,6 @@ vim.host.VirtualSwitch.AutoBridge :extends: vim.host.VirtualSwitch.Bridge_ Attributes: - excludedNicDevice (`str`_, optional): + excludedNicDevice ([`str`_], optional): List of physical network adapters that have been excluded from participating in the AutoBridge diff --git a/docs/vim/host/VirtualSwitch/BondBridge.rst b/docs/vim/host/VirtualSwitch/BondBridge.rst index 40ba2de..710d921 100644 --- a/docs/vim/host/VirtualSwitch/BondBridge.rst +++ b/docs/vim/host/VirtualSwitch/BondBridge.rst @@ -15,7 +15,7 @@ vim.host.VirtualSwitch.BondBridge :extends: vim.host.VirtualSwitch.Bridge_ Attributes: - nicDevice (`str`_): + nicDevice ([`str`_]): The list of keys of the physical network adapters to be bridged. beacon (`vim.host.VirtualSwitch.BeaconConfig`_, optional): diff --git a/docs/vim/host/VmciAccessManager/AccessSpec.rst b/docs/vim/host/VmciAccessManager/AccessSpec.rst index 08f2c94..81019b8 100644 --- a/docs/vim/host/VmciAccessManager/AccessSpec.rst +++ b/docs/vim/host/VmciAccessManager/AccessSpec.rst @@ -16,7 +16,7 @@ vim.host.VmciAccessManager.AccessSpec Attributes: vm (`vim.VirtualMachine`_): - services (`str`_, optional): + services ([`str`_], optional): mode (`str`_): diff --git a/docs/vim/host/VmfsDatastoreCreateSpec.rst b/docs/vim/host/VmfsDatastoreCreateSpec.rst index 276acaa..39a26c3 100644 --- a/docs/vim/host/VmfsDatastoreCreateSpec.rst +++ b/docs/vim/host/VmfsDatastoreCreateSpec.rst @@ -19,6 +19,6 @@ Attributes: vmfs (`vim.host.VmfsVolume.Specification`_): The VMFS creation specification. - extent (`vim.host.ScsiDisk.Partition`_, optional): + extent ([`vim.host.ScsiDisk.Partition`_], optional): Extents to append to VMFS. diff --git a/docs/vim/host/VmfsDatastoreExtendSpec.rst b/docs/vim/host/VmfsDatastoreExtendSpec.rst index ceb30b6..9aa5644 100644 --- a/docs/vim/host/VmfsDatastoreExtendSpec.rst +++ b/docs/vim/host/VmfsDatastoreExtendSpec.rst @@ -14,6 +14,6 @@ Attributes: partition (`vim.host.DiskPartitionInfo.Specification`_): Partitioning specification. - extent (`vim.host.ScsiDisk.Partition`_): + extent ([`vim.host.ScsiDisk.Partition`_]): Extents to append to VMFS. diff --git a/docs/vim/host/VmfsDatastoreOption/MultipleExtentInfo.rst b/docs/vim/host/VmfsDatastoreOption/MultipleExtentInfo.rst index 55afa9a..12be634 100644 --- a/docs/vim/host/VmfsDatastoreOption/MultipleExtentInfo.rst +++ b/docs/vim/host/VmfsDatastoreOption/MultipleExtentInfo.rst @@ -9,6 +9,6 @@ vim.host.VmfsDatastoreOption.MultipleExtentInfo :extends: vim.host.VmfsDatastoreOption.Info_ Attributes: - vmfsExtent (`vim.host.DiskPartitionInfo.BlockRange`_): + vmfsExtent ([`vim.host.DiskPartitionInfo.BlockRange`_]): The block ranges to be used as extents in a VMFS datastore. The first block range will be the head partition. diff --git a/docs/vim/host/VmfsVolume.rst b/docs/vim/host/VmfsVolume.rst index 3e79e0e..5218e30 100644 --- a/docs/vim/host/VmfsVolume.rst +++ b/docs/vim/host/VmfsVolume.rst @@ -38,7 +38,7 @@ Attributes: uuid (`str`_): The universally unique identifier assigned to VMFS. - extent (`vim.host.ScsiDisk.Partition`_): + extent ([`vim.host.ScsiDisk.Partition`_]): The list of partition names that comprise this disk's VMFS extents.This property can be accessed via various enclosing objects. In VirtualCenter, where it can be accessed from multiple hosts, the value of this property may differ according to the context in which it is accessed. When accessed from the `VmfsDatastoreInfo`_ object, in VirtualCenter, this property reflects the extent information of any one of the hosts visible to the datastore.For a VirtualCenter system which manages ESX Server 2.x and ESX Server 3.x hosts, this extent information is only correlatable across hosts if the extents are exposed on the same adapter on all hosts which can access them. To find the extent names for a specific host, this same property should be accessed via the host's `HostFileSystemVolume`_ object, by correlating the uuid of the VMFS datastore in the VmfsDatastoreInfo object to the uuid in the FileSystemVolume object.For a Virtual Center system which manages only ESX Server hosts with versions 4.0 onwards , this extent information is correlatable across hosts, irrespective of the adapters the extents are exposed on. vmfsUpgradable (`bool`_): diff --git a/docs/vim/host/VsanSystem.rst b/docs/vim/host/VsanSystem.rst index a2ece03..a068b85 100644 --- a/docs/vim/host/VsanSystem.rst +++ b/docs/vim/host/VsanSystem.rst @@ -81,7 +81,7 @@ QueryDisksForVsan(canonicalName): Returns: - `vim.vsan.host.DiskResult`_: + [`vim.vsan.host.DiskResult`_]: a list of populated `VsanHostDiskResult`_ entries diff --git a/docs/vim/net/DhcpConfigInfo/DhcpOptions.rst b/docs/vim/net/DhcpConfigInfo/DhcpOptions.rst index 9bf0552..5bd1b1a 100644 --- a/docs/vim/net/DhcpConfigInfo/DhcpOptions.rst +++ b/docs/vim/net/DhcpConfigInfo/DhcpOptions.rst @@ -17,6 +17,6 @@ Attributes: enable (`bool`_): Report state of dhcp client services. - config (`vim.KeyValue`_, optional): + config ([`vim.KeyValue`_], optional): Platform specific settings for DHCP Client. The key part is a unique number, the value part is the platform specific configuration command. For example on Linux, BSD systems using the file dhclient.conf output would be reported at system scope: key='1', value='timeout 60;' key='2', value='reboot 10;' output reported at per interface scope: key='1', value='prepend domain-name-servers 192.0.2.1;' key='2', value='equire subnet-mask, domain-name-servers;' diff --git a/docs/vim/net/DhcpConfigSpec/DhcpOptionsSpec.rst b/docs/vim/net/DhcpConfigSpec/DhcpOptionsSpec.rst index 5258a9c..55339dd 100644 --- a/docs/vim/net/DhcpConfigSpec/DhcpOptionsSpec.rst +++ b/docs/vim/net/DhcpConfigSpec/DhcpOptionsSpec.rst @@ -23,7 +23,7 @@ Attributes: enable (`bool`_, optional): Enable or disable dhcp for IPv4. - config (`vim.KeyValue`_): + config ([`vim.KeyValue`_]): Platform specific settings for DHCP Client. The key part is a unique number, the value part is the platform specific configuration command. See `NetDhcpConfigInfo`_ for value formatting. operation (`str`_): diff --git a/docs/vim/net/DnsConfigInfo.rst b/docs/vim/net/DnsConfigInfo.rst index 14a6fbc..1f3d8a4 100644 --- a/docs/vim/net/DnsConfigInfo.rst +++ b/docs/vim/net/DnsConfigInfo.rst @@ -23,9 +23,9 @@ Attributes: domainName (`str`_): The domain name portion of the DNS name. "example.com" part of esx01.example.com. - ipAddress (`str`_, optional): + ipAddress ([`str`_], optional): The IP addresses of the DNS servers in order of use. IPv4 addresses are specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of the symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373. - searchDomain (`str`_, optional): + searchDomain ([`str`_], optional): The domain in which to search for hosts, placed in order of preference. diff --git a/docs/vim/net/DnsConfigSpec.rst b/docs/vim/net/DnsConfigSpec.rst index dbff751..b0de7dd 100644 --- a/docs/vim/net/DnsConfigSpec.rst +++ b/docs/vim/net/DnsConfigSpec.rst @@ -23,9 +23,9 @@ Attributes: domainName (`str`_, optional): The domain name portion of the DNS name. This would be the "example.com" part of esx01.example.com. The rules for forming a domain name are defined in RFC 1034. - ipAddress (`str`_, optional): + ipAddress ([`str`_], optional): Unicast IP address(s) of one or more DNS servers in order of use. IPv4 addresses are specified using dotted decimal notation. For example, "192.0.2.1". IPv6 addresses are 128-bit addresses represented as eight fields of up to four hexadecimal digits. A colon separates each field (:). For example, 2001:DB8:101::230:6eff:fe04:d9ff. The address can also consist of the symbol '::' to represent multiple 16-bit groups of contiguous 0's only once in an address as described in RFC 2373. - searchDomain (`str`_, optional): + searchDomain ([`str`_], optional): The domain in which to search for hosts in order of preference. diff --git a/docs/vim/net/IpConfigInfo.rst b/docs/vim/net/IpConfigInfo.rst index 58d3595..54ffa0f 100644 --- a/docs/vim/net/IpConfigInfo.rst +++ b/docs/vim/net/IpConfigInfo.rst @@ -16,7 +16,7 @@ vim.net.IpConfigInfo :since: `vSphere API 4.1`_ Attributes: - ipAddress (`vim.net.IpConfigInfo.IpAddress`_, optional): + ipAddress ([`vim.net.IpConfigInfo.IpAddress`_], optional): Zero, one or more manual (static) assigned IP addresses to be configured on a given interface. dhcp (`vim.net.DhcpConfigInfo`_, optional): diff --git a/docs/vim/net/IpConfigSpec.rst b/docs/vim/net/IpConfigSpec.rst index 6b55f22..aa56be6 100644 --- a/docs/vim/net/IpConfigSpec.rst +++ b/docs/vim/net/IpConfigSpec.rst @@ -16,7 +16,7 @@ vim.net.IpConfigSpec :since: `vSphere API 4.1`_ Attributes: - ipAddress (`vim.net.IpConfigSpec.IpAddressSpec`_, optional): + ipAddress ([`vim.net.IpConfigSpec.IpAddressSpec`_], optional): A set of manual (static) IP addresses to be configured on a given interface. dhcp (`vim.net.DhcpConfigSpec`_, optional): diff --git a/docs/vim/net/IpRouteConfigInfo.rst b/docs/vim/net/IpRouteConfigInfo.rst index a1c6c7a..f111283 100644 --- a/docs/vim/net/IpRouteConfigInfo.rst +++ b/docs/vim/net/IpRouteConfigInfo.rst @@ -12,6 +12,6 @@ vim.net.IpRouteConfigInfo :since: `vSphere API 4.1`_ Attributes: - ipRoute (`vim.net.IpRouteConfigInfo.IpRoute`_, optional): + ipRoute ([`vim.net.IpRouteConfigInfo.IpRoute`_], optional): IP routing table for all address families. diff --git a/docs/vim/net/IpRouteConfigSpec.rst b/docs/vim/net/IpRouteConfigSpec.rst index 93e6a19..95736b2 100644 --- a/docs/vim/net/IpRouteConfigSpec.rst +++ b/docs/vim/net/IpRouteConfigSpec.rst @@ -12,6 +12,6 @@ vim.net.IpRouteConfigSpec :since: `vSphere API 4.1`_ Attributes: - ipRoute (`vim.net.IpRouteConfigSpec.IpRouteSpec`_, optional): + ipRoute ([`vim.net.IpRouteConfigSpec.IpRouteSpec`_], optional): The set of updates to apply to the routing table. diff --git a/docs/vim/net/IpStackInfo.rst b/docs/vim/net/IpStackInfo.rst index d8c524b..c9e310a 100644 --- a/docs/vim/net/IpStackInfo.rst +++ b/docs/vim/net/IpStackInfo.rst @@ -14,9 +14,9 @@ vim.net.IpStackInfo :since: `vSphere API 4.1`_ Attributes: - neighbor (`vim.net.IpStackInfo.NetToMedia`_, optional): + neighbor ([`vim.net.IpStackInfo.NetToMedia`_], optional): Zero, one or more entries of neighbors discovered using ARP or NDP. This information is used to help diagnose connectivity or performance issues. This property maps to RFC 4293 ipNetToPhysicalTable. - defaultRouter (`vim.net.IpStackInfo.DefaultRouter`_, optional): + defaultRouter ([`vim.net.IpStackInfo.DefaultRouter`_], optional): Zero one or more entries of discovered IP routers that are directly reachable from a an interface on this system. This property maps to RFC 4293 ipDefaultRouterTable. diff --git a/docs/vim/option/ChoiceOption.rst b/docs/vim/option/ChoiceOption.rst index 2656cee..ea76788 100644 --- a/docs/vim/option/ChoiceOption.rst +++ b/docs/vim/option/ChoiceOption.rst @@ -11,7 +11,7 @@ vim.option.ChoiceOption :extends: vim.option.OptionType_ Attributes: - choiceInfo (`vim.ElementDescription`_): + choiceInfo ([`vim.ElementDescription`_]): The set of possible selections and descriptions. defaultIndex (`int`_, optional): diff --git a/docs/vim/option/OptionManager.rst b/docs/vim/option/OptionManager.rst index 2b893be..52ea507 100644 --- a/docs/vim/option/OptionManager.rst +++ b/docs/vim/option/OptionManager.rst @@ -23,9 +23,9 @@ vim.option.OptionManager Attributes ---------- - supportedOption (`vim.option.OptionDef`_): + supportedOption ([`vim.option.OptionDef`_]): A list of supported key/value pair options including their type information. - setting (`vim.option.OptionValue`_): + setting ([`vim.option.OptionValue`_]): A list of the current settings for the key/value pair options. @@ -57,7 +57,7 @@ QueryOptions(name): Returns: - `vim.option.OptionValue`_: + [`vim.option.OptionValue`_]: The option with the given name. If the name ends with a dot, all options for that subtree are returned. Raises: diff --git a/docs/vim/profile/ApplyProfile.rst b/docs/vim/profile/ApplyProfile.rst index fdf5f00..465670a 100644 --- a/docs/vim/profile/ApplyProfile.rst +++ b/docs/vim/profile/ApplyProfile.rst @@ -31,7 +31,7 @@ Attributes: enabled (`bool`_): Indicates whether the profile is enabled. - policy (`vim.profile.Policy`_, optional): + policy ([`vim.profile.Policy`_], optional): The list of policies comprising the profile. A `ProfilePolicy`_ stores one or more configuration data values in a `PolicyOption`_ . The policy option is one of the configuration options from the `ProfilePolicyMetadata`_ . `possibleOption`_ list. profileTypeName (`str`_, optional): @@ -40,6 +40,6 @@ Attributes: profileVersion (`str`_, optional): Profile engine version. - property (`vim.profile.ApplyProfileProperty`_, optional): + property ([`vim.profile.ApplyProfileProperty`_], optional): List of subprofiles for this profile. This list can change depending on which profile plug-ins are available in the system. Subprofiles can be nested to arbitrary depths to represent host capabilities. diff --git a/docs/vim/profile/ApplyProfileProperty.rst b/docs/vim/profile/ApplyProfileProperty.rst index a3d7b38..a636264 100644 --- a/docs/vim/profile/ApplyProfileProperty.rst +++ b/docs/vim/profile/ApplyProfileProperty.rst @@ -24,6 +24,6 @@ Attributes: array (`bool`_): Flag indicating whether this property is an array of profiles. - profile (`vim.profile.ApplyProfile`_, optional): + profile ([`vim.profile.ApplyProfile`_], optional): Subprofiles that define policies and nested subprofiles. diff --git a/docs/vim/profile/ComplianceManager.rst b/docs/vim/profile/ComplianceManager.rst index 6863b91..299f84a 100644 --- a/docs/vim/profile/ComplianceManager.rst +++ b/docs/vim/profile/ComplianceManager.rst @@ -82,7 +82,7 @@ QueryComplianceStatus(profile, entity): Returns: - `vim.profile.ComplianceResult`_: + [`vim.profile.ComplianceResult`_]: ComplianceResult. ComplianceResult information may not be available for all the entities. If the ComplianceResult is not available already, a new ComplianceCheck will not be triggered. Raises: @@ -137,7 +137,7 @@ QueryExpressionMetadata(expressionName, profile): Returns: - `vim.profile.ExpressionMetadata`_: + [`vim.profile.ExpressionMetadata`_]: Raises: diff --git a/docs/vim/profile/ComplianceProfile.rst b/docs/vim/profile/ComplianceProfile.rst index ce9bd13..3dd5756 100644 --- a/docs/vim/profile/ComplianceProfile.rst +++ b/docs/vim/profile/ComplianceProfile.rst @@ -14,7 +14,7 @@ vim.profile.ComplianceProfile :since: `vSphere API 4.0`_ Attributes: - expression (`vim.profile.Expression`_): + expression ([`vim.profile.Expression`_]): List of expressions that make up the ComplianceChecks. rootExpression (`str`_): diff --git a/docs/vim/profile/ComplianceResult.rst b/docs/vim/profile/ComplianceResult.rst index 2380314..af54366 100644 --- a/docs/vim/profile/ComplianceResult.rst +++ b/docs/vim/profile/ComplianceResult.rst @@ -32,6 +32,6 @@ Attributes: checkTime (`datetime`_, optional): Time at which compliance check was last run on the entity - failure (`vim.profile.ComplianceResult.ComplianceFailure`_, optional): + failure ([`vim.profile.ComplianceResult.ComplianceFailure`_], optional): If complianceStatus is non-compliant, failure will contain additional information about the compliance errors. diff --git a/docs/vim/profile/CompositeExpression.rst b/docs/vim/profile/CompositeExpression.rst index 50fed11..8082286 100644 --- a/docs/vim/profile/CompositeExpression.rst +++ b/docs/vim/profile/CompositeExpression.rst @@ -15,6 +15,6 @@ Attributes: operator (`str`_): Logical operator to be applied between the expressions in the composite expression. e.g: or, and - expressionName (`str`_): + expressionName ([`str`_]): List of expression names that will be used for this composition. The individual expressions will return a boolean. The return values of the individual expressions will be used to compute the final return value of the CompositeExpression. The expressions specified in the list can themselves be CompositeExpressions. diff --git a/docs/vim/profile/CompositePolicyOption.rst b/docs/vim/profile/CompositePolicyOption.rst index 8d1113c..62d4843 100644 --- a/docs/vim/profile/CompositePolicyOption.rst +++ b/docs/vim/profile/CompositePolicyOption.rst @@ -10,6 +10,6 @@ vim.profile.CompositePolicyOption :since: `vSphere API 4.0`_ Attributes: - option (`vim.profile.PolicyOption`_, optional): + option ([`vim.profile.PolicyOption`_], optional): List of policy options that are composed and applicable for this composite policy option. The selected PolicyOptions in a CompositePolicyOption will be used in the policy. PolicyOptions need not be specified if they are not desired for the CompositePolicyOption. Order of PolicyOptions in the PolicyOption array is not significant. The host profile policy engine will not respect order of PolicyOptions. It will apply PolicyOptions in a pre-determined order. Clients of the API must produce PolicyOption in the same order as specified in the metadata. diff --git a/docs/vim/profile/CompositePolicyOptionMetadata.rst b/docs/vim/profile/CompositePolicyOptionMetadata.rst index 72242fb..0c4d929 100644 --- a/docs/vim/profile/CompositePolicyOptionMetadata.rst +++ b/docs/vim/profile/CompositePolicyOptionMetadata.rst @@ -20,6 +20,6 @@ vim.profile.CompositePolicyOptionMetadata :since: `vSphere API 4.0`_ Attributes: - option (`str`_): + option ([`str`_]): List of optional policy option identifiers that could be combined in this composite policy option. The policy options should already be part of the possible policy options for the policy. See the `ProfilePolicyMetadata`_ . `possibleOption`_ list. diff --git a/docs/vim/profile/DeferredPolicyOptionParameter.rst b/docs/vim/profile/DeferredPolicyOptionParameter.rst index 83bfb0d..bba5eeb 100644 --- a/docs/vim/profile/DeferredPolicyOptionParameter.rst +++ b/docs/vim/profile/DeferredPolicyOptionParameter.rst @@ -52,6 +52,6 @@ Attributes: inputPath (`vim.profile.ProfilePropertyPath`_): Complete path to the `PolicyOption`_ that defines the parameters. - parameter (`vmodl.KeyAnyValue`_, optional): + parameter ([`vmodl.KeyAnyValue`_], optional): List that contains values for the policy parameters.During parameter verification, this property is unspecified if the client has not provided the values for this parameter. See `ProfileExecuteResult`_ . `requireInput`_ . diff --git a/docs/vim/profile/ExpressionMetadata.rst b/docs/vim/profile/ExpressionMetadata.rst index 106bcb2..26a7254 100644 --- a/docs/vim/profile/ExpressionMetadata.rst +++ b/docs/vim/profile/ExpressionMetadata.rst @@ -17,6 +17,6 @@ Attributes: expressionId (`vim.ExtendedElementDescription`_): Id of the SimpleExpression - parameter (`vim.profile.ParameterMetadata`_, optional): + parameter ([`vim.profile.ParameterMetadata`_], optional): Parameters that can be specified for this SimpleExpression diff --git a/docs/vim/profile/PolicyMetadata.rst b/docs/vim/profile/PolicyMetadata.rst index 6b0ad75..7221e4c 100644 --- a/docs/vim/profile/PolicyMetadata.rst +++ b/docs/vim/profile/PolicyMetadata.rst @@ -25,6 +25,6 @@ Attributes: id (`vim.ExtendedElementDescription`_): Identifier for the policy. - possibleOption (`vim.profile.PolicyOptionMetadata`_): + possibleOption ([`vim.profile.PolicyOptionMetadata`_]): Possible policy options that can be set for a policy of the given kind. `HostProfile`_ s and subprofiles will contain selected policy options from this list. See `PolicyOption`_ . diff --git a/docs/vim/profile/PolicyOption.rst b/docs/vim/profile/PolicyOption.rst index e9b3b1b..0ce01cc 100644 --- a/docs/vim/profile/PolicyOption.rst +++ b/docs/vim/profile/PolicyOption.rst @@ -27,6 +27,6 @@ Attributes: id (`str`_): Identifier for the policy option. This value matches one of the keys from the list of possible options in the policy metadata ( `ProfilePolicyMetadata`_ . `possibleOption`_ []. `id`_ . `key`_ ). - parameter (`vmodl.KeyAnyValue`_, optional): + parameter ([`vmodl.KeyAnyValue`_], optional): Parameters for the policy option. This list must include all parameters that are not marked as optional in the policy option metadata parameter list ( `ProfilePolicyMetadata`_ . `possibleOption`_ []. `parameter`_ []. `optional`_ ). diff --git a/docs/vim/profile/PolicyOptionMetadata.rst b/docs/vim/profile/PolicyOptionMetadata.rst index e269e0f..a128cbc 100644 --- a/docs/vim/profile/PolicyOptionMetadata.rst +++ b/docs/vim/profile/PolicyOptionMetadata.rst @@ -50,6 +50,6 @@ Attributes: * ) contains a localizable summary of the policy option. Summary information can contain embedded variable names which can be replaced with values from the * parameter * property. - parameter (`vim.profile.ParameterMetadata`_, optional): + parameter ([`vim.profile.ParameterMetadata`_], optional): Metadata about the parameters for the policy option. diff --git a/docs/vim/profile/Profile.rst b/docs/vim/profile/Profile.rst index d0c4c4b..0ee8276 100644 --- a/docs/vim/profile/Profile.rst +++ b/docs/vim/profile/Profile.rst @@ -54,7 +54,7 @@ Attributes Time at which the profile was created. modifiedTime (`datetime`_): Time at which the profile was last modified. - entity (`vim.ManagedEntity`_): + entity ([`vim.ManagedEntity`_]): List of managed entities associated with the profile. complianceStatus (`str`_): Overall compliance of entities associated with this profile. If one of the entities is out of compliance, the profile isnonCompliant. If all entities are in compliance, the profile iscompliant. If the compliance status of one of the entities is not known, compliance status of the profile isunknown. See `ComplianceResultStatus`_ . diff --git a/docs/vim/profile/Profile/Description.rst b/docs/vim/profile/Profile/Description.rst index c9c84ec..9bc1102 100644 --- a/docs/vim/profile/Profile/Description.rst +++ b/docs/vim/profile/Profile/Description.rst @@ -14,6 +14,6 @@ vim.profile.Profile.Description :since: `vSphere API 4.0`_ Attributes: - section (`vim.profile.Profile.Description.Section`_): + section ([`vim.profile.Profile.Description.Section`_]): Sections which make up the profile description. diff --git a/docs/vim/profile/Profile/Description/Section.rst b/docs/vim/profile/Profile/Description/Section.rst index 66e207b..d4abf78 100644 --- a/docs/vim/profile/Profile/Description/Section.rst +++ b/docs/vim/profile/Profile/Description/Section.rst @@ -19,6 +19,6 @@ Attributes: description (`vim.ExtendedElementDescription`_): Localized message data. - message (`vmodl.LocalizableMessage`_, optional): + message ([`vmodl.LocalizableMessage`_], optional): List of messages that make up the section. diff --git a/docs/vim/profile/ProfileManager.rst b/docs/vim/profile/ProfileManager.rst index c3d237a..4a3ef20 100644 --- a/docs/vim/profile/ProfileManager.rst +++ b/docs/vim/profile/ProfileManager.rst @@ -29,7 +29,7 @@ vim.profile.ProfileManager Attributes ---------- - profile (`vim.profile.Profile`_): + profile ([`vim.profile.Profile`_]): privilege: Profile.View A list of profiles known to this ProfileManager. @@ -88,7 +88,7 @@ QueryPolicyMetadata(policyName, profile): Returns: - `vim.profile.PolicyMetadata`_: + [`vim.profile.PolicyMetadata`_]: The metadata information for the policy. Raises: @@ -117,7 +117,7 @@ FindAssociatedProfile(entity): Returns: - `vim.profile.Profile`_: + [`vim.profile.Profile`_]: diff --git a/docs/vim/profile/ProfileMetadata.rst b/docs/vim/profile/ProfileMetadata.rst index c8caba3..93ffd15 100644 --- a/docs/vim/profile/ProfileMetadata.rst +++ b/docs/vim/profile/ProfileMetadata.rst @@ -31,7 +31,7 @@ Attributes: description (`vim.ExtendedDescription`_, optional): Property which describes the profile - sortSpec (`vim.profile.ProfileMetadata.ProfileSortSpec`_, optional): + sortSpec ([`vim.profile.ProfileMetadata.ProfileSortSpec`_], optional): Property that determines a sorting order for display purposes. If the list contains more than one sort spec, then the precedence should be determined by the list order (i.e. sort first by the first spec in the list, then sort by the second spec in the list, etc). profileCategory (`str`_, optional): diff --git a/docs/vim/profile/ProfileStructure.rst b/docs/vim/profile/ProfileStructure.rst index 598ee66..8f378e6 100644 --- a/docs/vim/profile/ProfileStructure.rst +++ b/docs/vim/profile/ProfileStructure.rst @@ -17,6 +17,6 @@ Attributes: profileTypeName (`str`_): Identifier for the profile type - child (`vim.profile.ProfileStructureProperty`_, optional): + child ([`vim.profile.ProfileStructureProperty`_], optional): SubProfile properties available for this profile diff --git a/docs/vim/profile/SimpleExpression.rst b/docs/vim/profile/SimpleExpression.rst index 45e6626..e6c1c55 100644 --- a/docs/vim/profile/SimpleExpression.rst +++ b/docs/vim/profile/SimpleExpression.rst @@ -17,6 +17,6 @@ Attributes: expressionType (`str`_): Type of the simple expression to instantiate. The expressionType should be derived from the available expressions as listed in the metadata. - parameter (`vmodl.KeyAnyValue`_, optional): + parameter ([`vmodl.KeyAnyValue`_], optional): The parameters for the expressionType. The list of parameters needed for a simple expression can be obtained from the metadata. diff --git a/docs/vim/profile/UserInputRequiredParameterMetadata.rst b/docs/vim/profile/UserInputRequiredParameterMetadata.rst index 8b70fde..1289995 100644 --- a/docs/vim/profile/UserInputRequiredParameterMetadata.rst +++ b/docs/vim/profile/UserInputRequiredParameterMetadata.rst @@ -20,6 +20,6 @@ vim.profile.UserInputRequiredParameterMetadata :since: `vSphere API 4.0`_ Attributes: - userInputParameter (`vim.profile.ParameterMetadata`_, optional): + userInputParameter ([`vim.profile.ParameterMetadata`_], optional): Metadata for user input options. diff --git a/docs/vim/profile/cluster/ClusterProfile/ConfigServiceCreateSpec.rst b/docs/vim/profile/cluster/ClusterProfile/ConfigServiceCreateSpec.rst index 82232dd..55fa5be 100644 --- a/docs/vim/profile/cluster/ClusterProfile/ConfigServiceCreateSpec.rst +++ b/docs/vim/profile/cluster/ClusterProfile/ConfigServiceCreateSpec.rst @@ -14,6 +14,6 @@ vim.profile.cluster.ClusterProfile.ConfigServiceCreateSpec :since: `vSphere API 4.0`_ Attributes: - serviceType (`str`_, optional): + serviceType ([`str`_], optional): Type of the service for which the ClusterProfile is being requested. If more than one service is specified, the created ClusterProfile will cater for all the services. Possible values are specified by `ClusterProfileServiceType`_ . If unset, clear the compliance expressions on the profile. diff --git a/docs/vim/profile/host/AnswerFile.rst b/docs/vim/profile/host/AnswerFile.rst index 6d99edd..7909146 100644 --- a/docs/vim/profile/host/AnswerFile.rst +++ b/docs/vim/profile/host/AnswerFile.rst @@ -53,7 +53,7 @@ vim.profile.host.AnswerFile :since: `vSphere API 5.0`_ Attributes: - userInput (`vim.profile.DeferredPolicyOptionParameter`_, optional): + userInput ([`vim.profile.DeferredPolicyOptionParameter`_], optional): List containing host-specific configuration data. createdTime (`datetime`_): diff --git a/docs/vim/profile/host/AnswerFileStatusResult.rst b/docs/vim/profile/host/AnswerFileStatusResult.rst index 2a6a66f..8520702 100644 --- a/docs/vim/profile/host/AnswerFileStatusResult.rst +++ b/docs/vim/profile/host/AnswerFileStatusResult.rst @@ -31,6 +31,6 @@ Attributes: status (`str`_): Status of the answer file. See `HostProfileManagerAnswerFileStatus`_ for valid values. - error (`vim.profile.host.AnswerFileStatusResult.AnswerFileStatusError`_, optional): + error ([`vim.profile.host.AnswerFileStatusResult.AnswerFileStatusError`_], optional): Ifstatusisinvalid, this property contains a list of status error objects. diff --git a/docs/vim/profile/host/DvsProfile.rst b/docs/vim/profile/host/DvsProfile.rst index a778139..1391c25 100644 --- a/docs/vim/profile/host/DvsProfile.rst +++ b/docs/vim/profile/host/DvsProfile.rst @@ -26,6 +26,6 @@ Attributes: name (`str`_): Unique identifier for the distributed virtual switch. - uplink (`vim.profile.host.PnicUplinkProfile`_, optional): + uplink ([`vim.profile.host.PnicUplinkProfile`_], optional): List of subprofiles that map physical NICs to uplink ports. Use the `key`_ property to access subprofiles in the list. diff --git a/docs/vim/profile/host/ExecuteResult.rst b/docs/vim/profile/host/ExecuteResult.rst index 392370e..4c892ea 100644 --- a/docs/vim/profile/host/ExecuteResult.rst +++ b/docs/vim/profile/host/ExecuteResult.rst @@ -46,10 +46,10 @@ Attributes: configSpec (`vim.host.ConfigSpec`_, optional): Host configuration specification. This data is valid only if thestatusvalue issuccess. See `ProfileExecuteResultStatus`_ .Use this data object when you apply the configuration to a host. See theconfigSpecparameter to the `HostProfileManager`_ . `ApplyHostConfig_Task`_ method. - inapplicablePath (`str`_, optional): + inapplicablePath ([`str`_], optional): List of property paths. Each path identifies a policy that does not apply to this host. For example, if the precheck policies for a port group are not satisfied, the port group will not be created when you apply the profile to the host. Based on this information, the client might not display that part of the profile tree. - requireInput (`vim.profile.DeferredPolicyOptionParameter`_, optional): + requireInput ([`vim.profile.DeferredPolicyOptionParameter`_], optional): List that describes the required input for host configuration and identifies any policy options that still require parameter data. Each entry in the list specifies the path to a policy and a parameter list. If the call to `ExecuteHostProfile`_ includes deferred parameters, therequireInputentries (requireInput[]. `parameter`_ []) will be populated with the parameter data that was passed to the execute method. For policies that still require input data, the parameter list in the corresponding entry will be null.A vSphere client that displays a GUI can use this information to show the host-specific configuration policy options. The client can highlight required input fields and ask the user for data in increments instead of collecting all of the input at once. For example, in the first pass, the client collects a minimum of user input and sends that to the Server. The Server evaluates the profile and might decide to invalidate a particular part of the subtree or enable a new subtree in the profile. This would result in a new set of invalid paths ( `inapplicablePath`_ []) and required input property paths ( `ProfileDeferredPolicyOptionParameter`_ . `inputPath`_ ). The client can make a series of calls to the method until it achieves a success status.When `ExecuteHostProfile`_ returns a success status, therequireInputlist contains the complete list of parameters, consisting of the following data: * Deferred parameter values resolved through successive calls to @@ -57,6 +57,6 @@ Attributes: * . * Default parameter values from the host configuration. * User-specified values that override the defaults.You can specify the returnedrequireInputlist in theuserInputparameter to the `HostProfileManager`_ . `ApplyHostConfig_Task`_ method. The Server will use the list to update the `AnswerFile`_ associated with the host. - error (`vim.profile.host.ExecuteResult.ExecuteError`_, optional): + error ([`vim.profile.host.ExecuteResult.ExecuteError`_], optional): List of errors that were encountered during execute. This field will be set if status is set to error. diff --git a/docs/vim/profile/host/FirewallProfile.rst b/docs/vim/profile/host/FirewallProfile.rst index bed206e..b7eb210 100644 --- a/docs/vim/profile/host/FirewallProfile.rst +++ b/docs/vim/profile/host/FirewallProfile.rst @@ -18,6 +18,6 @@ vim.profile.host.FirewallProfile :since: `vSphere API 4.0`_ Attributes: - ruleset (`vim.profile.host.FirewallProfile.RulesetProfile`_, optional): + ruleset ([`vim.profile.host.FirewallProfile.RulesetProfile`_], optional): List of Rulesets that will be configured for the firewall subprofile. diff --git a/docs/vim/profile/host/HostApplyProfile.rst b/docs/vim/profile/host/HostApplyProfile.rst index ca458a5..8b8a72f 100644 --- a/docs/vim/profile/host/HostApplyProfile.rst +++ b/docs/vim/profile/host/HostApplyProfile.rst @@ -56,16 +56,16 @@ Attributes: security (`vim.profile.host.SecurityProfile`_, optional): Security Configuration of the host. The security subprofile can include data such as administrator passwords. - service (`vim.profile.host.ServiceProfile`_, optional): + service ([`vim.profile.host.ServiceProfile`_], optional): Host configuration for services. Use the `key`_ property to access a subprofile in the list. - option (`vim.profile.host.OptionProfile`_, optional): + option ([`vim.profile.host.OptionProfile`_], optional): List of subprofiles representing advanced configuration options. Use the `key`_ property to access a subprofile in the list. - userAccount (`vim.profile.host.UserProfile`_, optional): + userAccount ([`vim.profile.host.UserProfile`_], optional): List of subprofiles for user accounts to be configured on the host. Use the `key`_ property to access a subprofile in the list. - usergroupAccount (`vim.profile.host.UserGroupProfile`_, optional): + usergroupAccount ([`vim.profile.host.UserGroupProfile`_], optional): List of subprofiles for user groups to be configured on the host. Use the `key`_ property to access a subprofile in the list. authentication (`vim.profile.host.AuthenticationProfile`_, optional): diff --git a/docs/vim/profile/host/HostProfile/CompleteConfigSpec.rst b/docs/vim/profile/host/HostProfile/CompleteConfigSpec.rst index 7c35e82..e6a3d47 100644 --- a/docs/vim/profile/host/HostProfile/CompleteConfigSpec.rst +++ b/docs/vim/profile/host/HostProfile/CompleteConfigSpec.rst @@ -45,7 +45,7 @@ Attributes: disabledExpressionListChanged (`bool`_): Flag indicating if this configuration specification contains changes in the `disabledExpressionList`_ . If False, the Profile Engine ignores the contents of the disabled expression list. - disabledExpressionList (`str`_, optional): + disabledExpressionList ([`str`_], optional): List of expressions to be disabled. Each entry in the list specifies a `ProfileExpression`_ . `id`_ . All expressions are enabled by default.If you set `disabledExpressionListChanged`_ to True, the Profile Engine uses the contents of this list to replace the contents of the `HostProfile`_ . `config`_ . `disabledExpressionList`_ .The expression list is contained in the `defaultComplyProfile`_ . The Profile Engine automatically generates the default compliance profile when you create a host profile. validatorHost (`vim.HostSystem`_, optional): diff --git a/docs/vim/profile/host/HostProfile/ConfigInfo.rst b/docs/vim/profile/host/HostProfile/ConfigInfo.rst index 156c8c3..cbb74f7 100644 --- a/docs/vim/profile/host/HostProfile/ConfigInfo.rst +++ b/docs/vim/profile/host/HostProfile/ConfigInfo.rst @@ -32,12 +32,12 @@ Attributes: defaultComplyProfile (`vim.profile.ComplianceProfile`_, optional): Default compliance profile. The ESX Server uses theapplyProfile( `HostProfile`_ . `config`_ . `applyProfile`_ ) to generate the default compliance profile when you create a host profile. When theapplyProfileis modified, the Server automatically updates the compliance profile to match it. - defaultComplyLocator (`vim.profile.ComplianceLocator`_, optional): + defaultComplyLocator ([`vim.profile.ComplianceLocator`_], optional): List of compliance locators. Each locator specifies an association between theapplyProfileand thedefaultComplyProfile. The association identifies a component profile and the expression generated by the profile. vSphere clients can use this data to provide contextual information to the user. customComplyProfile (`vim.profile.ComplianceProfile`_, optional): User defined compliance profile. Reserved for future use. - disabledExpressionList (`str`_, optional): + disabledExpressionList ([`str`_], optional): Disabled expressions in the default compliance profile (DefaultComplyProfile). Use this property to specify which expressions are disabled. All expressions are enabled by default. diff --git a/docs/vim/profile/host/IpRouteProfile.rst b/docs/vim/profile/host/IpRouteProfile.rst index 642dbee..bd34d1e 100644 --- a/docs/vim/profile/host/IpRouteProfile.rst +++ b/docs/vim/profile/host/IpRouteProfile.rst @@ -18,6 +18,6 @@ vim.profile.host.IpRouteProfile :since: `vSphere API 4.0`_ Attributes: - staticRoute (`vim.profile.host.StaticRouteProfile`_, optional): + staticRoute ([`vim.profile.host.StaticRouteProfile`_], optional): List of static routes to be configured. diff --git a/docs/vim/profile/host/NetworkProfile.rst b/docs/vim/profile/host/NetworkProfile.rst index 750176c..a487e3f 100644 --- a/docs/vim/profile/host/NetworkProfile.rst +++ b/docs/vim/profile/host/NetworkProfile.rst @@ -42,16 +42,16 @@ vim.profile.host.NetworkProfile :since: `vSphere API 4.0`_ Attributes: - vswitch (`vim.profile.host.VirtualSwitchProfile`_, optional): + vswitch ([`vim.profile.host.VirtualSwitchProfile`_], optional): List of virtual switch subprofiles. Use the `key`_ property to access a subprofile in the list. - vmPortGroup (`vim.profile.host.VmPortGroupProfile`_, optional): + vmPortGroup ([`vim.profile.host.VmPortGroupProfile`_], optional): List of port groups for use by virtual machines. Use the `VmPortGroupProfile`_ . `key`_ property to access a port group in the list. - hostPortGroup (`vim.profile.host.HostPortGroupProfile`_, optional): + hostPortGroup ([`vim.profile.host.HostPortGroupProfile`_], optional): List of port groups for use by the host. Use the `HostPortGroupProfile`_ . `key`_ property to access port groups in the list. - serviceConsolePortGroup (`vim.profile.host.ServiceConsolePortGroupProfile`_, optional): + serviceConsolePortGroup ([`vim.profile.host.ServiceConsolePortGroupProfile`_], optional): List of port groups for use by the service console. The Profile Engine uses this field only when applying a profile to a host that has a service console. dnsConfig (`vim.profile.host.NetworkProfile.DnsConfigProfile`_, optional): @@ -63,18 +63,18 @@ Attributes: consoleIpRouteConfig (`vim.profile.host.IpRouteProfile`_, optional): Subprofile that describes the IP Route configuration for the Service Console gateway. - pnic (`vim.profile.host.PhysicalNicProfile`_, optional): + pnic ([`vim.profile.host.PhysicalNicProfile`_], optional): List of subprofiles that represent physical NIC configuration. Use the `key`_ property to access a subprofile in the list. - dvswitch (`vim.profile.host.DvsProfile`_, optional): + dvswitch ([`vim.profile.host.DvsProfile`_], optional): List of subprofiles for distributed virtual switches to which this host is connected. Use the `key`_ property to access a subprofile in the list. - dvsServiceConsoleNic (`vim.profile.host.DvsServiceConsoleVNicProfile`_, optional): + dvsServiceConsoleNic ([`vim.profile.host.DvsServiceConsoleVNicProfile`_], optional): List of subprofiles for service console Virtual NICs connected to a distributed virtual switch. Use the `DvsServiceConsoleVNicProfile`_ . `key`_ property to access a subprofile in the list. - dvsHostNic (`vim.profile.host.DvsHostVNicProfile`_, optional): + dvsHostNic ([`vim.profile.host.DvsHostVNicProfile`_], optional): List of subprofiles for host Virtual NICs connected to a distributed virtual switch. Use the `DvsHostVNicProfile`_ . `key`_ property to access a subprofile in the list. - netStackInstance (`vim.profile.host.NetStackInstanceProfile`_, optional): + netStackInstance ([`vim.profile.host.NetStackInstanceProfile`_], optional): List of NetStackInstance subprofiles. Use the `key`_ property to access a subprofile in the list. diff --git a/docs/vim/profile/host/ProfileManager.rst b/docs/vim/profile/host/ProfileManager.rst index 3ab5d6f..36e1f94 100644 --- a/docs/vim/profile/host/ProfileManager.rst +++ b/docs/vim/profile/host/ProfileManager.rst @@ -199,7 +199,7 @@ QueryHostProfileMetadata(profileName, profile): Returns: - `vim.profile.ProfileMetadata`_: + [`vim.profile.ProfileMetadata`_]: List of profile metadata objects. Raises: @@ -447,7 +447,7 @@ QueryAnswerFileStatus(host): Returns: - `vim.profile.host.AnswerFileStatusResult`_: + [`vim.profile.host.AnswerFileStatusResult`_]: List of answer file status objects. diff --git a/docs/vim/profile/host/ProfileManager/AnswerFileOptionsCreateSpec.rst b/docs/vim/profile/host/ProfileManager/AnswerFileOptionsCreateSpec.rst index e1506e3..dcd391a 100644 --- a/docs/vim/profile/host/ProfileManager/AnswerFileOptionsCreateSpec.rst +++ b/docs/vim/profile/host/ProfileManager/AnswerFileOptionsCreateSpec.rst @@ -14,6 +14,6 @@ vim.profile.host.ProfileManager.AnswerFileOptionsCreateSpec :since: `vSphere API 5.0`_ Attributes: - userInput (`vim.profile.DeferredPolicyOptionParameter`_, optional): + userInput ([`vim.profile.DeferredPolicyOptionParameter`_], optional): List of parameters that contain host-specific data. diff --git a/docs/vim/profile/host/ProfileManager/ConfigTaskList.rst b/docs/vim/profile/host/ProfileManager/ConfigTaskList.rst index a1d397a..438a47d 100644 --- a/docs/vim/profile/host/ProfileManager/ConfigTaskList.rst +++ b/docs/vim/profile/host/ProfileManager/ConfigTaskList.rst @@ -19,6 +19,6 @@ Attributes: configSpec (`vim.host.ConfigSpec`_, optional): Set of configuration changes to be applied to the host. - taskDescription (`vmodl.LocalizableMessage`_, optional): + taskDescription ([`vmodl.LocalizableMessage`_], optional): Description of tasks that will be performed on the host to carry out HostProfile application. diff --git a/docs/vim/profile/host/SecurityProfile.rst b/docs/vim/profile/host/SecurityProfile.rst index 28950c2..487e8bb 100644 --- a/docs/vim/profile/host/SecurityProfile.rst +++ b/docs/vim/profile/host/SecurityProfile.rst @@ -18,6 +18,6 @@ vim.profile.host.SecurityProfile :since: `vSphere API 4.0`_ Attributes: - permission (`vim.profile.host.PermissionProfile`_, optional): + permission ([`vim.profile.host.PermissionProfile`_], optional): Permission configuration. diff --git a/docs/vim/profile/host/StorageProfile.rst b/docs/vim/profile/host/StorageProfile.rst index 982d4d1..e7f006a 100644 --- a/docs/vim/profile/host/StorageProfile.rst +++ b/docs/vim/profile/host/StorageProfile.rst @@ -18,6 +18,6 @@ vim.profile.host.StorageProfile :since: `vSphere API 4.0`_ Attributes: - nasStorage (`vim.profile.host.NasStorageProfile`_, optional): + nasStorage ([`vim.profile.host.NasStorageProfile`_], optional): List of NAS storage subprofiles. Use the `key`_ property to access a subprofile in the list. diff --git a/docs/vim/scheduler/ScheduledTaskDescription.rst b/docs/vim/scheduler/ScheduledTaskDescription.rst index cac11ad..4a92090 100644 --- a/docs/vim/scheduler/ScheduledTaskDescription.rst +++ b/docs/vim/scheduler/ScheduledTaskDescription.rst @@ -19,18 +19,18 @@ vim.scheduler.ScheduledTaskDescription :extends: vmodl.DynamicData_ Attributes: - action (`vim.TypeDescription`_): + action ([`vim.TypeDescription`_]): Action class descriptions for a scheduled task. - schedulerInfo (`vim.scheduler.ScheduledTaskDescription.SchedulerDetail`_): + schedulerInfo ([`vim.scheduler.ScheduledTaskDescription.SchedulerDetail`_]): Scheduler class description details. - state (`vim.ElementDescription`_): + state ([`vim.ElementDescription`_]): `TaskInfo State enum`_ - dayOfWeek (`vim.ElementDescription`_): + dayOfWeek ([`vim.ElementDescription`_]): `MonthlyByWeekdayTaskScheduler Days of the week enum description`_ - weekOfMonth (`vim.ElementDescription`_): + weekOfMonth ([`vim.ElementDescription`_]): `MonthlyByWeekdayTaskScheduler Week of the month enum description`_ diff --git a/docs/vim/scheduler/ScheduledTaskManager.rst b/docs/vim/scheduler/ScheduledTaskManager.rst index c8ccf54..c87c765 100644 --- a/docs/vim/scheduler/ScheduledTaskManager.rst +++ b/docs/vim/scheduler/ScheduledTaskManager.rst @@ -28,7 +28,7 @@ vim.scheduler.ScheduledTaskManager Attributes ---------- - scheduledTask (`vim.scheduler.ScheduledTask`_): + scheduledTask ([`vim.scheduler.ScheduledTask`_]): privilege: System.View All available scheduled tasks. description (`vim.scheduler.ScheduledTaskDescription`_): @@ -92,7 +92,7 @@ RetrieveEntityScheduledTask(entity): Returns: - `vim.scheduler.ScheduledTask`_: + [`vim.scheduler.ScheduledTask`_]: The scheduled tasks. @@ -150,7 +150,7 @@ RetrieveObjectScheduledTask(obj): Returns: - `vim.scheduler.ScheduledTask`_: + [`vim.scheduler.ScheduledTask`_]: The scheduled tasks. diff --git a/docs/vim/storageDrs/ConfigInfo.rst b/docs/vim/storageDrs/ConfigInfo.rst index abdacfd..c8bea27 100644 --- a/docs/vim/storageDrs/ConfigInfo.rst +++ b/docs/vim/storageDrs/ConfigInfo.rst @@ -21,6 +21,6 @@ Attributes: podConfig (`vim.storageDrs.PodConfigInfo`_): Pod-wide configuration of the storage DRS service. - vmConfig (`vim.storageDrs.VmConfigInfo`_, optional): + vmConfig ([`vim.storageDrs.VmConfigInfo`_], optional): List of virtual machine configurations for the storage DRS service. Each entry applies to all the virtual disks of the virtual machine on this pod.If a virtual machine is not specified in this array, the service uses the default settings for that virtual machine. diff --git a/docs/vim/storageDrs/ConfigSpec.rst b/docs/vim/storageDrs/ConfigSpec.rst index 1e9f545..8f92860 100644 --- a/docs/vim/storageDrs/ConfigSpec.rst +++ b/docs/vim/storageDrs/ConfigSpec.rst @@ -19,6 +19,6 @@ Attributes: podConfigSpec (`vim.storageDrs.PodConfigSpec`_, optional): Changes to the configuration of the storage DRS service. - vmConfigSpec (`vim.storageDrs.VmConfigSpec`_, optional): + vmConfigSpec ([`vim.storageDrs.VmConfigSpec`_], optional): Changes to the per-virtual-machine storage DRS settings. diff --git a/docs/vim/storageDrs/PodConfigInfo.rst b/docs/vim/storageDrs/PodConfigInfo.rst index 1d6b399..0d12518 100644 --- a/docs/vim/storageDrs/PodConfigInfo.rst +++ b/docs/vim/storageDrs/PodConfigInfo.rst @@ -51,9 +51,9 @@ Attributes: ioLoadBalanceConfig (`vim.storageDrs.IoLoadBalanceConfig`_, optional): The configuration settings for load balancing I/O workload. This takes effect only if `ioLoadBalanceEnabled`_ istrue. - rule (`vim.cluster.RuleInfo`_, optional): + rule ([`vim.cluster.RuleInfo`_], optional): Pod-wide rules. - option (`vim.option.OptionValue`_, optional): + option ([`vim.option.OptionValue`_], optional): Advanced settings. diff --git a/docs/vim/storageDrs/PodConfigSpec.rst b/docs/vim/storageDrs/PodConfigSpec.rst index 7ab7266..6ac75df 100644 --- a/docs/vim/storageDrs/PodConfigSpec.rst +++ b/docs/vim/storageDrs/PodConfigSpec.rst @@ -53,9 +53,9 @@ Attributes: ioLoadBalanceConfig (`vim.storageDrs.IoLoadBalanceConfig`_, optional): The configuration settings for load balancing I/O workload. This takes effect only if `ioLoadBalanceEnabled`_ istrue. - rule (`vim.cluster.RuleSpec`_, optional): + rule ([`vim.cluster.RuleSpec`_], optional): Changes to the set of rules. - option (`vim.storageDrs.OptionSpec`_, optional): + option ([`vim.storageDrs.OptionSpec`_], optional): Changes to advance settings. diff --git a/docs/vim/storageDrs/PodSelectionSpec.rst b/docs/vim/storageDrs/PodSelectionSpec.rst index 1d8b642..3183c79 100644 --- a/docs/vim/storageDrs/PodSelectionSpec.rst +++ b/docs/vim/storageDrs/PodSelectionSpec.rst @@ -14,7 +14,7 @@ vim.storageDrs.PodSelectionSpec :since: `vSphere API 5.0`_ Attributes: - initialVmConfig (`vim.storageDrs.PodSelectionSpec.VmPodConfig`_, optional): + initialVmConfig ([`vim.storageDrs.PodSelectionSpec.VmPodConfig`_], optional): An optional list that allows specifying the storage pod location for each virtual disk and the VM configurations and overrides to be used during placement. storagePod (`vim.StoragePod`_, optional): diff --git a/docs/vim/storageDrs/PodSelectionSpec/DiskLocator.rst b/docs/vim/storageDrs/PodSelectionSpec/DiskLocator.rst index f55490e..e0c1d77 100644 --- a/docs/vim/storageDrs/PodSelectionSpec/DiskLocator.rst +++ b/docs/vim/storageDrs/PodSelectionSpec/DiskLocator.rst @@ -27,6 +27,6 @@ Attributes: diskBackingInfo (`vim.vm.device.VirtualDevice.BackingInfo`_, optional): The disk backing info. - profile (`vim.vm.ProfileSpec`_, optional): + profile ([`vim.vm.ProfileSpec`_], optional): Virtual Disk Profile requirement. Profiles are solution specific. 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. diff --git a/docs/vim/storageDrs/PodSelectionSpec/VmPodConfig.rst b/docs/vim/storageDrs/PodSelectionSpec/VmPodConfig.rst index ec15df0..1c8666b 100644 --- a/docs/vim/storageDrs/PodSelectionSpec/VmPodConfig.rst +++ b/docs/vim/storageDrs/PodSelectionSpec/VmPodConfig.rst @@ -23,12 +23,12 @@ Attributes: storagePod (`vim.StoragePod`_): The pod that this initial configuration applies to. Since there could be multiple pods in a single placement request, we may need to specify multiple initial VM configurations, one per pod. - disk (`vim.storageDrs.PodSelectionSpec.DiskLocator`_, optional): + disk ([`vim.storageDrs.PodSelectionSpec.DiskLocator`_], optional): Array of PodDiskLocator objects. vmConfig (`vim.storageDrs.VmConfigInfo`_, optional): The VM configuration for the VM that is being placed. - interVmRule (`vim.cluster.RuleInfo`_, optional): + interVmRule ([`vim.cluster.RuleInfo`_], optional): The initial interVmRules that should during placement of this virtual machine. It may not always be possible to specify that the virtual machine being placed is part of the rule because the virtual machine may not have been created yet. So for simplicity, we assume the virtual machine being placed is always implicitly part of any rule specified. It will be explicitly added to the rule before it is saved to the pod config. diff --git a/docs/vim/storageDrs/StoragePlacementResult.rst b/docs/vim/storageDrs/StoragePlacementResult.rst index 917b8cf..26379ea 100644 --- a/docs/vim/storageDrs/StoragePlacementResult.rst +++ b/docs/vim/storageDrs/StoragePlacementResult.rst @@ -20,7 +20,7 @@ vim.storageDrs.StoragePlacementResult :since: `vSphere API 5.0`_ Attributes: - recommendations (`vim.cluster.Recommendation`_, optional): + recommendations ([`vim.cluster.Recommendation`_], optional): The list of recommendations that the client needs to approve manually. drsFault (`vim.cluster.DrsFaults`_, optional): diff --git a/docs/vim/storageDrs/VirtualDiskAntiAffinityRuleSpec.rst b/docs/vim/storageDrs/VirtualDiskAntiAffinityRuleSpec.rst index 60a8b1c..320f268 100644 --- a/docs/vim/storageDrs/VirtualDiskAntiAffinityRuleSpec.rst +++ b/docs/vim/storageDrs/VirtualDiskAntiAffinityRuleSpec.rst @@ -12,6 +12,6 @@ vim.storageDrs.VirtualDiskAntiAffinityRuleSpec :since: `vSphere API 5.0`_ Attributes: - diskId (`int`_): + diskId ([`int`_]): The list of virtual disks. diff --git a/docs/vim/vApp/CloneSpec.rst b/docs/vim/vApp/CloneSpec.rst index 1ce5928..681b141 100644 --- a/docs/vim/vApp/CloneSpec.rst +++ b/docs/vim/vApp/CloneSpec.rst @@ -42,13 +42,13 @@ Attributes: vmFolder (`vim.Folder`_, privilege: VApp.Create, optional): The VM Folder to associate the vApp with - networkMapping (`vim.vApp.CloneSpec.NetworkMappingPair`_, optional): + networkMapping ([`vim.vApp.CloneSpec.NetworkMappingPair`_], optional): Network mappings. See NetworkMappingPair. - property (`vim.KeyValue`_, optional): + property ([`vim.KeyValue`_], optional): A set of property values to override. - resourceMapping (`vim.vApp.CloneSpec.ResourceMap`_, optional): + resourceMapping ([`vim.vApp.CloneSpec.ResourceMap`_], optional): The resource configuration for the cloned vApp. provisioning (`str`_, optional): diff --git a/docs/vim/vApp/IPAssignmentInfo.rst b/docs/vim/vApp/IPAssignmentInfo.rst index ad7aa93..4638da1 100644 --- a/docs/vim/vApp/IPAssignmentInfo.rst +++ b/docs/vim/vApp/IPAssignmentInfo.rst @@ -19,13 +19,13 @@ vim.vApp.IPAssignmentInfo :since: `vSphere API 4.0`_ Attributes: - supportedAllocationScheme (`str`_, optional): + supportedAllocationScheme ([`str`_], optional): Specifies the IP allocation schemes supported by the guest software.When updating this field, an empty array will be interpreted as no changes. An array of the form [""] will clear all settings. Otherwise, the supplied value will overwrite the current setting.Reconfigure privilege: VApp.ApplicationConfig ipAllocationPolicy (`str`_, optional): Specifies how IP allocation should be managed by the VI platform. This is typically specified by the deployer. The set of valid options for the policy is based on the capabilities of the vApp software, as specified by the supportedAllocationSchemes property.Reconfigure privilege: VApp.InstanceConfig - supportedIpProtocol (`str`_, optional): + supportedIpProtocol ([`str`_], optional): Specifies the IP protocols supported by the guest software.When updating this field, an empty array will be interpreted as no changes. An array of the form [""] will clear all settings. Otherwise, the supplied value will overwrite the current setting.Reconfigure privilege: VApp.ApplicationConfig ipProtocol (`str`_, optional): diff --git a/docs/vim/vApp/IpPool.rst b/docs/vim/vApp/IpPool.rst index af8a0ac..d8a7172 100644 --- a/docs/vim/vApp/IpPool.rst +++ b/docs/vim/vApp/IpPool.rst @@ -44,7 +44,7 @@ Attributes: httpProxy (`str`_, optional): The HTTP proxy to use on this network, e.g.,: - networkAssociation (`vim.vApp.IpPool.Association`_, optional): + networkAssociation ([`vim.vApp.IpPool.Association`_], optional): The networks that are associated with this IP pool availableIpv4Addresses (`int`_, optional): diff --git a/docs/vim/vApp/IpPool/IpPoolConfigInfo.rst b/docs/vim/vApp/IpPool/IpPoolConfigInfo.rst index 83dd5c9..39c422c 100644 --- a/docs/vim/vApp/IpPool/IpPoolConfigInfo.rst +++ b/docs/vim/vApp/IpPool/IpPoolConfigInfo.rst @@ -34,7 +34,7 @@ Attributes: IP range. This is specified as a set of ranges separated with commas. One range is given by a start address, a hash (#), and the length of the range.For example: * 192.0.2.235 # 20 is the IPv4 range from 192.0.2.235 to 192.0.2.254 * 2001::7334 # 20 is the IPv6 range from 2001::7334 to 2001::7347 - dns (`str`_, optional): + dns ([`str`_], optional): DNS serversFor example: * IPv4: ["10.20.0.1", "10.20.0.2"] diff --git a/docs/vim/vApp/VAppConfigInfo.rst b/docs/vim/vApp/VAppConfigInfo.rst index f20cebe..cd2573d 100644 --- a/docs/vim/vApp/VAppConfigInfo.rst +++ b/docs/vim/vApp/VAppConfigInfo.rst @@ -18,7 +18,7 @@ vim.vApp.VAppConfigInfo :since: `vSphere API 4.0`_ Attributes: - entityConfig (`vim.vApp.EntityConfigInfo`_, optional): + entityConfig ([`vim.vApp.EntityConfigInfo`_], optional): Configuration of sub-entities (virtual machine or vApp). annotation (`str`_): diff --git a/docs/vim/vApp/VAppConfigSpec.rst b/docs/vim/vApp/VAppConfigSpec.rst index 1ca55a3..7f273d9 100644 --- a/docs/vim/vApp/VAppConfigSpec.rst +++ b/docs/vim/vApp/VAppConfigSpec.rst @@ -20,7 +20,7 @@ vim.vApp.VAppConfigSpec :since: `vSphere API 4.0`_ Attributes: - entityConfig (`vim.vApp.EntityConfigInfo`_, optional): + entityConfig ([`vim.vApp.EntityConfigInfo`_], optional): Configuration of sub-entities (virtual machine or vApp container).Reconfigure privilege: See EntityConfigInfo annotation (`str`_, optional): diff --git a/docs/vim/vApp/VAppImportSpec.rst b/docs/vim/vApp/VAppImportSpec.rst index a78bdb1..5d91e24 100644 --- a/docs/vim/vApp/VAppImportSpec.rst +++ b/docs/vim/vApp/VAppImportSpec.rst @@ -33,6 +33,6 @@ Attributes: resourcePoolSpec (`vim.ResourceConfigSpec`_): Resource pool specification.If resourcePoolSpec.entity is specified, that resource pool is used as the parent resource pool and the vApp will be made a linked child to the parent vApp. This field is ignored for the root node in an ImportSpec tree. Use of resourcePoolSpec.entity for creating linked children is deprecated as of vSphere API 5.1. - child (`vim.ImportSpec`_, optional): + child ([`vim.ImportSpec`_], optional): Contains a list of children ( `VirtualMachine`_ s and `VirtualApp`_ s). diff --git a/docs/vim/vApp/VmConfigInfo.rst b/docs/vim/vApp/VmConfigInfo.rst index c9c817b..e625090 100644 --- a/docs/vim/vApp/VmConfigInfo.rst +++ b/docs/vim/vApp/VmConfigInfo.rst @@ -26,22 +26,22 @@ vim.vApp.VmConfigInfo :since: `vSphere API 4.0`_ Attributes: - product (`vim.vApp.ProductInfo`_, optional): + product ([`vim.vApp.ProductInfo`_], optional): Information about the package content. - property (`vim.vApp.PropertyInfo`_, optional): + property ([`vim.vApp.PropertyInfo`_], optional): List of properties ipAssignment (`vim.vApp.IPAssignmentInfo`_): IP assignment policy and DHCP support configuration. - eula (`str`_, optional): + eula ([`str`_], optional): End User Liceses Agreements. - ovfSection (`vim.vApp.OvfSectionInfo`_, optional): + ovfSection ([`vim.vApp.OvfSectionInfo`_], optional): List of uninterpreted OVF meta-data sections. - ovfEnvironmentTransport (`str`_, optional): + ovfEnvironmentTransport ([`str`_], optional): List the transports to use for properties. Supported values are: iso and com.vmware.guestInfo. installBootRequired (`bool`_): diff --git a/docs/vim/vApp/VmConfigSpec.rst b/docs/vim/vApp/VmConfigSpec.rst index 200f133..91f2310 100644 --- a/docs/vim/vApp/VmConfigSpec.rst +++ b/docs/vim/vApp/VmConfigSpec.rst @@ -28,22 +28,22 @@ vim.vApp.VmConfigSpec :since: `vSphere API 4.0`_ Attributes: - product (`vim.vApp.ProductSpec`_, optional): + product ([`vim.vApp.ProductSpec`_], optional): Information about the product.Reconfigure privilege: VApp.ApplicationConfig - property (`vim.vApp.PropertySpec`_, optional): + property ([`vim.vApp.PropertySpec`_], optional): List of properties.Adding and editing properties requires various privileges depending on which fields are affected. See `VAppPropertyInfo`_ for details.Deleting properties requires the privilege VApp.ApplicationConfig. ipAssignment (`vim.vApp.IPAssignmentInfo`_, optional): IP assignment policy and DHCP support configuration.Reconfigure privilege: See `VAppIPAssignmentInfo`_ - eula (`str`_, optional): + eula ([`str`_], optional): End User Liceses Agreements.If this list is set, it replaces all exiting licenses. An empty list will not make any changes to installed licenses. A list with a single element {""} will remove all licenses and leave an empty list.Reconfigure privilege: VApp.ApplicationConfig - ovfSection (`vim.vApp.OvfSectionSpec`_, optional): + ovfSection ([`vim.vApp.OvfSectionSpec`_], optional): List of uninterpreted OVF meta-data sections.Reconfigure privilege: VApp.ApplicationConfig - ovfEnvironmentTransport (`str`_, optional): + ovfEnvironmentTransport ([`str`_], optional): List the transports to use for properties. Supported values are: iso and com.vmware.guestInfo.If this list is set, it replaces all exiting entries. An empty list will not make any changes. A list with a single element {""} will clear the list of transports.Reconfigure privilege: VApp.ApplicationConfig installBootRequired (`bool`_, optional): diff --git a/docs/vim/view/ContainerView.rst b/docs/vim/view/ContainerView.rst index f604574..227474c 100644 --- a/docs/vim/view/ContainerView.rst +++ b/docs/vim/view/ContainerView.rst @@ -45,7 +45,7 @@ Attributes ---------- container (`vim.ManagedEntity`_): The Folder, Datacenter, ComputeResource, ResourcePool, or HostSystem instance that provides the objects that the view presents. - type (`str`_): + type ([`str`_]): An optional list of types to be applied to the set of objects in the view. The list of types indicates objects that are included in the view. If empty, all types are included. recursive (`bool`_): Whether to include only the immediate children of the container instance, or to include additional objects by following the paths beyond the immediate children.For information about recursive behavior, see the description of `CreateContainerView`_ . diff --git a/docs/vim/view/InventoryView.rst b/docs/vim/view/InventoryView.rst index cedf38e..c365de4 100644 --- a/docs/vim/view/InventoryView.rst +++ b/docs/vim/view/InventoryView.rst @@ -84,7 +84,7 @@ OpenInventoryViewFolder(entity): Returns: - `vim.ManagedEntity`_: + [`vim.ManagedEntity`_]: A list containing any entities in the argument could not be resolved. @@ -104,7 +104,7 @@ CloseInventoryViewFolder(entity): Returns: - `vim.ManagedEntity`_: + [`vim.ManagedEntity`_]: A list containing any entities in the argument could not be resolved. diff --git a/docs/vim/view/ListView.rst b/docs/vim/view/ListView.rst index cf20006..f0c797c 100644 --- a/docs/vim/view/ListView.rst +++ b/docs/vim/view/ListView.rst @@ -46,7 +46,7 @@ ModifyListView(add, remove): Returns: - `vmodl.ManagedObject`_: + [`vmodl.ManagedObject`_]: A list containing any objects in 'add' that could not be resolved. @@ -66,7 +66,7 @@ ResetListView(obj): Returns: - `vmodl.ManagedObject`_: + [`vmodl.ManagedObject`_]: A list containing any objects in 'obj' that could not be resolved. diff --git a/docs/vim/view/ManagedObjectView.rst b/docs/vim/view/ManagedObjectView.rst index 6ee6fc2..cf8050b 100644 --- a/docs/vim/view/ManagedObjectView.rst +++ b/docs/vim/view/ManagedObjectView.rst @@ -18,7 +18,7 @@ vim.view.ManagedObjectView Attributes ---------- - view (`vmodl.ManagedObject`_): + view ([`vmodl.ManagedObject`_]): The list of references to objects mapped by this view. diff --git a/docs/vim/view/ViewManager.rst b/docs/vim/view/ViewManager.rst index d16f8f9..8bb12c2 100644 --- a/docs/vim/view/ViewManager.rst +++ b/docs/vim/view/ViewManager.rst @@ -90,7 +90,7 @@ vim.view.ViewManager Attributes ---------- - viewList (`vim.view.View`_): + viewList ([`vim.view.View`_]): privilege: System.View An array of view references. Each array entry is a managed object reference to a view created by this ViewManager. diff --git a/docs/vim/vm/AffinityInfo.rst b/docs/vim/vm/AffinityInfo.rst index 1e6362f..56c498b 100644 --- a/docs/vim/vm/AffinityInfo.rst +++ b/docs/vim/vm/AffinityInfo.rst @@ -9,6 +9,6 @@ vim.vm.AffinityInfo :extends: vmodl.DynamicData_ Attributes: - affinitySet (`int`_, optional): + affinitySet ([`int`_], optional): List of nodes (processors for CPU, NUMA nodes for memory) that may be used by the virtual machine. If the array is empty when modifying the affinity setting, then any existing affinity is removed. diff --git a/docs/vim/vm/BootOptions.rst b/docs/vim/vm/BootOptions.rst index ab289fc..1fb8e2d 100644 --- a/docs/vim/vm/BootOptions.rst +++ b/docs/vim/vm/BootOptions.rst @@ -34,6 +34,6 @@ Attributes: bootRetryDelay (`long`_, optional): Delay in milliseconds before a boot retry. The boot retry delay specifies a time interval between virtual machine boot failure and the subsequent attempt to boot again. The virtual machine uses this value only if `bootRetryEnabled`_ is true. - bootOrder (`vim.vm.BootOptions.BootableDevice`_, optional): + bootOrder ([`vim.vm.BootOptions.BootableDevice`_], optional): Boot order. Listed devices are used for booting. After list is exhausted, default BIOS boot device algorithm is used for booting. Note that order of the entries in the list is important: device listed first is used for boot first, if that one fails second entry is used, and so on. Platform may have some internal limit on the number of devices it supports. If bootable device is not reached before platform's limit is hit, boot will fail. At least single entry is supported by all products supporting boot order settings. diff --git a/docs/vim/vm/ConfigInfo.rst b/docs/vim/vm/ConfigInfo.rst index 7d3d182..4ed2306 100644 --- a/docs/vim/vm/ConfigInfo.rst +++ b/docs/vim/vm/ConfigInfo.rst @@ -106,10 +106,10 @@ Attributes: instanceUuid (`str`_, optional): VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID. - npivNodeWorldWideName (`long`_, optional): + npivNodeWorldWideName ([`long`_], optional): A 64-bit node WWN (World Wide Name). These WWNs are paired with the `npivPortWorldWideName`_ to be used by the NPIV VPORTs instantiated for the virtual machine on the physical HBAs of the host. A pair of node and port WWNs serves as a unique identifier in accessing a LUN, so that it can be monitored or controlled by the storage administrator.If this property contains a single node WWN, the same node WWN is used to pair with all port WWNs listed in `npivPortWorldWideName`_ . If this property or `npivPortWorldWideName`_ is empty or unset, NPIV WWN is disabled for the virtual machine. - npivPortWorldWideName (`long`_, optional): + npivPortWorldWideName ([`long`_], optional): A 64-bit port WWN (World Wide Name). For detail description on WWN, see `npivNodeWorldWideName`_ . npivWorldWideNameType (`str`_, optional): @@ -193,13 +193,13 @@ Attributes: networkShaper (`vim.vm.NetworkShaperInfo`_, optional): Resource limits for network. - extraConfig (`vim.option.OptionValue`_, optional): + extraConfig ([`vim.option.OptionValue`_], optional): Additional configuration information for the virtual machine. - cpuFeatureMask (`vim.host.CpuIdInfo`_, optional): + cpuFeatureMask ([`vim.host.CpuIdInfo`_], optional): Specifies CPU feature compatibility masks that override the defaults from the `GuestOsDescriptor`_ of the virtual machine's guest OS. - datastoreUrl (`vim.vm.ConfigInfo.DatastoreUrlPair`_, optional): + datastoreUrl ([`vim.vm.ConfigInfo.DatastoreUrlPair`_], optional): Enumerates the set of datastores that this virtual machine is stored on, as well as the URL identification for each of these.Changes to datastores do not generate property updates on this property. However, when this property is retrieved it returns the current datastore information. swapPlacement (`str`_, optional): diff --git a/docs/vim/vm/ConfigOption.rst b/docs/vim/vm/ConfigOption.rst index 3f120eb..d247f8b 100644 --- a/docs/vim/vm/ConfigOption.rst +++ b/docs/vim/vm/ConfigOption.rst @@ -32,7 +32,7 @@ Attributes: description (`str`_): A description string for this configOption. - guestOSDescriptor (`vim.vm.GuestOsDescriptor`_): + guestOSDescriptor ([`vim.vm.GuestOsDescriptor`_]): List of supported guest operating systems. The choice of guest operating system may limit the set of valid devices. For example, you cannot select Vmxnet with all guest operating systems. guestOSDefaultIndex (`int`_): @@ -47,15 +47,15 @@ Attributes: datastore (`vim.vm.DatastoreOption`_): The datastore options for this virtual machine. - defaultDevice (`vim.vm.device.VirtualDevice`_, optional): + defaultDevice ([`vim.vm.device.VirtualDevice`_], optional): The list of virtual devices that are created on a virtual machine by default. Clients should not create these devices. - supportedMonitorType (`str`_): + supportedMonitorType ([`str`_]): The monitor types supported by a host. The acceptable monitor types are enumerated by `VirtualMachineFlagInfoMonitorType`_ . - supportedOvfEnvironmentTransport (`str`_, optional): + supportedOvfEnvironmentTransport ([`str`_], optional): Specifies the supported property transports that are available for the OVF environment - supportedOvfInstallTransport (`str`_, optional): + supportedOvfInstallTransport ([`str`_], optional): Specifies the supported transports for the OVF installation phase. diff --git a/docs/vim/vm/ConfigOptionDescriptor.rst b/docs/vim/vm/ConfigOptionDescriptor.rst index cb9140b..3fd3a2b 100644 --- a/docs/vim/vm/ConfigOptionDescriptor.rst +++ b/docs/vim/vm/ConfigOptionDescriptor.rst @@ -27,7 +27,7 @@ Attributes: description (`str`_, optional): A description of the configOption object. - host (`vim.HostSystem`_, optional): + host ([`vim.HostSystem`_], optional): List of hosts to which this descriptor applies. List of hosts is not set when descriptor is returned from `queryDatacenterConfigOptionDescriptor`_ . createSupported (`bool`_): diff --git a/docs/vim/vm/ConfigSpec.rst b/docs/vim/vm/ConfigSpec.rst index 46953de..622b48c 100644 --- a/docs/vim/vm/ConfigSpec.rst +++ b/docs/vim/vm/ConfigSpec.rst @@ -98,10 +98,10 @@ Attributes: instanceUuid (`str`_, optional): VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexadecimal string. This identifier is used by VirtalCenter to uniquely identify all virtual machine instances in the Virtual Infrastructure environment, including those that may share the same SMBIOS UUID.Normally, this property is not set by a client, allowing the Virtual Infrastructure environment to assign or change it when VirtualCenter detects an identifier conflict between virtual machines. This identifier can be modified even when a virtual machine is powered on. Clients can specify that vCenter Server reassign a new identifier by a providing an empty string. Reassigning the identifer is not allowed for Fault Tolerance virtual machines.Reconfigure privilege: VirtualMachine.Config.Settings - npivNodeWorldWideName (`long`_, optional): + npivNodeWorldWideName ([`long`_], optional): The NPIV node WWN to be assigned to a virtual machine. This property should only be used or set when the value of `npivWorldWideNameOp`_ property is "set". Otherwise, an `InvalidVmConfig`_ fault will be thrown. If the specified node WWN is currently being used by another virtual machine, a `VmWwnConflict`_ fault will be thrown.For detail description on WWN, see `npivNodeWorldWideName`_ .Reconfigure privilege: VirtualMachine.Config.Settings. - npivPortWorldWideName (`long`_, optional): + npivPortWorldWideName ([`long`_], optional): The NPIV port WWN to be assigned to a virtual machine. This property should only be used or set when the value of `npivWorldWideNameOp`_ property is "set". Otherwise, an `InvalidVmConfig`_ fault will be thrown. If the specified port WWN is currently being used by another virtual machine, a `VmWwnConflict`_ fault will be thrown.For detail description on WWN, see `npivPortWorldWideName`_ .Reconfigure privilege: VirtualMachine.Config.Settings. npivWorldWideNameType (`str`_, optional): @@ -173,7 +173,7 @@ Attributes: virtualSMCPresent (`bool`_, optional): Does this virtual machine have System Management Controller - deviceChange (`vim.vm.device.VirtualDeviceSpec`_, optional): + deviceChange ([`vim.vm.device.VirtualDeviceSpec`_], optional): Set of virtual devices being modified by the configuration operation.Reconfigure privileges: * VirtualMachine.Config.Resource if setting the "shares" property of a new or existing VirtualDisk device @@ -207,10 +207,10 @@ Attributes: networkShaper (`vim.vm.NetworkShaperInfo`_, optional): Resource limits for network.Reconfigure privilege: VirtualMachine.Config.Resource - cpuFeatureMask (`vim.vm.ConfigSpec.CpuIdInfoSpec`_, optional): + cpuFeatureMask ([`vim.vm.ConfigSpec.CpuIdInfoSpec`_], optional): Specifies the CPU feature compatibility masks.Reconfigure privilege: VirtualMachine.Config.Settings - extraConfig (`vim.option.OptionValue`_, optional): + extraConfig ([`vim.option.OptionValue`_], optional): Additional configuration information for the virtual machine. This describes a set of modifications to the additional options. If the key is already present, it will be reset with the new value provided. Otherwise, a new option is added. Keys with empty values will be removed.Configuration keys that would conflict with parameters that are explicitly configurable through other fields in the ConfigSpec object are silently ignored.Reconfigure privilege: VirtualMachine.Config.AdvancedConfig (also required when setting this property while creating a virtual machine) swapPlacement (`str`_, optional): @@ -258,6 +258,6 @@ Attributes: scheduledHardwareUpgradeInfo (`vim.vm.ScheduledHardwareUpgradeInfo`_, optional): Configuration of scheduled hardware upgrades.See `ScheduledHardwareUpgradeInfo`_ - vmProfile (`vim.vm.ProfileSpec`_, optional): + vmProfile ([`vim.vm.ProfileSpec`_], optional): Virtual Machine Profile requirement. Profiles are solution specific. Profile Based Storage Management is a vSphere server extension. 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. diff --git a/docs/vim/vm/ConfigTarget.rst b/docs/vim/vm/ConfigTarget.rst index 8ad3fc8..f0565db 100644 --- a/docs/vim/vm/ConfigTarget.rst +++ b/docs/vim/vm/ConfigTarget.rst @@ -73,49 +73,49 @@ Attributes: smcPresent (`bool`_): Presence of System Management Controller, indicates the host is Apple hardware, and thus capable of running Mac OS guest as VM. - datastore (`vim.vm.DatastoreInfo`_, optional): + datastore ([`vim.vm.DatastoreInfo`_], optional): List of datastores available for virtual disks and associated storage. - network (`vim.vm.NetworkInfo`_, optional): + network ([`vim.vm.NetworkInfo`_], optional): List of networks available for virtual network adapters. - opaqueNetwork (`vim.vm.OpaqueNetworkInfo`_, optional): + opaqueNetwork ([`vim.vm.OpaqueNetworkInfo`_], optional): List of opaque networks available for virtual network adapters. - distributedVirtualPortgroup (`vim.dvs.DistributedVirtualPortgroupInfo`_, optional): + distributedVirtualPortgroup ([`vim.dvs.DistributedVirtualPortgroupInfo`_], optional): List of networks available from DistributedVirtualSwitch for virtual network adapters. - distributedVirtualSwitch (`vim.dvs.DistributedVirtualSwitchInfo`_, optional): + distributedVirtualSwitch ([`vim.dvs.DistributedVirtualSwitchInfo`_], optional): List of distributed virtual switch available for virtual network adapters. - cdRom (`vim.vm.CdromInfo`_, optional): + cdRom ([`vim.vm.CdromInfo`_], optional): List of CD-ROM devices available for use by virtual CD-ROMs. Used for `VirtualCdromAtapiBackingInfo`_ . - serial (`vim.vm.SerialInfo`_, optional): + serial ([`vim.vm.SerialInfo`_], optional): List of serial devices available to support virtualization. Used for `VirtualSerialPortDeviceBackingInfo`_ . - parallel (`vim.vm.ParallelInfo`_, optional): + parallel ([`vim.vm.ParallelInfo`_], optional): List of parallel devices available to support virtualization. Used for `VirtualParallelPortDeviceBackingInfo`_ . - sound (`vim.vm.SoundInfo`_, optional): + sound ([`vim.vm.SoundInfo`_], optional): List of sound devices available to support virtualization. Used for `VirtualSoundCardDeviceBackingInfo`_ . - usb (`vim.vm.UsbInfo`_, optional): + usb ([`vim.vm.UsbInfo`_], optional): List of USB devices on the host that are available to support virtualization. Used for `VirtualUSBUSBBackingInfo`_ . - floppy (`vim.vm.FloppyInfo`_, optional): + floppy ([`vim.vm.FloppyInfo`_], optional): List of floppy devices available for use by virtual floppies. Used for `VirtualFloppyDeviceBackingInfo`_ . - legacyNetworkInfo (`vim.vm.LegacyNetworkSwitchInfo`_, optional): + legacyNetworkInfo ([`vim.vm.LegacyNetworkSwitchInfo`_], optional): Legacy switch names when using the LegacyNetworkBacking types. - scsiPassthrough (`vim.vm.ScsiPassthroughInfo`_, optional): + scsiPassthrough ([`vim.vm.ScsiPassthroughInfo`_], optional): List of generic SCSI devices. - scsiDisk (`vim.vm.ScsiDiskDeviceInfo`_, optional): + scsiDisk ([`vim.vm.ScsiDiskDeviceInfo`_], optional): List of physical SCSI disks that can be used as targets for raw disk mapping backings. - ideDisk (`vim.vm.IdeDiskDeviceInfo`_, optional): + ideDisk ([`vim.vm.IdeDiskDeviceInfo`_], optional): List of physical IDE disks that can be used as targets for raw disk backings. maxMemMBOptimalPerf (`int`_): @@ -127,12 +127,12 @@ Attributes: autoVmotion (`bool`_, optional): Information whether a virtual machine with this ConfigTarget can auto vmotion. This field is only populated from an Environment browser obtained from a virtual machine. - pciPassthrough (`vim.vm.PciPassthroughInfo`_, optional): + pciPassthrough ([`vim.vm.PciPassthroughInfo`_], optional): List of generic PCI devices. - sriov (`vim.vm.SriovInfo`_, optional): + sriov ([`vim.vm.SriovInfo`_], optional): List of SRIOV devices. - vFlashModule (`vim.vm.VFlashModuleInfo`_, optional): + vFlashModule ([`vim.vm.VFlashModuleInfo`_], optional): List of vFlash modules. diff --git a/docs/vim/vm/DatastoreOption.rst b/docs/vim/vm/DatastoreOption.rst index f99f9f6..861a6a2 100644 --- a/docs/vim/vm/DatastoreOption.rst +++ b/docs/vim/vm/DatastoreOption.rst @@ -9,6 +9,6 @@ vim.vm.DatastoreOption :extends: vmodl.DynamicData_ Attributes: - unsupportedVolumes (`vim.vm.DatastoreOption.FileSystemVolumeOption`_, optional): + unsupportedVolumes ([`vim.vm.DatastoreOption.FileSystemVolumeOption`_], optional): The type of file system volumes on which this virtual machine cannot have its disk and configuration files. diff --git a/docs/vim/vm/DeviceRuntimeInfo/VirtualEthernetCardRuntimeState.rst b/docs/vim/vm/DeviceRuntimeInfo/VirtualEthernetCardRuntimeState.rst index fade18b..1f6e281 100644 --- a/docs/vim/vm/DeviceRuntimeInfo/VirtualEthernetCardRuntimeState.rst +++ b/docs/vim/vm/DeviceRuntimeInfo/VirtualEthernetCardRuntimeState.rst @@ -31,10 +31,10 @@ Attributes: vmDirectPathGen2Active (`bool`_): Flag to indicate whether VMDirectPath Gen 2 is active on this device. If false, the reason(s) for inactivity will be provided in one or more of `vmDirectPathGen2InactiveReasonVm`_ , `vmDirectPathGen2InactiveReasonOther`_ , and `vmDirectPathGen2InactiveReasonExtended`_ . - vmDirectPathGen2InactiveReasonVm (`str`_, optional): + vmDirectPathGen2InactiveReasonVm ([`str`_], optional): If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are related to virtual machine state or configuration (chosen from VmDirectPathGen2InactiveReasonVm). Other reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonOther`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive. - vmDirectPathGen2InactiveReasonOther (`str`_, optional): + vmDirectPathGen2InactiveReasonOther ([`str`_], optional): If `vmDirectPathGen2Active`_ is false, this array will be populated with reasons for the inactivity that are not related to virtual machine state or configuration (chosen from VmDirectPathGen2InactiveReasonOther). Virtual machine related reasons for inactivity will be provided in `vmDirectPathGen2InactiveReasonVm`_ . If there is a reason for inactivity that cannot be described by the available constants, `vmDirectPathGen2InactiveReasonExtended`_ will be populated with an additional explanation provided by the platform.Note that this list of reasons is not guaranteed to be exhaustive.See `vmDirectPathGen2Supported`_ vmDirectPathGen2InactiveReasonExtended (`str`_, optional): diff --git a/docs/vim/vm/DiskDeviceInfo.rst b/docs/vim/vm/DiskDeviceInfo.rst index 1bd98b5..b2983f9 100644 --- a/docs/vim/vm/DiskDeviceInfo.rst +++ b/docs/vim/vm/DiskDeviceInfo.rst @@ -14,6 +14,6 @@ Attributes: capacity (`long`_, optional): Size of disk - vm (`vim.VirtualMachine`_, optional): + vm ([`vim.VirtualMachine`_], optional): List of known virtual machines using this physical disk as a backing diff --git a/docs/vim/vm/FaultToleranceConfigInfo.rst b/docs/vim/vm/FaultToleranceConfigInfo.rst index 87925e1..f855426 100644 --- a/docs/vim/vm/FaultToleranceConfigInfo.rst +++ b/docs/vim/vm/FaultToleranceConfigInfo.rst @@ -17,9 +17,9 @@ Attributes: role (`int`_): The index of the current VM in instanceUuids array starting from 1, so 1 means that it is the primary VM. - instanceUuids (`str`_): + instanceUuids ([`str`_]): The instanceUuid of all the VMs in this fault tolerance group. The first element is the instanceUuid of the primary VM. - configPaths (`str`_): + configPaths ([`str`_]): The configuration file path for all the VMs in this fault tolerance group. diff --git a/docs/vim/vm/FaultTolerancePrimaryConfigInfo.rst b/docs/vim/vm/FaultTolerancePrimaryConfigInfo.rst index 09a0ebb..6e04258 100644 --- a/docs/vim/vm/FaultTolerancePrimaryConfigInfo.rst +++ b/docs/vim/vm/FaultTolerancePrimaryConfigInfo.rst @@ -12,5 +12,5 @@ vim.vm.FaultTolerancePrimaryConfigInfo :since: `vSphere API 4.0`_ Attributes: - secondaries (`vim.VirtualMachine`_): + secondaries ([`vim.VirtualMachine`_]): diff --git a/docs/vim/vm/FileLayout.rst b/docs/vim/vm/FileLayout.rst index 7b2c7bc..3835468 100644 --- a/docs/vim/vm/FileLayout.rst +++ b/docs/vim/vm/FileLayout.rst @@ -21,16 +21,16 @@ vim.vm.FileLayout Attributes: - configFile (`str`_, optional): + configFile ([`str`_], optional): A list of files that makes up the configuration of the virtual machine (excluding the .vmx file, since that file is represented in the FileInfo). These are relative paths from the configuration directory. A slash is always used as a separator. This list will typically include the NVRAM file, but could also include other meta-data files. - logFile (`str`_, optional): + logFile ([`str`_], optional): A list of files stored in the virtual machine's log directory. These are relative paths from the logDirectory. A slash is always used as a separator. - disk (`vim.vm.FileLayout.DiskLayout`_, optional): + disk ([`vim.vm.FileLayout.DiskLayout`_], optional): Files making up each virtual disk. - snapshot (`vim.vm.FileLayout.SnapshotLayout`_, optional): + snapshot ([`vim.vm.FileLayout.SnapshotLayout`_], optional): Files of each snapshot. swapFile (`str`_, optional): diff --git a/docs/vim/vm/FileLayout/DiskLayout.rst b/docs/vim/vm/FileLayout/DiskLayout.rst index ae68b30..680b8db 100644 --- a/docs/vim/vm/FileLayout/DiskLayout.rst +++ b/docs/vim/vm/FileLayout/DiskLayout.rst @@ -16,6 +16,6 @@ Attributes: key (`int`_): Identification of the disk in `config`_ . - diskFile (`str`_): + diskFile ([`str`_]): List of files that makes up the virtual disk. At least one entry always exists in this array. The first entry is the main descriptor of the virtual disk (the one used when adding the disk to a virtual machine). These are complete datastore paths, not relative paths. diff --git a/docs/vim/vm/FileLayout/SnapshotLayout.rst b/docs/vim/vm/FileLayout/SnapshotLayout.rst index d0323d3..ef26b8a 100644 --- a/docs/vim/vm/FileLayout/SnapshotLayout.rst +++ b/docs/vim/vm/FileLayout/SnapshotLayout.rst @@ -14,6 +14,6 @@ Attributes: key (`vim.vm.Snapshot`_): Identification of the snapshot - snapshotFile (`str`_): + snapshotFile ([`str`_]): A list of files that make up the snapshot state. These are relative paths from the snapshotDirectory. A slash is always used as a separator. diff --git a/docs/vim/vm/FileLayoutEx.rst b/docs/vim/vm/FileLayoutEx.rst index c26c6f0..3ce13d4 100644 --- a/docs/vim/vm/FileLayoutEx.rst +++ b/docs/vim/vm/FileLayoutEx.rst @@ -25,13 +25,13 @@ vim.vm.FileLayoutEx :since: `vSphere API 4.0`_ Attributes: - file (`vim.vm.FileLayoutEx.FileInfo`_, optional): + file ([`vim.vm.FileLayoutEx.FileInfo`_], optional): Information about all the files that constitute the virtual machine including configuration files, disks, swap file, suspend file, log files, core files, memory file etc. `VirtualMachineFileLayoutExFileType`_ lists the different file-types that make a virtual machine. - disk (`vim.vm.FileLayoutEx.DiskLayout`_, optional): + disk ([`vim.vm.FileLayoutEx.DiskLayout`_], optional): Layout of each virtual disk attached to the virtual machine.For a virtual machine with snaphots, this property gives only those disks that are attached to it at the current point of running. - snapshot (`vim.vm.FileLayoutEx.SnapshotLayout`_, optional): + snapshot ([`vim.vm.FileLayoutEx.SnapshotLayout`_], optional): Layout of each snapshot of the virtual machine. timestamp (`datetime`_): diff --git a/docs/vim/vm/FileLayoutEx/DiskLayout.rst b/docs/vim/vm/FileLayoutEx/DiskLayout.rst index 27a9250..f60e380 100644 --- a/docs/vim/vm/FileLayoutEx/DiskLayout.rst +++ b/docs/vim/vm/FileLayoutEx/DiskLayout.rst @@ -19,6 +19,6 @@ Attributes: key (`int`_): Identifier for the virtual disk in `device`_ . - chain (`vim.vm.FileLayoutEx.DiskUnit`_, optional): + chain ([`vim.vm.FileLayoutEx.DiskUnit`_], optional): The disk-unit chain that makes up this virtual disk. diff --git a/docs/vim/vm/FileLayoutEx/DiskUnit.rst b/docs/vim/vm/FileLayoutEx/DiskUnit.rst index b7532d9..bb6ad66 100644 --- a/docs/vim/vm/FileLayoutEx/DiskUnit.rst +++ b/docs/vim/vm/FileLayoutEx/DiskUnit.rst @@ -18,6 +18,6 @@ vim.vm.FileLayoutEx.DiskUnit :since: `vSphere API 4.0`_ Attributes: - fileKey (`int`_): + fileKey ([`int`_]): Array of keys of the files that make up the disk unit. Values here correspond to property `key`_ in `file`_ .At least one entry always exists in this array. Property `type`_ of the referenced file can be used to distinguish the disk descriptor (type `diskDescriptor`_ ) from the extents. diff --git a/docs/vim/vm/FileLayoutEx/SnapshotLayout.rst b/docs/vim/vm/FileLayoutEx/SnapshotLayout.rst index 535fa3d..672133d 100644 --- a/docs/vim/vm/FileLayoutEx/SnapshotLayout.rst +++ b/docs/vim/vm/FileLayoutEx/SnapshotLayout.rst @@ -24,6 +24,6 @@ Attributes: dataKey (`int`_): Key to the snapshot data file in `file`_ . - disk (`vim.vm.FileLayoutEx.DiskLayout`_, optional): + disk ([`vim.vm.FileLayoutEx.DiskLayout`_], optional): Layout of each virtual disk of the virtual machine when the snapshot was taken. diff --git a/docs/vim/vm/GuestInfo.rst b/docs/vim/vm/GuestInfo.rst index 74eefaa..c71a703 100644 --- a/docs/vim/vm/GuestInfo.rst +++ b/docs/vim/vm/GuestInfo.rst @@ -65,13 +65,13 @@ Attributes: ipAddress (`str`_, optional): Primary IP address assigned to the guest operating system, if known. - net (`vim.vm.GuestInfo.NicInfo`_, optional): + net ([`vim.vm.GuestInfo.NicInfo`_], optional): Guest information about network adapters, if known. - ipStack (`vim.vm.GuestInfo.StackInfo`_, optional): + ipStack ([`vim.vm.GuestInfo.StackInfo`_], optional): Guest information about IP networking stack, if known. - disk (`vim.vm.GuestInfo.DiskInfo`_, optional): + disk ([`vim.vm.GuestInfo.DiskInfo`_], optional): Guest information about disks.You can obtain Linux guest disk information for the following file system types only: Ext2, Ext3, Ext4, ReiserFS, ZFS, NTFS, VFAT, UFS, PCFS, HFS, and MS-DOS. screen (`vim.vm.GuestInfo.ScreenInfo`_, optional): @@ -99,6 +99,6 @@ Attributes: interactiveGuestOperationsReady (`bool`_, optional): Interactive Guest Operations availability. If true, the vitrual machine is ready to process guest operations as the user interacting with the guest desktop. - generationInfo (`vim.vm.GuestInfo.NamespaceGenerationInfo`_, privilege: VirtualMachine.Namespace.EventNotify, optional): + generationInfo ([`vim.vm.GuestInfo.NamespaceGenerationInfo`_, privilege: VirtualMachine.Namespace.EventNotify], optional): A list of namespaces and their corresponding generation numbers. Only namespaces with non-zero `maxSizeEventsFromGuest`_ are guaranteed to be present here. Use `ListNamespaces`_ to retrieve list of namespaces. diff --git a/docs/vim/vm/GuestInfo/NicInfo.rst b/docs/vim/vm/GuestInfo/NicInfo.rst index 5caa497..b9bcf08 100644 --- a/docs/vim/vm/GuestInfo/NicInfo.rst +++ b/docs/vim/vm/GuestInfo/NicInfo.rst @@ -22,7 +22,7 @@ Attributes: network (`str`_, optional): Name of the virtual switch portgroup or dvPort connected to this adapter. - ipAddress (`str`_, optional): + ipAddress ([`str`_], optional): macAddress (`str`_, optional): diff --git a/docs/vim/vm/GuestInfo/StackInfo.rst b/docs/vim/vm/GuestInfo/StackInfo.rst index 7ee9cef..1b994be 100644 --- a/docs/vim/vm/GuestInfo/StackInfo.rst +++ b/docs/vim/vm/GuestInfo/StackInfo.rst @@ -24,7 +24,7 @@ Attributes: ipRouteConfig (`vim.net.IpRouteConfigInfo`_, optional): IP route table configuration. - ipStackConfig (`vim.KeyValue`_, optional): + ipStackConfig ([`vim.KeyValue`_], optional): Report Kernel IP configuration settings. The key part contains a unique number in the report. The value part contains the 'key=value' as provided by the underlying provider. For example on Linux, BSD, the systcl -a output would be reported as: key='5', value='net.ipv4.tcp_keepalive_time = 7200' dhcpConfig (`vim.net.DhcpConfigInfo`_, optional): diff --git a/docs/vim/vm/GuestOsDescriptor.rst b/docs/vim/vm/GuestOsDescriptor.rst index ae059a7..d6a4a1d 100644 --- a/docs/vim/vm/GuestOsDescriptor.rst +++ b/docs/vim/vm/GuestOsDescriptor.rst @@ -51,7 +51,7 @@ Attributes: recommendedColorDepth (`int`_): Recommended default color depth for this guest. - supportedDiskControllerList (`str`_): + supportedDiskControllerList ([`str`_]): List of supported disk controller types for this guest. recommendedSCSIController (`str`_, optional): @@ -69,7 +69,7 @@ Attributes: recommendedCdromController (`str`_): Recommended default CD-ROM type for this guest. - supportedEthernetCard (`str`_): + supportedEthernetCard ([`str`_]): List of supported ethernet cards for this guest. recommendedEthernetCard (`str`_, optional): @@ -78,7 +78,7 @@ Attributes: supportsSlaveDisk (`bool`_, optional): Flag to indicate whether or not this guest can support a disk configured as a slave. - cpuFeatureMask (`vim.host.CpuIdInfo`_, optional): + cpuFeatureMask ([`vim.host.CpuIdInfo`_], optional): Specifies the CPU feature compatibility masks. smcRequired (`bool`_): @@ -99,13 +99,13 @@ Attributes: supportsCpuHotRemove (`bool`_): Whether virtual CPUs can be removed from this guest while the virtual machine is running. - supportedFirmware (`str`_): + supportedFirmware ([`str`_]): Supported firmware types for this guest. Possible values are described in `GuestOsDescriptorFirmwareType`_ recommendedFirmware (`str`_): Recommended firmware type for this guest. Possible values are described in `GuestOsDescriptorFirmwareType`_ - supportedUSBControllerList (`str`_, optional): + supportedUSBControllerList ([`str`_], optional): List of supported USB controllers for this guest. recommendedUSBController (`str`_, optional): diff --git a/docs/vim/vm/IdeDiskDeviceInfo.rst b/docs/vim/vm/IdeDiskDeviceInfo.rst index 5f1a133..0f06abd 100644 --- a/docs/vim/vm/IdeDiskDeviceInfo.rst +++ b/docs/vim/vm/IdeDiskDeviceInfo.rst @@ -9,5 +9,5 @@ vim.vm.IdeDiskDeviceInfo :extends: vim.vm.DiskDeviceInfo_ Attributes: - partitionTable (`vim.vm.IdeDiskDeviceInfo.PartitionInfo`_, optional): + partitionTable ([`vim.vm.IdeDiskDeviceInfo.PartitionInfo`_], optional): diff --git a/docs/vim/vm/Message.rst b/docs/vim/vm/Message.rst index c8ae2d7..5061e3a 100644 --- a/docs/vim/vm/Message.rst +++ b/docs/vim/vm/Message.rst @@ -53,7 +53,7 @@ Attributes: id (`str`_): A unique identifier for this particular message. This field is a key for looking up format strings in the locmsg catalog. - argument (`object`_, optional): + argument ([`object`_], optional): Substitution arguments for variables in the localized message. Substitution variables in the format string identified by `id`_ are 1-based indexes into this array. Substitution variable {1} corresponds to argument[0], etc. text (`str`_, optional): diff --git a/docs/vim/vm/QuestionInfo.rst b/docs/vim/vm/QuestionInfo.rst index 8ed5e33..cc71dbe 100644 --- a/docs/vim/vm/QuestionInfo.rst +++ b/docs/vim/vm/QuestionInfo.rst @@ -22,6 +22,6 @@ Attributes: choice (`vim.option.ChoiceOption`_): List of key-value pairs that specify possible answers. - message (`vim.vm.Message`_, optional): + message ([`vim.vm.Message`_], optional): The message data for the individual messages that comprise the question. Only available on servers that support localization. diff --git a/docs/vim/vm/RelocateSpec.rst b/docs/vim/vm/RelocateSpec.rst index 24b692f..58ffdb6 100644 --- a/docs/vim/vm/RelocateSpec.rst +++ b/docs/vim/vm/RelocateSpec.rst @@ -56,15 +56,15 @@ Attributes: * if resource pool is specified, and the target pool represents a DRS-enabled cluster, a host selected by DRS is used. * if resource pool is specified and the target pool represents a cluster without DRS enabled, an InvalidArgument exception be thrown. * - disk (`vim.vm.RelocateSpec.DiskLocator`_, optional): + disk ([`vim.vm.RelocateSpec.DiskLocator`_], optional): An optional list that allows specifying the datastore location for each virtual disk. transform (`vim.vm.RelocateSpec.Transformation`_, optional): Transformation to perform on the disks. The backend is free to ignore this hint if it is not valid for the current operation. This can be used by clients, for example, to create sparse disks for templates.See `VirtualMachineRelocateTransformation`_ - deviceChange (`vim.vm.device.VirtualDeviceSpec`_, optional): + deviceChange ([`vim.vm.device.VirtualDeviceSpec`_], optional): An optional list of virtual device specs that allow specifying the migrate options for the relocate operation. The supported device type is `VirtualDisk`_ For VirtualDisk device, `VirtualDiskConfigSpec`_ has to be used to specify migrateCache option for disk with vFlash cache. - profile (`vim.vm.ProfileSpec`_, optional): + profile ([`vim.vm.ProfileSpec`_], optional): Storage profile requirement for Virtual Machine's home directory. Profiles are solution specific. Storage Profile Based Management(SPBM) is a vSphere server extension. The API users who want to provision VMs using Storage Profiles, need to interact with SPBM. This is an optional parameter and if user doesn't specify profile, the default behavior will apply. diff --git a/docs/vim/vm/RelocateSpec/DiskLocator.rst b/docs/vim/vm/RelocateSpec/DiskLocator.rst index c1b6238..51fab19 100644 --- a/docs/vim/vm/RelocateSpec/DiskLocator.rst +++ b/docs/vim/vm/RelocateSpec/DiskLocator.rst @@ -51,6 +51,6 @@ Attributes: * * `VirtualDiskSeSparseBackingInfo`_ * (ESX 5.1 or later) - profile (`vim.vm.ProfileSpec`_, optional): + profile ([`vim.vm.ProfileSpec`_], optional): Virtual Disk Profile requirement. Profiles are solution specific. 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. diff --git a/docs/vim/vm/RuntimeInfo.rst b/docs/vim/vm/RuntimeInfo.rst index a320820..cb02133 100644 --- a/docs/vim/vm/RuntimeInfo.rst +++ b/docs/vim/vm/RuntimeInfo.rst @@ -49,7 +49,7 @@ vim.vm.RuntimeInfo :extends: vmodl.DynamicData_ Attributes: - device (`vim.vm.DeviceRuntimeInfo`_, optional): + device ([`vim.vm.DeviceRuntimeInfo`_], optional): Per-device runtime info. This array will be empty if the host software does not provide runtime info for any of the device types currently in use by the 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. 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): @@ -112,13 +112,13 @@ Attributes: consolidationNeeded (`bool`_): Whether any disk of the virtual machine requires consolidation. This can happen for example when a snapshot is deleted but its associated disk is not committed back to the base disk. Use `ConsolidateVMDisks_Task`_ to consolidate if needed. - offlineFeatureRequirement (`vim.vm.FeatureRequirement`_, optional): + offlineFeatureRequirement ([`vim.vm.FeatureRequirement`_], optional): These requirements must have equivalent host capabilities `featureCapability`_ in order to power on. - featureRequirement (`vim.vm.FeatureRequirement`_, optional): + featureRequirement ([`vim.vm.FeatureRequirement`_], optional): These requirements must have equivalent host capabilities `featureCapability`_ in order to power on, resume, or migrate to the host. - featureMask (`vim.host.FeatureMask`_, optional): + featureMask ([`vim.host.FeatureMask`_], optional): The masks applied to an individual virtual machine as a result of its configuration. vFlashCacheAllocation (`long`_, optional): diff --git a/docs/vim/vm/Snapshot.rst b/docs/vim/vm/Snapshot.rst index 58e808f..6b06d82 100644 --- a/docs/vim/vm/Snapshot.rst +++ b/docs/vim/vm/Snapshot.rst @@ -49,7 +49,7 @@ Attributes ---------- config (`vim.vm.ConfigInfo`_): Information about the configuration of this virtual machine when this snapshot was taken.The datastore paths for the virtual machine disks point to the head of the disk chain that represents the disk at this given snapshot. The fileInfo.fileLayout field is not set. - childSnapshot (`vim.vm.Snapshot`_): + childSnapshot ([`vim.vm.Snapshot`_]): All snapshots for which this snapshot is the parent. diff --git a/docs/vim/vm/SnapshotInfo.rst b/docs/vim/vm/SnapshotInfo.rst index fd68292..3fc035f 100644 --- a/docs/vim/vm/SnapshotInfo.rst +++ b/docs/vim/vm/SnapshotInfo.rst @@ -18,6 +18,6 @@ Attributes: currentSnapshot (`vim.vm.Snapshot`_, optional): Current snapshot of the virtual machineThis property is set by calling `Snapshot.revert`_ or `VirtualMachine.createSnapshot`_ . This property will be empty when the working snapshot is at the root of the snapshot tree. - rootSnapshotList (`vim.vm.SnapshotTree`_): + rootSnapshotList ([`vim.vm.SnapshotTree`_]): Data for the entire set of snapshots for one virtual machine. diff --git a/docs/vim/vm/SnapshotTree.rst b/docs/vim/vm/SnapshotTree.rst index 8ea966c..5581616 100644 --- a/docs/vim/vm/SnapshotTree.rst +++ b/docs/vim/vm/SnapshotTree.rst @@ -50,7 +50,7 @@ Attributes: backupManifest (`str`_, optional): The relative path from the snapshotDirectory pointing to the backup manifest. Available for certain quiesced snapshots only. - childSnapshotList (`vim.vm.SnapshotTree`_, optional): + childSnapshotList ([`vim.vm.SnapshotTree`_], optional): The snapshot data for all snapshots for which this snapshot is the parent. replaySupported (`bool`_, optional): diff --git a/docs/vim/vm/StorageInfo.rst b/docs/vim/vm/StorageInfo.rst index 6e9c8b5..0efe78b 100644 --- a/docs/vim/vm/StorageInfo.rst +++ b/docs/vim/vm/StorageInfo.rst @@ -16,7 +16,7 @@ vim.vm.StorageInfo :since: `vSphere API 4.0`_ Attributes: - perDatastoreUsage (`vim.vm.StorageInfo.UsageOnDatastore`_, optional): + perDatastoreUsage ([`vim.vm.StorageInfo.UsageOnDatastore`_], optional): Storage space used by this virtual machine on all datastores that it is located on.Total storage space committed to this virtual machine across all datastores is simply an aggregate of the property `committed`_ .See `committed`_ timestamp (`datetime`_): diff --git a/docs/vim/vm/Summary.rst b/docs/vim/vm/Summary.rst index bfc746d..8feeda2 100644 --- a/docs/vim/vm/Summary.rst +++ b/docs/vim/vm/Summary.rst @@ -48,6 +48,6 @@ Attributes: overallStatus (`vim.ManagedEntity.Status`_): Overall alarm status on this node. 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. - customValue (`vim.CustomFieldsManager.Value`_, optional): + customValue ([`vim.CustomFieldsManager.Value`_], optional): Custom field values. diff --git a/docs/vim/vm/TargetInfo.rst b/docs/vim/vm/TargetInfo.rst index a1b228f..4595590 100644 --- a/docs/vim/vm/TargetInfo.rst +++ b/docs/vim/vm/TargetInfo.rst @@ -12,6 +12,6 @@ Attributes: name (`str`_): The identification of the endpoint on the host. The format of this depends on the kind of virtual device this endpoints is used for. For example, for a VirtualEthernetCard this would be a networkname, and for a VirtualCDROM it would be a device name. - configurationTag (`str`_, optional): + configurationTag ([`str`_], optional): List of configurations that this device is available for. This is only filled out if more than one configuration is requested. diff --git a/docs/vim/vm/UsbInfo.rst b/docs/vim/vm/UsbInfo.rst index 9294724..bb5fd5d 100644 --- a/docs/vim/vm/UsbInfo.rst +++ b/docs/vim/vm/UsbInfo.rst @@ -32,10 +32,10 @@ Attributes: physicalPath (`str`_): An autoconnect pattern which describes the device's physical path. This is the path to the specific port on the host where the USB device is attached. - family (`str`_, optional): + family ([`str`_], optional): The device class families. For possible values see `VirtualMachineUsbInfoFamily`_ - speed (`str`_, optional): + speed ([`str`_], optional): The possible device speeds detected by server. For possible values see `VirtualMachineUsbInfoSpeed`_ summary (`vim.vm.Summary`_, optional): diff --git a/docs/vim/vm/VirtualHardware.rst b/docs/vim/vm/VirtualHardware.rst index 0adae5d..605e910 100644 --- a/docs/vim/vm/VirtualHardware.rst +++ b/docs/vim/vm/VirtualHardware.rst @@ -28,6 +28,6 @@ Attributes: virtualSMCPresent (`bool`_, optional): Does this virtual machine have System Management Controller - device (`vim.vm.device.VirtualDevice`_, optional): + device ([`vim.vm.device.VirtualDevice`_], optional): The set of virtual devices belonging to the virtual machine. This list is unordered. diff --git a/docs/vim/vm/VirtualHardwareOption.rst b/docs/vim/vm/VirtualHardwareOption.rst index d5f1463..4452ce2 100644 --- a/docs/vim/vm/VirtualHardwareOption.rst +++ b/docs/vim/vm/VirtualHardwareOption.rst @@ -32,13 +32,13 @@ Attributes: hwVersion (`int`_): The virtual hardware version. - virtualDeviceOption (`vim.vm.device.VirtualDeviceOption`_): + virtualDeviceOption ([`vim.vm.device.VirtualDeviceOption`_]): Array of virtual device options valid for this virtual machine configuration. The list is unordered. deviceListReadonly (`bool`_): Whether the set of virtual devices can be changed, e.g., can devices be added or removed. This does not preclude changing devices. - numCPU (`int`_): + numCPU ([`int`_]): List of acceptable values for the number of CPUs supported by this `ConfigOption`_ . This is usually superceded by the information available in the guest operating system descriptors. The guest operating system descriptor describes a maximum CPU count, but the acceptable values are still constrained to the set specified here. The default value is stored at index 0 in the list. numCoresPerSocket (`vim.option.IntOption`_): @@ -68,7 +68,7 @@ Attributes: numPS2Controllers (`vim.option.IntOption`_): The minimum, maximum, and default number of PS2 controllers for this virtual machine configuration. - licensingLimit (`str`_, optional): + licensingLimit ([`str`_], optional): List of propery names which limits are given be a licensing restriction of the underlying product, e.g., a limit that is not derived based on the product or hardware features. For example, the property name "numCPU" numSupportedWwnPorts (`vim.option.IntOption`_, optional): diff --git a/docs/vim/vm/check/Result.rst b/docs/vim/vm/check/Result.rst index b3661a4..a7149bf 100644 --- a/docs/vim/vm/check/Result.rst +++ b/docs/vim/vm/check/Result.rst @@ -26,9 +26,9 @@ Attributes: host (`vim.HostSystem`_, optional): The host involved in the testing. - warning (`vmodl.LocalizedMethodFault`_, optional): + warning ([`vmodl.LocalizedMethodFault`_], optional): A list of faults representing problems which may require attention, but which are not fatal. - error (`vmodl.LocalizedMethodFault`_, optional): + error ([`vmodl.LocalizedMethodFault`_], optional): A list of faults representing problems which are fatal to the operation. For `VirtualMachineProvisioningChecker`_ an error means that the given provisioning operation would fail. For `VirtualMachineCompatibilityChecker`_ an error means that either a power-on of this virtual machine would fail, or that the virtual machine would not run correctly once powered-on. diff --git a/docs/vim/vm/customization/GlobalIPSettings.rst b/docs/vim/vm/customization/GlobalIPSettings.rst index c21dd9a..e28e7a7 100644 --- a/docs/vim/vm/customization/GlobalIPSettings.rst +++ b/docs/vim/vm/customization/GlobalIPSettings.rst @@ -9,9 +9,9 @@ vim.vm.customization.GlobalIPSettings :extends: vmodl.DynamicData_ Attributes: - dnsSuffixList (`str`_, optional): + dnsSuffixList ([`str`_], optional): List of name resolution suffixes for the virtual network adapter. This list applies to both Windows and Linux guest customization. For Linux, this setting is global, whereas in Windows, this setting is listed on a per-adapter basis, even though the setting is global in Windows. - dnsServerList (`str`_, optional): + dnsServerList ([`str`_], optional): List of DNS servers, for a virtual network adapter with a static IP address. If this list is empty, then the guest operating system is expected to use a DHCP server to get its DNS server settings. These settings configure the virtual machine to use the specified DNS servers. These DNS server settings are listed in order of preference. diff --git a/docs/vim/vm/customization/GuiRunOnce.rst b/docs/vim/vm/customization/GuiRunOnce.rst index 449d8a0..76b6831 100644 --- a/docs/vim/vm/customization/GuiRunOnce.rst +++ b/docs/vim/vm/customization/GuiRunOnce.rst @@ -13,6 +13,6 @@ vim.vm.customization.GuiRunOnce :extends: vmodl.DynamicData_ Attributes: - commandList (`str`_): + commandList ([`str`_]): A list of commands to run at first user logon, after guest customization. diff --git a/docs/vim/vm/customization/IPSettings.rst b/docs/vim/vm/customization/IPSettings.rst index 0bc98b3..ee0f153 100644 --- a/docs/vim/vm/customization/IPSettings.rst +++ b/docs/vim/vm/customization/IPSettings.rst @@ -21,13 +21,13 @@ Attributes: subnetMask (`str`_, optional): Subnet mask for this virtual network adapter. - gateway (`str`_, optional): + gateway ([`str`_], optional): For a virtual network adapter with a static IP address, this data object type contains a list of gateways, in order of preference. ipV6Spec (`vim.vm.customization.IPSettings.IpV6AddressSpec`_, optional): This contains the IpGenerator, subnet mask and gateway info for all the ipv6 addresses associated with the virtual network adapter. - dnsServerList (`str`_, optional): + dnsServerList ([`str`_], optional): A list of server IP addresses to use for DNS lookup in a Windows guest operating system. In Windows, these settings are adapter-specific, whereas in Linux, they are global. As a result, the Linux guest customization process ignores this setting and looks for its DNS servers in the globalIPSettings object.Specify these servers in order of preference. If this list is not empty, and if a DHCP IpGenerator is used, then these settings override the DHCP settings. dnsDomain (`str`_, optional): diff --git a/docs/vim/vm/customization/IPSettings/IpV6AddressSpec.rst b/docs/vim/vm/customization/IPSettings/IpV6AddressSpec.rst index dc20a69..72538df 100644 --- a/docs/vim/vm/customization/IPSettings/IpV6AddressSpec.rst +++ b/docs/vim/vm/customization/IPSettings/IpV6AddressSpec.rst @@ -14,9 +14,9 @@ vim.vm.customization.IPSettings.IpV6AddressSpec :since: `vSphere API 4.0`_ Attributes: - ip (`vim.vm.customization.IpV6Generator`_): + ip ([`vim.vm.customization.IpV6Generator`_]): ipv6 address generators - gateway (`str`_, optional): + gateway ([`str`_], optional): gateways diff --git a/docs/vim/vm/customization/Specification.rst b/docs/vim/vm/customization/Specification.rst index b1b7103..be520e5 100644 --- a/docs/vim/vm/customization/Specification.rst +++ b/docs/vim/vm/customization/Specification.rst @@ -26,9 +26,9 @@ Attributes: globalIPSettings (`vim.vm.customization.GlobalIPSettings`_): Global IP settings constitute the IP settings that are not specific to a particular virtual network adapter. - nicSettingMap (`vim.vm.customization.AdapterMapping`_, optional): + nicSettingMap ([`vim.vm.customization.AdapterMapping`_], optional): IP settings that are specific to a particular virtual network adapter. The AdapterMapping object maps a network adapter's MAC address to its Adapter settings object. May be empty if there are no network adapters, else should match number of network adapters in the VM. - encryptionKey (`int`_, optional): + encryptionKey ([`int`_], optional): Byte array containing the public key used to encrypt any passwords stored in the specification. Both the client and the server can use this to determine if stored passwords can be decrypted by the server or if the passwords need to be re-entered and re-encrypted before the specification can be used. diff --git a/docs/vim/vm/device/HostDiskMappingOption.rst b/docs/vim/vm/device/HostDiskMappingOption.rst index 1753f7a..6fa2734 100644 --- a/docs/vim/vm/device/HostDiskMappingOption.rst +++ b/docs/vim/vm/device/HostDiskMappingOption.rst @@ -11,7 +11,7 @@ vim.vm.device.HostDiskMappingOption :extends: vmodl.DynamicData_ Attributes: - physicalPartition (`vim.vm.device.HostDiskMappingOption.PartitionOption`_, optional): + physicalPartition ([`vim.vm.device.HostDiskMappingOption.PartitionOption`_], optional): Array of valid partitions on this physical disk. There is no default for this array. name (`str`_): diff --git a/docs/vim/vm/device/VirtualController.rst b/docs/vim/vm/device/VirtualController.rst index 632871f..66de4eb 100644 --- a/docs/vim/vm/device/VirtualController.rst +++ b/docs/vim/vm/device/VirtualController.rst @@ -14,6 +14,6 @@ Attributes: busNumber (`int`_): Bus number associated with this controller. - device (`int`_, optional): + device ([`int`_], optional): List of devices currently controlled by this controller. Each entry contains the `key`_ property of the corresponding device object. diff --git a/docs/vim/vm/device/VirtualControllerOption.rst b/docs/vim/vm/device/VirtualControllerOption.rst index 530fb33..ad3506a 100644 --- a/docs/vim/vm/device/VirtualControllerOption.rst +++ b/docs/vim/vm/device/VirtualControllerOption.rst @@ -14,6 +14,6 @@ Attributes: devices (`vim.option.IntOption`_): The minimum and maximum number of devices this controller can control at run time. - supportedDevice (`str`_, optional): + supportedDevice ([`str`_], optional): Array of supported device options for this controller. diff --git a/docs/vim/vm/device/VirtualDeviceOption.rst b/docs/vim/vm/device/VirtualDeviceOption.rst index afdd67c..aee8d2f 100644 --- a/docs/vim/vm/device/VirtualDeviceOption.rst +++ b/docs/vim/vm/device/VirtualDeviceOption.rst @@ -38,13 +38,13 @@ Attributes: autoAssignController (`vim.option.BoolOption`_, optional): Flag to indicate whether or not this device will be auto-assigned a controller if one is required. If this is true, then a client need not explicitly create the controller that this device will plug into. - backingOption (`vim.vm.device.VirtualDeviceOption.BackingOption`_, optional): + backingOption ([`vim.vm.device.VirtualDeviceOption.BackingOption`_], optional): A list of backing options that can be used to map the virtual device to the host. The list is optional, since some devices exist only within the virtual machine; for example, a VirtualController. defaultBackingOptionIndex (`int`_, optional): Index into the backingOption list, indicating the default backing. - licensingLimit (`str`_, optional): + licensingLimit ([`str`_], optional): List of property names enforced by a licensing restriction of the underlying product. For example, a limit that is not derived based on the product or hardware features; the property name "numCPU". deprecated (`bool`_): diff --git a/docs/vim/vm/device/VirtualDeviceSpec.rst b/docs/vim/vm/device/VirtualDeviceSpec.rst index 3c72f55..bcf8af9 100644 --- a/docs/vim/vm/device/VirtualDeviceSpec.rst +++ b/docs/vim/vm/device/VirtualDeviceSpec.rst @@ -26,6 +26,6 @@ Attributes: device (`vim.vm.device.VirtualDevice`_): Device specification, with all necessary properties set. - profile (`vim.vm.ProfileSpec`_, optional): + profile ([`vim.vm.ProfileSpec`_], optional): Virtual Device Profile requirement. Profiles are solution specifics. Storage Profile Based Management(SPBM) is a vSphere server extension. The API users who want to provision VMs using Storage Profiles, need to interact with SPBM service. This is an optional parameter and if user doesn't specify profile, the default behavior will apply. diff --git a/docs/vim/vm/device/VirtualDisk/PartitionedRawDiskVer2BackingInfo.rst b/docs/vim/vm/device/VirtualDisk/PartitionedRawDiskVer2BackingInfo.rst index c7f94c4..df77d68 100644 --- a/docs/vim/vm/device/VirtualDisk/PartitionedRawDiskVer2BackingInfo.rst +++ b/docs/vim/vm/device/VirtualDisk/PartitionedRawDiskVer2BackingInfo.rst @@ -9,6 +9,6 @@ vim.vm.device.VirtualDisk.PartitionedRawDiskVer2BackingInfo :extends: vim.vm.device.VirtualDisk.RawDiskVer2BackingInfo_ Attributes: - partition (`int`_): + partition ([`int`_]): Array of partition indexes. This array identifies the partitions that are used on the physical disk drive. diff --git a/docs/vim/vm/device/VirtualDiskOption/FlatVer2BackingOption.rst b/docs/vim/vm/device/VirtualDiskOption/FlatVer2BackingOption.rst index 580b501..4bf761a 100644 --- a/docs/vim/vm/device/VirtualDiskOption/FlatVer2BackingOption.rst +++ b/docs/vim/vm/device/VirtualDiskOption/FlatVer2BackingOption.rst @@ -73,6 +73,6 @@ Attributes: * * * - deltaDiskFormatsSupported (`vim.vm.device.VirtualDiskOption.DeltaDiskFormatsSupported`_): + deltaDiskFormatsSupported ([`vim.vm.device.VirtualDiskOption.DeltaDiskFormatsSupported`_]): Delta disk formats supported for each datastore type. diff --git a/docs/vim/vm/device/VirtualDiskOption/SeSparseBackingOption.rst b/docs/vim/vm/device/VirtualDiskOption/SeSparseBackingOption.rst index d0b8a70..983421a 100644 --- a/docs/vim/vm/device/VirtualDiskOption/SeSparseBackingOption.rst +++ b/docs/vim/vm/device/VirtualDiskOption/SeSparseBackingOption.rst @@ -52,6 +52,6 @@ Attributes: uuid (`bool`_): Flag to indicate whether this backing supports disk UUID property. - deltaDiskFormatsSupported (`vim.vm.device.VirtualDiskOption.DeltaDiskFormatsSupported`_): + deltaDiskFormatsSupported ([`vim.vm.device.VirtualDiskOption.DeltaDiskFormatsSupported`_]): Delta disk formats supported for each datastore type. diff --git a/docs/vim/vm/device/VirtualSCSIControllerOption.rst b/docs/vim/vm/device/VirtualSCSIControllerOption.rst index 865b7aa..e9206c2 100644 --- a/docs/vim/vm/device/VirtualSCSIControllerOption.rst +++ b/docs/vim/vm/device/VirtualSCSIControllerOption.rst @@ -26,7 +26,7 @@ Attributes: numSCSIPassthrough (`vim.option.IntOption`_): Three properties (numSCSIPassthrough.min, numSCSIPassthrough.max, and numSCSIPassthrough.defaultValue) define the minimum, maximum, and default number of VirtualSCSIPassthrough instances available have at any given time in the SCSI controller. The number of VirtualSCSIPassthrough instances is also limited by the number of available slots in the SCSI controller. - sharing (`vim.vm.device.VirtualSCSIController.Sharing`_): + sharing ([`vim.vm.device.VirtualSCSIController.Sharing`_]): Supported shared bus modes. defaultSharedIndex (`int`_): diff --git a/docs/vim/vm/device/VirtualUSB.rst b/docs/vim/vm/device/VirtualUSB.rst index 8590c2a..015c6fb 100644 --- a/docs/vim/vm/device/VirtualUSB.rst +++ b/docs/vim/vm/device/VirtualUSB.rst @@ -88,9 +88,9 @@ Attributes: product (`int`_, optional): Product ID of the USB device. - family (`str`_, optional): + family ([`str`_], optional): Device class families. For possible values see `VirtualMachineUsbInfoFamily`_ . - speed (`str`_, optional): + speed ([`str`_], optional): Device speeds detected by server. For possible values see `VirtualMachineUsbInfoSpeed`_ . diff --git a/docs/vim/vm/device/VirtualUSBControllerOption.rst b/docs/vim/vm/device/VirtualUSBControllerOption.rst index 683d073..4cd78b8 100644 --- a/docs/vim/vm/device/VirtualUSBControllerOption.rst +++ b/docs/vim/vm/device/VirtualUSBControllerOption.rst @@ -19,6 +19,6 @@ Attributes: ehciSupported (`vim.option.BoolOption`_): Flag to indicate whether or not enhanced host controller interface (USB 2.0) is available on this virtual USB controller. - supportedSpeeds (`str`_): + supportedSpeeds ([`str`_]): Range of USB device speeds supported by this USB controller type. Acceptable values are specified at `VirtualMachineUsbInfoSpeed`_ . diff --git a/docs/vim/vm/device/VirtualUSBXHCIControllerOption.rst b/docs/vim/vm/device/VirtualUSBXHCIControllerOption.rst index 5ca633d..0821f0d 100644 --- a/docs/vim/vm/device/VirtualUSBXHCIControllerOption.rst +++ b/docs/vim/vm/device/VirtualUSBXHCIControllerOption.rst @@ -19,6 +19,6 @@ Attributes: autoConnectDevices (`vim.option.BoolOption`_): Flag to indicate whether or not the ability to autoconnect devices is enabled for this virtual USB controller. - supportedSpeeds (`str`_): + supportedSpeeds ([`str`_]): Range of USB device speeds supported by this USB controller type. Acceptable values are specified at `VirtualMachineUsbInfoSpeed`_ . diff --git a/docs/vim/vm/guest/FileManager/ListFileInfo.rst b/docs/vim/vm/guest/FileManager/ListFileInfo.rst index 930e301..9906a1d 100644 --- a/docs/vim/vm/guest/FileManager/ListFileInfo.rst +++ b/docs/vim/vm/guest/FileManager/ListFileInfo.rst @@ -16,7 +16,7 @@ vim.vm.guest.FileManager.ListFileInfo :since: `vSphere API 5.0`_ Attributes: - files (`vim.vm.guest.FileManager.FileInfo`_, optional): + files ([`vim.vm.guest.FileManager.FileInfo`_], optional): A list of `GuestFileInfo`_ data objects containing information for all the matching files. remaining (`int`_): diff --git a/docs/vim/vm/guest/ProcessManager.rst b/docs/vim/vm/guest/ProcessManager.rst index aac5b5a..37220bd 100644 --- a/docs/vim/vm/guest/ProcessManager.rst +++ b/docs/vim/vm/guest/ProcessManager.rst @@ -156,7 +156,7 @@ ListProcessesInGuest(vm, auth, pids): Returns: - `vim.vm.guest.ProcessManager.ProcessInfo`_: + [`vim.vm.guest.ProcessManager.ProcessInfo`_]: The list running processes is returned in an array of `GuestProcessInfo`_ structures. Raises: @@ -279,7 +279,7 @@ ReadEnvironmentVariableInGuest(vm, auth, names): Returns: - `str`_: + [`str`_]: A string array containing the value of the variables, or all environment variables if nothing is specified. The format of each string is "name=value". If any specified environment variable isn't set, then nothing is returned for that variable. Raises: diff --git a/docs/vim/vm/guest/ProcessManager/ProgramSpec.rst b/docs/vim/vm/guest/ProcessManager/ProgramSpec.rst index 2393757..1954521 100644 --- a/docs/vim/vm/guest/ProcessManager/ProgramSpec.rst +++ b/docs/vim/vm/guest/ProcessManager/ProgramSpec.rst @@ -25,6 +25,6 @@ Attributes: workingDirectory (`str`_, optional): The absolute path of the working directory for the program to be run. VMware recommends explicitly setting the working directory for the program to be run. If this value is unset or is an empty string, the behavior depends on the guest operating system. For Linux guest operating systems, if this value is unset or is an empty string, the working directory will be the home directory of the user associated with the guest authentication. For other guest operating systems, if this value is unset, the behavior is unspecified. - envVariables (`str`_, optional): + envVariables ([`str`_], optional): An array of environment variables, specified in the guest OS notation (eg PATH=c:\bin;c:\windows\system32 or LD_LIBRARY_PATH=/usr/lib:/lib), to be set for the program being run. Note that these are not additions to the default environment variables; they define the complete set available to the program. If none are specified the values are guest dependent. diff --git a/docs/vim/vsan/host/ClusterStatus.rst b/docs/vim/vsan/host/ClusterStatus.rst index 38d06fd..fff5bda 100644 --- a/docs/vim/vsan/host/ClusterStatus.rst +++ b/docs/vim/vsan/host/ClusterStatus.rst @@ -32,6 +32,6 @@ Attributes: nodeState (`vim.vsan.host.ClusterStatus.State`_): VSAN node state for this host. - memberUuid (`str`_, optional): + memberUuid ([`str`_], optional): List of UUIDs for VSAN nodes known to this host. diff --git a/docs/vim/vsan/host/ConfigInfo/NetworkInfo.rst b/docs/vim/vsan/host/ConfigInfo/NetworkInfo.rst index a72bfdb..3c2ed04 100644 --- a/docs/vim/vsan/host/ConfigInfo/NetworkInfo.rst +++ b/docs/vim/vsan/host/ConfigInfo/NetworkInfo.rst @@ -12,6 +12,6 @@ vim.vsan.host.ConfigInfo.NetworkInfo :since: `vSphere API 5.5`_ Attributes: - port (`vim.vsan.host.ConfigInfo.NetworkInfo.PortConfig`_, optional): + port ([`vim.vsan.host.ConfigInfo.NetworkInfo.PortConfig`_], optional): Set of PortConfig entries for use by the VSAN service, one per "virtual network" as used by VSAN. diff --git a/docs/vim/vsan/host/ConfigInfo/StorageInfo.rst b/docs/vim/vsan/host/ConfigInfo/StorageInfo.rst index d98bd36..f98376a 100644 --- a/docs/vim/vsan/host/ConfigInfo/StorageInfo.rst +++ b/docs/vim/vsan/host/ConfigInfo/StorageInfo.rst @@ -25,6 +25,6 @@ Attributes: autoClaimStorage (`bool`_, optional): Whether the VSAN service is configured to automatically claim local unused storage on this host. When set, the VSAN service will automatically format and use local disks. Side effects from any disk consumption will be reflected in `diskMapping`_ . If this argument is specified as a host-level configuration input at the VC-level (see `vsanHostConfig`_ ), it will override that of any cluster-level default value.See `diskMapping`_ See `vsanHostConfig`_ See `defaultConfig`_ - diskMapping (`vim.vsan.host.DiskMapping`_, optional): + diskMapping ([`vim.vsan.host.DiskMapping`_], optional): List of `VsanHostDiskMapping`_ entries in use by the VSAN service. DiskMappings to be used by the VSAN service may be manually specified using vim.host.VsanSystem#initializeDisks(DiskMapping[]).See vim.host.VsanSystem#initializeDisks(DiskMapping[]) diff --git a/docs/vim/vsan/host/DiskMapResult.rst b/docs/vim/vsan/host/DiskMapResult.rst index 6ca299e..ba55962 100644 --- a/docs/vim/vsan/host/DiskMapResult.rst +++ b/docs/vim/vsan/host/DiskMapResult.rst @@ -27,7 +27,7 @@ Attributes: mapping (`vim.vsan.host.DiskMapping`_): DiskMapping for this result. - diskResult (`vim.vsan.host.DiskResult`_, optional): + diskResult ([`vim.vsan.host.DiskResult`_], optional): List of results for each disk in the mapping. error (`vmodl.LocalizedMethodFault`_, optional): diff --git a/docs/vim/vsan/host/DiskMapping.rst b/docs/vim/vsan/host/DiskMapping.rst index e12afe1..c8801fe 100644 --- a/docs/vim/vsan/host/DiskMapping.rst +++ b/docs/vim/vsan/host/DiskMapping.rst @@ -21,6 +21,6 @@ Attributes: ssd (`vim.host.ScsiDisk`_): SSD ScsiDisk. - nonSsd (`vim.host.ScsiDisk`_): + nonSsd ([`vim.host.ScsiDisk`_]): Set of non-SSD backing ScsiDisk. diff --git a/docs/vim/vsan/host/VsanRuntimeInfo.rst b/docs/vim/vsan/host/VsanRuntimeInfo.rst index cc37bfb..ffdcac8 100644 --- a/docs/vim/vsan/host/VsanRuntimeInfo.rst +++ b/docs/vim/vsan/host/VsanRuntimeInfo.rst @@ -18,10 +18,10 @@ vim.vsan.host.VsanRuntimeInfo :since: `vSphere API 5.5`_ Attributes: - membershipList (`vim.vsan.host.MembershipInfo`_, optional): + membershipList ([`vim.vsan.host.MembershipInfo`_], optional): This property reports host membership information. - diskIssues (`vim.vsan.host.VsanRuntimeInfo.DiskIssue`_, optional): + diskIssues ([`vim.vsan.host.VsanRuntimeInfo.DiskIssue`_], optional): List of disk issues detected on this host.To retrieve more information on the issues, use `QueryDisksForVsan`_ . accessGenNo (`int`_, optional): diff --git a/docs/vmodl/DynamicArray.rst b/docs/vmodl/DynamicArray.rst index 81352ff..2da06f0 100644 --- a/docs/vmodl/DynamicArray.rst +++ b/docs/vmodl/DynamicArray.rst @@ -11,6 +11,6 @@ Attributes: dynamicType (`str`_, optional): Reserved. - val (`object`_): + val ([`object`_]): Array of dynamic values. diff --git a/docs/vmodl/DynamicData.rst b/docs/vmodl/DynamicData.rst index 25ff5b1..17350e0 100644 --- a/docs/vmodl/DynamicData.rst +++ b/docs/vmodl/DynamicData.rst @@ -11,6 +11,6 @@ Attributes: dynamicType (`str`_, optional): Reserved. - dynamicProperty (`vmodl.DynamicProperty`_, optional): + dynamicProperty ([`vmodl.DynamicProperty`_], optional): Set of dynamic properties. This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future. diff --git a/docs/vmodl/LocalizableMessage.rst b/docs/vmodl/LocalizableMessage.rst index 9d242c7..5d655b3 100644 --- a/docs/vmodl/LocalizableMessage.rst +++ b/docs/vmodl/LocalizableMessage.rst @@ -59,7 +59,7 @@ Attributes: key (`str`_): Unique key identifying the message in the localized message catalog. - arg (`vmodl.KeyAnyValue`_, optional): + arg ([`vmodl.KeyAnyValue`_], optional): Substitution arguments for variables in the localized message. message (`str`_, optional): diff --git a/docs/vmodl/query/PropertyCollector.rst b/docs/vmodl/query/PropertyCollector.rst index f147685..1173562 100644 --- a/docs/vmodl/query/PropertyCollector.rst +++ b/docs/vmodl/query/PropertyCollector.rst @@ -78,7 +78,7 @@ vmodl.query.PropertyCollector Attributes ---------- - filter (`vmodl.query.PropertyCollector.Filter`_): + filter ([`vmodl.query.PropertyCollector.Filter`_]): privilege: System.View The filters that this `PropertyCollector`_ uses to determine the list of properties for which it detects incremental changes. @@ -146,7 +146,7 @@ RetrieveProperties(specSet): Returns: - `vmodl.query.PropertyCollector.ObjectContent`_: + [`vmodl.query.PropertyCollector.ObjectContent`_]: The data contents of the specified objects. Raises: diff --git a/docs/vmodl/query/PropertyCollector/FilterSpec.rst b/docs/vmodl/query/PropertyCollector/FilterSpec.rst index e0bd54c..06e9fc2 100644 --- a/docs/vmodl/query/PropertyCollector/FilterSpec.rst +++ b/docs/vmodl/query/PropertyCollector/FilterSpec.rst @@ -25,10 +25,10 @@ vmodl.query.PropertyCollector.FilterSpec :extends: vmodl.DynamicData_ Attributes: - propSet (`vmodl.query.PropertyCollector.PropertySpec`_): + propSet ([`vmodl.query.PropertyCollector.PropertySpec`_]): Set of properties to include in the filter, specified for each object type. - objectSet (`vmodl.query.PropertyCollector.ObjectSpec`_): + objectSet ([`vmodl.query.PropertyCollector.ObjectSpec`_]): Set of specifications that determine the objects to filter. reportMissingObjectsInResults (`bool`_, optional): diff --git a/docs/vmodl/query/PropertyCollector/FilterUpdate.rst b/docs/vmodl/query/PropertyCollector/FilterUpdate.rst index 6eb9393..5ab6d67 100644 --- a/docs/vmodl/query/PropertyCollector/FilterUpdate.rst +++ b/docs/vmodl/query/PropertyCollector/FilterUpdate.rst @@ -26,9 +26,9 @@ Attributes: filter (`vmodl.query.PropertyCollector.Filter`_): Filter that was updated. - objectSet (`vmodl.query.PropertyCollector.ObjectUpdate`_, optional): + objectSet ([`vmodl.query.PropertyCollector.ObjectUpdate`_], optional): Set of changes to object properties in the filter. - missingSet (`vmodl.query.PropertyCollector.MissingObject`_, optional): + missingSet ([`vmodl.query.PropertyCollector.MissingObject`_], optional): Objects that could not be found on the server, but were specified in a `objectSet`_ .This field will only be populated for objects that were determined to be missing since the data version passed to `CheckForUpdates`_ , `WaitForUpdates`_ , or `WaitForUpdatesEx`_ and will not contain objects that were missing prior to that data version. diff --git a/docs/vmodl/query/PropertyCollector/ObjectContent.rst b/docs/vmodl/query/PropertyCollector/ObjectContent.rst index 50ab63c..15c563e 100644 --- a/docs/vmodl/query/PropertyCollector/ObjectContent.rst +++ b/docs/vmodl/query/PropertyCollector/ObjectContent.rst @@ -18,9 +18,9 @@ Attributes: obj (`vmodl.ManagedObject`_): Reference to the managed object that contains properties of interest. - propSet (`vmodl.DynamicProperty`_, optional): + propSet ([`vmodl.DynamicProperty`_], optional): Set of name-value pairs for the properties of the managed object. - missingSet (`vmodl.query.PropertyCollector.MissingProperty`_, optional): + missingSet ([`vmodl.query.PropertyCollector.MissingProperty`_], optional): Properties for which values could not be retrieved and the associated fault. diff --git a/docs/vmodl/query/PropertyCollector/ObjectSpec.rst b/docs/vmodl/query/PropertyCollector/ObjectSpec.rst index adced43..ce5b2d1 100644 --- a/docs/vmodl/query/PropertyCollector/ObjectSpec.rst +++ b/docs/vmodl/query/PropertyCollector/ObjectSpec.rst @@ -29,6 +29,6 @@ Attributes: skip (`bool`_, optional): Flag to specify whether or not to report this managed object's properties. If the flag is true, the filter will not report this managed object's properties. - selectSet (`vmodl.query.PropertyCollector.SelectionSpec`_, optional): + selectSet ([`vmodl.query.PropertyCollector.SelectionSpec`_], optional): Set of selections to specify additional objects to filter. diff --git a/docs/vmodl/query/PropertyCollector/ObjectUpdate.rst b/docs/vmodl/query/PropertyCollector/ObjectUpdate.rst index 7357be8..ff9c74c 100644 --- a/docs/vmodl/query/PropertyCollector/ObjectUpdate.rst +++ b/docs/vmodl/query/PropertyCollector/ObjectUpdate.rst @@ -23,9 +23,9 @@ Attributes: obj (`vmodl.ManagedObject`_): Reference to the managed object to which this update applies. - changeSet (`vmodl.query.PropertyCollector.Change`_, optional): + changeSet ([`vmodl.query.PropertyCollector.Change`_], optional): Optional set of changes to the object. Present only if the "kind" is either "modify" or "enter". - missingSet (`vmodl.query.PropertyCollector.MissingProperty`_, optional): + missingSet ([`vmodl.query.PropertyCollector.MissingProperty`_], optional): Properties whose value could not be retrieved and their associated faults. Present only if the "kind" is either "modify" or "enter". diff --git a/docs/vmodl/query/PropertyCollector/PropertySpec.rst b/docs/vmodl/query/PropertyCollector/PropertySpec.rst index f92ddc3..fa4ef57 100644 --- a/docs/vmodl/query/PropertyCollector/PropertySpec.rst +++ b/docs/vmodl/query/PropertyCollector/PropertySpec.rst @@ -27,6 +27,6 @@ Attributes: all (`bool`_, optional): Specifies whether or not all properties of the object are read. If this property is set to true, the `pathSet`_ property is ignored. - pathSet (`str`_, optional): + pathSet ([`str`_], optional): Specifies which managed object properties are retrieved. If the `pathSet`_ is empty, then the `PropertyCollector`_ retrieves references to the managed objects and no managed object properties are collected. diff --git a/docs/vmodl/query/PropertyCollector/RetrieveResult.rst b/docs/vmodl/query/PropertyCollector/RetrieveResult.rst index e384b50..fc34666 100644 --- a/docs/vmodl/query/PropertyCollector/RetrieveResult.rst +++ b/docs/vmodl/query/PropertyCollector/RetrieveResult.rst @@ -25,6 +25,6 @@ Attributes: token (`str`_, optional): A token used to retrieve further retrieve results.If set, the token should be passed to `ContinueRetrievePropertiesEx`_ to retrieve more results. Each token may be passed to continueRetrievePropertiesEx only once, and only in the same session in which it was returned and to the same `PropertyCollector`_ object that returned it.If unset, there are no further results to retrieve after this `RetrieveResult`_ . - objects (`vmodl.query.PropertyCollector.ObjectContent`_): + objects ([`vmodl.query.PropertyCollector.ObjectContent`_]): retrieved objects. diff --git a/docs/vmodl/query/PropertyCollector/TraversalSpec.rst b/docs/vmodl/query/PropertyCollector/TraversalSpec.rst index 7c081de..28afe52 100644 --- a/docs/vmodl/query/PropertyCollector/TraversalSpec.rst +++ b/docs/vmodl/query/PropertyCollector/TraversalSpec.rst @@ -22,6 +22,6 @@ Attributes: skip (`bool`_, optional): Flag to indicate whether or not to filter the object in the "path" field. - selectSet (`vmodl.query.PropertyCollector.SelectionSpec`_, optional): + selectSet ([`vmodl.query.PropertyCollector.SelectionSpec`_], optional): Optional set of selections to specify additional objects to filter. diff --git a/docs/vmodl/query/PropertyCollector/UpdateSet.rst b/docs/vmodl/query/PropertyCollector/UpdateSet.rst index 51707a9..c2f1d0f 100644 --- a/docs/vmodl/query/PropertyCollector/UpdateSet.rst +++ b/docs/vmodl/query/PropertyCollector/UpdateSet.rst @@ -34,7 +34,7 @@ Attributes: version (`str`_): New data version to pass in the next call to `CheckForUpdates`_ , `WaitForUpdates`_ , or `WaitForUpdatesEx`_ . These versions, although they are opaque, are strongly ordered in the sense that passing a version to `WaitForUpdates`_ , `CheckForUpdates`_ or `WaitForUpdatesEx`_ requests updates that reflect changes in the objects selected by the Filter that happened after the specified version. - filterSet (`vmodl.query.PropertyCollector.FilterUpdate`_, optional): + filterSet ([`vmodl.query.PropertyCollector.FilterUpdate`_], optional): Set of managed object updates detected by specific filters. Updates are reported in sets. Each set is associated with a reference to a filter that detected the updates in the set. truncated (`bool`_, optional):