Get Collection

GET /existing-systems

None

Array of Existing Systems: Resource Elements

Common Operations and Sort By are not supported.

Example: Getting a Collection of Hosts with Name "*274*", Example: Getting a Collection of Existing Systems with Platform VMware

Get Individual

GET /existing-systems/<id>

None

Existing Systems: Resource Elements

Retrieve the elements of the Existing Systems specified by id.

Example: Getting an Individual Existing Host System, Example: Getting an Individual Existing Guest System

id, name, href

strings

F by id, name, name_like

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

To filter systems with names that contain a given input string, use ?name_like="<substring>" in your collection request. This filter is case insensitive. The '%' character can be used to match zero or more characters.

children

string

Children, from the System Summary DSE page.

For a host system (i.e. "type": "HOST"), this is the number of VMs the host system has (e.g. "children": "10"). For a VM (i.e. "type": "GUEST"), this does not apply (i.e. "children": "N/A").

control_environment

[id, name, platform_category, href, icon]

F by control_environment, platform, platform_category

The associated Control Environment where the system belongs. See Control Environments.

Note that when filtering on Control Environments, you must use the element control_environment with a name specified, platform with a platform specified, or platform_category with a platform category specified.

cores_per_cpu

string

Cores per CPU, from the System Summary DSE page.

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_model

string

CPU Architecture, from the System Summary DSE page.

cpu_speed

string

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

entity_role_name

string

Entity Role Name, from the System Summary DSE page.

entity_type

string

Type, from the System Summary DSE page.

hostId

string

Host Id, from the System Details DSE Config page.

I/O_benchmarks

[name, score_type, value]

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.

infrastructure_group

{id, name, href}

F by infrastructure_group

The associated Infrastructure Group where the system belongs. See Infrastructure Groups.

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

ip_address

string

Primary IP address, from the System Summary DSE page.

mac_address

string

MAC Address, from the System Details DSE Config page.

manufacturer

string

Manufacturer, from the System Summary DSE page.

memory

string

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

os

string

Operating System Name, from the System Summary DSE page.

os_patch_level

string

Operating Patch Level, from the System Summary DSE page.

os_version

string

Operating Version, from the System Summary DSE page.

parent

string

Parent, from the System Summary DSE page.

For a host system (i.e. "type": "HOST"), this does not apply (i.e. "parent": "N/A"). For a VM (i.e. "type": "GUEST"), this is the name of the parent host system (e.g. "parent": "esx-host-221").

serial_number

string

Serial number, from the System Details DSE page.

size

hidden element

This element is used to sort a collection by size. See Sorting By Size for details.

total_logical_cpus

string

Total Logical CPUs, from the System Summary DSE page.

total_physical_cpus

string

Total Physical CPUs, from the System Summary DSE page.

threads_per_core

string

Threads Per Core, from the System Summary DSE page.

type

string

F

The type of system.

• HOST
• GUEST