Catalog Specifications

Catalog Specifications

#340040

Description

A Catalog Specification represents a pre-configured specification for a new guest or host. All Catalog Specifications shipped with Densify are defined with a medium utilization Workload Profile and one disk definition.

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

Catalog Specifications: Resource Elements

Returns the Catalog Specification.

Example: Getting an Individual 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

Resource Elements

Table: Catalog Specification Resource Elements

Element

Type

Filter

Description

id, name, href

strings

F by name

See ID, Name and Self Reference (id, name, href).

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.

  • name—Label with possible values:
    • "CINT2000"
    • "CINT2000 Rate"
    • "CINT2006 Rate"
    • "RPE2"
  • score_type—Score type with possible values:
    • "cint2000"
    • "cint2000rate"
    • "cint2006rate"
    • "rpe2"
  • value

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:

  • name—name of the disk
  • provisioned_space—provisioned space in MB
  • used_space—used space in MB
  • attributes: [id, name, value]—id, name and value of the datastore attributes. The id is mapped to its display name (e.g. "attr_DatastoreTier" is mapped to "Datastores") and can be determined by performing GET /sensors. An example of id, name and value:
  • {

      "id": "attr_DatastoreTier",

      "name": "Datastore Tier",

      "value": "Gold"

    }

I/O_benchmarks

[name, value, score_type]

 

The list of all available I/O benchmarks.

  • name—Label with possible values:
    • "Maximum Disk Throughput (bytes/s)"
    • "Maximum Network Throughput (bytes/s)"
  • score_type—Score type with possible values:
    • "disk"
    • "net"
  • value—A value of -1 means there is no value specified.

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:

  • "GUEST"
  • "HOST"

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

See ID, Name and Self Reference (id, name, href).

group

string

F

Type of group:

  • "manufacturer"
  • "os"

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.

Example: Getting a Collection of Catalog Specification Groups

The following example shows you how to get a collection of catalog specification groups.

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.

Example: Getting a Collection of Manufacturer Catalog Specifications for Hosts

This example retrieves the Manufacturer Catalog Specifications for hosts.

Example: Getting an Individual Manufacturer Catalog Specification

This example retrieves the Dell Manufacturer Catalog Specification.