Get Collection

GET /systems

Query String Parameter Options:

• Collection Details
• Paging
• Element Filters
• Attributes On/Off Mode
• Attributes On/Off Mode
• Attribute Filters - Multiple Values Support
• Sorting

Collection of Response elements

Used to return configuration and attribute information of systems (of supported type) that are being tracked under recent data collection activity.

Example: Getting a Collection of VMware Systems using Attribute Filters

Get Individual Systems

GET /systems/<id>

Path Parameter:

• id (system ID)

Response elements

Used to return configuration and attribute information for a system specified by id. The system returned is being tracked under recent data collection activity and must be one of the supported system type.

Example: Getting an Individual Host System

Example: Getting an Individual Guest System

Get System's Instance Type Details

GET /systems/<id>/analysis-details

Path Parameter:

• id (system ID)

Request Body Parameters:

• name
• value
• value

ResponseJSON structure for each supplied system ID.

Used to provide instance type details of the specified system as well as details of the optimal instance for this workload. Additional targets are listed based on the optional spend and effort tolerance parameters.

Get Report PDF

GET /systems/<id>/analysis-report

Path Parameter:

• id (system ID)

Used to obtain the Impact Analysis and Recommendation Report (also known as the Application Owner report).

See Viewing the Impact Analysis and Recommendation Report (Help Topic ID 380450) for details on the content of the report.

Use Accept : application/octet-stream in the request header to download the PDF file.

Example: Downloading an Impact Analysis and Recommendation Report

Modify System Attributes

PUT /systems/<id>/attributes

Path Parameter:

• id (system ID)

Request Body Parameters:

array of attributes

• name
• value

Response elements with attributes modified

Used to modify the values of a system’s attributes.

If attribute name corresponds to an existing set attribute in the system, then the attribute's value will be updated to value. If attribute name is not set in the system, then the [name,value] tuple will be added to the system's attribute array.

For multi-value attributes (i.e. "Multiple Values" property is enabled for the attribute), a PUT request for that attribute will append the new [name,value] pair to the attribute array, if that attribute [name,value] pair does not exist. To overwrite a multi-value attribute value, you will first need to delete the existing attribute value.

Example: Modifying a System’s Attributes

Delete System Attributes

DELETE /systems/<id>/attributes

Path Parameter:

• id (system ID)

Request Body Parameters:

array of attributes

• id
• value

or

• id (attribute ID)

Response elements with attributes deleted

Used to delete attributes from an individual system given the attribute ID-value [id,value] pair or attribute [id].

If the attribute [id,value] pair is provided, the attribute will be deleted only if the attribute [id] and corresponding [value] matched the one found in the system.

For multi-value attributes (i.e. "Multiple Values" property is enabled for the attribute), a DELETE request with only attribute [id] provided will delete all the values with that attribute ID; a DELETE request with [id,value] pair provided will delete only the attribute ID entry with that specific value.

Example: Deleting a System’s Attributes

id, name, href

strings

F by

• id
• name
• name_like

S by name

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. The '%' character can be used to match zero or more characters.

Example: Getting a Collection of Azure Systems with Name "*test*"

resource_id

strings

F

The unique system ID assigned by the cloud provider.

To search for a system with a particular cloud provider ID, use ?resource_id=<cloud_id> in your request.

Example: Getting Public Cloud Attributes for an Individual System

attributes

[id, name, value]

M

F by

• attribute_name_like
• attribute_id
• attribute_name
• attribute_id_value
• attribute_name_value

System attributes are properties set by an audit from a vendor platform or by Densify for control analytics.

On a GET request, only those attributes that have values are returned. To hide the set attributes, use the attributes_mode=Off option. See Attributes On/Off Mode for details. To only return set attributes in specific categories, use the setdisplay_category option. See Attribute Display Categories for details.

To filter based on attributes, you must use one of the following element options — in each case, system data will be returned only if the attributes selected have values assigned to them:

• attribute_name_like
• attribute_id with a provided list of attribute IDs
• attribute_name with a provided list of attribute names
• attribute_id_value with a provided list of attribute ID-value pairs
• attribute_name_value with a provided list of attribute name-value pairs

Refer to Attribute Filters - Multiple Values Support for a description of how to use these attribute filters.

Note that when you use attributes to filter the collection, the attributes_mode=Off feature is disabled.

Example: Getting a Collection of VMware Systems using Attribute Filters

