POST /api/v1/managers-management/managers

Use this method to connect (register) one XClarity Management Hub 2.0 or XClarity Management Hub management hubs, or connect one or more Schneider Electric EcoStruxure IT Expert, VMware vRealize Operations Manager, and Lenovo XClarity Administrator resource managers.

When connecting multiple managers, a job is created to complete this request. The response header returns the URI for the job in the Location field.

When connecting multiple managers, a successful response code indicates that the job was successfully transmitted and accepted by the orchestrator. It does not indicate that the operation that is associated with the job was successful. If a job was not successfully started, refer to the response code and response body for details.

Note

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

Authentication

Authentication with username and password is required.

Resource URI

POST https://{orchestrator_server_IP}/api/v1/managers-management/managers

Query parameters

None

Request body

Table 1. XClarity Management Hub 2.0 or XClarity Management Hub management hub
Attributes			Required / Optional	Type	Description
registrationRequest			Required	String	Registration key that is generated by the management hub

Table 2. EcoStruxure IT Expert resource managers.
Attributes			Required / Optional	Type	Description
managers			Required	Array of objects	Information about each resource manager
	authentication		Required	Object	Information about authentication settings
		token	Required	String	Token value
		type	Required	String	Authentication type. This is always token.
	connection		Optional	Object	Information about connection settings
		url	Optional	String	Resource manager URL
	name		Required	String	Resource manager name
	type		Required	String	Type of resource manager. This is always Schneider EcoStruxure IT.

Table 3. vRealize Operations Manager resource managers.
Attributes			Required / Optional	Type	Description
managers			Required	Array of objects	Information about each resource manager
	authentication		Required	Object	Information about authentication settings
		authSource	Optional	String	Name of the authentication source for users and groups To obtain a list of available authorization sources, use GET /api/v1/connector/vrealizeAuthSources.
		password	Required	String	Password to use for basic authentication
		type	Required	String	Authentication type. This is always basic.
		username	Required	String	username to use for basic authentication
	connection		Required	Object	Information about connection settings
		hostname	Required	String	Resource manager host name
		port	Required	Integer	Resource manager port
	hubID		Required	String	ID of the XClarity Management Hub used to manage this manager
	type		Required	String	Type of resource manager. This is always vRealize Operations Manager

Table 4. XClarity Administrator resource managers.
Attributes			Required / Optional	Type	Description
managers			Required	Array of objects	Information about each resource manager
	authentication		Required	Object	Information about authentication settings
		password	Required	String	Password to use for basic authentication
		type	Required	String	Authentication type. This is always basic.
		username	Required	String	Username to use for basic authentication
	connection		Required	Object	Information about connection settings
		hostname	Required	String	Resource manager host name
		port	Required	Integer	Resource manager port
	options		Required	Object	Information about options
		enableDriveAnalyticsData	Required	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. Note This attribute is supported by XClarity Administrator v3.3 and later.
	type		Required	String	Type of resource manager. This is always XClarity Administrator.

The following example connects to a management hub.

