Retrieve Vmfs Datastore Storage Controller operation


The Retrieve Vmfs Datastore Storage Controller operation enables you to retrieve the volume information for the specified Vmfs datastore and corresponding SCSI Transport information about the target.

The following table describes the elements for this request.

Adapter request elements for the Retrieve Vmfs Datastore Storage Controller operation

Element

Definition

Required

<operation-type>

Defines the type of operation: Datastore

Yes

<operation-name>

Defines the name of operation: Retrieve_Vmfs_Datastore_Storage_Controller

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Warning

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

No

<transport>

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Warning

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

<parameters>

Contains the <virtual-machine> element required to execute the operation

Yes

<datastore>

Specifies the name of the datastore for which you want to discover the volume information and corresponding SCSI transport information

Valid value: String

Yes

The following code sample shows a sample adapter request for the Retrieve Vmfs Datastore Storage Controller operation.

Sample adapter request for the Retrieve Vmfs Datastore Storage Controller operation

<vmware-infrastructure-request>
   <operation-type>Datastore</operation-type>
   <operation-name>Retrieve_Vmfs_Datastore_Storage_Controller</operation-name>
   <soap-url></soap-url>
   <transport></transport>
   <user-name></user-name>
   <password></password>
   <parameters>
<datastore>TestVmfs</datastore>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Retrieve Vmfs Datastore Storage Controller operation.

Sample adapter response for the Retrieve Vmfs Datastore Storage Controller operation

<vmware-infrastructure-response>
 <metadata>
<status>success</status>
 </metadata>
 <RetrieveVmfsDatastoreStorageControllerResponse>
       <returnval>
         <Datastore>datastore-8011</Datastore>
         <propSet>
           <name>info</name>
           <VmfsDatastoreInfo>
             <name>TestVmfs </name>
             <url>sanfs://vmfs_uuid:4c5aaf43-d2673665-681c-0019b9e1c5fe/</url>
             <freeSpace>241172480</freeSpace>
             <maxFileSize>274877906944</maxFileSize>
             <vmfs>
               <type>VMFS</type>
               <name>TestVmfs</name>
               <capacity>268435456</capacity>
               <blockSizeMb>1</blockSizeMb>
               <maxBlocks>262144</maxBlocks>
               <majorVersion>3</majorVersion>
               <version>3.31</version>
               <uuid>4c5aaf43-d2673665-681c-0019b9e1c5fe</uuid>
               <extent>
                 <diskName>vmhba32:2:1</diskName>
                 <partition>1</partition>
                 <HostInternetScsiTargetTransport>
                   <iScsiName>iq1.1992-08.com.netapp:sn.99932695</iScsiName>
                   <iScsiAlias></iScsiAlias>
                   <address>10.128.249.37:3260</address>
                 </HostInternetScsiTargetTransport>
               </extent>
               <vmfsUpgradable>false</vmfsUpgradable>
             </vmfs>
           </VmfsDatastoreInfo>
         </propSet>
       </returnval>
     </RetrieveVmfsDatastoreStorageControllerResponse>
</vmware-infrastructure-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 20.19.02