Example: Getting Public Cloud Attributes for an Individual System

children

string

The number of other systems that are considered "children" of the current system.

For a host system (i.e. "type": "host"), this is the number of VMs the host system has (e.g. "children": "10"). For AWS ASGs (i.e. "type" : "asg"), this is the number of active EC2 instances that belong to the group. For other type of systems where this element does not apply, children is not returned.

This element is returned for host and ASG systems only when the details=true option is in the request URI. See Collection Details.

control_environment

[id, name, platform_category, href, icon]

F by

• control_environment
• platform_category

If the system is associated with a Control Environment, the environment details are returned:

• id
• name
• platform_category
• href
• icon

To filter based on Control Environment, you must use one of the following elements:

• control_environment—with a control environment name specified
• platform_category—with a platform category specified (i.e. "External Cloud" or "Internal Virtual")

Example: Getting a Filtered Collection of Systems.

cores_per_cpu

string

Tertiary sort key for sort_by=size

Cores per CPU for computing systems.

cpu_benchmarks

[name, score_type, value]

The default CPU benchmark for applicable systems.

• 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

The CPU architecture model of the compute system.

cpu_speed

string

The normalized CPU speed (MHz) of the compute system.

entity_role_name

string

The entity role name that Densify assigns to the system (e.g. "VMWARE_VM") based on their platform and system role.

entity_type

string

The entity type that Densify assigns to the system (e.g. "VMware ESX Guest") based on their platform and system type.

hostId

string

An ID of the system provided from the data collection audit for the purpose of resolving duplication conflicts.

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

If the system is associated with an Infrastructure Group (cluster), the group details are returned:

• id
• name
• href

When filtering based on Infrastructure Group, you must use the element infrastructure_group with the group name specified.

Example: Getting a Filtered Collection of Systems.

ip_address

string

Primary IP address of the system.

mac_address

string

MAC address of the system provided by the data collection audit.

manufacturer

string

For host type systems, the manufacturer of the host is returned (e.g. "Dell", "IBM"). For cloud systems, the vendor platform is returned (e.g. "GCP") or "CONTAINERS" is returned for container type systems.

This element is returned only when the details=true option is in the request URI. See Collection Details.

memory

string

S by size

The normalized total memory (MB) for the system.

os

string

Operating System name of the host or VM instance.

This element is returned only when the details=true option is in the request URI. See Collection Details

os_patch_level

string

Operating System patch level of the host or VM instance.

os_version

string

Operating System version of the host or VM instance.

parent

string

Logical parent of the current system.

For a host system (i.e. "type": "HOST"), this does not apply (i.e. "parent": "N/A").

For a VM, this is the name of the parent host system (e.g. "parent": "esx-host-221").

platform

string

F

The platform of the system. Use this element to filter systems from the various supported platforms:

• VMWARE—For systems in VMware
• HMC—For systems in IBM Power
• AWS—For systems in AWS
• GCP—For systems in GCP
• AZURE—For systems in Azure
• CONTAINERS—For containers, both Kubernetes and ECS

For example, use platform=azure to return a collection of Azure cloud systems. See Example: Getting a Collection of Azure Systems with Name "*test*".

platform_model

string

For host systems, the host system model is returned. For cloud instance systems, the instance type is returned.

serial_number

string

The serial number of the system from the vendor.

size

hidden element

S by size

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

total_logical_cpus

string

The total number of logical CPUs for the system.

total_physical_cpus

string

Secondary sort key for sort_by=size

The total number of physical CPUs for the system.

threads_per_core

string

The threads per core for the system.

type

string

F

The type of system.

The supported types of systems for the /systems resource include:

• host—For host systems in VMware, IBM PowerVM (via data collection for HMC 8 method), and AWS platforms.
• guest—For guest systems in a VMware platform.
• vm—For instances in VMware, IBM PowerVM(via data collection for HMC 8 method), GCP (Compute Engine), and AWS (EC2, ECS) platforms.
• arm_vm—For instances in the Azure platform.
• classic_vm—For classic instances in the Azure platform.
• rds—For RDS instances in the AWS platform.
• asg—For Auto Scaling groups in the AWS platform.
• ecs_svc—For ECS services in the AWS platform.
• Containers realized through data collection are supported by the /systems endpoint, but does not have the type element populated. You can filter Container systems via the platform=containers element filter.