EMC ViPR REST API

Search (SHIFT+S)

API Reference


Update Object Virtual Pool

PUT /object/vpools/{id}

Update Object VirtualPool only allows if there are no resources associated and list of attributes changed not changed. List of attributes can updated if it satisfies above constraint: assignedStoragePools & useMatchedStoragePools flag.

id

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<object_vpool_update>
<max_retention> The maximum retention settings for the virtual pool. Integer
<min_datacenters> The minimum number of data centers required for each CoprHD storage pool Integer
<varray_changes>    
<add>    
<varray> String 0-* Elements
</add>      
<remove>    
<varray> String 0-* Elements
</remove>      
</varray_changes>      
<name> The new virtual pool name. String Valid Values:
  •  Length: 2..128
<description> The new virtual pool description. String
<protocol_changes>    
<add>    
<protocol> The set of protocols. Valid values: FC = Fibre Channel (block) ISCSI = Internet Small Computer System Interface (block) FCoE = Fibre Channel over Ethernet (block) NFS = Network File System (file) NFSV4 = Network File System Version 4 (file) CIFS = Common Internet File System (file) String 0-* Elements
</add>      
<remove>    
<protocol> The set of protocols. Valid values: FC = Fibre Channel (block) ISCSI = Internet Small Computer System Interface (block) FCoE = Fibre Channel over Ethernet (block) NFS = Network File System (file) NFSV4 = Network File System Version 4 (file) CIFS = Common Internet File System (file) String 0-* Elements
</remove>      
</protocol_changes>      
<use_matched_pools> Determines if matched or valid assigned pools are returned from command to retrieve the list of storage pools. Boolean
<system_type> The new supported system type for the virtual pool. Valid values: NONE vnxblock (Block) vmax (Block) vnxfile (File) isilon (File) netapp (File) String
<provisioning_type> The new provisioning type for the virtual pool, Valid values: NONCE Thin Thick String
</object_vpool_update>

Response Body

VirtualPool details

Field Description Type Notes
<object_vpool>
<max_retention> Integer
<min_datacenters> The minimum number of data centers required for each CoprHD storage pool Integer
<type> Virtual pool storage resource type. Valid values: block = Volume file = File System object = Object Store String
<description> User defined description for this virtual pool. String
<provisioning_type> Storage type provisioned for this virtual pool. String
<protocols>
<protocol> String 0-* Elements
</protocols>
<system_type> The supported system type for the virtual pool. Valid values: NONE vnxblock (Block) vmax (Block) vnxfile (File) isilon (File) netapp (File) String
<num_paths> Integer
<num_resources> Number of resources provisioned to this ViPR using this virtual pool. Integer
<varrays>
<varray>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
</varrays>
<use_matched_pools> Determines if matched or valid assigned pools are returned from command to retrieve the list of storage pools. Boolean
<assigned_storage_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</assigned_storage_pools>
<invalid_matched_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</invalid_matched_pools>
<matched_storage_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</matched_storage_pools>
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</object_vpool>