Copy a remote file to the file store

Copy a remote file to the file store. If you use scp or sftp,
you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.

Request:

Method:

POST

URI Path(s):

/api/v1/node/file-store/<file-name>?action=copy_from_remote_file
/api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
/api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

CopyFromRemoteFileProperties+

Name	Description	Type	Notes
port	Server port	integer	Minimum: 1 Maximum: 65535
protocol	Protocol to use to copy file	Protocol (Abstract type: pass one of the following concrete types) HttpProtocol HttpsProtocol ScpProtocol SftpProtocol	Required
server	Remote server hostname or IP address	string	Required Pattern: "^[^/:]+$"
uri	URI of file to copy	string	Required

Example Request:

POST https://<nsx-mgr>/api/v1/node/file-store/file.txt?action=copy_from_remote_file { "port" : 22, "server": "192.168.120.151", "uri" : "/tmp/file.txt", "protocol" : { "name" : "scp", "ssh_fingerprint" : "b5:08:df:c6:55:62:e4:6e:95:70:7c:25:ba:f2:46:f1", "authentication_scheme" : { "scheme_name" : "password", "username" : "root", "password" : "s4druMuJEw" } } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

FileProperties+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
created_epoch_ms	File creation time in epoch milliseconds	integer	Required
modified_epoch_ms	File modification time in epoch milliseconds	integer	Required
name	File name	string	Required Pattern: "^[^/]+$"
size	Size of the file in bytes	integer	Required

Example Response:

{ "_schema": "FileProperties", "_self": "/node/file-store/file.txt", "created_epoch_ms": 1459401409964, "modified_epoch_ms": 1459401409748, "name": "file.txt", "size": 19 }

Copy a remote file to the file store

Request:

CopyFromRemoteFileProperties (schema)

Example Request:

Successful Response:

FileProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: