POST /aicc/service/sftp/locks
Use this method to start (enable) the SFTP service for a specific function and acquire an SFTP service lock by creating a lock ID.
Note
- You must be a member of a user group to which the predefined Supervisor role is assigned.
- This REST API requires Lenovo XClarity Administrator v4.1.0 or later.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/aicc/service/sftp/locks
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| component | Required | String | Predefined Lenovo XClarity Administrator component ID. This can be one of the following values.
| ||
| expirationTimeOut | Required | Integer | Amount of time, in seconds, after which the lock expires When the lock expires, the lock ID is deleted and if there are no other locks, the SFTP service is stopped (disabled). | ||
The following example starts the SFTP service for the updates function and deletes the lock ID after 20 minutes.
{
"component": "UP",
"expirationTimeOut": 1200
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 201 | Created | One or more new resources were successfully created. |
| 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. Ensure that you have privileges to perform the request. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response header
If the SFTP service is successfully locked, the lock ID is returned in the location field in response header, for example:
location:/aicc/service/sftp/locks/FE3L4N5L6N9D8FVLSDLS0S223JSNLSE3
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| messages | Array of objects | Information about one or more messages | ||
| id | String | Message identifier of a returned message | ||
| text | String | Message text associated with the message identifier | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| recovery | Array of objects | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
The following example is returned if the request is successful.
{
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"explanation": "",
"text": "The request completed successfully.",
"recovery": {
"text": "Information only. No action is required.",
"URL": ""
}
}]
}
Give documentation feedback