VNX NAS CLI Command Reference Guide

vnx1.jpg

Other CLI Reference Guides:
Isilon CLI  |  EMC ECS CLI  |  VNX NAS CLI  |  ViPR Controller CLI  NetApp Clustered ONTAP CLI  |  Data Domain CLI  |  Brocade FOS CLI

This VNX NAS CLI reference guide includes command syntax samples for more commonly used commands at the top, and a list of available commands at the bottom with a brief description of their function.  Here are some other posts on my blog that provide more specific examples of using some CLI commands, with additional detail and some scripting examples:

Undocumented VNX CLI Commands
Using the Database Query option with the VNX NAS CLI
Celerra Health Check CLI Commands
Testing Disaster Recovery with VDM’s and CIFS Servers
Checking Replication Job Throughput with the CLI
Collecting info on Actives Shares, Clients, Protocols, & Authentication with the CLI
Listing and Counting Multiprotocol File Systems from the CLI

VNX NAS CLI Command Reference (Updated January 2018):

NAS Commands:
nas_disk   -list Lists the disk table
nas_checkup Runs a system health check.
nas_pool   -size -all Lists available space on each defined storage pool
nas_replicate  -info –all | grep <fs> Info about each filesystem’s replication status, grep to view just one.
nas_replicate  -list A list of all current replications
nas_server  -list Lists all datamovers. 1=primary,4=standby,6=rdf (remote data facility)
<watch> /nas/sbin/getreason Shows current status of each datamover. 5=up, 0=down or rebooting
nas_fs Creates, deletes, extends, modifies, and lists filesystems.
nas_config Control station configuration (requires root login)
nas_version View current nas revision
nas_ckpt_schedule Manage  checkpoint schedule
nas_storage -list List the attached backend storage systems (with ID’s)
nas_storage -failback id=<x> Fail back failed over SP’s or disks
nas_server  -vdm <vdm_name> -setstate loaded Loads a VDM
nas_server  -vdm <vdm_name> -setstate mounted Unloads a VDM
/nas/sbin/t2reset pwron -s Powers on a data mover that has been shut down.
Server commands:
server_cpu server_<x> -r now Reboots a datamover
server_ping <IP> Ping any IP from the control station
server_ifconfig server_2 –all View all configured interfaces
server_route server_2 {-list,flush,add,delete} Routing table commands
server_mount Mount a filesystem
server_export Export a filesystem
server_stats Provides realtime stats for a datamover, many different options.
server_sysconfig Modifies hardware config of the data movers.
server_devconfig Configures devices on the data movers.
server_sysstat Shows current Memory, CPU, and thread utilization
server_log server_2 Shows current log
vi /nas/jserver/logs/system_log Java System log
vi /var/log/messages System Messages
server_ifconfig server_2 <interface_name> up Bring up a specific interface
server_ifconfig server_2 <interface_name> down Take a specific interface down
server_date Sets system time and NTP server settings
server_date <server_X> timesvc start ntp Starts NTP on a data mover
server_date <server_X> timesvc stats ntp To view the status of NTP.
server_date <server_X> timesvc update ntp Forces an update of NTP
server_file FTP equivalent command
server_dns Configure DNS
server_cifssupport Support services for CIFS users
nas_ckpt_schedule -create <ckpt_fs_name> -filesystem -recurrence once To create a single Checkpoint
fs_ckpt <ckpt_fs_name> -name -Create -readonly n To create a Read/Write copy of a single Checkpoint
server_export [vdm] -P cifs -name [filesystem]_ckpt1 -option netbios=[cifserver] [filesystem]_ckpt1_writeable1 To export a Read/Write checkpoint copy to a CIFS Share
server_cifs server_2 -Join compname=SERVERNAME,domain=DOMAIN.COM,admin=ADMINID Join a CIFS Server to the domain
server_cifs server_2 -Unjoin compname=SERVERNAME,domain=DOMAIN.COM,admin=ADMINID Unjoin a CIFS Server to the domain
 .server_config server_2 -v “pdc dump” To view the current domain controllers visible on the data mover
