Skip to main content
Hitachi Vantara Knowledge

Set FTP logging config for a virtual server

Sets FTP configuration parameters for a virtual server.

HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/virtual-servers/{virtualServerId}/ftp/logging
Name Type Required Values Description
virtualServerId URI_PARAM Y string/number Specifies either the virtual server object ID or the HNAS storage virtual server ID.
filesystemIdBODYNstringHNAS filesystem ID that will hold the logs files. The filesystem should be assigned to the virtual server.
ensurePathExistsBODYNbooleanTrue to ensure the specified path exists.
isEnabledBODYNbooleanTrue to enable FTP logging, False to disable logging.
loggingDirectoryBODYNstringAbsolute file system path to use for storing the log files. The path should be in UNIX format.
numberOfLogFilesBODYNintegerMaximum number of log files.
numberOfRecordsPerFileBODYNintegerNumber of records each log file can contain. When this value is reached a new log file will be created.
Return codes
Code Data Description
204 No Data FTP logging config successfully updated.
400 Error Message Missing or invalid request contents.
403Error MessageOperation forbidden by access level.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.

Any HTTP status code other than 204 indicates that the API did not complete successfully.

Request example: Enable logging, and set the number of log files to 5
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" -X PATCH -d '{"isEnabled": true, "numberOfLogFiles": 5}'
Response example
HTTP/1.1 204 No Content


  • Was this article helpful?