Dell FluidFS NAS Solutions CLI Reference Guide
Notes, Cautions, and Warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2012 Dell Inc.
Contents Notes, Cautions, and Warnings...................................................................................................2 1 Command Line Interface............................................................................................................7 Overview...................................................................................................................................................................7 Accessing The CLI.................................................
monitoring-configuration........................................................................................................................................34 snmp.................................................................................................................................................................34 email.................................................................................................................................................................35 syslog......
delete................................................................................................................................................................70 edit....................................................................................................................................................................70 nfs-exports..............................................................................................................................................................
status................................................................................................................................................................84 sample..............................................................................................................................................................84 controllers........................................................................................................................................................
Command Line Interface 1 Overview The NAS cluster solution Command Line Interface (CLI) provides a convenient way to manage the NAS cluster solution. It can be used to configure subsystems, manage administrative users, enable licensed features, and to monitor the system. The CLI contains a set of commands to view, edit, add, delete, enable, disable, and set NAS cluster solution entities, such as exports, shares, volumes, and accounts.
Navigating The CLI You can navigate in the CLI in two ways: • one menu item at a time • single line command One Menu At A Time To navigate through the CLI one menu at a time: 1. Type the and press the key. 2. Type the and press the key. The available menu items and commands under the main menu is displayed. The available menu items and commands under the sub-menu is displayed. 3. Type the and press the key. The command is executed.
For example: CLI > access quota rules edit volume type [options] • access—is the name of the top level menu. • quota—is the name of the sub-menu under access. • rules—is the name of the sub-menu under quota. • edit—is the name of the command under sub-menu rules. • volume type—are the arguments that you must enter with the edit command to execute the command successfully. • [options]—are the options that you have available for a command.
Menu Menu or Command Options events The events menu lets you monitor your Dell Fluid File System by detecting normal and abnormal events. It includes the following commands: • • • monitor The monitor menu lets you monitor your Dell Fluid File System. It includes the following menus: • • • • • • • diag diagtool check-ping-to-host list start The service-pack menu lets you update the NAS solution firmware and check its installation status.
Protecting Data 2 Data protection is an important and integral part of any storage infrastructure. You can configure various methods for protecting the data in your Dell Fluid File System using the data-protection menu in the CLI including: • Replication—NAS replication is based on Dell Fluid File System snapshot technology. It uses snapshots to identify the changes between two adjacent snapshots, and only copies the modified blocks.
• replicate-now • disable • list policy The commands available under policy are: • set-weekly-policy • view • set-daily-policy • set-hourly-policy • set-type set-weekly-policy Description This command sets the policy for weekly snapshot creation for a specified NAS volume. You must define the number of snapshots that must be maintained for the weekly scheduler.
source The source NAS volume in following format: (volume name)@(system name) destination The destination NAS volume in following format: (volume name)@(system name) set-daily-policy Description This command sets the policy for daily snapshot creation for a specified NAS volume. You must define the number of snapshots that must be maintained for the daily scheduler.
[-hourlyall/-nohourlyall] Enable/disable snapshot on every hour [-hourlyat hourlyat] Comma separated list of hours to snapshot at, hours are 0-23 [-hourlystartmin hourlystartmin] Offset minute of hour to snapshot at, 0-59 [-hourlykeep hourlykeep] Number of snapshots to keep for hourly scheduler set-type Description This command sets the type of schedule for the replication policy between the source and destination NAS volumes.
source The source NAS volume in the following format: (volume name)@(system name) destination The destination NAS volume in the following format: (volume name)@(system name) add Description This command creates a replication partnership between the source volume on the source cluster and the destination volume on the destination cluster.
source The source NAS volume in the following format: (volume name)@(system name) destination The destination NAS volume in the following format: (volume name)@(system name) remove-from-replication Description This command removes the replication partnership between a source and destination NAS volumes and optionally applies the source NAS volume configuration to the destination NAS volume.
source The source NAS volume in the following format: (volume name)@(system name) destination The destination NAS volume in the following format: (volume name)@(system name) replicate-now Description This command starts the replication operation between the source and destination NAS volumes.
Syntax data-protection replication partner-systems add user_name remote_mgmt_console_VIP Where the arguments are: user_name The administrator user name of the remote cluster remote_mgmt_console_VIP The IP/Name of the remote cluster mgmt console view Description This command displays a list of the replication partners trusted by the selected system.
Where the argument is : system_name(s) The name (or comma separated names list) of the remote replication partner(s) to remove list Description This command lists the currently defined replication partners. Syntax data-protection replication partner-systems list snapshots The menus under snapshots are: • actions • policies The command available under snapshots is revert. revert Description This command reverts the data in the selected NAS volume to the contents of the selected snapshot.
Syntax data-protection snapshots actions rename volume snap_name new_snap_name Where the arguments are: volume The NAS volumes name snap_name The current snapshot name new_snap_name The new snapshot name create Description This command creates a snapshot of the specified NAS volume. You must have unique names for each snapshot.
Syntax data-protection snapshots actions view-delta volume snap_name Where the arguments are: volume The NAS volumes name snap_name The current snapshot name list Description This command lists all existing snapshots created for each NAS volume. Syntax data-protection snapshots actions list list-vol Description This command displays the snapshots created for a specified NAS volume.
volume NAS volume to set status Set status for weekly scheduler (on/ off) The options are: [-weeklyday weeklyday] Day of the week to snapshot at, days are 0-6 (0 = Monday, 6 = Sunday) [-weeklystarttimehour weeklystarttimehour] Offset hour of the day to snapshot at, 0-23 [-weeklystarttimemin weeklystarttimemin] Offset minute of the hour to snapshot at, 0-59 [-weeklykeep weeklykeep] Number of snapshots to keep for the weekly scheduler set-periodic-policy Description This command sets the policy fo
set-daily-policy Description This command sets the policy for daily snapshot creation for a specified NAS volume. You must define the number of snapshots that must be maintained for the daily scheduler.
set-hourly-policy Description This command sets the policy for hourly snapshot creation for a specified NAS volume. You must define the number of snapshots that must be maintained for the hourly scheduler.
Where the argument is: hosts The comma separated list of host:port pairs. Use none to clear the list ndmp The menus available under ndmp are: • active-jobs • configuration active-jobs The commands available under active-jobs are: • view • kill • list view Description This command displays the active backup or restore operations by session ids.
configuration The commands available under configuration are: • view • set view Description This command displays the NDMP configuration for the current user. Syntax data-protection ndmp configuration view set Description This command allows you to change NDMP configuration for the backup username.
Managing The System 3 You can manage your system wide settings from the system menu in the CLI. The management tasks include: • viewing and setting general system information • configuring the file system and network parameters • setting the required protocols • configuring authentication settings The system menu lets you configure various system-wide properties.
• cluster-id system-version The command under system-version is view. view Description This command displays the system version. Syntax system general info system-version view cluster-id The command under cluster-id is view. view Description This command displays the cluster ID. Syntax system general cluster-id view background-operations The menu under background-operations is health-scans.
level Background file-system health scan throttling level. The levels can be low, normal, high, or unlimited. enable Description This command enables file-system health scan throttling. Syntax system general background-operations health-scans enable view Description This command displays the current status for file-system health scan throttling. Syntax system general background-operations health-scans view disable Description This command disables file-system health scan throttling.
Syntax system general administrators usermod username [options] Where the argument is: username Name of the admin account to be edited the options are: [-level level] Integer value of user level, can be current user level or lower (1 is the highest level) [-email address] Comma separated list of e-mail addresses or 'None' to clear all e-mails [-filter name] Comma separated list topics and their severity (None, All, Major) separated by a dash (eg.
list-topics Description This command displays the filter topics for which e-mail alerts can be sent to various users. Syntax system general administrators list-topics view Description This command displays the user ID, user level, defined e-mail address, and list of filter topics and their severity for which the specified user receives alert e-mails. Syntax system general administrators view userdel Description This command deletes an existing user.
Syntax system general cluster-name view set Description This command allows you to change the name of the NAS cluster. Syntax system general cluster-name set name Where the argument is: New system name name licensing The commands available under licensing are: • • • • • view install delete install-instructions list view Description This command displays the status, expiration date, usage status, and so on of the specifies feature.
Syntax system general licensing delete feature-id Where the argument is : feature-id License feature-id, as it appears in the features list. install-instructions Description This command displays the instructions to install any newly downloaded license file to activate premium features. Syntax system general licensing install-instructions list Description This command lists the currently installed licenses for premium features.
This command allows you to the set the time on your NAS appliance by the timezone, NTP server IP address, and by directly entering the time in the command. Syntax system time-configuration set [options] Where the options are: [-timezone timezone] Time zone [-ntpserver server] Comma separate Name/IP of NTP server.
volume NAS volume that the exported CSV file will be placed on path Path of the directory (in the specified NAS volume) that the exported CSV file will be placed view Description This command displays the SNMP configuration details like the system contact, system location, host IP address, and so on. Syntax system monitoring-configuration snmp set Description This command sets the SNMP configuration options. You can set the system location, system contact, host IP address, and so on.
Syntax system monitoring-configuration email test-email address Where the argument is: address Address that the test email will be sent to SMTP-servers The commands available under SMTP-servers are: • set-authentication • add • view • delete • edit set-authentication Description This command allows you to change the username and password of the specified SMTP server.
This command displays the details of the configured SMTP server. Syntax system monitoring-configuration email SMTP-servers view delete Description This command deletes the specified SMTP server. Syntax system monitoring-configuration email SMTP-servers delete idx Where the argument is : Comma separated list of server IDs idx edit Description This command allows you to change the SMTP server configuration details. You can change the index of the SMTP server, the IP address, and the server description.
view-max-mail-size Description This command displays the maximum mail size in KB. Syntax system monitoring-configuration email advanced view-max-mail-size set-mail-from-address Description This command sets the e-mail address that is displayed in the From fields for e-mails.
Syntax system monitoring-configuration syslog log-monitor time-interval set timeinterval Where the argument is : time-interval seconds max-msg The commands available under max-msg are: • view • set view Description This command displays the configured value for the maximum number of identical messages per time interval. Syntax system monitoring-configuration syslog log-monitor max-msg view set Description This command allows you to set the maximum number of identical messages per time interval.
Syntax system monitoring-configuration syslog server add host/IP Where the argument is : host/IP name/IP of the Syslog server to be added view Description This command displays the host/IP addresses of the Syslog servers. Syntax system monitoring-configuration syslog server view delete Description This command deletes the specified Syslog server from the NAS cluster.
Syntax system maintenance controllers save-conf controller [options] Where the argument is: controller The controller id (e.g. 0) the option is: [-usb device] The full USB device name list Description This command displays the controller name, configuration status, and system member status of all the controllers in the NAS cluster.
attach The commands available under attach are: • status • start status Description This command displays the status of a currently running attach controller operation. Syntax system maintenance controllers attach status start Description This command starts the attach controller operation. Syntax system maintenance controllers attach start controller [options] Where the argument is: controller The controller id (e.g. 0) the options are: [-blocking/-noblocking] Block prompt until attach is done.
This command unformats the FluidFS LUNs. Syntax system maintenance luns unformat rescan Description This command rescans the NAS cluster to check if any additional luns have been added. Syntax system maintenance luns rescan list Description This command lists all existing luns and new luns identified by the system.
start Description This command starts the format operation for the file system. Syntax system maintenance luns format start expand The commands available under expand are: • status • start status Description This command displays the status of a currently running attach controller operation. Syntax system maintenance luns expand status start Description This commands starts the expand operation for the LUNs.
Fc-set NOTE: This command is not applicable to the Dell PowerVault NX3600/NX3610. Description This command auto-updates the current Fibre Channel configuration (i.e. in case the FC card was replaced) Syntax system maintenance luns configuration Fc-set iscsi-set Description This command allows you to change the iSCSI discovery IP address, username, and passwords.
set-journaling Description This command moves the file system to journaling mode so that maintenance actions can be performed. Syntax system maintenance actions set-journaling stop Description This command stops the file system. Syntax system maintenance actions stop set-mirroring Description This command moves the file system to mirroring mode. Syntax system maintenance actions set-mirroring status Description This command displays the status of the file system.
Syntax system maintenance backup-configuration entire-cluster view-system-options Description This command displays the configuration restore sources and modules for the file system. Syntax system maintenance backup-configuration view-system-options restore-system Description This command restores the configuration for the entire file system from the saved backup configuration.
This command displays the configuration restore sources and modules for the specified NAS volume. Syntax system maintenance backup-configuration view-volume-options target_conf Where the argument is: target_conf NAS volume for which configuration options will be shown protocols The menu available under protocols is cifs. cifs The menu under cifs is configuration. restart Description This command restarts the CIFS service on the NAS cluster.
[-enabled/-noenabled] Enable/Disable the CIFS protocol [-security mode] Determines how clients respond to Samba; available options: ActiveDirectory LocalUsers [-unixcharset charset] UNIX charset of share [-doscharset charset] DOS charset of share authentication The menus under authentication are: • user-mapping • active-directory • local-accounts • full-access-account • user-database The commands available under authentication are: • list-groups • list-users list-groups Description Thi
• set-hourly-policy • set-type view Description This command displays the current user mapping policy on the NAS cluster. Syntax system authentication user-mapping policy view set Description This command allows you to change the user mapping policy parameters.
[-srvstring serverString] String that will be shown in browse lists beside the machine name [-netbios NetBIOS name that will appear in the network neighborhood. This name is limited to 15 characters. The default is the system name. netbios_name] [-advanced/-noadvanced] Advanced configuration. [-workgroup workgroup] (Only for advanced mode) [-domain_controller domain_controller] Active directory Server.
groupname Name of the local group to be added the option is: [-gid GIS] Group ID that will be assigned to the group view Description This command displays the specified groupname, group ID, and the group system provided ID. Syntax system authentication local-accounts groups view groupname Where the argument is : groupname Name of the local groups to be viewed delete Description This command deletes the specified local group names.
Syntax system authentication local-accounts users add username [options] Where the argument is: username Name of the local user account to be added the options are: [-uid Uid that will be assigned to user UID] [-group Group] Primary group that will be assigned to user [-additionalGroups additionalGroups] Comma separated list of additional groups [-realname name] Full name of the user remarks] Free text for remarks [-remark view Description This command displays the user parameters for the sp
username Name of the local user account whose password you would like to change edit Description This command allows you to change the parameters of a specified user.
Syntax system authentication full-access-account delete set Description This command allows you to add a full access user account from an existing user in the Active Directory domain. Syntax system authentication full-access-account set account Where the argument is: account Active Directory account of a form: DOMAIN+username user-database The commands available under user-database are: • view • set view Description This command displays the user database configuration details.
networking The menus under networking are: • default-gateway • dns • client-connections • network-configuration • static-routes • subnets default-gateway The commands available under default-gateway are: • view • set view Description This command displays the IP address of the default client gateway. Syntax system networking default-gateway view set Description This command allows you to change the current default client gateway IP address.
set Description This command allows you to change the DNS configuration settings. You can change the host name or IP address of the DNS server and the DNS suffixes.
protocol Name of the protocol to be updated: nfs, cifs, ndmp, or other policy Policy to set: MANUAL, IMMEDIATE, AUTOMATIC mass-failback Description This command allows you to mass-failback to client connections. Syntax system networking client-connections mass-failback view Description This command displays the client connections for the specified client and system IP addresses.
This command rebalances all the client connections for the specified protocol. Syntax system networking client-connections mass-rebalance protocol Where the argument is : protocol Protocol to be mass rebalanced: nfs, cifs, ndmp, other or all list Description This command displays the client/router IP address, the access vie virtual IP address, and so on.
mtu MTU (Maximum Transmission Unit) list Description This command displays all the networks available on the NAS cluster. Syntax system networking network-configuration list static-routes The commands available under static-routes are: • add • delete • list add Description This command adds static network routes to the NAS cluster.
list Description This command lists all the static routes configured on the NAS cluster. Syntax system networking static-routes list subnets The commands available under subnets are: • add • view • delete • edit • list add Description This command adds an additional subnet on the NAS cluster. Syntax system networking subnets add subnet interface netmask [options] where arguments are: subnet Name of subnet (e.g.
Where the argument is: subnet Name of subnet (e.g. Finance) delete Description This command deletes the specified subnet. Syntax system networking subnets delete subnet Where the argument is: subnet Name of subnet (e.g. Finance) edit Description This command allows you to change the parameters of the specified subnet. Syntax system networking subnets edit subnet [options] Where the argument is: subnet Name of subnet (e.g.
4 User Access You can define and manage Dell Fluid File System from the client perspective in the access menu. The menus available under access are: • quota—A disk quota is a set of rules that restrict disk space and the number of files used by a user or a group. You can restrict the total space used in a NAS volume or the usage of users and groups within an NAS Volume using the quotas menu. • cifs-shares—CIFS shares provide an effective way of sharing files and data across a Windows network.
name Name of client to view. list Description This command lists the available quota for all the NAS volumes. Syntax access quota usage list recompute-quota The commands available under recompute-quota are: • recompute • view-status recompute Description This command recomputes the quota availability for a NAS volume.
This command adds additional quota rules to the NAS volumes. Syntax access quota rules add volume type name quotasoft quotahard Where the arguments are: volume Owner NAS volume. type Client type to configure: defuser, defgroup, user, group, ug (user in group). name Name of client to configure. required for non-default user or group. quotasoft Soft quota size for configured client: size in mega bytes or 'disabled'. quotahard Hard quota size for configured client: size in mega bytes or 'unlimited'.
edit Description This command allows you to change certain parameters in existing rules. Syntax access quota rules edit volume type [options] Where the arguments are: volume Owner NAS volume. type Client type to configure: defuser, defgroup, user, group, ug (user in group). the options are: [-name name] Name of client to configure. required for non-default user or group. [-quotasoft userSoftDef] Soft quota size for configured client: size in mega bytes or 'disabled'.
where the arguments are: shareName Name of the share to be added volume NAS volume on which share exists path Path to exported directory the options are: Create the shared folder if it does not exist [create_dir_on_the_fly/nocreate_dir_on_the_fly] [-description description] Comment beside share when querying server [-allowguests/noallowguests] Enable access by the guest account [-vetofiles files/..
Syntax access cifs-shares delete ShareName(s) [options] Where the argument is : shareName(s) The comma separated list of shares to be deleted. clear-shares Description This command disconnects all users from the NAS appliance and NAS volumes. Syntax access cifs-shares clear-shares edit Description This command allows you to change certain parameters of an existing CIFS share.
[-av_extensions extensions] Comma separated list of file extensions which should/ shouldn't be sent to antivirus [av_extensions_policy policy] Defines whether to include or exclude the files with av_extentions in antivirus check, optional values are Include or Exclude [-av_exclude_dirs dirs] Comma separated list of directory paths which should not be checked for viruses list Description This command lists all the CIFS shares on the NAS appliance.
[-vetofiles files/..
[-description description] Comment beside share when querying server [-allowguests/noallowguests] Enable access by the guest account [-vetofiles files/..
volume NAS volume of exported directory path Path to exported directory the options are: [-create_dir_on_the_fly/nocreate_dir_on_the_fly] Create the shared folder if it does not exist [-mode hostMode] Export to: everyone, host, network, netgroup [-host host/IP] Host that will be granted access to export (according to host mode option) [-netmask mask] Netmask on host mode network [-secure/-nosecure] Enable/disable use of TCP/UDP port below 1024 [-access accessMode] Access mode: ro, rw [-squas
edit Description This command allows you to change certain parameters of the NFS exports. The parameters you can change are the path, host/IP, and so on.
• add • view • delete • edit • list total-volumes-status Description This command displays the status of the complete system volume. It displays information like the system capacity, unallocated space, number of NAS volumes, and so on. Syntax access nas-volumes total-volumes-status add Description This command allows you to add additional NAS volumes.
This command displays the properties of the specified NAS volume. Syntax access nas-volumes view [volume] Where the argument is: volume The name of the NAS volume delete Description This command deletes the specified NAS volume. Syntax access nas-volumes delete [volume] edit Description This command allows you to change certain parameters in the specified NAS volume. You can change the NAS volume name, threshold, security style and so on.
[-access_time_granularity granularity] Granularity of updating file access time. Available values: Disabled, Always, Weekly, Daily, Hourly, EveryFiveMinutes. list Description This command lists all the NAS volumes on the NAS appliance. It displays the allocated space, used space, free space, and snapshot of each NAS volume.
5 Events The events menu lets you monitor your Dell Fluid File System by detecting normal and abnormal events. In the events menu, you can: • export the events list to a CSV file and save it on your system. • view the latest events generated in your file system.
[-until timeUntil] tail Description This command displays the last few lines of the events log.
Monitoring The System 6 You can monitor various components of the system, view the overall status of the system, view the quotas usage report, and receive remote replication job status reports using the monitor menu. The menus available under monitor are: • quota—You can view and change the quota configuration using the quota menu. • traffic-statistics—You can monitor the system rate traffic statistics for the file system using the traffic-statistics menu.
volume Owner NAS volume. type The client type to view. the client type may be user, group, or a user in a group name The name of client to view list Description This command lists the quotas and usage of all users including users for which no quota has been defined. It includes users that have been removed from the system but still have usage.
view_history Description This command displays the replication history between a source and destination NAS volumes. Syntax data-protection replication nas-replication view_history source destination Where the arguments are: source The source NAS volume in the following format: (volume name)@(system name) destination The destination NAS volume in the following format: (volume name)@(system name) list Description This command lists currently defined replication relationships.
PID The process ID of connection which you want to disconnect. controller The controller ID on which the process runs. export-data The commands available under export-data are: • nas-file-system-capacity • loadbalancing • performance nas-file-system-capacity Description This command exports the capacity details of the NAS file system at a given time to a CSV file and saves it at the location mentioned in the command.
performance This command exports the performance details at a given time to a CSV file and saves it at the location mentioned in the command.
status Description This command displays the status information of the NAS appliance and all the controllers in the NAS appliance.
Where the argument is: applianceId The index of a specific appliance to be viewed, for example 0 or 1.
7 Running Diagnostics Diagnostics provides a way for system administrators to troubleshoot potential issues with the system. Diagnostics can be run while the system is still online and serving data. In the diag menu you can: • Run the Dell Support Diagnostic Tool. • Check the connectivity to the host server. • View a list of available diagnostics.
start Description This command starts the diagnostic tool that you want to start. Syntax diag start name [options] where the arguments are: - Diagnostic name (refer to list command, in order to view the available diagnostics) name the options are: Possible diagnostics with relevant parameters: GeneralSystemDiagnostic FileSystemDiagnostic ProtocolsDiagnostic -action logs (default) ProtocolsDiagnostic -action client protocol cifs|nfs -client_host xxx.xxx.xxx.
[-client_host [-file_path params] params] [-nas_vol_name params] - Diagnostic parameter - Diagnostic parameter - Diagnostic parameter 89
8 Upgrading Firmware You can upgrade the firmware on your controllers, monitor the status of updates, and view the instructions to upgrade the firmware on your controller using the service-pack menu. The commands available under service-pack are: • instructions • status • start instructions Description This command provides the instructions to perform a firmware update. Syntax service-pack instructions status Description This command provides the status of the firmware update.
Getting Help 9 Contacting Dell NOTE: If you do not have an active Internet connection, you can find contact information on your purchase invoice, packing slip, bill, or Dell product catalog. Dell provides several online and telephone-based support and service options. Availability varies by country and product, and some services may not be available in your area. To contact Dell for sales, technical support, or customer service issues: 1. Visit support.dell.com. 2. Select your support category. 3.
