Use this method retrieve information about a specific remote file-server profile.
Authentication with user name and password is required.
GET https://{management_server_IP}/osImages/remoteFileServers/{id}
where {id} is the ID of an remote file-server profile. To obtain the ID, use the GET /osImages/remoteFileServers method.
None
None
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. |
404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Attributes | Type | Description | ||
---|---|---|---|---|
address | String | IP address of the remote file server | ||
keyType | String | Type of encryption algorithm. This can be one of the following
values.
|
||
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 | ||
username | String | User name to connect to the remote file server. | ||
result | String | Result of the request. This can be one of the
following values.
|
||
messages | Array | 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 | Array | 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 |
{
"address": "192.168.1.10",
"keyType": "RSA-2048",
"port": 8080,
"protocol": "SFTP",
"serverId": "100",
"serverPublicKey": "KLAJDSLFAKEUIJ387U28379…"
"result": "success",
"messages": [{
"id": "FQXHMSE0001I",
"explanation": "",
"recovery": {
"text": "Informationonly;noactionisrequired.",
"URL": ""
},
"text": "Therequestcompletedsuccessfully."
}]
}