Get Collection

GET /inbound-hosts

None

Inbound Host collection of [id, name, href]

Example: Getting a Collection of Inbound Hosts

Get Individual

GET /inbound-hosts/<id>

None

Inbound Hosts: Resource Elements

Retrieve the Inbound Host elements of the specified id.

Example: Getting an Individual Inbound Host

Create Individual

POST /inbound-hosts

Inbound Hosts: Resource Elements

Inbound Hosts: Resource Elements

One or more Inbound Hosts can be created.

Example: Creating Multiple Inbound Hosts

Create Multiple

POST /inbound-hosts

Inbound Hosts: Resource Elements>

With "num_copy" : <number> specified

Inbound Hosts: Resource Elements

Similar to the Create Individual operation, but specifying the number of Inbound Hosts to create using "num_copy" : <number> with no limit to the number of instances created at a time. The names of the Inbound Hosts are auto-generated by appending a number after name. For example, if name=Host, then the generated names would be Host1, Host2, etc.

Example: Creating Multiple Inbound Hosts

Modify Individual

PUT /inbound-hosts/<id>

None

Inbound Hosts: Resource Elements

An Inbound Host that is in PENDING or COMMITTED state can be modified through the PUT command. Only the name can be modified.

Example: Modifying an Inbound Host Name

Delete Individual

DELETE /inbound-hosts/<id>

None

None

An Inbound Host in any state can be deleted.

Delete Multiple

DELETE /inbound-hosts

ids: [<id>, <id>,…]

None

Similar to deleting a single Inbound Host above, however, this command deletes multiple Inbound Hosts in one call.

Example: Deleting Multiple Inbound Hosts

id, name, href

strings

CM-R for name

S by name

F by name

See ID, Name and Self Reference (id, name, href). The expected system name of the incoming host, required for auto-reconciliation. For details, see section Auto-Reconciliation of Systems of Booking Overview (Help Topic ID 230350).

attributes

[id, name, value]

C

F only as that defined in cfg\bookings\bookings-config.xml

On a create request, defines any other attributes of the incoming system. If the attribute name or value is incorrectly specified, an error is returned and the Inbound Host object is not created.

For a create, only the name-value pairs are required. The id is not required.

For a single-valued attribute, if the name-value pair is defined more than once, then only the first occurrence is used and the second one is ignored.

For a multi-valued attribute, the name-value pair can be specified multiple times as required for the same named attribute. Duplicates when specifying the same value more than once for the same named attribute are ignored.

On a GET request, only those attributes that have values are returned.

The name corresponds to the actual field label. For example:
{
  "id": "attr_SecurityZone",
  "name": "Security Zone",
  "value": "Level 1"
}

To filter on an attribute, use attribute.id. For example, to filter all Inbound Hosts that belong to Level 1 Security Zone:
/inbound-hosts/?attribute.attr_SecurityZone=Level 1

control_environment

id, name, href, icon

F using control_environment_id

This is the link to the associated Control Environment where the host is to be placed. This environment must consist of full control hosting venues.

cores_per_cpu

string

C-R

Cores per CPU on the Plan and Manage Supply > Add Host Supply dialog box.

Cores per CPU, from the System Summary DSE page.

cpu_allocation

string

C

Not displayed on the Plan and Manage Supply > Add Host Supply dialog box.

CPU Allocation of the system.

cpu_benchmarks

[name, score_type, value]

C

The CPU benchmark.

If not specified, the benchmark is automatically calculated. To recalculate manually, see Helper Utilities.

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

cpu_model

string

C-R

CPU Architecture on the Plan and Manage Supply > Add Host Supply dialog box.

CPU Architecture, as from the System Summary DSE page.

cpu_speed

string

C-R

CPU Speed on the Plan and Manage Supply > Add Host Supply dialog box.

Normalized CPU Speed (MHz), as from the System Summary DSE page.

creation_time

number

S

F

The date and time this Inbound Host object was created, in UTC.

description

string

C

An arbitrary string that describes the new host.

expected_date

number

C

S

F

The expected date this Inbound Host is expected to be running and available for placing VMs, in UTC format. The time portion is ignored and always set to 04:00:00.

A default of tomorrow's date is used, meaning the host must be provisioned today.

infrastructure_group

id, name, href

C-R

F using infrastructure_group_id or infrastructure_group

This is the link to the associated Infrastructure Group where the host is to be placed.

Note that when filtering on Infrastructure Groups, you must use the element infrastructure_group_id with a UUID specified or element infrastructure_group with a name specified.

I/O_benchmarks

[name, score_type, value]

C

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

C-R

Manufacturer on the Plan and Manage Supply > Add Host Supply dialog box.

Manufacturer, from the System Summary DSE page.

memory

number

C-R

S

Normalized Total Memory (MB), as from the System Summary DSE page.

owner

string

C

S

Used to define the owner or Customer Name of this Inbound Host. If not set, this field is set to the user who is creating the Inbound Host.

owner_email

string

C

The email address of the owner.

platform_model

string

C-R

Platform/Model on the Plan and Manage Supply > Add Host Supply dialog box.

Model, from the System Summary DSE page.

project

string

C

Used to define the Project. If not set, the Project is defined as "__Unknown__".

status

string

S

F

The status of the Inbound Host. See State Diagrams for Supply for state details.

• "PENDING"
• "COMMITTED"
• "COMPLETED"
• "EXPIRED"
• "CANCELLED"

total_logical_cpus

string

Total Logical CPUs, as from the System Summary DSE page. This is defined by the system catalog (if specified) or is calculated from total_physical_cpus x cores_per_cpu x threads_per_core.

total_physical_cpus

string

C-R

Physical CPUs on the Plan and Manage Supply > Add Host Supply dialog box.

Total Physical CPUs, from the System Summary DSE page.

threads_per_core

string

C-R

Threads Per Core on the Plan and Manage Supply > Add Host Supply dialog box.

Threads Per Core, as from the System Summary DSE page.