.server_config server_2 -v “pdc enable=<ip_address>” Enable a domain controller
.server_config server_2 -v “pdc disable=<ip_address>” Disable a domain controller
server_setup server_2 -P cifs -o stop Stop CIFS Service
server_setup server_2 -P cifs -o start Start CIFS Service
server_iscsi server_2 -service -start Start iSCSI service
server_iscsi server_2 -service -stop Stop iSCSI service
server_iscsi server_2 -service -status Check the status of the iSCSI service
.server_config  server_x  “logsys set  severity  NDMP=LOG_DBG2” Enable NDMP Logging [run both of these commands]
.server_config  server_x  “logsys set  severity  PAX=LOG_DBG2” Enable NDMP Logging [run both of these commands]
.server_config  server_x  “logsys  set severity  NDMP=LOG_ERR” Disable NDMP Logging [run both of these commands]
.server_config  server_x  “logsys set severity   PAX=LOG_ERR” Disable NDMP Logging [run both of these commands]
server_netstat server_x -i               Interface statistics Gather interface performance statistics
server_sysconfig server_x -v         Lists virtual devices List Virtual Devices
server_sysconfig server_x -v -i vdevice_name  Informational stats on the virtual device Informational stats on the virtual device
server_netstat server_x -s -a tcp  Retransmissions Retransmissions
server_nfsstat server_x                    NFS SRTs NFS SRTs
server_nfsstat server_x -zero        Reset NFS stats Reset NFS Stats
To view HBA Statistics:
.server_config server_2 -v “printstats fcp reset” View HBA Stats:  Toggles the service on/off
.server_config server_2 -v “printstats fcp full” View HBA Stats:  View stats table (must wait for some stats to collect before viewing)
Filesystem specific commands:
fs_ckpt Manage Checkpoints
fs_dhsm Manage File Mover
fs_group Manage filesystem groups
Complete List of  “nas_”  Commands:
nas_acl Creates, lists, and displays information for access control level entries within the table
nas_ckpt_schedule Manages SnapSure checkpoint scheduling for the VNX
nas_dbtable Displays the table records of the Control Station.
nas_emailuser Manages email notifications for serious system events
nas_inventory Provides detailed information about hardware components
nas_pool Manages the user-defined and system-defined storage pools
nas_slice Manage Slices
nas_task Manages in-progress or completed tasks
nas_automountmap Creates and displays an automount map containing all permanently exported file systems
nas_cmd nas_cmd
nas_devicegroup Manages an established MirrorView/Synchronous consistency group
nas_event Provides a user interface to system-wide events
nas_license Enables software packages.
nas_quotas Manages quotas for mounted file systems.
nas_stats Manages Statistics Groups.
nas_version Displays the software version running on the Control Station.
nas_cel Performs management of remotely linked VNX or a linked pair of Data Movers.
nas_copy Creates a replication session for a one-time copy of a file system.
nas_disk Manages the disk table.
nas_fs Manages local file systems for the VNX.
nas_logviewer Displays the content of nas_eventlog generated log files.
nas_replicate Manages loopback, local, and remote VNX Replicator sessions.
nas_storage Controls storage system access and performs some management tasks
nas_volume Manages the volume table.
nas_checkup Provides a system health checkup for the VNX.
nas_cs Manages the configuration properties of the Control Station.
nas_diskmark Queries the system, manages and lists the SCSI devices configuration.
nas_fsck Manages fsck and aclchk utilities on specified file systems.
nas_message Displays message description.
nas_server Manages the Data Mover (server) table.
nas_symm nas_symm
nas_xml nas_xml
Complete list of  “server_”  Commands:
server_archive Reads and writes file archives, and copies directory hierarchies.
server_cifssupport Provides support services for CIFS users.
server_file Copies files between the Control Station and the specified Data Movers.
server_log Displays the log generated by the specified Data Mover.
server_name Manages the name for the specified Data Movers.
server_ping6 Checks the IPv6 network connectivity for the specified Data Movers.
server_sysconfig Manages the hardware configuration for the specified Data Mover(s).
server_vtlu Configures a virtual tape library unit (VTLU) on the specified Data Movers
server_arp Manages the Address Resolution Protocol (ARP) table for the Data Movers.
server_cpu Performs an orderly, timed, or immediate halt or reboot of a Data Mover.
server_ftp Configures the FTP server configuration for the specified Data Movers.
server_mgr server_mgr (deprecated?)
server_netstat Displays the network statistics for the specified Data Mover.
server_rip Manages the Routing Information Protocol (RIP) configuration
server_sysstat Displays the operating system statistics for the specified Data Movers.
server_cdms Provides File Migration Service for VNX functionality
server_date Displays or sets the date and time for a Data Mover, and synchronizes time
server_http Configures the HTTP configuration file for independent services
server_mount Mounts file systems and manages mount options
server_nfs Manages the NFS service, including secure NFS and NVSv4
server_route Manages the routing table for the specified Data Movers.
server_tftp Manages the Trivial File Transfer Protocol (TFTP)
server_cepp Manages the Common Event Publishing Agent (CEPA) service
server_dbms Enables backup and restore of databases, displays database environment statistics.
server_ifconfig Manages the network interface configuration
server_mountpoint Manages mount points for the specified Data Movers.
server_nfsstat server_nfsstat (deprecated?)
server_security Manages GPO Policy settings for CIFS Servers
server_umount Unmounts file systems
server_certificate Manages VNX for file system’s Public Key Infrastructure (PKI)
server_devconfig Queries, saves, and displays the SCSI over Fibre Channel device configuration
server_ip Manages the IPv6 neighbor cache and route table for VNX.
server_mpfs Sets up and configures MPFS protocol.
server_nis Manages the Network Information Service (NIS) configuration
server_setup Manages the type and protocol component for the specified Data Movers.
server_uptime Displays the length of time that a specified Data Mover has been running since the last reboot
server_checkup Checks the configuration parameters, and state of a Data Mover and its dependencies
server_df Reports free and used disk space and inodes for mounted file systems
server_iscsi server_iscsi (deprecated?)
server_mpfsstat server_mpfsstat (deprecated?)
server_param Manages parameter information for the specified Data Movers.
server_snmpd Manages the Simple Network Management Protocol (SNMP) config values
server_usermapper Provides an interface to manage the Internal Usermapper service.
server_cifs Manages the CIFS configuration for the specified Data Movers or VDMs
server_dns Manages the Domain Name System (DNS) lookup server config
server_kerberos Manages the Kerberos configuration within the specified Data Movers.
server_mt Manages the magnetic tape drive for the specified Data Mover.
server_pax Displays and resets backup and restore statistics and file system information for a backup session already in progress.
server_standby Manages the standby and RDF relationships for the specified Data Movers.
server_version Displays the software version running on the specified Data Movers.
server_cifsstat server_cifsstat (deprecated?)
server_export Exports file systems and manages access on the specified Data Movers for NFS/CIFS clients
server_ldap Manages the LDAP-based directory client configuration and LDAP over SSL
server_muxconfig server_muxconfig (deprecated?)
server_ping Checks the network connectivity for the specified Data Movers.
server_stats Displays sets of statistics that are running on the specified Data Mover.
server_viruschk Manages the virus checker configuration for the specified Data Movers.
Complete list of  “fs_” Commands:
fs_ckpt Manages checkpoints using the EMCSnapSure functionality.
fs_dedupe Manages filesystem deduplication state.
fs_dhsm Manages the VNX FileMover file system connections.
fs_group Creates a file system group from the specified file systems or a single file system
fs_rdf Manages the Remote Data Facility (RDF) functionality for a file system residing on RDF drives.
fs_timefinder Manages the TimeFinderTM/FS functionality for the specified filesystem

