GET /api/v1/managers-management/managers/{id}
Use this method to return information about a specific resource manager.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/i/v1/managers-management/managers/{id}
where {id} is the ID of the resource manager. To obtain the manager IDs, use GET /api/v1/managers-management/managers.
Query parameters
None
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
Attributes | Type | Description | |||
---|---|---|---|---|---|
id | String | Resource-manager ID | |||
authenticationKey | String | (Lenovo XClarity Management Hub and Lenovo XClarity Administrator only) Authentication key | |||
authSource | String | (vRealize Operations Manager only) Name of the authentication source for users and groups To obtain a list of available authorization sources, use GET /api/v1/connector/vrealizeAuthSources. | |||
connectTimestamp | String | Timestamp when the manager was registered with the orchestrator server This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||
connection | Object | Information about connection settings | |||
hostname | String | Manager host name | |||
port | Integer | Manager port number | |||
url | Integer | (EcoStruxure IT Expert) Manager port number | |||
groups | Array of objects | Information about each group in which this manager is a member | |||
id | String | Group ID | |||
name | String | Group name | |||
type | String | Group type. This value is always ManagerGroup. | |||
healthState | String | Health state (translated). This can be one of the following values.
| |||
hubID | String | (vRealize Operations Manager only) Management Hub ID to use to connect the resource manager | |||
issues | Array of strings | Reason for an unhealthy status If healthState is Normal, this attribute is set to an empty array. If healthState is not Normal, this attribute can be one or more of the following values.
| |||
lastInventorySyncTimestamp | String | Timestamp when the portal last refreshed the inventory for the manager This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||
lastSyncTimestamp | String | Timestamp when portal last refreshed the information about the manager This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||
name | String | Resource manager name to use for basic authentication | |||
options | Object | (Lenovo XClarity Management Hub and XClarity Administrator only) Information about applicable options | |||
enableDriveAnalyticsData | Boolean | Indicates whether drive analytics-data collection is enabled. This can be one of the following values.
| |||
properties | Object | Information about the resource manager properties | |||
build | Integer | Manager build number | |||
buildNumber | Integer | Manager build number | |||
forwarderID | String | (Lenovo XClarity Management Hub and XClarity Administrator only) ID of the event forwarder in XClarity Administrator that pushes events to this XClarity Orchestrator instance | |||
metricsSubscriptionID | String | (Lenovo XClarity Management Hub and XClarity Administrator only) ID of the metrics subscription in XClarity Administrator that pushes metrics to this XClarity Orchestrator instance | |||
networkSettings | Object | (Lenovo XClarity Management Hub and XClarity Administrator only) Manager network settings | |||
domainName | String | Manager domain name | |||
hostname | String | Manager host number | |||
ipv4Addresses | Array of strings | List of IPv4 addresses for the manager | |||
ipv6Addresses | Array of strings | List of IPv6 addresses for the manager | |||
uuid | String | Manager UUID | |||
version | String | Manager version number | |||
versionNumber | Integer | Manager version number | |||
type | String | Type of manager. This can be one of the following values.
| |||
updates | Object | (Lenovo XClarity Management Hub and XClarity Administrator only) Information about current software updates | |||
components | Array of objects | Information about updates on each component | |||
componentID | String | Component ID | |||
name | String | Component name | |||
targetVersion | Object | Information about the target update for the component based on the assigned policy If a policy is not assigned, this value is null. | |||
identifier | String | Version identifier | |||
number | String | Version number | |||
releaseTimestamp | String | Timestamp when the update was released This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||
upgradeable | Boolean | Indicates whether the component can be updated. This can be one of the following values.
| |||
version | Object | Information about current version | |||
identifier | String | Version identifier | |||
number | String | Version number | |||
releaseTimestamp | String | Timestamp when the update was released This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | |||
identifier | String | Update identifier | |||
policy | Object | Information about the assigned update policy | |||
id | String | Policy ID If a policy is not assigned to the manager, this value is null. | |||
name | String | Policy name If a policy is not assigned to the manager, this value is No Assignment. | |||
policyState | String | Update policy state (translated)
| |||
policyStateKey | String | Update policy state key
| |||
_links | Object | Resource URI (see Links) | |||
_ui | Object | Information about UI-specific attributes | |||
healthStateKey | String | Health state key. This can be one of the following values.
|
{
"id": "53788A673607458DA14766162020FDAD",
"authenticationKey": "53788A673607458DA14766162020FDAD",
"connectTimestamp": "2022-08-02T03:21:20.079Z",
"connection": {
"hostname": "10.241.54.10",
"port": 443
},
"groups": [],
"healthState": "Normal",
"issues": [],
"lastInventorySyncTimestamp": "2022-08-02T17:53:35.322Z",
"lastSyncTimestamp": "2022-08-02T03:21:20.079Z",
"name": "10.241.54.10",
"options": {
"enableDriveAnalyticsData": false
},
"properties": {
"build": "108",
"buildNumber": 108,
"forwarderID": "1659410478081",
"metricsSubscriptionID": "62e8982fcdd22d416d86f82e",
"networkSettings": {
"domainName": "",
"hostname": "localhost",
"ipv4Addresses": ["10.241.54.10"],
"ipv6Addresses": ["fd64:30d9:58db:5bbc:0:0:0:1e10","fe80:0:0:0:250:56ff:fe8b:2320"]
},
"uuid": "53788A673607458DA14766162020FDAD",
"version": "1.0.0",
"versionNumber": 100
},
"type": "Lenovo XClarity Management Hub",
"updates": {
"components": [{
"componentID": "lxca",
"name": "Lenovo XClarity Management Hub 1.0.0",
"targetVersion": null,
"upgradeable": true,
"version": {
"identifier": "108",
"number": "1.0.0",
"releaseTimestamp": null
},
}],
"identifier": "lxca",
"policy": {
"id": null,
"name": "No Assignment"
},
"policyState": "No Policy Assigned",
"policyStateKey": "NoPolicyAssigned"
},
"_links": {
"rel": "self",
"uri": "/api/v1/managers-management/managers/53788A673607458DA14766162020FDAD"
},
"_ui": {
"healthStateKey": "Normal"
}
}
{
"id": "b17c3accec1e2a94e28b108ed757a6705c77066d",
"connectTimestamp": "2021-02-16T12:36:40.809Z",
"connection": {
"url": "https://api.ecostruxureit.com/rest/v1/organizations"
},
"details": {
"build": null,
"uuid": null,
"version": null,
"versionNumber": null
},
"groups": [],
"healthState": "Normal",
"healthStateKey": "Normal",
"issues": [],
"lastInventorySyncTimestamp": null,
"lastSyncTimestamp": "2021-02-16T12:36:40.809Z",
"name": "Demo Ecox manager1",
"type": "Schneider EcoStruxure IT",
"updates": null,
"_links": {
"rel": "self",
"uri": "/api/v1/connector/managers/b17c3accec1e2a94e28b108ed757a6705c77066d"
}
}
{
"id": "b17c3accec1e2a94e28b108ed757a6705c77066d",
"authSource": "",
"connectTimestamp": null,
"connection": {
"hostname": "10.241.54.100",
"port": 443
},
"groups": [],
"healthState": "Normal",
"hubID": "1234",
"issues": [],
"lastInventorySyncDate": null,
"lastSyncTimestamp": null,
"name": "vRealize Operations Manager",
"properties": {
"uuid": "21A727A22EECA0B85DCE38F16C7CEB1F",
"build": "41",
"buildNumber": 41,
"version": "1.4.0",
"versionNumber": 140
},
"type": "vRealize Operations Manager",
"_links": {
"rel": "self",
"uri": "/api/v1/managers-management/managers/b17c3accec1e2a94e28b108ed757a6705c77066d"
},
"_ui": {
"healthStateKey": "Normal"
}
}