Skip to main content

GET /osImages/remoteFileServers/{id}

Use this method retrieve information about a specific remote file-server profile.

Note
This REST API requires Lenovo XClarity Administrator v1.3.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

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.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
403ForbiddenThe 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.

404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
addressStringIP address of the remote file server
keyTypeStringType of encryption algorithm. This can be one of the following values.

  • RSA-2048

  • RSA-4096

  • ECDSA-521-secp521r1

portIntegerPort number
protocolStringServer protocol. This can be one of the following values.

  • HTTP

  • HTTPS

  • FTP

  • SFTP

serverIdStringProfile ID for the remote file server
serverPublicKeyStringXClarity Administrator generated public key
usernameStringUser name to connect to the remote file server.
resultStringResult of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
messagesArrayInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned message
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 textStringMessage text associated with the message identifier
The following example is returned if the request is successful.
{
   "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."
   }]
}