NSX-T Data Center REST API

Return aggregate information of upgrade-units filtered using given query.

Return information of upgrade-units filtered by given query in the upgrade plan.

Request:

Method:
POST
URI Path(s):
/api/v1/upgrade/filter/upgrade-units
Request Headers:
n/a
Query Parameters:
ListRequestParameters+
Request Body:
UpgradeResourcesFilterListRequestParameters+

Example Request:

{ "component_type": "HOST", "query": [ { "resource_type": "UPGRADE_GROUP", "filters": [ { "field_name": "name", "values": [ "*Group for " ] } ] }, { "resource_type": "UPGRADE_UNIT", "filters": [ { "field_name": "version", "values": [ "4.2.0.0.0.69377131" ] } ] } ] }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UpgradeUnitAggregateInfoListResult+

Example Response:

{ "results": [ { "id": "4aa5a00e-e25e-4377-9dcf-24899fda8a7e", "display_name": "10.218.132.26", "type": "HOST", "current_version": "4.2.0.0.0.69377131", "group": { "id": "b09da76b-8743-4361-87d8-64b116027d1b:domain-c10", "display_name": "Group for vLCM-cluster" }, "warnings": [], "metadata": [ { "key": "DEPLOYMENT_STATUS", "value": "INSTALL_SUCCESSFUL" }, { "key": "HYPERVISOR_VERSION", "value": "8.0.3" }, { "key": "PARENT_COMPLUTE_COLLECTION_DISPLAY_NAME", "value": "vLCM-cluster" }, { "key": "IN_TN_MAINTENANCE_MODE", "value": "false" }, { "key": "COMPUTE_MANAGER_VERSION", "value": "8.0" }, { "key": "PARENT_COMPLUTE_COLLECTION", "value": "b09da76b-8743-4361-87d8-64b116027d1b:domain-c10" }, { "key": "VLCM_ENABLED", "value": "true" }, { "key": "CM_LOCAL_ID", "value": "host-19" }, { "key": "DISCOVERED_IPS", "value": "10.218.132.26,fd01:0:106:304:425:26ff:fe8b:b410" }, { "key": "COMPUTE_MANAGER_PORT", "value": "443" }, { "key": "vlcm_sah", "value": "false" }, { "key": "HYPERVISOR_OS", "value": "ESXI" }, { "key": "HYPERVISOR_IP", "value": "10.218.132.26" }, { "key": "COMPUTE_MANAGER_SERVER", "value": "10.168.213.132" }, { "key": "lockdownMode", "value": "lockdownDisabled" }, { "key": "COMPUTE_MANAGER_ID", "value": "b09da76b-8743-4361-87d8-64b116027d1b" }, { "key": "COMPUTE_MANAGER_TYPE", "value": "vCenter" } ], "status": "SUCCESS", "percent_complete": 100.0, "pre_upgrade_checks": { "successful_checks": { "checks": [ { "display_name": "Restore Operation Check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check to validate staging on vLCM enabled cluster", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check whether all the NVDS switches are migrated to CVDS on hosts.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for enhanced datapath license validity.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check if a host is in WCP Partial Maintenance Mode.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Checks if VC version is supported for upgrade.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for federation upgrade compatibility", "status": "SUCCESS", "component_type": "MP" }, { "display_name": "Check for NSX Application Platform version for upgrade", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for CCP cluster status", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Compute manager connectivity check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "vSAN support check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Manager connectivity check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Reboot required check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "ESXi supported versions check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "KVM dependencies check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "ESXi maintenance-mode upgrade dataplane check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "KVM supported versions check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check if host transport node has PENDING_HOST_MAINTENANCE_MODE user action.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "MP FQDN resolution check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for sufficient free space on tmp partition of all ESXi hosts", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for sufficient free space on root partition of all hosts", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Maintenance-mode check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "NSX maintenance mode check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "DRS status check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Stateless ESXi check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Stale host management IP check", "status": "SUCCESS", "component_type": "HOST" } ], "result_count": 26 } } }, { "id": "9994b4b3-0831-4cdd-9466-e5141a9da368", "display_name": "10.185.254.252", "type": "HOST", "current_version": "4.2.0.0.0.69377131", "group": { "id": "b09da76b-8743-4361-87d8-64b116027d1b:domain-c8", "display_name": "Group for non-vLCM Cluster" }, "warnings": [], "metadata": [ { "key": "DEPLOYMENT_STATUS", "value": "INSTALL_SUCCESSFUL" }, { "key": "HYPERVISOR_VERSION", "value": "8.0.3" }, { "key": "PARENT_COMPLUTE_COLLECTION_DISPLAY_NAME", "value": "non-vLCM Cluster" }, { "key": "IN_TN_MAINTENANCE_MODE", "value": "false" }, { "key": "COMPUTE_MANAGER_VERSION", "value": "8.0" }, { "key": "PARENT_COMPLUTE_COLLECTION", "value": "b09da76b-8743-4361-87d8-64b116027d1b:domain-c8" }, { "key": "VLCM_ENABLED", "value": "false" }, { "key": "CM_LOCAL_ID", "value": "host-14" }, { "key": "DISCOVERED_IPS", "value": "10.185.254.252,2620:124:6020:c302:0:96ff:fe70:7d65,2620:124:6020:c302:0:a:0:108" }, { "key": "COMPUTE_MANAGER_PORT", "value": "443" }, { "key": "vlcm_sah", "value": "false" }, { "key": "HYPERVISOR_OS", "value": "ESXI" }, { "key": "HYPERVISOR_IP", "value": "10.185.254.252" }, { "key": "COMPUTE_MANAGER_SERVER", "value": "10.168.213.132" }, { "key": "lockdownMode", "value": "lockdownDisabled" }, { "key": "COMPUTE_MANAGER_ID", "value": "b09da76b-8743-4361-87d8-64b116027d1b" }, { "key": "COMPUTE_MANAGER_TYPE", "value": "vCenter" } ], "status": "SUCCESS", "percent_complete": 100.0, "pre_upgrade_checks": { "successful_checks": { "checks": [ { "display_name": "Restore Operation Check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check to validate staging on vLCM enabled cluster", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check whether all the NVDS switches are migrated to CVDS on hosts.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for enhanced datapath license validity.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check if a host is in WCP Partial Maintenance Mode.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Checks if VC version is supported for upgrade.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for federation upgrade compatibility", "status": "SUCCESS", "component_type": "MP" }, { "display_name": "Check for NSX Application Platform version for upgrade", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for CCP cluster status", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Compute manager connectivity check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "vSAN support check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Manager connectivity check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Reboot required check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "ESXi supported versions check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "KVM dependencies check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "ESXi maintenance-mode upgrade dataplane check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "KVM supported versions check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check if host transport node has PENDING_HOST_MAINTENANCE_MODE user action.", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "MP FQDN resolution check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for sufficient free space on tmp partition of all ESXi hosts", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Check for sufficient free space on root partition of all hosts", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Maintenance-mode check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "NSX maintenance mode check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "DRS status check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Stateless ESXi check", "status": "SUCCESS", "component_type": "HOST" }, { "display_name": "Stale host management IP check", "status": "SUCCESS", "component_type": "HOST" } ], "result_count": 26 } } } ], "result_count": 2 }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: