GET /api/v1/connector/managers/`{id}`

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

Attention

This REST API will be deprecated in a future release. Use GET /api/v1/managers-management/managers/{id} instead.

Authentication

Authentication with username and password is required.

Resource URI

GET https://{orchestrator_server_IP}/api/v1/connector/managers/{id}

Query parameters

None

Request body

None

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
401	Unauthorized	The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403	Forbidden	The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body.

Response body

The returned attributes vary depending on the type of resource manager.

Lenovo XClarity Orchestrator resource managers
XClarity Management Hub 2.0 and Lenovo XClarity Administrator resource managers
Schneider Electric EcoStruxure IT Expert resource managers
VMware vRealize Operations Manager resource managers

Table 1. Lenovo XClarity Orchestrator resource managers.
Attributes		Type	Description
id		String	Resource manager ID
connectDate		String	Timestamp when the resource manager was registered with XClarity Orchestrator 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	Resource manager host name
	port	Integer	Resource manager port
details		Object	Information about the resource manager properties
	build	String	Resource manager build number
	buildNumber	String	Resource manager build number
	uuid	String	Resource manager UUID
	version	String	Resource manager version
	versionNumber	String	Resource manager version number
groups		Array of object	Information about each group in which this resource manager is a member
	id	String	Group ID
	name	String	Group name
	type	String	Group type. This value is always ManagerGroup.
	uri	String	Group URI
healthState		String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
healthStateKey		String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
issues		Array of strings	Reason for an unhealthy status If healthState is Normal, this attribute is set to null. If healthState is not Normal, this attribute can be one of the following values. InvalidCredentials ConnectionProblems
lastInventorySyncTimestamp		String	Timestamp when XClarity Orchestrator last refreshed the inventory for the resource 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.
lastSyncDate		String	Timestamp when XClarity Orchestrator last refreshed the information about the resource 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
type		String	Type of resource manager. This is always XClarity Orchestrator.
_links		Object	Resource manager URI (see Links)

The following example is returned if the request is successful for XClarity Orchestrator.

{
   "id": "00000000000000000000000000000000",
   "connectDate": null,
   "connection": null,
   "details": {
      "build": "186",
      "buildNumber": 186,
      "uuid": "21A727A22EECA0B85DCE38F16C7CEB1F",
      "version": "1.6.0",
      "versionNumber": 160
   },
   "groups": [],
   "healthState": "Normal",
   "healthStateKey": "Normal",
   "issues": [],
   "lastInventorySyncDate": null,
   "lastSyncDate": null,
   "name": "XClarity Orchestrator",
   "type": "XClarity Orchestrator",
   "_links": {
      "rel": "self",
      "uri": "/api/v1/connector/managers/00000000000000000000000000000000"
   }
}

Table 2. XClarity Management Hub 2.0 and Lenovo XClarity Administrator resource managers.
Attributes				Type	Description
id				String	Resource manager ID
connectTimestamp				String	Timestamp when the resource manager was registered with XClarity Orchestrator 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	Resource manager host name
	port			Integer	Resource manager port
details				Object	Information about the resource manager properties
	build			String	Resource manager build number
	buildNumber			String	Resource manager build number
	forwarderID			String	ID of the event forwarder in XClarity Administrator that pushes events to this XClarity Orchestrator instance
	metricsSubscriptionID			String	ID of the metrics subscription in XClarity Administrator that pushes metrics to this XClarity Orchestrator instance
	networkSettings			Object	Information about network settings for the resource manager
		domainName		String	Domain
		hostname		String	Host name
		ipv4Addresses		Array of strings	List of IPv4 addresses
		ipv6Addresses		Array of strings	List of IPv6 addresses
	uuid			String	Resource manager UUID
	version			String	Resource manager version
	versionNumber			String	Resource manager version number
groups				Array of object	Information about each group in which this resource manager is a member
	id			String	Group ID
	name			String	Group name
	type			String	Group type. This value is always ManagerGroup.
	uri			String	Group URI
