Catalog Specifications
#340040
Description
When you create a Workload, you specify the Catalog Specification using element catalog_spec.
Manufacturer, OS Groups
The Catalog Specification collection is currently grouped by manufacturer and operating system. To obtain this list of supported groups, simply perform a collection request using /catalog-spec-groups.
To obtain the group collection, simply append the group name (i.e. manufacturer or os) to your Catalog Specification Group collection request (e.g. use /catalog-spec-groups/os to obtain the list of operating systems). The group collection is returned in alphabetical order by name.
To obtain the list of Catalog Specifications for a specific manufacturer or operating system, use /catalog-spec-groups/<group>/<group name> (e.g. /catalog-spec-groups/os/AIX to obtain the Catalog Specifications supporting AIX).
Resource
/catalog-specs
/catalog-spec-groups
/catalog-spec-groups/manufacturer
/catalog-spec-groups/os
Supported Operations
Table: Catalog Specification Supported Operations
Operation |
HTTP Method |
Input |
Output |
Description |
Get Collection |
GET /catalog-specs |
None |
Catalog Specification Collection of [id, name, href] |
Returns the Catalog Specifications. Example: Getting a Collection of Catalog Specification Groups |
Get Individual |
GET /catalog-specs/<id> |
None |
Returns the Catalog Specification. |
Table: Manufacturer/OS Supported Operations
Operation |
HTTP Method |
Input |
Output |
Description |
Get Collection |
GET /catalog-spec-groups/ |
None |
Group collection of [id, name, group, href] |
The list of Catalog Specification groups. Currently, only os and manufacturer are supported. Sort By is not supported. |
Get Collection |
GET /catalog-spec-groups/os/ |
None |
OS collection of [id, name, group, href] |
The list of OSs, in alphabetical order, defined by all Catalog Specifications. Sort By is not supported. Example: Getting a Collection of OS Catalog Specification for Guests |
GET /catalog-spec-groups/manufacturer/ |
None |
Manufacturer collection of [id, name, group, href] |
The list of manufacturers, in alphabetical order, defined by all Catalog Specifications. Sort By is not supported. |
|
Get Individual |
GET /catalog-spec-groups/os/<id> |
None |
id, name, group, href, systems[id, name, href] |
The list of Catalog Specifications with the specified OS. |
Get /catalog-spec-groups/manufacturer/<id> |
None |
id, name, group, href, systems[id, name, href] |
The list of Catalog Specifications with the specified manufacturer. Example: Getting an Individual Manufacturer Catalog Specification |
Table: Catalog Specification Resource Elements
Element |
Type |
Filter |
Description |
id, name, href |
strings |
F by name |
|
attributes |
[id, name, value] |
|
Defines any other attributes of the Catalog Specification. |
cores_per_cpu |
string |
F |
The Cores per CPU. |
cpu_benchmarks |
[name, score_type, value] |
|
The default CPU benchmark.
|
cpu_entitlement |
number |
F |
The CPU Entitlement (Proc Units). |
cpu_model |
string |
F |
The CPU Architecture. |
cpu_speed |
string |
F |
The Normalized CPU Speed (MHz). |
cpus |
number |
F |
The number of CPUs in the specification. |
disks |
[name, attributes[], provisioned_space, used_space] |
F |
An array of disk requirements, with sizes and tier capabilities. One disk is defined by default. When modifying this array, you must specify all disks as the new array replaces the existing one. Defaulted to that of the associated catalog_spec, if defined. Each disk is defined as follows:
{ "id": "attr_DatastoreTier", "name": "Datastore Tier", "value": "Gold" } |
I/O_benchmarks |
[name, value, score_type] |
|
The list of all available I/O benchmarks.
|
manufacturer |
string |
F |
The manufacturer, e.g. "Cisco". |
memory |
number |
F |
The Total Memory (MB). |
os |
string |
F |
The Operating System Name. |
platform_model |
string |
|
The Model. |
provisioned_space |
string |
F |
The Provisioned Space (GB). The sum of the provisioned space for the disks within the specification (i.e. sum of the provisioned_space in MB of the disk array). |
threads_per_core |
string |
|
The Threads per Core. |
total_physical_cpus |
string |
|
The Total Physical CPUs. |
type |
string |
F |
The Catalog Specification type:
|
used_space |
string |
F |
The Used Space (GB). The sum of the used space for the disks within the specification (i.e. sum of the used_space in MB of the disk array). |
workload_profile |
string |
|
The Workload Profile. |
Table: Manufacturer/OS Resource Elements
Element |
Type |
Filter |
Description |
id, name, href |
strings |
F by name |
|
group |
string |
F |
Type of group:
|
systems |
[id, name, href] |
|
The list of Catalog Specifications that have the specified group, e.g. with an os of "AIX". |
Examples
Example: Getting an Individual Catalog Specification
This example retrieves an individual Catalog Specification.

