/
Datastore 5x

Datastore 5x

Activities


Create Datastore

This activity creates a new datastore.

Activity Parameters

The Create Datastore activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datastore Name (text box editor type) (type: string): the name of the new created Datastore.
  • Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored. E.g "host-20".
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from Create Datastore activity:   

                                  

  • Host IP (text box editor type) (type: string): the Host IP.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: string): outputs the new datastore ID.
 

Execution: The example below is an execution where a new datastore will be created on the specified host:



 

Get All Paths for Datastore

This activity gets and returns all the paths for the desired datastore.

Activity Parameters

The Get All Paths for Datastore activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datacenter Name (text box editor type) (type: string): the name of the datacenter on which the host can be found.
  • Datastore Name (text box editor type) (type: string): the name of the datastore for which you want the paths.
  • Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from Get All Paths For Datastore activity:
        
  • Host IP (text box editor type) (type: string): the Host IP.


The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: collection<collection<string>>): outputs all the multipath paths for the desired datastore.
 

In order to extract the values from the OutputMultipaths collection, For Each and Get Element From Collection activities should be used:



Execution: The example below is an execution where all multipaths are returned for DemoDatastore datastore:

 

 

Get Datastore

This activity returns the specified Datastore ID.

Activity Parameters

The Get Datastore activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datacenter Name (text box editor type) (type: string): the name of the Datacenter.
  • Datastore Name (text box editor type) (type: string): the name of the Datastore.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: string): outputs the resulting data store ID. If the data store is not found, value is empty.
 

Execution: The example below is an execution where datastore ID for DemoDatastore is returned:

 


 

Get Datastore Capacity

This activity retrieves the capacity available on a specific data store.

Activity Parameters

The Get Datastore Capacity activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datastore ID (text box editor type) (type: string): the ID of the data store for which to retrieve the capacity.
    The value can also be obtained from activity: Get Datastore using the following steps:
    • use a Get Datastore activity to extract the DatastoreID:
       
    • bind the obtained DatastoreID (stored in variable) to the Datastore ID field from Get Datastore Capacity activity:
       

The Read Only Output variable are the possible output values that the activity will provide:

  • Output Capacity  (type: single): outputs the total capacity of the data store.
  • Output Free Space  (type: single): outputs the total amount of available space.
  • Output Percent Free  (type: single): outputs the amount of available space as a percentage of the available capacity.
 


Execution: The example below is an execution where info about DemoDatastore's capacity and availability is returned:



 

Get Path Policy for Datastore

This activity gets and returns the path policy for the desired datastore.

Activity Parameters

The Get Path Policy for Datastore activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datacenter Name (text box editor type) (type: string): the name of the datacenter on which the host can be found.
  • Datastore Name (text box editor type) (type: string): the name of the datastore for which you want the path policy.
  • Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from Get Path Policy For Datastore activity:
  • Host IP (text box editor type) (type: string): the Host IP.

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: string): outputs the desired multipath policy.


Execution: The example below is an execution where the multipath policy for DemoDatastore is returned:

 


 

List Datastores

This activity lists all the Datastores from a specified object (host, cluster, datacenter , virtual machine).

Activity Parameters

The List Datastores activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datacenter Name (text box editor type) (type: string): the name of the datacenter.
  • Cluster ID (text box editor type) (type: string): the cluster from which the datastores to be retrieved.
    The value can also be obtained from activities: Create Cluster or Get Cluster using the following steps:
    • use a Get Cluster/ Create Cluster activity to extract the ClusterID 
    • bind the obtained ClusterID (stored in variable) to the Cluster ID field from List Datastores activity:   

              

  • Host ID (text box editor type) (type: string): the host from which the datastores to be retrieved.
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:
    • bind the obtained HostID (stored in variable) to the HostID field from List Datastores activity:
  • VirtualMachine ID (text box editor type) (type: string): the virtual machine from which the datastores to be retrieved. 
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from List Datastores activity:

The Read Only Output variable are the possible output values that the activity will provide:

  • Output  (type: collection<string>): outputs a collection of existing Datastore names.


In order to extract the values from the DatastoreNames output collection , For Each and Log Track Data activities should be used:


 Execution: The example below is an execution where all datastore names are listed for host with ID host-21:

 

Remove Datastore

This activity removes a datastore from a host.

Activity Parameters

The Remove Datastore activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

  • Datastore ID (text box editor type) (type: string): the ID of the datastore. E.g "datastore-20".
    The value can also be obtained from activity: Get Datastore using the following steps:
    • use a Get Datastore activity to extract the DatastoreID:
       
    • bind the obtained DatastoreID (stored in variable) to the Datastore ID field from Remove Datastore activity:
        
  • Host ID (text box editor type) (type: string): the ID of the host. E.g."host-20".
    The value can also be obtained from activity: Get Host using the following steps:
    • use a Get Host activity to extract the HostID:  
    • bind the obtained HostID (stored in variable) to the Host ID field from Remove Datastore activity:  
       

The Read Only Output variable are the possible output values that the activity will provide:

  • Output Status  (type: boolean): outputs the status of the deletion operation.