Reference Guide

Name Description Schema
is_sftp_enable
d
optional
Indicates whether the SFTP server is enabled on the NAS
server. Values are: - true - SFTP server is enabled on the
specified NAS server. - false - SFTP server is disabled on the
specified NAS server.
Default : false
boolean
is_smb_authe
ntication_ena
bled
optional
Indicates whether FTP and SFTP clients can be
authenticated using an SMB user name. These user names
are defined in a Windows domain controller, and their
formats are user@domain or domain\user. Values are: -
true - SMB user names are accepted for authentication. -
false - SMB user names are not accepted for authentication.
Default : true
boolean
is_unix_authe
ntication_ena
bled
optional
Indicates whether FTP and SFTP clients can be
authenticated using a Unix user name. Unix user names are
defined in LDAP, NIS servers or in local passwd file. Values
are: - true - Unix user names are accepted for
authentication. - false - Unix user names are not accepted
for authentication.
Default : true
boolean
message_of_th
e_day
optional
Message of the day displayed on the console of FTP clients
after their authentication. The length of this message is
limited to 511 bytes of UTF-8 characters, and the length of
each line is limited to 80 bytes.
Length : 0 - 511
string
nas_server
optional
This is the embeddable reference form of nas_server_id
attribute.
nas_server_instance
nas_server_id
optional
Unique identifier of the NAS server that is configured with
the FTP server.
string
users
optional
Allowed or denied users, depending on the value of the
is_allowed_users attribute. - If allowed users exist, only
those users and no others can connect to the NAS server
through FTP or SFTP. - If denied users exist, they have
always access denied to the NAS server through FTP or
SFTP. - If the list is empty, there is no restriction to the NAS
server access through FTP or SFTP based on the user name.
< string > array
556