Managed Object - DirectPathProfileManager(vim.DirectPathProfileManager)

Property of: ServiceContent
See also: DirectPathProfileInfo, DirectPathProfileManagerCapacityQuerySpec, DirectPathProfileManagerCapacityResult, DirectPathProfileManagerCreateSpec, DirectPathProfileManagerFilterSpec, DirectPathProfileManagerTargetEntity, DirectPathProfileManagerUpdateSpec
Since: vSphere API Release 9.0.0.0

Managed Object Description

This interface is responsible for managing DirectPath profiles in vCenter.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
DirectPathProfileManagerCreate, DirectPathProfileManagerDelete, DirectPathProfileManagerList, DirectPathProfileManagerQueryCapacity, DirectPathProfileManagerUpdate

DirectPathProfileManagerCreate(createDirectPathProfile)

Create a DirectPath profile from the specified CreateSpec.

Required Privileges: DirectPathProfileManager.Manage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DirectPathProfileManager used to make the method call.
spec	DirectPathProfileManagerCreateSpec	*Since* vSphere API Release 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the DirectPathProfileManager used to make the method call.

spec

DirectPathProfileManagerCreateSpec

Since vSphere API Release 9.0.0.0

Return Value

Type	Description
xsd:string	Unique identifier of the DirectPath profile created.

Faults

Type	Description
AlreadyExists	Thrown if a DirectPath profile with the attributes in the createSpec already exists in the target vCenter. There cannot be two DirectPath profiles with the same name or the same device details.
InvalidArgument	Thrown if the spec argument does not meet the constraints specified in CreateSpec.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerCreate" type="vslm:DirectPathProfileManagerCreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerCreateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </sequence>
                  </complexType>
               </element>

DirectPathProfileManagerDelete(deleteDirectPathProfile)

Delete a DirectPath profile.

Required Privileges: DirectPathProfileManager.Manage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DirectPathProfileManager used to make the method call.
id	xsd:string	Unique identifier of the DirectPath profile to be deleted. *Since* vSphere API Release 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the DirectPathProfileManager used to make the method call.

xsd:string

Unique identifier of the DirectPath profile to be deleted.

Since vSphere API Release 9.0.0.0

Return Value

Type	Description
None

Faults

Type	Description
NotFound	Thrown if there is no DirectPath profile found with the specified identifier.
ResourceInUse	Thrown if the DirectPath profile with the specified identifier is being used by a VM or associated with a VM resource profile.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerDelete" type="vslm:DirectPathProfileManagerDeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerDeleteResponse">
                  <complexType/>
               </element>

DirectPathProfileManagerList(listDirectPathProfiles)

List DirectPath profiles in this vCenter that match the specified filtering criteria.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DirectPathProfileManager used to make the method call.
filterSpec	DirectPathProfileManagerFilterSpec	*Since* vSphere API Release 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the DirectPathProfileManager used to make the method call.

filterSpec

DirectPathProfileManagerFilterSpec

Since vSphere API Release 9.0.0.0

Return Value

Type	Description
DirectPathProfileInfo[]	Information about DirectPath profiles matching the attributes specified in the input FilterSpec. If an empty filterSpec is specified, then all the DirectPath profiles in the target vCenter are returned. If none of the DirectPath profiles match the attributes specified in the filterSpec, then an empty list is returned.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerList" type="vslm:DirectPathProfileManagerListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerListResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:DirectPathProfileInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

DirectPathProfileManagerQueryCapacity(queryDirectPathProfileCapacity)

Query capacity of DirectPath profiles against a compute resource.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DirectPathProfileManager used to make the method call.
target	DirectPathProfileManagerTargetEntity	specifies the compute resource for which the capacity needs to be computed. See TargetEntity. A null or an invalid target will cause an exception. *Since* vSphere API Release 9.0.0.0
querySpec*	DirectPathProfileManagerCapacityQuerySpec[]	specifies a list of CapacityQuerySpec, where each of them specifies the information about the DirectPath profile for which capacity needs to be computed. *Since* vSphere API Release 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the DirectPathProfileManager used to make the method call.