healthState				String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
healthStateKey				String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
issues				Array of strings	Reason for an unhealthy status If healthState is Normal, this attribute is set to null. If healthState is not Normal, this attribute can be one of the following values. InvalidCredentials ConnectionProblems
lastInventorySyncTimestamp				String	Timestamp when XClarity Orchestrator last refreshed the inventory for the resource 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 XClarity Orchestrator last refreshed the information about the resource 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
options				Object	Information about options
	enableDriveAnalyticsData			Boolean	Indicates whether drive analytics-data collection is enabled. This can be one of the following values. true. Drive analytics data collection is enabled. false. Drive analytics data collection is disabled.
type				String	Type of resource manager. This is always XClarity Administrator.
updates				Object	(XClarity Administrator and EcoStruxure IT Expert only) Information about the update history for the resource manager
	identifier			String	Update ID
	components			Array of objects	Information about each update 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 ID
			number	String	Version number
			releaseTimestamp	String	Timestamp when the version 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. true. The component can be updated. false. The component cannot be updated.
		version		Object	Information about the update that is currently installed for the component
			identifier	String	Version ID
			number	String	Version number
			releaseTimestamp	String	Timestamp when the version 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.
	policy			Object	Information about the update-compliance policy that is assigned to this device If a policy is not assigned, this value is null.
		id		String	Policy ID
		name		String	Policy name
	policyState			String	Policy state (translated). This can be one of the following values. No Policy Assigned Policy Assigned
	policyStateKey			String	Policy state key. This can be one of the following values. No Policy Assigned Policy Assigned
_links				Object	Resource manager URI (see Links)

The following example is returned if the request is successful for XClarity Administrator.

{
   "id": "23C87F0A2CB6491097489193447A655C",
   "connectTimestamp": "2022-04-25T15:13:43.833Z",
   "connection": {
      "hostname": "10.243.2.107",
      "port": 443
   },
   "details": {
      "build": "41",
      "buildNumber": 41,
      "forwarderID": "1650899611143",
      "metricsSubscriptionID": "6266baa3fac263b8917b9181",
      "networkSettings": {
         "domainName": "labs.lenovo.com",
         "hostname": "xhmc194",
         "ipv4Addresses": ["10.243.2.107"],
         "ipv6Addresses": ["fd55:faaf:e1ab:2021:5054:ff:fec4:df97","fe80:0:0:0:5054:ff:fec4:df97"]
      },
      "uuid": "23C87F0A2CB6491097489193447A655C",
      "version": "3.6.0",
      "versionNumber": 360
   },
   "groups": [],
   "healthState": "Normal",
   "healthStateKey": "Normal",
   "issues": [],
   "lastInventorySyncTimestamp": "2022-04-25T15:14:33.480Z",
   "lastSyncTimestamp": "2022-04-25T15:13:43.833Z",
   "name": "xhmc194.labs.lenovo.com",
   "options": {
      "enableDriveAnalyticsData": true
   },
   "type": "XClarity Administrator",
   "updates": {
      "identifier": "lxca",
      "components": [{
         "componentID": "lxca",
         "name": "Lenovo XClarity Administrator 3.6.0",
         "targetVersion": null,
         "upgradeable": true,
         "version": {
            "identifier": "41",
            "number": "3.6.0",
            "releaseTimestamp": null
         }
      }],
      "policy": {
         "id": null,
         "name": "No Assignment"
      },
      "policyState": "No Policy Assigned",
      "policyStateKey": "NoPolicyAssigned",
   },
   "_links": {
      "rel": "self",
      "uri": "/api/v1/connector/managers/23C87F0A2CB6491097489193447A655C"
   }
}

Table 3. Schneider Electric EcoStruxure IT Expert resource managers.
Attributes				Type	Description
id				String	Resource manager ID
connectTimestamp				String	Timestamp when the resource manager was registered with XClarity Orchestrator 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
	url			String	Resource manager URL
details				Object	Information about the resource manager properties
	build			String	Resource manager build number
	uuid			String	Resource manager UUID
	version			String	Resource manager version
	versionNumber			String	Resource manager version number