{
   "registrationRequest": "eyJzZWxmSW5mbyI6eyJ1dWlkIjoiMjNjODdmMGEtMmNiNi00OTEwLTk3NDgtOTE5MzQ0N2E
                           2NTVjIiwiaG9zdG5hbWUiOiJ4aG1jMTk0IiwiZG9tYWluIjoibGFicy5sZW5vdm8uY29tIi
                           wiZnFkbiI6InhobWMxOTQubGFicy5sZW5vdm8uY29tIiwiaXBBZGRyZXNzZXMiOlsiMTAuM
                           jQzLjIuMTA3Il0sInZlcnNpb24iOiIzLjYuMCIsImJ1aWxkIjoiNDEiLCJodWJWZXJzaW9u
                           IjoiMS4wLjAifSwiY3NyIjoiLS0tLS1CRUdJTiBDRVJUSUZJQ0FURSBSRVFVRVNULS0tLS1
                           cbk1JSUV0ekNDQXA4Q0FRQXdjakVMTUFrR0ExVUVCaE1DVlZNeEN6QUpCZ05WQkFnTUFrNU
                           RNUkF3RGdZRFZRUUhcbkRBZFNZV3hsYVdkb01ROHdEUVlEVlFRS0RBWk1aVzV2ZG04eEREQ
                           UtCZ05WQkFzTUEwbFRSekVsTUNNR0ExVUVcbkF3d2NUMjRnY0hKbGJXbHpaU0JuWVhSbGQy
                           RjVJSFJ2SUhCdmNuUmhiRENDQWlJd0RRWUpLb1pJaHZjTkFRRUJcbkJRQURnZ0lQQURDQ0F
                           nb0NnZ0lCQU1kS01UcFNzRFRuVlVlSloxa1JLc1ZCUlhUNktGYkRlYmhVSU50akgxWFRcbl
                           htMWhncEQyTDVua05sVUN1ejdMSTJOOVBLYkxWOEV1T2kxcUl1L3diR3dQMzArcU1qUjl1U
                           EorL0FUcXNUVWNcbkFFY1lFS0k0cWM4YnlKa0ZYN25qa3hpbDBQMEp6cDBzTjh3WUJTUlNE
                           SnBFOTd4dGtZcHNIaEFyRFNpYTlPamVcbit3cERnTDBRemR5TGg5djIwaVMrS21rQzE2Szc
                           yZzZmMFgwR0p1Zk1YZE5hR25zK1Q4TXNVZ3YwUUo1MTY5L3dcblY2TnVTbXVvVTM4QlY4Rn
                           lwUWxTYXQwaGt5M1lEMldhY2pnaU5tUUUyd0JaQWpqQ0tTL3pIYm1LVnQ4a3kvUlpcbmtza
                           ktsS2V4UUcvUnl6ZGVyaTREV2dzMVhkekJhNVFYNjYwcStwYmkwUVhtNDVNSGFqMnAvOVN2
                           Q2FBRlBhTUtcbk5qTkRCWkhYd0o0RTNpdlFXK3NTVkRqajJCbVY3bXZadTVOWkdDKzEydy9
                           xU2tVMW4vbDFObHhUTStvV3pqRjBcblBSZlgwWVZCbklSeUdaMGdpL1BHTUVtVlVZRmY2Y1
                           BIQWhlMmlOZVVxTWxEZnVTS2xVeGUyM0hDaUZlL2ZOL2tcblh3N2NyVVgrL1daTnRkdXZUa
                           3hwUHovMVBiL3k0cWQ3YThGeWVmTnNUYklab0Vrb1lIc3A0Z1d5d2dGbFM0YXRcbjF5Sno3
                           bzNiUmVZcnNKRzlQeFY3V204b1hiSCtZTFlyY1FkM1hsbWg3OWtyS0k0SElWRXo4SHNIOWY
                           zbWptTnlcbmlZZlMvRFV0Vkdtd2t4aENVd0hKRDJ6cER6eS9qYkQzbVJnRnZ6RzlNR2p5eF
                           NlREhVM1M2NGUyaWw5TE5RQzVcbkFnTUJBQUdnQURBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQ
                           WdFQUYxYmowS3libUJyR2VzWjRxYTFXODlkYkh6QVRcbnFGQVRacVpkdFoxYlluS29HUmFG
                           YXgzc0tUTWJuZmgyaEtnQm1KMUZ3ZUxOelFSQ3hqbHJOQzQ2cUs5S0JhQUNcbjRMQmxYWGp
                           tSmYyMDBzRkgyN3htL1NvSnlFRE1UYW5jdkFZUCswZUlRUEJDd2ZpVmFIYWpJK1l3ZlNTYW
                           lNelZcbnJyMzU1ZHlxMFJMOEljNzU5S2VoTWZpTWhiTlF4U0k0OUJPejNSMW9RQ2xlblMzW
                           llYS1FCcFE1dnRibHpKZEhcbnNOcHU4ZEs0YnY2Tm5iU0svT3U2Mm9SR3h5d1B6SUhRRWpQ
                           SFkrOHMwNXBqcnBibGRONlljQUlwZEMxdW1PS1VcbjFQWCtoY2lLNnI0YzRnN2JicW91MEt
                           VNmdDUUxwMGJiZ0xDUldIY0o1Vk92T1Vrb044UWthb09Qa05aa1Jyck9cbllFSmExQXB5YT
                           Uwb0oreUlTc05ENGtsdjFhS0xvWTlDalV6K0pLYXVoNW04VVRmaFFuSFFkY09XNVF4dWlCY
                           U5cbmxjV0VON0xTMVIvUjk4ekdqOXY4WEoxNnNKYUc1ajdaZUc3OG1DazNERTRNdGJUZUpW
                           K2VwVStBaytWbWp6WDRcbmg1c1FDaGxlRm96NWVlL0MvQWFoakJLL2tHQ1h1T1k2S3dvU1B
                           0K0xLQTF0MFRrNnlyend3SEJIRHI4dkVCMjJcbkdzOVFqcjJZaVJGZjVwYnc2YVZVWFpXOE
                           1MdUpuRHRSSXMwdzhzdmp3dmFxenFzWUxsNnNRZDVlVjdjdzdmWTRcbnlPRjNEV21qK25na
                           mZtT0haS1hEckFTUXF4dDlZNTF2RnViMmlUTjlxS0RZU2cxQWpJS2wySXVnNDRQdjB1aXFc
                           blNwNWo4dGJJcXB0ck50ND1cbi0tLS0tRU5EIENFUlRJRklDQVRFIFJFUVVFU1QtLS0tLVx
                           uIiwicHVibGljS2V5IjoiLS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS1cbk1JSUNJakFOQm
                           drcWhraUc5dzBCQVFFRkFBT0NBZzhBTUlJQ0NnS0NBZ0VBeHhGb0NsVWpkMFJLL0FmSXhpR
                           Stcbk9CNmdsdGhBZ1JCNzFWS3FnWElPWWY5UEtVYmVlZjAzdWtDU2hTWjFtZ0dXSmorUXll
                           cXNSZDBVZHRjNCs5dmdcbkFSbW4ramZOaHFGbjVmMFpNZUNNbHcrcGh4S0h1ZHlvQUEyTCt
                           IMHBlenhzWVZDUkpWeHduTzVGQXVqU3hieVJcbmNtVWt6eWRxTjQ0OEdZUXdnYkRDMDBjb1
                           BBRGxsYXdrODV6MmIwK2NmZG1VbGU4VUd3dzh3L21zWmNUbFBqVkFcbk1FWGZodHFKYUhia
                           2pDZlh5eml6RnZtanJYdDRBbitwb1lmSGYvdGlWWmQ1STBXaTBpNXR4d3pPWkxVYTZvWHhc
                           bmxhSmtpMFN3bmlmUVIyWE9pVCttV1hTRWlTQ3pZMWtwbDg5RnorQUdYMExhTjJkNFFuWFJ
                           xclVmTmFhTlNpbVBcblFzUDFxdGpQVDRxcjdWSHlMQ1drQjI0Wjl0VzFHNGR0VWVZMDJwa0
                           dJVXVwbmlwemR6UU1tOGZ5UHBFQTlNQVFcblc2SEN5RWdwdzR2eDJESWNKWE84ZDhRWWUxL
                           0gxTzU1Z0dYSGZ2Z1F1ekJUdEg0cU9uTWZ1WmxGQ3N4eStQbVZcbmNYUDRyWWU4cVBJRzdw
                           MjFCWEgydFhiNHkxZVpPUmZqa1E3TGw5ZmRudkFRYVgvMW8vQVRSNlpveFBTZEE5WXZcbnc
                           3UkpzeElIWmg1RUFzT1RadXJpczkyV0RjZ1kwTnJSRFFJUkNNYU0xZGVSU0xzSTF6ZWRVbm
                           NpNWtYK0NIU1pcbmJHdVBBNWhPK3BEdnhQOUQ4UkRSNWpJWDNTb21KOXNoNVpYa0NnakdmQ
                           WE4eU55a3k4dGdlN3hYUVJ0SSs5aUhcbml5U2FJMHpyb1Bjb1V1cEx5TkxKRkpzQ0F3RUFB
                           UT09XG4tLS0tLUVORCBQVUJMSUMgS0VZLS0tLS1cbiJ9",
}

