PUT /osImages/remoteFileServers/{id}
Use this method to modify a remote file-server profile.
The public key is returned in the response body. The generated private key is stored in Lenovo XClarity Administrator.
Note
This REST API requires Lenovo XClarity Administrator v1.3.0 or later.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/osImages/remoteFileServers/{id}
where {id} is the ID of the remote file-server profile to be modified. To obtain the ID, use the GET /osImages/remoteFileServers method.
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| address | Required | String | IP address of the remote file server | ||
| displayName | Required | String | User-defined name of the remote file server | ||
| keyComment | Optional | String | Key comment | ||
| keyPassphras | Optional | String | Key passphrase | ||
| keyType | Optional | String | Type of encryption algorithm. This can be one of the following values.
| ||
| password | Optional | String | Password to connect to the remote file server | ||
| port | Required | Integer | Port number | ||
| protocol | Required | String | Server protocol. This can be one of the following values.
| ||
| serverId | Optional | String | Profile ID for the remote file server If specified, the profile is modified. If not specified, a new profile is created. | ||
| username | Optional | String | User name to connect to the remote file server | ||
The following example modifies a remote file-server profile using a user name and password.
{
"address" : "192.168.1.10",
"password" : "Passw0rd",
"port" : 8081,
"protocol" : "HTTPS",
"username" : "admin"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 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 body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| address | String | IP address of the remote file server | ||
| keySignature | String | SFTP server key signature | ||
| port | Integer | Port number | ||
| protocol | String | Server protocol. This can be one of the following values.
| ||
| serverId | String | Profile ID for the remote file server | ||
| serverPublicKey | String | XClarity Administrator generated public key | ||
| result | String | Results of the request. This can be one of the following values.
| ||
| messages | Array of objects | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | Object | 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 | ||
| text | String | Message text associated with the message identifier | ||
The following example is returned if the request is successful.
{
"address" : "192.168.1.10",
"keySignature" : "WJILKEKJLKJLKSJ092039230948…",
"port" : 8080,
"protocol" : "SFTP",
"serverId" : "100",
"serverPublicKey" : "KADKJADSKF94JK9O$#@@5983739AD…",
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"explanation": "",
"recovery": {
"text": "Information only; no action is required.",
"URL": ""
},
"text": "The request completed successfully."
}]
}
Give documentation feedback