Skip to main content

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

Use this method to modify authentication and connection settings for a resource manager.

Attention
This REST API will be deprecated in a future release.
Note
This REST API requires Lenovo XClarity Orchestrator v1.2.0 or later.

Authentication​

Authentication with user name and password is required.

Resource URI​

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

where {id} is the ID of the resource manager. To obtain the resource manager IDs, use GET /api/v1/connector/managers.

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
opRequiredStringAction to take. This can be the following value.
  • replace. Replaces the entire attribute value with the specified value.
pathRequiredStringName of the attribute to be modified. This can be one of the following values.
  • authentication. Modifies authentication settings.
  • connection. Modifies connection settings.
  • options.enableDriveAnalyticsData. Enables or disables drive analytics-data collection for XClarity Administrator resource managers.
valueRequiredStringAttribute value, depending on the data type
The following example modifies the authentication and connection settings for an XClarity Administrator resource manager.
[
   { "op": "replace", "path": "authentication", "value": { "username": "USERID",
                                                           "password": "CME44len",
                                                           "type": "basic"}
   },
   { "op": "replace", "path": "connection", "value": { "hostname": "10.241.54.113",
                                                       "port": 443 } 
   },
   { "op": "replace", "path": "options.enableDriveAnalyticsData", "value": true
   }
]

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
404Not foundThe resource cannot be found. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
{message_attributes}variesStatus messages (see Status messages)