Skip to main content

GET /api/v1/managers-management/managers/{id}

Use this method to return information about a specific resource manager.

Note
This REST API requires Lenovo XClarity Orchestrator v2.0 or later.

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

CodeDescriptionComments
200OKThe request completed successfully.
404Not foundThe 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).

AttributesTypeDescription
idStringResource-manager ID
authenticationKeyString(Lenovo XClarity Management Hub and Lenovo XClarity Administrator only) Authentication key
authSourceString(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.

connectTimestampStringTimestamp 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.

connectionObjectInformation about connection settings
 hostnameStringManager host name
 portIntegerManager port number
 urlInteger(EcoStruxure IT Expert) Manager port number
groupsArray of objectsInformation about each group in which this manager is a member
 idStringGroup ID
 nameStringGroup name
 typeStringGroup type. This value is always ManagerGroup.
healthStateStringHealth state (translated). This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
hubIDString(vRealize Operations Manager only) Management Hub ID to use to connect the resource manager
issuesArray of stringsReason 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.

  • InvalidCredentials
  • ConnectionProblems
lastInventorySyncTimestampStringTimestamp 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.

lastSyncTimestampStringTimestamp 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.

nameStringResource manager name to use for basic authentication
optionsObject(Lenovo XClarity Management Hub and XClarity Administrator only) Information about applicable options
 enableDriveAnalyticsDataBooleanIndicates whether drive analytics-data collection is enabled. This can be one of the following values.
  • true. The component can be updated.
  • false. The component cannot be updated.
propertiesObjectInformation about the resource manager properties
 buildIntegerManager build number
 buildNumberIntegerManager build number
 forwarderIDString(Lenovo XClarity Management Hub and XClarity Administrator only) ID of the event forwarder in XClarity Administrator that pushes events to this XClarity Orchestrator instance
 metricsSubscriptionIDString(Lenovo XClarity Management Hub and XClarity Administrator only) ID of the metrics subscription in XClarity Administrator that pushes metrics to this XClarity Orchestrator instance
 networkSettingsObject(Lenovo XClarity Management Hub and XClarity Administrator only) Manager network settings
  domainNameStringManager domain name
  hostnameStringManager host number
  ipv4AddressesArray of stringsList of IPv4 addresses for the manager
  ipv6AddressesArray of stringsList of IPv6 addresses for the manager
 uuidStringManager UUID
 versionStringManager version number
 versionNumberIntegerManager version number
typeStringType of manager. This can be one of the following values.
  • XClarity Management Hub 2.0
  • XClarity Management Hub
  • XClarity Administrator
  • Schneider EcoStruxure IT
  • VMware vRealize Operations Manager
updatesObject(Lenovo XClarity Management Hub and XClarity Administrator only) Information about current software updates
 componentsArray of objectsInformation about updates on each component
  componentIDStringComponent ID
  nameStringComponent name
  targetVersionObjectInformation about the target update for the component based on the assigned policy

If a policy is not assigned, this value is null.

   identifierStringVersion identifier
   numberStringVersion number
   releaseTimestampStringTimestamp 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.

  upgradeableBooleanIndicates whether the component can be updated. This can be one of the following values.
  • true. The component can be updated.
  • false. The component cannot be updated.
  versionObjectInformation about current version
   identifierStringVersion identifier
   numberStringVersion number
   releaseTimestampStringTimestamp 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.

 identifierStringUpdate identifier
 policyObjectInformation about the assigned update policy
  idStringPolicy ID

If a policy is not assigned to the manager, this value is null.

  nameStringPolicy name

If a policy is not assigned to the manager, this value is No Assignment.

 policyStateStringUpdate policy state (translated)
  • No Policy Assigned
  • Policy Assigned
 policyStateKeyStringUpdate policy state key
  • NoPolicyAssigned
  • PolicyAssigned
_linksObjectResource URI (see Links)
_uiObjectInformation about UI-specific attributes
 healthStateKeyStringHealth state key. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
The following example is returned if the request is successful for a Lenovo XClarity Management Hub resource manager.
{
"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"
}
}
The following example is returned if the request is successful for a EcoStruxure IT Expert resource manager.
{
"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"
}
}
The following example is returned if the request is successful for a vRealize Operations Manager resource manager.
{
"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"
}
}