A Roundup of Storage Startups

Blockchain and Enterprise Storage

Advertisements

38 thoughts on “VNX NAS CLI Command Reference Guide”

  1. Very useful page – thanks. There is a distinct lack of cli commands referenced online and I ended up specifically requesting the cli guide from EMC as I could not find a link to it on their website…

  2. where do i run these commands from? do i have to have the command line agent? currently trying to get av software to run on a virtual server with CAVA.

    1. The commands need to be run from a control station login. You can connect directly to the control station with a terminal emulator (I use putty). There is no host agent for the celerra that’s similar to the Navipshere CLI.

  3. Hi, how to verify
    – How many shares?
    – How many clients (windows vs *nix) ?
    – Which protocol (SMB vs NFS) ?
    – Authentication type (LDAP, AD) ?
    – Virusscan information (Cava server list, product version, etc..)

  4. Hi – we recently moved a celerra but now getting the following error messages after running the /nas_checkup script..
    ————————————-Checks————————————-
    Control Station: Checking if NBS clients are started………………….. Pass
    Control Station: Checking if NBS configuration exists…………………. Pass
    Control Station: Checking if NBS devices are accessible……………….. Fail
    Control Station: Checking if NBS service is started…………………… Fail
    Control Station: Checking if NAS partitions are mounted……………….. Pass
    Data Movers : Checking status……………………………………. ?
    ——————————————————————————–

    Any help would be greatly appreciated .
    Thanks in advance..

    1. NBS is the Network Block Service, which is a proprietary client/server protocol of VNX/Celerra for file that provides a block device (for example,
      iSCSI device) management functionality over a TCP/IP connection. You can check the parameter by typing server_param server_2 -facility nbs -list, then check the settings for each parameter with server_param server_2 -facility nbs -info *param_name*. To be honest, I’m not at all familiar with NBS, if EMC support is available to you I’d recommend opening an SR. Sorry I can’t be of more help.

  5. I like the valuable info you provide in your articles.

    I will bookmark your weblog and check again here frequently.
    I’m quite sure I’ll learn a lot of new stuff right here! Best of luck for the next!

  6. Great info — thanks for collecting! Very helpful. One suggestion — to allow people to be able to cut’n’paste, some of the commands were put into uppercase (probably an automatic “correction” by your blog software); for example, “Nas_fs”, “Server_stats”, and “Fs_group” are examples of commands not found (because of the initial capital letter). There are also 3 commands with syntax “..server_config” (two leading dots) instead of “.server_config” (one leading dot). For newbies, might have problem debugging what went wrong, and this is so wonderful I wanted to help you make it “perfect” 🙂

    1. You can use -p in the command if you want to specify tcp, udp, icmp, or ip. It is not a required parameter. Here is the syntax: server_netstat movername [ -A {inet|inet6} ][ -a ][ -i ][ -r ][ -s ] [ -p {tcp|udp|icmp|ip} ]

  7. Is there any command to view the domain controller which Celerra contacts for SID lookups? I am creating home folders by a tool and Celerra doesn’t find the newly created users when setting permissions and throws the error – ‘Error 1337 : Invalid SID structure’. It seems celerra doesn’t find users in the DC it contacts. Can we change the DC preference of Celerra for lookups?

    1. It is possible to see which DC’s are being used by the Celerra. To view the current domain controllers visible on the data mover run this command:
      .server_config server_2 -v “pdc dump”

      That command will show you all of the domain controllers that the Celerra can see. It pulls the info from DNS. A successful connection to a DC will show a ‘Cnx=SUCCESS,DC request succeeded’ in the output. If you want to disable certain DC’s from being used, you can enable or disable a domain controller on the data mover with these commands:
      .server_config server_2 -v “pdc enable=0.0.0.0” Enable a domain controller
      .server_config server_2 -v “pdc disable=0.0.0.0” Disable a domain controller

      With that said, I don’t believe there is a specific command to change the preference for lookups. That’s just my experience, however, there could be a way I’m not aware of. I’ll do a little research and post again if I find anything. Remember that the .server_config command is undocumented from EMC. If you decide to use it, I would recommend opening an SR before using the above mentioned commands on a production system, test it on a test/dev array first. Use the .server_config command at your own risk!

        1. I don’t have any firsthand experience with the issue you’re having so I can’t say for certain that setting those parameters will help, but on the surface it does look like you’d be ok to do it. I of course don’t work for EMC so you’d need to contact them for assurance that it won’t cause another problem. I read that that changing those parameters will trigger SID-to-Name lookup attempts to the Domain Controller for any orphaned SID detected, which could cause performance problems between the Celerra and the DC, so be warned.

          You can modify those CIFS Parameters using the server_param command:

          # server_param server_2 -facility cifs -modify acl.mappingErrorAction -value 3
          # server_param server_2 -facility cifs -modify acl.retryAuthSid -value 600
          # server_param server_2 -facility cifs -modify acl.FailOnSDRestoreError -value 0

  8. This drove me crazy for a few hours …

    When running the below command you have to ensure that you leave off the initial “/” in the export directory you want to add.

    Ex. server_export server_2 -Protocol nfs -name exports/usr/home/ace /ace/path1

    So in this example I wanted to add /exports/usr/how/ace to the /ace/path1 filesystem. After many attempts I found out that I can not have the initial “/” in the command. I couldn’t find this in any documentation and it was trial and error until I figured it out. Perhaps this is common knowledge but just thought I’d share.

    1. Check the following:

      – The source file system MUST be mounted Read-Only (what’s easier is to create a checkpoint of the FS)
      – The destination file system:
      ….. MUST be the same size or larger than the source file system.
      ….. MUST also be mounted Read Only
      – The ReplicatorV2 license must be enabled for nas_copy to work, that is, nas_license -create replicatorV2.

  9. Hi . this is amazing site. You are doing great job. Wondering if you can help me. What is the command to check on LUN’s through CLI

    1. Thanks. Use nas_disk -list to view the connected LUNs. The fifth column in the output is a dash with a four digit number. This number is a hexadecimal representation of the Clariion/VNX LUN (for example, 021D = LUN 541).

      Sample Output:

      [nasadmin@celerra ~]$ nas_disk -list
      id inuse sizeMB storageID-devID type name servers
      17 y 511999 CKM00111009999-0078 MIXED d17 1,2
      18 y 511999 CKM00111009999-0207 MIXED d18 1,2
      19 y 511999 CKM00111009999-0085 MIXED d19 1,2
      20 y 511999 CKM00111009999-0215 MIXED d20 1,2
      21 y 511999 CKM00111009999-021C MIXED d21 1,2
      22 y 511999 CKM00111009999-021B MIXED d22 1,2
      23 y 511999 CKM00111009999-021E MIXED d23 1,2

      1. Thanks EMCSAN.

        here is what i have
        id inuse sizeMB storageID-devID type name servers
        1 y 11263 BB000C29BC4788-0000 CLSTD root_disk 1,2
        2 y 11263 BB000C29BC4788-0001 CLSTD root_ldisk 1,2
        3 y 2047 BB000C29BC4788-0002 CLSTD d3 1,2
        4 y 2047 BB000C29BC4788-0003 CLSTD d4 1,2
        5 y 2047 BB000C29BC4788-0004 CLSTD d5 1,2
        6 y 14335 BB000C29BC4788-0005 CLSTD d6 1,2
        7 y 11503 BB000C29BC4788-0010 CLSTD d7 1,2
        8 y 11503 BB000C29BC4788-0011 CLSTD d8 1,2
        9 y 11503 BB000C29BC4788-0012 CLSTD d9 1,2
        10 y 11503 BB000C29BC4788-0013 CLSTD d10 1,2
        11 y 11503 BB000C29BC4788-0014 CLSTD d11 1,2
        12 y 11503 BB000C29BC4788-0015 CLSTD d12 1,2
        13 y 11503 BB000C29BC4788-0016 CLSTD d13 1,2
        14 y 11503 BB000C29BC4788-0017 CLSTD d14 1,2
        15 y 11503 BB000C29BC4788-0018 CLSTD d15 1,2
        16 y 11503 BB000C29BC4788-0019 CLSTD d16 1,2
        i am actually using virtual VNX through VSA.

        One of my major problems is that all the sudden in Unisphere I no longer can see disks and LUN’s tab under storage

        Not sure how to fix it . Any advice would highly appreciated

        1. Unfortunately I don’t know off the top of my head what would be causing that issue for you. This is one of those times I’d probably open an SR with EMC.

  10. Appreciating the persistence you put into your site and detailed information you offer.

    It’s awesomee to come across a blog every once in a while that isn’t the same old rehashed information.
    Fantastic read! I’ve saved your site and I’m including your RSS feeds to my Google account.

  11. What’s Happening i am new to this, I stumbled upon this I have
    found It absolutely useful and it has helped me out loads.
    I hope to give a contribution & aid different customers like its aided me.
    Great job.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.