The following example connects to a EcoStruxure IT Expert, vRealize Operations Manager, and XClarity Administrator resource manager.

{
   "managers": [{
      "authentication": {
         "token": "AK1/2sixskmmc06wj/1i6v3epcz5c25rc29jv1t00hce1pjahyobux63 ",
         "type": "token"
      },
      "connection": {
         "url": "https://api.ecostruxureit.com/rest/v1/organizations"
      },
      "name": "Croco 1",
      "type": "Schneider EcoStruxure IT"
   },
   {
      "authentication": {
        "authSource": "All vCenter Servers",
        "password": "********",
        "type": "basic",
        "username": "USERID"
      },
      "connection": {
        "hostname": "10.241.54.100",
        "port": 443
      },
      "hubID": "B7DE58431234C23839398F3AD4873923",
      "type": "vRealize Operations Manager"
   },
   {
      "authentication": {
         "password": "CME44len",
         "type": "basic",
         "username": "USERID"
      },
      "connection": {
         "hostname": "10.241.54.102",
         "port": 443
      },
      "options": {
         "enableDriveAnalyticsData": true
      },
      "type": "XClarity Administrator"
   }]
}

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 header

When connecting multiple managers, the URI and ID of the root job are returned in the Location and JobID fields respectively.

Response body

For XClarity Management Hub resource managers, when the request is successful, the following attribute is returned. If the request fails, standard message attributes are returned. For all other resource managers, standard message attributes are always returned (see Status messages).

Attributes			Type	Description
registrationKey			String	Registration key that is generated by Lenovo XClarity Orchestrator to complete the connection to the management hub To complete the connection, import the registration key in the XClarity Management Hub by clicking Administration > Hub Configuration, and clicking Install Registration Key, entering the registration key, and then clicking Submit.

The following example is returned if the request is successful.

{
   "registrationKey": "0DF4-0110-E231",
}

Give documentation feedback

POST /api/v1/managers-management/managers

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response header​

Response body​