target

DirectPathProfileManagerTargetEntity

specifies the compute resource for which the capacity needs to be computed. See TargetEntity. A null or an invalid target will cause an exception.

Since vSphere API Release 9.0.0.0

querySpec*

DirectPathProfileManagerCapacityQuerySpec[]

specifies a list of CapacityQuerySpec, where each of them specifies the information about the DirectPath profile for which capacity needs to be computed.

Since vSphere API Release 9.0.0.0

*Need not be set

Return Value

Type	Description
DirectPathProfileManagerCapacityResult[]	List of CapacityResult when target is valid. The content of the list is subjected to the following conditions: - Content of the return list will be in the same order as content of the list in querySpec argument, except when querySpec is a null or empty list. - If the query specification is of type CapacityQueryById, then the capacity of a DirectPath profile with the matching ID is returned. - If the query specification is of type CapacityQueryByName, then the capacity of a DirectPath profile with the matching name is returned. - If the query specification is of type CapacityQueryByDeviceConfig, then the capacity of a device with the specified configuration in the specified Target will be returned. - When querySpec is null or an empty list, the returned list contains CapacityInfo of all the DirectPath profiles available in the specified target.

Type

Description

DirectPathProfileManagerCapacityResult[]

List of CapacityResult when target is valid. The content of the list is subjected to the following conditions: - Content of the return list will be in the same order as content of the list in querySpec argument, except when querySpec is a null or empty list. - If the query specification is of type CapacityQueryById, then the capacity of a DirectPath profile with the matching ID is returned. - If the query specification is of type CapacityQueryByName, then the capacity of a DirectPath profile with the matching name is returned. - If the query specification is of type CapacityQueryByDeviceConfig, then the capacity of a device with the specified configuration in the specified Target will be returned. - When querySpec is null or an empty list, the returned list contains CapacityInfo of all the DirectPath profiles available in the specified target.

Faults

Type	Description
InvalidArgument	when target is null or contains invalid content such as invalid host or cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerQueryCapacity" type="vslm:DirectPathProfileManagerQueryCapacityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerQueryCapacityResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:DirectPathProfileManagerCapacityResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

DirectPathProfileManagerUpdate(updateDirectPathProfile)

Update a DirectPath profile based on the specified UpdateSpec.

Required Privileges: DirectPathProfileManager.Manage

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DirectPathProfileManager used to make the method call.
id	xsd:string	Unique identifier of the DirectPath profile being updated. *Since* vSphere API Release 9.0.0.0
spec	DirectPathProfileManagerUpdateSpec	Specification for the DirectPath device being updated. *Since* vSphere API Release 9.0.0.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the DirectPathProfileManager used to make the method call.

xsd:string

Unique identifier of the DirectPath profile being updated.

Since vSphere API Release 9.0.0.0

spec

DirectPathProfileManagerUpdateSpec

Specification for the DirectPath device being updated.

Since vSphere API Release 9.0.0.0

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists	Thrown if the desired name specified in the spec is already assigned to a different DirectPath profile.
InvalidArgument	Thrown if the spec argument does not meet the constraints specified in UpdateSpec.
NotFound	Thrown if there is no DirectPath profile found with the specified identifier.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerUpdate" type="vslm:DirectPathProfileManagerUpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="DirectPathProfileManagerUpdateResponse">
                  <complexType/>
               </element>

Virtual Storage Lifecycle Management API

Managed Object - DirectPathProfileManager(vim.DirectPathProfileManager)

Managed Object Description

DirectPathProfileManagerCreate(createDirectPathProfile)

DirectPathProfileManagerDelete(deleteDirectPathProfile)

DirectPathProfileManagerList(listDirectPathProfiles)

DirectPathProfileManagerQueryCapacity(queryDirectPathProfileCapacity)

DirectPathProfileManagerUpdate(updateDirectPathProfile)