NAME

vicfg-nas - manipulate NAS file systems on an ESX/ESXi host.

SYNOPSIS

 vicfg-nas [<conn_options>]
     [--add --nasserver <server_name> --share <share_name> |
      --delete <share_name> |
      --help |
      --list |
      --nasserver <server_name> |
      --readonly |
      --vihost <esx_host ]

DESCRIPTION

The vicfg-nas command manipulates NAS file systems associated with ESX/ESXi hosts. For more information on working with NAS file systems, see the ESX Configuration Guide and the ESXi Configuration Guide.

OPTIONS

--add | -a: Adds a new NAS file system to /vmfs/volumes on the ESX/ESXi host. The command adds an entry to the known NAS file system list, but does not mount the file system. When you use this option, you must also use the --nasserver|-o and --share|-s options, and must specify a label name for the new file system.
connection_options: Specifies the target server and authentication information if required. Run vicfg-nas --help for a list of all connection options.
--delete | -d <share_name>: Deletes a NAS file system. This command unmounts the NAS file system and removes it from the list of known file systems.
--help: Prints a help message for each command-specific and each connection option. Calling the script with no arguments or with --help has the same effect.
--list | -l: Optional. Lists all known NAS file systems with their mount name, share name, and host name and indicates for each file system whether it is mounted.
--nasserver | -o <server_name>: Used in conjunction with the --add|-a option to supply the host name for a new NAS file system.
--share | -s <share_name>: Used in conjunction with the --add|-a option to supply the share name of a new NAS file system.
--readonly | -y: Adds the new NAS filesystem with readonly access.
--vihost | -h: When you run a vCLI command with the --server option pointing to a vCenter Server system, use --vihost to specify the ESX/ESXi host to run the command against.

EXAMPLES

The following examples assume you are specifying connection options, either explicitly or, for example, by specifying the server, user name, and password. Run vicfg-nas --help for a list of common options including connection options.

List all known NAS file systems with their mount name, share name, and hostname and indicate whether each is mounted:

 vicfg-nas <conn_options> -l

Add a new NAS file system to the ESX Server. This will add an entry to the known NAS file system list. You must supply the host name and the share name for the new NAS file system:

 vicfg-nas <conn_options> -a -o <nasserver> -s /home FileServerHome

Add a new readonly NAS file system to the ESX Server. This will add an entry to the known NAS file system list. You must supply the host name and the share name for the new NAS file system:

 vicfg-nas <conn_options> -a -y -o <nasserver> -s /home FileServerHome

Delete a NAS file system. The command unmounts the NAS file system and removes it from the list of known file systems:

 vicfg-nas <conn_options> -d FileServerHome