POST /api/v1/connector/managers

Use this method to connect (register) one or more resource managers.

Attention

This REST API will be deprecated in a future release. Use POST /api/v1/managers-management/managers instead.

A job is created to complete this request. The response header returns the URI for the job in the Location field.

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.

Important

You must be a member of a user group to which the predefined Supervisor role is assigned.

Authentication

Authentication with user name and password is required.

Resource URI

POST https://{orchestrator_server_IP}/api/v1/connector/managers

Query parameters

None

Request body

Table 1. Lenovo 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	User name 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.

Table 2. Schneider Electric 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. VMware 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
		password	Required	String	Password to use for basic authentication
		username	Required	String	User name to use for basic authentication
	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.
	connection		Required	Object	Information about connection settings
		hostname	Required	String	Resource manager host name
		port	Required	Integer	Resource manager port
	type		Required	String	Type of resource manager. This is always vRealize Operations Manager

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

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

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
400	Bad Request	A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
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 header

The URI and ID of the root job are returned in the Location and JobID fields respectively, for example:

Location: /api/v1/jobs-management/jobs/56?childrenLevels=-1
jobID: 56

Response body

Attributes			Type	Description
`{message_attributes}`			`varies`	Status messages (see Status messages)

Give feedback

POST /api/v1/connector/managers

Authentication​

Resource URI​

Query parameters​

Request body​

Response codes​

Response header​

Response body​