Routing Requests—Available Capacity Query
Routing Requests—Available Capacity Query
#340120
The Routing Request Available Capacity Query accepts UNROUTED or REJECTED Workloads, or REJECTED Routing Requests.
Available capacity is determined using a conservative approach, reserving capacity for Workloads specified in Routing Requests that are not yet placed for all future timeframes and continuing to reserve capacity for outbound Bookings that are still online. Also, the available capacity query returns capacity for new planned hosts and sensors, including those sensors that are shared among open and closed hosting venues. Infinite capacity is calculated for non-control and guest-level environments and hosting venues.
For Fit-for-Purpose, the query returns the Fit-for-Purpose results for the hosting venues and datastores. This includes fit according to software requirements, fit for business rules, fit for storage tiers, etc. A Routing Request cannot be routed to a hosting venue that is not fit, i.e. does not pass the Fit-for-Purpose rules, does not have enough capacity, and does not Allow New VM Bookings.
Note: The results of this query INCLUDE sensors that do not Allow New VM Bookings.
The query can be posted by defining a scope of environments and/or hosting venues to consider. In this way, you can narrow your query as needed.
Hosting Venues
This API supports a mix of full control hosting venues (i.e. infrastructure groups), non-control hosting venues and guest-level hosting venues.
With respect to this API, the difference between these venues is as follows:
- Supported Operations—all operations are supported for all three hosting venues except:
- for non-control and guest-level hosting venues, options ?detailed_sensor_calc=true and ?detailed_host_calc=true do not apply
- Resource Elements—only elements that are applicable to the hosting venue is returned in the response. Also, some elements may have special values as non-control and guest-level hosting venues have infinite capacity. Specifically:
- for non-control and guest-level hosting venues and their environments, element cei, constraint and constraint_name are not returned
- for non-control and guest-level hosting venues and environments, empty array elements "subslots": [], "sensor_capacity": [], "host_capacity": [] are returned
- for non-control and guest-level hosting venues of infinite capacity, slots is set to MAXINT (with a "hosting_score": 100) if the hosting venue passes the Fit-for-Purpose requirements and is 0 otherwise (with a "hosting_score": 0)
- for environments of non-control and guest-level hosting venues, total_slots is set to MAXINT if at least one of its hosting venues has slots set to MAXINT and is 0 otherwise
- for non-control and guest-level hosting venues, the capacity/cost mode does not apply. The mode is always assumed capacity_sensitive and element "hosting_cost": 0 is returned.
You can extend the query with one or all of the following:
- ?subslots=true (default is false)—to return the slot workload metrics which can be used to determine the primary constraint for the available capacity. When set to true, the query returns the elements of the subslots array for each hosting venue (even if the Infrastructure Group is closed/blocked), subslots and tiers array for each sensor type (where applicable), and subslots array for each host.
- ?detailed_sensor_calc=true (default is false)—to return sensor metrics using a highly detailed computation of sensor capacity that also consolidates duplicate sensors across Control Environments. The recommendation is to use this flag when trying to determine available capacity at the environment level. If you are only considering available capacity at a hosting venue level, then the recommendation is not to use this flag. When ?detailed_sensor_calc=true is not used, the query aggregates all sensor metrics before determining slot counts, instead of aggregating slot counts based on individual sensor metrics.
- ?ffp_enabled=false (default is true)—to return available capacity without Fit-for-Purpose calculations. With this option, all Fit-for-Purpose tests pass. The "categories": [] is returned empty and the resulting pass status "status": "PASS" is returned. The hosting_score (described below) is calculated assuming the Fit-for-Purpose tests all pass. This option is used when the Route and Reserve Demand page is first displayed and can be used when generating slot reports.
- ?negative_slots=true (default is false)—to perform capacity calculations and then either return actual slot counts even if negative (when true) or show negative slot counts as 0. This affects element slots for the number of Workloads and Sensors that can fit in this hosting venue, element subslots value for specific slot and sensor metrics, and element total_slots for the total sum of slots elements for the hosting venues within the environment. All constraints and sums are calculated first before any values are updated when ?negative_slots=false. For example, if IG1=10 and IG2=-5, then IG1=10, IG2=-5 and Env=5 are returned with ?negative_slots=true, and IG1=10, IG2=0 and Env=5 are returned with ?negative_slots=false. The constraint is the same, independent of this ?negative_slots option.
- ?detailed_host_calc=true (default is false)—to return the slot count, primary constraint and subslot metrics on a per host basis for today. When set to true and if the expected_date is today, the query returns the element host_capacity.
Capacity Based on Expected Date
This POST returns the following capacity information based on the expected_date (or today if no expected_date is specified). For each hosting venue that matches the request, the number of available slots (i.e. the number of Workloads that can fit including sensor capacity), CEI, subslot metrics, Fit-for-Purpose tests and hosting_score are returned. The hosting_score is a standard metric with a range 0..100 to determine the best routing choice. For each Control Environment that matches the request, total_slots, CEI and subslot metrics are returned. The total_slots and subslot metrics of each environment is equal to the total of all slots and subslot metrics from the returned list of matching hosting venues, only if sensors are not shared across hosting venues or other environments.
Capacity/Cost Mode Option and Hosting Score
The available capacity query calculates the hosting_score as an integer from 0..100 where 0 means no placement and 100 provides the best placement out of the specified scope. There are three modes that are supported, which affect this score. You can either take the default mode as defined by the configuration setting API Default Routing Strategy (see Configuration Settings) or you can specify the mode as part of the query:
- ?mode=capacity_sensitive—Calculates the hosting_score according to the available capacity of the hosting venues. The more capacity available, the higher the score.
- ?mode=cost_sensitive—Calculates the hosting_score according to the cost while ensuring there is enough capacity. The higher the cost, the lower the score. If the hosting_cost is 0, then the hosting_score=0.
- ?mode=cost_and_capacity—Calculates the hosting_score as the average of the capacity_sensitive and cost_sensitive. This is the default.
Note: If an Infrastructure Group has an availability_status=UNAVAILABLE or BLOCKED_BY_USER, has no available slots (i.e. slots<=0 or sensor_capacity slots<=0), or fails the Fit-for-Purpose tests, then the returned hosting_score is 0 for that Infrastructure Group. Workloads cannot be routed to such Infrastructure Groups, unless the placement is forced.
Available Slots
The number of available slots is the number of Workloads (taking into account sensor capacity requirements) that can fit within a hosting venue. The size of each slot is defined by the aggregate of the Workloads specified in the Routing Request. For example, if there are 2 available slots, then that means two Routing Requests with the same Workload requirements can fit.
The available slots is defined in element slots and can take on any of the following values (rounded down to the nearest integer):
- MAXINT—applies only to a non-control or guest-level hosting venue, if it passes the Fit-for-Purpose requirements
- positive integer—number of such Workloads that can still fit in the hosting venue. Capacity is still available and is limited by the policy high limits.
- 0—no available capacity, or the Infrastructure Group has an availability_status of "UNAVAILABLE". 0 is also returned if the hosting venue does not pass the Fit-for-Purpose validation or if the expected_date is past the timeline for that hosting venue. If there is no capacity, option ?negative_slots=false always updates the slot count to 0.
- negative integer—number of such Workloads that have been over-provisioned to the hosting venue. This number of Workloads should be moved to another hosting venue. There is no capacity left, as defined by the policy high limits.
Notes
If there is no data for the timeframe as specified by the requested_date of the Routing Request, the CEI for today and the slot capacity of 0 are returned.
See Querying Available Capacity for Specified Workloads for more information on slots.
This query supports inline Workloads having only single disk requirements with no storage tier specified and with no attributes specified.
Resource
/routing-requests/available-capacity-query
Supported Operations
Table: Routing Requests–Available Capacity Query Supported Operations
|
Operation |
HTTP Method |
Input |
Output |
Description |
|
Query |
POST /routing-requests/available-capacity-query |
[Routing Requests–Available Capacity Query: Resource Elements] |
This request is exactly the same as the POST to a Routing Request, except no objects are created with this query (i.e. Routing Request and specified Workloads). Note that when specifying an inline Workload object, the name element is not required. This post returns the cost, capacity and Fit-for-Purpose results for the Control Environments and Infrastructure Groups. The expected_date should be within the supported Timeline Definition of the Control Console. Otherwise, metrics are not returned (e.g. "constraint": null, "subslots": [] and "sensor_capacity": []). Note: The specification of only 1 inline workload and 1 inline disk is supported, with no attributes and no tier specified. Example: Selecting Placement From Multiple Environments, Example: With Host Available Capacity Example: Obtaining Subslot Available Capacity, Example: Obtaining Available Capacity for a Catalog Spec, Example: Obtaining Available Capacity for the Default Catalog Spec with Overrides |
Table: Routing Requests–Available Capacity Query Resource Elements
|
Element |
Type |
Description |
|
control_environment |
Complex, as specified in the Description |
The Control Environment that is associated with the array of Infrastructure Groups above. The Control Environment’s available capacity is as follows:
|
|
infrastructure_groups |
[Complex, as specified in the Description] |
An array of Infrastructure Groups, matching the scopes definition in the query and belonging to the Control Environment specified by control_environment below. Each Infrastructure Group is defined by the following array of elements (see Infrastructure Groups):
"subslots": [
This is an example when the capacity cannot be computed (e.g. data is too stale): |
|
|
|
|
The sensor_capacity includes sensors that are configured as Do Not Allow New VM Bookings (see Managing Storage Settings (Help Topic ID 172390)), as well as sensors of closed hosting venues. For datastores, subslots[] is returned with the totals of all datastore metrics, independent of tier requirements. If no tier capabilities are specified for the Workloads, then only this array with totals is returned. Also for datastores, a tiers[] array is returned (if ?subslots=true) for each tier specified in the Routing Request, with the metrics specific for that tier and slots calculated as the number of such requests that can fit for that tier. For example, if the Routing Request only includes "Gold" tier disks, then only the slot count and metrics for Gold datastores are returned, along with the subslots totals. If there are no sensors audited, the sensor_capacity is returned with "slots": 2147483647. This means that the space is unlimited. Here is an example of what is returned (note that the 107 slot limitation is due to the Total Provisioned Space which has the same 107 value): |
||
|
"sensor_capacity": [ { "type": "phystor", "slots": 1456, "constraint": "509E681F-0C7A-4193-95B0-9523C14E0FED", "constraint_name": "Total Used Space (MB)", "subslots": [ // ... *SNIP* of subslot metrics ... ] }, { "type": "datastore", "slots": 113, "constraint": "B4E008AD-8ECC-43DB-BFA7-6A590873453E", "constraint_name": "Total Used Space (MB)", "subslots": [ { "name": "Total Provisioned Space (MB)", "value": 159, "spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C" }, { "name": "Number of VMs", "value": 180, "spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC" }, { "name": "Total Used Space (MB)", "value": 113, "spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E" }, { "name": "Health Status", "value": 2147483647, "spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59" }, { "name": "Total Required Space (MB)", "value": 170, "spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A" } ], |
||
|
|
|
"tiers": [ { "name": "Gold", "slots": 113, "subslots": [ { "name": "Total Provisioned Space (MB)", "value": 159, "spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C" }, { "name": "Number of VMs", "value": 180, "spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC" }, { "name": "Total Used Space (MB)", "value": 113, "spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E" }, { "name": "Health Status", "value": 0, "spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59" }, { "name": "Total Required Space (MB)", "value": 170, "spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A" } } ] } ] This is an example where the environment or the hosting venue does not have any sensors, when the capacity cannot be computed (e.g. data is too stale): "sensor_capacity": [] |
The slots calculation is the sum of the host slots of the request (i.e. defined by the total Workload requirement in the Routing Request). Negative slot counts are not included in the sum (e.g. if host1 has 5 and host2 has -10, then slots will be set to 5). The hosts array lists all the hosts within the infrastructure group, along with the primary constraint and subslots array of each host. See Example: With Host Available Capacity for an example. |
||
|
|
|
|
Form Definition
You need to define the workloads and optionally specify Control Environments and Infrastructure Groups for your query. Use the same form definition as that used for the Routing Request (see Routing Requests: Form Definition).
Examples
Example: Selecting Placement From Multiple Environments
The following example shows you how to select a placement from multiple environments:
Example: Selecting Placement From Multiple Environments
Request:
POST /routing-requests/available-capacity-query/?mode=cost_sensitive
{
"scopes": [
{
"control_environment": "Boston"
},
{
"control_environment": "Singapore",
"infrastructure_groups": ["Assessment","Densify"]
}
],
"workloads": [
{
"name": "group-vm",
"catalog_spec": "lin-medium-4gb",
"workload_profile": "Memory_Intensive"
}
]
}
Response:
[
{
"infrastructure_groups": [
{
"id": "f7a5ef21-3d0a-442e-b65c-541b0084b950",
"name": "General App Cloud",
"slots": 91,
"cei": 0.5,
"constraint": "Total_Memory",
"constraint_name": "Total Memory",
"href": "/infrastructure-groups/f7a5ef21-3d0a-442e-b65c-541b0084b950",
"control_type": "FULL"
"hosting_cost": 66,
"fit_for_purpose": {
"categories": [
{
"name": "Resource",
"test": [
{
"name": "Datastore Tier",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Operating Systems",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Guest Sizes",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Security",
"test": [
{
"name": "Data Jurisdiction",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Compliance",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Encryption and Key Management",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Identity and Access Management",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Security Zones",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Network Isolation",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Intel TXT Support",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Business",
"test": [
{
"name": "Location",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Departments",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Service Level",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Technical",
"test": [
{
"name": "Hosting Platform",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Hypervisor",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Maximum Guest I/O",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Operational Environments",
"status_reasons": [],
"status": "PASS"
},
{
"name": "DPDK",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Software Licenses",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Crypto H/W Acceleration",
"status_reasons": [],
"status": "PASS"
},
{
"name": "License Groups",
"status_reasons": [],
"status": "PASS"
}
{
"name": "Transport Zone",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
}
],
"status": "PASS"
},
"sensor_capacity": [
{
"type": "phystor",
"slots": 254,
"constraint": "509E681F-0C7A-4193-95B0-9523C14E0FED",
"constraint_name": "Total Used Space (MB)",
"subslots": []
},
{
"type": "datastore",
"slots": 232,
"constraint": "B4E008AD-8ECC-43DB-BFA7-6A590873453E",
"constraint_name": "Number of VMs",
"subslots": []
}
{
"type": "ipaddresspools",
"slots": 2147483647,
"constraint": "62d95498-6fdb-4fce-aebe-5f297ca0f7c3",
"constraint_name": "IP Addresses Assigned",
"subslots": []
}
],
"subslots": [],
"hosting_score": 100
},
// ... *SNIP* of Infrastructure Groups...
],
"control_environment": {
"id": "e6cf1672-77ff-4e7d-9dda-5387b0bc95cc",
"name": "Boston",
"platform": "VMWARE",
"platform_category": "Internal Virtual",
"control_type": "FULL"
"total_slots": 302,
"cei": 0.53,
"href": "/control-environments/e6cf1672-77ff-4e7d-9dda-5387b0bc95cc",
"subslots": [],
"sensor_capacity": [
{
"type": "phystor",
"slots": 233,
"constraint": "509E681F-0C7A-4193-95B0-9523C14E0FED",
"constraint_name": "Total Used Space (MB)",
"subslots": []
},
{
"type": "datastore",
"slots": 241,
"constraint": "B4E008AD-8ECC-43DB-BFA7-6A590873453E",
"constraint_name": "Number of VMs",
"subslots": []
}
{
"type": "ipaddresspools",
"slots": 2147483647,
"constraint": "62d95498-6fdb-4fce-aebe-5f297ca0f7c3",
"constraint_name": "IP Addresses Assigned",
"subslots": []
}
],
"icon": "/control-environments/e6cf1672-77ff-4e7d-9dda-5387b0bc95cc/icon"
}
},
{
"infrastructure_groups": [
// ... *SNIP* of Infrastructure Groups Assessment, Densify...
],
"control_environment": {
// ... *SNIP* of Control Environment Singapore...
}
}
]
Example: With Host Available Capacity
The following example shows you how to obtain host-level capacity information for the hosts in scope. Using the same example as above, the response highlights the delta in the response:
Example: Selecting Placement From Multiple Environments with Host Capacity
Request:
POST /routing-requests/available-capacity-query/?mode=cost_sensitive&detailed_host_calc=true
{
"scopes": [
{
"control_environment": "Boston"
},
{
"control_environment": "Singapore",
"infrastructure_groups": ["Assessment","Densify"]
}
],
"workloads": [
{
"name": "group-vm",
"catalog_spec": "lin-medium-4gb",
"workload_profile": "Memory_Intensive"
}
]
}
Response:
[
{
"infrastructure_groups": [
{
"id": "f7a5ef21-3d0a-442e-b65c-541b0084b950",
"name": "General App Cloud",
"slots": 91,
"cei": 0.5,
"constraint": "Total_Memory",
"constraint_name": "Total Memory",
"href": "/infrastructure-groups/f7a5ef21-3d0a-442e-b65c-541b0084b950",
"control_type": "FULL"
"hosting_cost": 66,
"fit_for_purpose": {
// ... *SNIP* of fit_for_purpose...
},
"sensor_capacity": [
// ... *SNIP* of sensor_capacity...
],
"subslots": [],
"host_capacity": {
"slots": 10,
"hosts": [
{
"name": "esxcrb06.int.Densify.com",
"constraint": "Mem_Utilization_As_Pct",
"constraint_name": "Memory Utilization in Percent",
"id": "69aeab94-6a2f-4708-aaf4-a65ad5674dd3",
"slots": 3,
"subslots": []
},
// ... *SNIP* of Hosts...
]
},
"hosting_score": 100
},
// ... *SNIP* of Infrastructure Groups...
],
"control_environment": {
// ... *SNIP* of Control Environment Boston...
}
},
{
"infrastructure_groups": [
// ... *SNIP* of Infrastructure Groups Assessment, Densify...
],
"control_environment": {
// ... *SNIP* of Control Environment Singapore...
}
}
]
Example: Obtaining Subslot Available Capacity
The following example shows you how to obtain slot metrics. The referenced Workload is defined with one disk with a tier definition of "Gold". A few datastores are defined with "Gold", which are located in the Boston environment. As well, in the Boston environment, two hosting venues are configured with "Do Not Allow" new VM bookings.
As the Singapore environment has no datastores, each Infrastructure Group will return sensor_capacity: []. The slots and hosting_score are calculated ignoring any of the disk requirements.
For the two Infrastructure Groups that are not accepting new bookings, slots: 0 is returned.
Example: Obtaining Subslot Available Capacity
Request:
POST /routing-requests/available-capacity-query/?subslots=true
{
"expected_date": 1421816400000,
"scopes": [
{
"control_environment": "Boston"
},
{
"control_environment": "Singapore",
"infrastructure_groups": ["Assessment","Densify"]
}
],
"workloads": [
{ "id": "0de059a5-8d1a-49a6-8848-765aef4786e5" }
]
}
Response:
[
{
"infrastructure_groups": [
{
"id": "f7a5ef21-3d0a-442e-b65c-541b0084b950",
"name": "General App Cloud",
"slots": 25,
"cei": 0.78,
"subslots": [
// ... *SNIP* subslots ...
],
"constraint": "Total_Memory",
"constraint_name": "Total Memory",
"href": "/infrastructure-groups/f7a5ef21-3d0a-442e-b65c-541b0084b950",
"control_type": "FULL"
"hosting_cost": 66,
"fit_for_purpose": {
"categories": [
{
"name": "Resource",
"test": [
{
"name": "Datastore Tier",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Operating Systems",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Guest Sizes",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Security",
"test": [
{
"name": "Data Jurisdiction",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Compliance",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Encryption and Key Management",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Identity and Access Management",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Security Zones",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Network Isolation",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Intel TXT Support",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Business",
"test": [
{
"name": "Location",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Departments",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Service Level",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
},
{
"name": "Technical",
"test": [
{
"name": "Hosting Platform",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Hypervisor",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Maximum Guest I/O",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Operational Environments",
"status_reasons": [],
"status": "PASS"
},
{
"name": "DPDK",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Software Licenses",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Crypto H/W Acceleration",
"status_reasons": [],
"status": "PASS"
},
{
"name": "License Groups",
"status_reasons": [],
"status": "PASS"
},
{
"name": "Transport Zone",
"status_reasons": [],
"status": "PASS"
}
],
"status": "PASS"
}
],
"status": "PASS"
},
"sensor_capacity": [
{
"type": "datastore",
"slots": 165,
"constraint": "B4E008AD-8ECC-43DB-BFA7-6A590873453E",
"constraint_name": "Total Used Space (MB)",
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 215,
"spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C"
},
{
"name": "Number of VMs",
"value": 1512,
"spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC"
},
{
"name": "Total Used Space (MB)",
"value": 165,
"spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E"
},
{
"name": "Health Status",
"value": 2147483647,
"spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59"
},
{
"name": "Total Required Space (MB)",
"value": 234,
"spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A"
}
],
"tiers": [
{
"name": "Gold",
"slots": 152,
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 215,
"spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C"
},
{
"name": "Number of VMs",
"value": 152,
"spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC"
},
{
"name": "Total Used Space (MB)",
"value": 165,
"spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E"
},
{
"name": "Health Status",
"value": 0,
"spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59"
},
{
"name": "Total Required Space (MB)",
"value": 234,
"spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A"
}
]
}
]
},
{
"type": "phystor",
"slots": 259,
"constraint": "509E681F-0C7A-4193-95B0-9523C14E0FED",
"constraint_name": "Total Used Space (MB)",
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 467,
"spec_code": "B92D5BCE-4578-48EA-9B80-70B98DCD07D8"
},
{
"name": "Number of VMs",
"value": 727,
"spec_code": "309504CA-0B67-4E01-8707-AFC0CCDCB07B"
},
{
"name": "Total Used Space (MB)",
"value": 259,
"spec_code": "509E681F-0C7A-4193-95B0-9523C14E0FED"
}
]
},
{
"type": "ipaddresspools",
"slots": 2147483647,
"constraint": "62d95498-6fdb-4fce-aebe-5f297ca0f7c3",
"constraint_name": "IP Addresses Assigned",
"subslots": []
}
],
"hosting_score": 48
},
// ... *SNIP* of Infrastructure Groups...
],
"control_environment": {
"id": "e6cf1672-77ff-4e7d-9dda-5387b0bc95cc",
"name": "Boston",
"platform": "VMWARE",
"platform_category": "Internal Virtual",
"control_type": "FULL"
"total_slots": 25,
"cei": 0.82,
"href": "/control-environments/e6cf1672-77ff-4e7d-9dda-5387b0bc95cc",
"subslots": [
// ... *SNIP* subslots ...
],
"sensor_capacity": [
{
"type": "datastore",
"slots": 278,
"constraint": "B4E008AD-8ECC-43DB-BFA7-6A590873453E",
"constraint_name": "Total Used Space (MB)",
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 374,
"spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C"
},
{
"name": "Number of VMs",
"value": 332,
"spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC"
},
{
"name": "Total Used Space (MB)",
"value": 278,
"spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E"
},
{
"name": "Health Status",
"value": 2147483647,
"spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59"
},
{
"name": "Total Required Space (MB)",
"value": 404,
"spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A"
}
],
"tiers": [
{
"name": "Gold",
"slots": 165,
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 215,
"spec_code": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C"
},
{
"name": "Number of VMs",
"value": 167,
"spec_code": "525F567D-61FC-4A6E-A617-D203FB8E9CDC"
},
{
"name": "Total Used Space (MB)",
"value": 165,
"spec_code": "B4E008AD-8ECC-43DB-BFA7-6A590873453E"
},
{
"name": "Health Status",
"value": 0,
"spec_code": "C17D631D-C584-48AE-B4F1-77D9EAAAAB59"
},
{
"name": "Total Required Space (MB)",
"value": 234,
"spec_code": "98EA05B5-E0E1-4828-A3DD-919C5738D29A"
}
]
}
]
},
{
"type": "phystor",
"slots": 469,
"constraint": "509E681F-0C7A-4193-95B0-9523C14E0FED",
"constraint_name": "Total Used Space (MB)",
"subslots": [
{
"name": "Total Provisioned Space (MB)",
"value": 840,
"spec_code": "B92D5BCE-4578-48EA-9B80-70B98DCD07D8"
},
{
"name": "Number of VMs",
"value": 1482,
"spec_code": "309504CA-0B67-4E01-8707-AFC0CCDCB07B"
},
{
"name": "Total Used Space (MB)",
"value": 469,
"spec_code": "509E681F-0C7A-4193-95B0-9523C14E0FED"
}
]
},
{
"type": "ipaddresspools",
"slots": 2147483647,
"constraint": "62d95498-6fdb-4fce-aebe-5f297ca0f7c3",
"constraint_name": "IP Addresses Assigned",
"subslots": []
}
],
"icon": "/control-environments/e6cf1672-77ff-4e7d-9dda-5387b0bc95cc/icon"
}
},
{
"infrastructure_groups": [
{
"id": "9d202491-f84c-405f-92b7-53648e8b4e92",
"name": "Assessment",
"slots": 0,
"cei": 1,
"subslots": [
// ... *SNIP* subslots ...
],
"constraint": "Total_Memory",
"constraint_name": "Total Memory",
"href": "/infrastructure-groups/9d202491-f84c-405f-92b7-53648e8b4e92",
"control_type": "FULL"
"hosting_cost": 0,
"fit_for_purpose": {
"categories": [
// ... *SNIP* Fit-for-Purpose categories ...
],
"status": "PASS"
},
"sensor_capacity": [
// ... *SNIP* sensor_capacity ...
],
"hosting_score": 0
},
{
"id": "ae8c8d5a-0d91-44dc-a679-b7188f2adbdf",
"name": "Dev",
"slots": 0,
"cei": 1,
"subslots": [
// ... *SNIP* Fit-for-Purpose categories ...
],
"constraint": "Total_Memory",
"constraint_name": "Total Memory",
"href": "/infrastructure-groups/ae8c8d5a-0d91-44dc-a679-b7188f2adbdf",
"hosting_cost": 0,
"fit_for_purpose": {
"categories": [
// ... *SNIP* Fit-for-Purpose categories ...
],
"status": "PASS"
},
"sensor_capacity": [
// ... *SNIP* sensor_capacity ...
],
"hosting_score": 0
}
],
"control_environment": {
"id": "14798cc6-f844-46b2-aa29-fcbcd68a2972",
"name": "London",
"platform": "IBM",
"platform_category": "Internal Virtual",
"control_type": "FULL"
"total_slots": 0,
"cei": 0.86,
"href": "/control-environments/14798cc6-f844-46b2-aa29-fcbcd68a2972",
"subslots": [
// ... *SNIP* subslots ...
],
"sensor_capacity": [
// ... *SNIP* sensor_capacity ...
],
"icon": "/control-environments/14798cc6-f844-46b2-aa29-fcbcd68a2972/icon"
}
}
]
The following example output shows you the Fit-for-Purpose test when it fails. This failure is due to the Infrastructure Group not having any datastores with the proper tier definition. In this case, the datastores are all defined as "Default", not "Gold".
Example: Obtaining Available Capacity for a Catalog Spec
Response:
[
{
"infrastructure_groups": [
{
"id": "e59b6ccb-69c6-422b-93b5-e7ca64b61be4",
"name": "ProdCloud-Apps1",
"slots": 0,
"cei": 0.88,
// ... *SNIP* ...
"fit_for_purpose": {
"categories": [
// ... *SNIP* categories...
{
"name": "Resource",
"test": [
// ... *SNIP* tests ...
{
"name": "Datastore Tier",
"status_reasons": [
{
"reason": "Required Datastore Tier not supported",
"workload_id": "0de059a5-8d1a-49a6-8848-765aef4786e5",
"workload_name": "VM-1"
}
],
"status": "FAIL"
}
],
"status": "FAIL"
},
// ... *SNIP* categories...
],
"status": "FAIL"
},
"sensor_capacity": [
{
"type": "datastore",
"slots": 0,
"constraint": "B89E1E20-F71D-4B70-9179-EEA3C6F81D6C",
"constraint_name": "Number of VMs",
"subslots": [
// ... *SNIP* ...
],
"tiers": [
{
"name": "Gold",
"slots": 0,
"subslots": [
// ... *SNIP* ...
Example: Obtaining Available Capacity for a Catalog Spec
The following example shows you how to obtain available capacity for a specific catalog specification:
Example: Obtaining Available Capacity for a Catalog Spec
Request:
POST /routing-requests/available-capacity-query
{
"workloads": [
{ "catalog_spec": "win-medium-2gb" }
]
}
Example: Obtaining Available Capacity for the Default Catalog Spec with Overrides
The following example shows you how to obtain available capacity for the default catalog specification with overrides:
Example: Obtaining Available Capacity for the Default Catalog Spec with Overrides
Request:
POST /routing-requests/available-capacity-query
{
"workloads": [
{
"workload_profile": "Memory_Intensive",
"disks": [
{
"name":"SYSTEM",
"provisioned_space":20480,
"used_space":5120
}
]
}
]
}