groups				Array of object	Information about each group in which this resource manager is a member
	id			String	Group ID
	name			String	Group name
	type			String	Group type. This value is always ManagerGroup.
	uri			String	Group URI
healthState				String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
healthStateKey				String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
issues				Array of strings	Reason for an unhealthy status If healthState is Normal, this attribute is set to null. If healthState is not Normal, this attribute can be one of the following values. InvalidCredentials ConnectionProblems
lastInventorySyncTimestamp				String	Timestamp when XClarity Orchestrator last refreshed the inventory for the resource 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 XClarity Orchestrator last refreshed the information about the resource 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
type				String	Type of resource manager. This is always Schneider EcoStruxure IT.
updates				Object	Information about the update history for the resource manager
	identifier			String	Update ID
	components			Array of objects	Information about each update 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 ID
			number	String	Version number
			releaseTimestamp	String	Timestamp when the version 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. true. The component can be updated. false. The component cannot be updated.
		version		Object	Information about the update that is currently installed for the component
			identifier	String	Version ID
			number	String	Version number
			releaseTimestamp	String	Timestamp when the version 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.
	policy			Object	Information about the update-compliance policy that is assigned to this device If a policy is not assigned, this value is null.
		id		String	Policy ID
		name		String	Policy name
	policyState			String	Policy state (translated). This can be one of the following values. No Policy Assigned Policy Assigned
	policyStateKey			String	Policy state key. This can be one of the following values. No Policy Assigned Policy Assigned
_links				Object	Resource manager URI (see Links)

The following example is returned if the request is successful for an Schneider Electric EcoStruxure IT Expert.

{
   "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"
   }
}

Table 4. VMware vRealize Operations Manager resource managers.
Attributes		Type	Description
id		String	Resource manager ID
authSource		String	Name of the authentication source for users and groups
connectTimestamp		String	Timestamp when the resource manager was registered with XClarity Orchestrator 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	Resource manager host name
	port	Integer	Resource manager port
details		Object	Information about the resource manager properties
	build	String	Resource manager build number
	uuid	String	Resource manager UUID
	version	String	Resource manager version
	versionNumber	String	Resource manager version number
groups		Array of object	Information about each group in which this resource manager is a member
	id	String	Group ID
	name	String	Group name
	type	String	Group type. This value is always ManagerGroup.
	uri	String	Group URI
healthState		String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
healthStateKey		String	Health state (translated). This can be one of the following values. Normal Non-Critical Warning Minor-Failure Major-Failure Non-Recoverable Critical Unknown
issues		Array of strings	Reason for an unhealthy status If healthState is Normal, this attribute is set to null. If healthState is not Normal, this attribute can be one of the following values. InvalidCredentials ConnectionProblems
lastInventorySyncTimestamp		String	Timestamp when XClarity Orchestrator last refreshed the inventory for the resource 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 XClarity Orchestrator last refreshed the information about the resource 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
type		String	Type of resource manager. This is always VMware vRealize Operations Manager.
_links		Object	Resource manager URI (see Links)

The following example is returned if the request is successful for a VMware vRealize Operations Manager.

{
   "id": "b17c3accec1e2a94e28b108ed757a6705c77066d",

   "authSource": "",
   "connectTimestamp": null,
   "connection": {
      "hostname": "10.243.2.107",
      "port": 443
   },
   "details": {
      "build": "41",
      "uuid": "21A727A22EECA0B85DCE38F16C7CEB1F",
      "version": "1.4.0",
      "versionNumber": 140
   },
   "groups": [],
   "healthState": "Normal",
   "healthStateKey": "Normal",
   "issues": [],
   "lastInventorySyncDate": null,
   "lastSyncTimestamp": null,
   "name": "vRO",
   "type": "VMware vRealize Operations Manager",
   "_links": {
      "rel": "self",
      "uri": "/api/v1/connector/managers/b17c3accec1e2a94e28b108ed757a6705c77066d"
   }
}

Give documentation feedback

GET /api/v1/connector/managers/{id}

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response body​