Package com.vmware.fcd

Class FcdRetrieveOperations

  • @Sample(name="fcd-retrieveoperations",
        description="This sample retrieves a virtual storage object,  retrieves virtual storage object state and lists all virtual storage object from vslm.")
public class FcdRetrieveOperations
extends com.vmware.connection.ConnectedVimServiceBase
     FcdRetrieveOperations

 This sample executes below retrieve related operations on
 a snapshot of a given VStorageObject from vslm.:

 1. Retrieve virtual storage object.
 2. Retrieve multiple virtual storage objects.
 3. Retrieve a virtual storage object state.
 4. List all virtual storage objects or by matching queries.

 Pre-requisite :        1. Existing VStorageObject ID

 Parameters:
 url                    [required] : url of the web service
 username               [required] : username for the authentication
 password               [required] : password for the authentication
 vstorageobjectid       [required] : Uuid of the vstorageobject
 maxresult              [required] : Maximum number of virtual storage object IDs to return.
 queryfield             [required] : The searchable field.
 queryoperator          [required] : The operator to compare with the searchable field.
 queryvalue             [required] : The value to compare with the searchable field.

 Command Line:
 run.bat com.vmware.fcd.FcdRetrieveOperations --url [webserviceurl]
 --username [username] --password [password]
 --vstorageobjectid [vstorageobjectid] --maxresult [maxresult]
 --queryfield [queryfield] --queryvalue [queryvalue] --queryoperator [queryoperator]

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.vmware.connection.ConnectedVimServiceBase

        com.vmware.connection.ConnectedVimServiceBase.ConnectionException

    • Field Summary

      • Fields inherited from class com.vmware.connection.ConnectedVimServiceBase

        PROP_ME_NAME, SVC_INST_NAME

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void run()  
      void setMaxResult​(java.lang.String maxResult)  
      void setQueryField​(java.lang.String queryField)  
      void setQueryOperator​(java.lang.String queryOperator)  
      void setQueryValue​(java.lang.String queryValue)  
      void setVStorageObjectId​(java.lang.String vStorageObjectId)  

      • Methods inherited from class com.vmware.connection.ConnectedVimServiceBase

        basicConnectionFromConnection, connect, disconnect, getServiceInstanceReference, setConnection, setHostConnection

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FcdRetrieveOperations

        public FcdRetrieveOperations()

    • Method Detail

      • setVStorageObjectId

        @Option(name="vstorageobjectid",
        required=true,
        description="Uuid of the vstorageobject.")
public void setVStorageObjectId​(java.lang.String vStorageObjectId)
        Parameters:
        vStorageObjectId - the vStorageObjectId to set

      • setMaxResult

        @Option(name="maxresult",
        required=true,
        description="Maximum number of virtual storage object IDs to return.")
public void setMaxResult​(java.lang.String maxResult)
        Parameters:
        maxResult - Maximum number of virtual storage object IDs to return.

      • setQueryField

        @Option(name="queryfield",
        required=true,
        description="This indicates the searchable field.")
public void setQueryField​(java.lang.String queryField)
        Parameters:
        queryField - This indicates the searchable field

      • setQueryOperator

        @Option(name="queryoperator",
        required=true,
        description="This field specifies the operator to compare the searchable field.")
public void setQueryOperator​(java.lang.String queryOperator)
        Parameters:
        queryOperator - the operator to compare the searchable field

      • setQueryValue

        @Option(name="queryvalue",
        required=true,
        description="This field specifies the operator to compare the searchable field.")
public void setQueryValue​(java.lang.String queryValue)
        Parameters:
        queryValue - This field specifies the value to be compared with the searchable field

      • run

        @Action
public void run()
         throws java.lang.Exception
        Throws:
        java.lang.Exception