Request:
GET /catalog-specs/53a234b0-90d2-44ee-ab54-bc06934b2c27
Response:
{
"id": "53a234b0-90d2-44ee-ab54-bc06934b2c27",
"name": "lin-small-2gb",
"type": "GUEST",
"cpus": 1,
"os": "Linux",
"manufacturer": "Bookings Catalog",
"disks": [
{
"name": "SYSTEM",
"attributes": [],
"provisioned_space": 81920,
"used_space": 20480
]
}
],
"attributes": [
{
"id": "attr_IPAddressesAssigned",
"values": [
"1"
]
}
],
"href": "/catalog-specs/53a234b0-90d2-44ee-ab54-bc06934b2c27",
"cpu_entitlement": 1,
"memory": 2048,
"provisioned_space": 81920,
"used_space": 20480,
"workload_profile": "Medium_Utilization",
"platform_model": "Small 2GB",
"cpu_model": "Intel Xeon E5-2670",
"cpu_speed": 2600,
"total_physical_cpus": 1,
"cores_per_cpu": 1,
"threads_per_core": 1,
"cpu_benchmarks": [
{
"name": "CINT2006 Rate",
"value": 39.5
"score_type": "cint2006rate",
}
]
"I/O_benchmarks": [
{
"name": "Maximum Disk Throughput (bytes/s)",
"value": -1,
"score_type": "disk",
},
{
"name": "Maximum Network Throughput (bytes/s)",
"value": -1,
"score_type": "net",
},
}
Example: Getting a Collection of Catalog Specification Groups
The following example shows you how to get a collection of catalog specification groups.

Request:
GET /catalog-spec-groups
Response:
[
{
"id": "os",
"name": "os",
"href": "/catalog-spec-groups/os"
},
{
"id": "manufacturer",
"name": "manufacturer",
"href": "/catalog-spec-groups/manufacturer"
}
]
Example: Getting a Collection of OS Catalog Specification for Guests
This example retrieves the collection of OS catalog specifications based on guest operating systems. ?type=guest is the default so no extra filtering is required.

Request:
GET /catalog-spec-groups/os
Response:
[
{
"id": "AIX",
"name": "AIX",
"group": "os",
"type": "GUEST",
"href": "/catalog-spec-groups/os/AIX"
},
{
"id": "Linux",
"name": "Linux",
"group": "os",
"type": "GUEST",
"href": "/catalog-spec-groups/os/Linux"
},
{
"id": "Windows",
"name": "Windows",
"group": "os",
"type": "GUEST",
"href": "/catalog-spec-groups/os/Windows"
}
]
Example: Getting a Collection of Manufacturer Catalog Specifications for Hosts
This example retrieves the Manufacturer Catalog Specifications for hosts.

Request:
GET /catalog-spec-groups/manufacturer/?type=HOST
Response:
[
{
"id": "Cisco",
"name": "Cisco",
"group": "manufacturer",
"type": "HOST",
"href": "/catalog-spec-groups/manufacturer/Cisco"
},
{
"id": "Dell",
"name": "Dell",
"group": "manufacturer",
"type": "HOST",
"href": "/catalog-spec-groups/manufacturer/Dell"
},
// ... *SNIP* of Manufacturer Catalog Specifications ...
}
]
Example: Getting an Individual Manufacturer Catalog Specification
This example retrieves the Dell Manufacturer Catalog Specification.

Request:
GET /catalog-spec-groups/manufacturer/Dell
Response:
{
"id": "Dell",
"name": "Dell",
"group": "manufacturer",
"href": "/catalog-spec-groups/manufacturer/Dell",
"systems": [
{
"id": "6f08aff2-7561-42ea-9488-c5e32ddec005",
"name": "bkl-db-fin1",
"href": "/catalog-specs/6f08aff2-7561-42ea-9488-c5e32ddec005"
},
// ... *SNIP* of Systems...
]
}