EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Compute Virtual Pool

GET /compute/vpools/{id}

Get compute virtual pool by ID

idthe URN of a Compute Virtual Pool

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

ComputeVirtualPoolRestRep representation of Compute Virtual Pool

Field Description Type Notes
<compute_vpool>
<description> User defined description for this virtual pool. String
<system_type> The supported system type for the virtual pool. Valid values: Cisco_UCSM Cisco_CSeries Generic String
<matched_compute_elements>
<compute_element>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</compute_element>      
</matched_compute_elements>
<available_matched_compute_elements>
<compute_element>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</compute_element>      
</available_matched_compute_elements>
<min_processors> Minimum Number of processors supported by this virtual pool. Integer
<max_processors> Maximum Number of processors supported by this virtual pool. Integer
<min_total_cores> Minimum Number of cores supported by this virtual pool. Integer
<max_total_cores> Maximum Number of cores supported by this virtual pool. Integer
<min_total_threads> Minimum Number of threads supported by this virtual pool. Integer
<max_total_threads> Maximum Number of threads supported by this virtual pool. Integer
<min_cpu_speed> Minimum CPU speed supported by this virtual pool. Integer
<max_cpu_speed> Maximum CPU speed supported by this virtual pool. Integer
<min_memory> Minimum memory supported by this virtual pool. Integer
<max_memory> Maximum memory supported by this virtual pool. Integer
<min_nics> Minimum number of NICs supported by this virtual pool. Integer
<max_nics> Maximum number of NICs supported by this virtual pool. Integer
<min_hbas> Minimum number of HBAs supported by this virtual pool. Integer
<max_hbas> Maximum number of HBAs supported by 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_elements> Determines if matched or valid assigned compute elements are returned from command to retrieve the list of compute elements. Boolean
<service_profile_templates> The service profile templates assigned to this virtual pool.
<service_profile_template>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</service_profile_template>      
</service_profile_templates>
<in_use> Is the compute virtual pool in use Boolean
<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
</compute_vpool>