Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Premier Sign In Partner Program Sign In

Dell Unity™ Family Unisphere® Management REST API Programmer's Guide

PDF

Downloading and uploading NAS server configuration files

You can download or upload the following types of NAS server configuration files:

LDAP schema
When configuring NAS server LDAP settings, the NAS server attempts to connect to the LDAP server and detect the default LDAP schema, based on the LDAP type. You can download the default schema file, customize it, and then upload the customized file to the NAS server. If the schema is valid, it is applied to the NAS server configuration.
LDAP Configuration Authority (CA) certificate
If the storage system uses LDAPS (LDAP using SSL) to communicate with the LDAP server, you might be required to upload the CA certificate to the NAS server. If the verification fails, or the LDAP server does not present a certificate, the connection is refused.
User mapping file (applies to multiprotocol NAS servers only)
When configuring a multiprotocol NAS server, the following types of user mappings are required:
  • A Windows user must map to a corresponding Unix user in order to access a file system.
  • A Unix user must map to a corresponding Windows user when using NFS to access a file system configured with a Windows access policy.
    NOTE A Unix user does not have to map to a corresponding Windows user when using NFS to access a file system configured with a Unix or native access policy.
The system automatically maps a Windows user to a Unix user when the same user name is defined to the Unix Directory Service (UDS) and Windows Active Directory (AD). If the user names are different, you can download a user mapping file template, customize it, and upload the customized file to the NAS server.
Antivirus configuration (applies to multiprotocol and SMB NAS servers)
Common AntiVirus Agent (CAVA) provides an antivirus solution to the client using a NAS server, and uses third-party antivirus software to identify and eliminate known viruses before they infect files on the storage system. You can download the current antivirus configuration file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
Local files - users
The user password file is a type of local file that defines which users can access the NAS server. It is used for resolving Unix users for NFS and FTP. Each line of the user password file contains the username, encrypted password (optional), user ID (UID) and group ID (GID). You can download the current user password file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE If a directory service is enabled, the local files are checked before the directory service.
Local files - groups
The groups file is a type of local file that defines the groups to which users belong. Each line of the group file contains the group name, GID and list of UIDs of group members. You can download the current group file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE If a directory service is enabled, the local files are checked before the directory service.
Local files - hosts
The hosts file is a type of local file that defines which hosts can access the NAS server. Each line of the hosts file contains the IP address, corresponding host name and an optional alias. You can download the current hosts file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE If a directory service is enabled, the local files are checked before the directory service.
Local files - network groups
The network groups file is a type of local file that contains a list of network group names with the list of hostnames for hosts belonging to the group. In addition to mapping hosts to network groups, it also maps users to network groups. Each line of the network group file contains the group name and members such as hosts and other groups. You can download the current network groups file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE If a directory service is enabled, the local files are checked before the directory service.
User mapping diagnostics report (applies to multiprotocol NAS servers only)
The user mapping diagnostics report is generated to confirm that the user mappings are properly configured. It also lists both resolved and unresolved users. You can generate a user mapping diagnostic report before enabling multiprotocol sharing or checking a multiprotocol NAS server for mapping issues. You can only download the generated user mapping diagnostics report after it is created. You cannot upload an existing user mapping diagnostics report.
Kerberos key table
The Kerberos key table (keytab) file is required for secure NFS services with Linux or Unix Kerberos Key Distribution Center (KDC). It contains service principal names (SPNs), encryption methods, and keys for secure NFS service. You can download the current keytab file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE A DNS server is required to join or unjoin a Kerberos server to a realm.
Local files - home directory
The homedir configuration file is defined with user names and home directories. Each line of the homedir configuration file contains a Windows domain (optional), a user name, a home directory related to the NAS server root and non-mandatory options. You can download the current homedir file, customize it, and then upload the customized file to the NAS server. If the file is valid, it is supplied to the NAS server configuration.
NOTE If a directory service is enabled, the local files are checked before the directory service.

Syntax for downloading a configuration file from a NAS server

To download a configuration file from a NAS server to the local host, use the following request components:

Headers 
Accept: application/json
Content-Type: application/json
X-EMC-REST-CLIENT: true
Operation 
GET
URI pattern 
/download/<protocolType>/nasServer/<nasServerId>
where:
  • <protocolType> is the type of configuration file to download. Values are:
    • 1 - Ldap_Configuration (LDAP schema file)
    • 2 - Ldap_CA_Certificate
    • 3 - Username_Mappings
    • 4 - Virus_Checker_Configuration
    • 5 - Users
    • 6 - Groups
    • 7 - Hosts
    • 8 - Netgroups
    • 9 - User_Mapping_Report
    • 10 - Kerberos_Key_Table
    • 11 - Homedir
  • <nasServerId> is the unique identifier of the NAS server from which you want to download a configuration file.
Body
Empty.

A successful download request returns a 200 OK HTTP status code. If the request does not succeed, the server returns a 4nn or 5nn HTTP status code in the response header and a message entity in the response body.

Syntax for uploading a configuration file from a NAS server

To upload a configuration file from the local host to a NAS server, use the following request components:

Header 
Accept: application/json
Content-Type: application/json
X-EMC-REST-CLIENT: true
Operations 
POST
URI pattern 
/upload/<protocolType>/nasServer/<nasServerId>
where:
  • <protocolType> is the type of configuration file to upload. Values are:
    • 1 - Ldap_Configuration (LDAP schema file)
    • 2 - Ldap_CA_Certificate
    • 3 - Username_Mappings
    • 4 - Virus_Checker_Configuration
    • 5 - Users
    • 6 - Groups
    • 7 - Hosts
    • 8 - Netgroups
    • 10 - Kerberos_Key_Table
    • 11 - Homedir
  • <nasServerId> is the unique identifier of the NAS server to which you want to upload a configuration file.
Body
None.
Usage
You must POST the configuration file using a multipart/form-data format as if from a simple web page form, like that shown in the following example: 
<html>
 <body>
   <form enctype="multipart/form-data" method="post"
     action="https://<IP_address>/upload/<protocol_type>/nasServer/<nas_server_id>">
     <input type="file" "name="filename"/> 
      <input type="submit"/> 
    </form>
 </body>
</html
>

A successful upload request returns 200 OK HTTP status code. If the request does not succeed, the server returns a 4nn or 5nn HTTP status code in the response header and a message entity in the response body.

Example 1: Downloading an LDAP schema file from a NAS server

The following example downloads an LDAP schema file from the NAS server that has an id of nas_1 to the local host:

Header 
Accept: application/json
X-EMC-REST-CLIENT: true
Request 
GET https://10.108.253.216/download/1/nasServer/nas_1
Request body
Empty.
Response body (raw) for a successful response
Contains the downloaded LDAP schema file.

Example 2: Uploading an LDAP schema file to a NAS server

The following example uploads LDAP schema file ldap1.conf from the local host to NAS server nas_1:

Header 
Accept: application/json
X-EMC-REST-CLIENT: true
EMC-CSRF-TOKEN: <token>
Request 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <body>
    <form enctype="multipart/form-data" method="post"
       action="https://10.108.253.216/upload/1/nasServer/nas_1">
        <input type="file" name="filename"/>
        <input type="submit"/>
    </form>
  </body>

filename="ldap1.conf"
Request body
Empty.
Response body (raw) for a successful response
Empty.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\