The following table provides a brief description and administrative role for each command in the administrative command-line interface.
Command | Description | Roles |
---|---|---|
General | ||
exit | Ends an administrative command-line interface (CLI) session. |
Monitor, Backup, Operator, Administrator |
help | Displays a list of commands available in an administrative command-line interface (CLI) and optionally displays the syntax or brief description of each command. |
Monitor, Backup, Operator, Administrator |
quit | Ends an administrative command-line interface (CLI) session. | Monitor, Backup, Operator, Administrator |
setoutput | Sets the output format for the administrative command-line interface (CLI). | Monitor, Backup, Operator, Administrator |
Alerts and logs | ||
addsnmpmgr | Adds an SNMP manager to receive SNMP traps. To generate traps, you must add an SNMP manager and set the SNMP traps to be generated (using the settrap command). | Administrator |
catlog | Displays the contents of the various log files maintained by the administrative server and the cluster. | Monitor, Backup, Operator, Administrator |
clearlog | Clears the audit log and cluster log files. Because the event log is a subset of the cluster log, the event log is also cleared when you clear the cluster log. | Administrator |
collectdiag | Collects data on all SAN File System components running in the system and saves the diagnostic results to various files on the local file system of one or more specified engines. This command is used to assist in problem determination. | Operator, Administrator |
lssnmpmgr | Displays a list of SNMP managers and their attributes. | Monitor, Backup, Operator, Administrator |
lstrapsetting | Displays a list of event types that currently generate an SNMP trap. | Monitor, Backup, Operator, Administrator |
rmsnmpmgr | Removes an SNMP manager (recipient). | Administrator |
settrap | Specifies SNMP events to be trapped. When the event occurs, a message is sent to all SNMP managers. | Administrator |
Clients | ||
addprivclient | Grants privileged access to the SAN File System global namespace to the specified clients. | Administrator |
lsclient | Displays a list of clients that are currently being served by one or more metadata servers in the cluster. | Monitor, Backup, Operator, Administrator |
reportclient | Displays a list of clients that have access to the specified volume or logical unit number (LUN). | Monitor, Backup, Operator, Administrator |
rmprivclient | Revokes privileged access to the SAN File System global namespace from the specified clients. | Administrator |
Cluster | ||
chadvclusterconfig | Modifies the advanced cluster
settings. Note: This
command should be used only by trained service personnel.
|
Administrator |
chclusterconfig | Modifies the cluster settings that do not require a restart when changed. | Administrator |
quiescecluster | Changes the state of all metadata servers in the cluster to one of three quiescent states. | Operator, Administrator |
resumecluster | Brings all metadata servers in the cluster to the online state. | Operator, Administrator |
startcluster | Starts all metadata servers in the cluster and brings them to the full online or offline state. | Operator, Administrator |
statcluster | Displays status, network, workload, and configuration information about the cluster. | Monitor, Backup, Operator, Administrator |
stopcluster | Stops all metadata servers in the cluster gracefully. | Operator, Administrator |
upgradecluster | Verifies that all the engines in the cluster have been upgraded to the new version of the software and then initiates the cluster upgrade process. | Administrator |
Engines | ||
lsengine | Displays a list of storage engines and their attributes. | Monitor, Backup, Operator, Administrator |
restartengine | Reboots one or more storage engines. | Operator, Administrator |
startengine | Starts the CPU and operating system on one or more storage engines. | Operator, Administrator |
statengine | Displays status information about a specific storage engine. | Monitor, Backup, Operator, Administrator |
stopengine | Shuts down the operating system and powers off one or more storage engines. | Operator, Administrator |
Files | ||
mvfile | Moves one or more files from the current storage pool to a different, specified storage pool. You can also use this command to defragment a file rather than move it by specifying the same storage pool as its current storage pool. | Operator, Administrator |
statfile | Displays metadata information about the specified files. | Monitor, Backup, Operator, Administrator |
Filesets | ||
attachfileset | Attaches an existing detached fileset to a specific point in the global namespace or moves an already attached fileset to a new attach location. | Administrator |
autofilesetserver | Makes a fileset that is statically assigned to a metadata server become a dynamic fileset. This might result in the fileset being reassigned to another metadata server if required by dynamic load-balancing. | Administrator |
chfileset | Modifies the settings of a fileset. | Administrator |
detachfileset | Detaches one or more filesets from the global namespace. | Administrator |
lsfileset | Displays a list of filesets and their attributes. | Monitor, Backup, Operator, Administrator |
mkfileset | Creates a new fileset. | Administrator |
reportfilesetuse | Displays the usage statistics for pools that currently store data for the specified fileset. | Monitor, Backup, Operator, Administrator |
rmfileset | Removes one or more empty, detached filesets and optionally the files in the filesets, including any FlashCopy® images. | Administrator |
setfilesetserver | Makes a fileset become statically assigned to the specified metadata server. | Administrator |
statfileset | Displays the transaction statistics for one or more specified filesets. | Monitor, Backup, Operator, Administrator |
FlashCopy images | ||
lsimage | Displays a list of FlashCopy images in all filesets or a specified fileset. | Monitor, Backup, Operator, Administrator |
mkimage | Creates a near-instantaneous FlashCopy image of the file layout and contents of the specified fileset and stores it in that fileset. | Backup, Operator, Administrator |
reverttoimage | Reverts the specified fileset to a specified FlashCopy image of the file layout and contents. | Administrator |
rmimage | Deletes one or more FlashCopy images for a specific fileset. | Backup, Operator, Administrator |
LDAP | ||
chldapconfig | Modifies LDAP configuration settings on the metadata server. | Administrator |
statldap | Displays Lightweight Directory Access Protocol (LDAP) configuration settings. | Monitor, Backup, Operator, Administrator |
Metadata | ||
builddrscript | Converts the system-metadata disaster-recovery file into a set of recovery scripts used to re-create the system metadata in the event of a disaster. | Backup, Operator, Administrator |
lsdrfile | Displays a list of system-metadata disaster-recovery files. | Monitor, Backup, Operator, Administrator |
mkdrfile | Creates a new system-metadata disaster-recovery dump file. | Backup, Operator, Administrator |
rmdrfile | Deletes an existing system-metadata disaster-recovery dump file. | Backup, Operator, Administrator |
startmetadatacheck | Starts the utility that performs a consistency check on the metadata for the entire system or a set of filesets, generates messages in the cluster log, and optionally repairs inconsistencies in the metadata. | Administrator |
stopmetadatacheck | Stops the metadata check utility that is currently in progress. | Administrator |
Metadata servers | ||
addserver | Adds a metadata server on a specific engine to the cluster. | Administrator |
dropserver | Stops and drops a metadata server on a specific engine from the cluster. | Administrator |
lsautorestart | Displays a list of metadata servers and the automatic-restart settings for each. | Monitor, Backup, Operator, Administrator |
lsserver | Displays a list of all metadata servers in the cluster and their attributes if issued from the master metadata server, or displays attributes about the local metadata server if issued from a subordinate metadata server. | Monitor, Backup, Operator, Administrator |
setautorestart | Modifies the metadata server
restart service settings. Note: This command should be used only by trained service personnel.
|
Administrator |
setport | Sets the port values for the metadata
server Note: This command should be used only by trained service personnel.
|
Administrator |
startautorestart | Enables the metadata server to restart automatically if it is down. | Administrator |
startserver | Starts the specified metadata server. | Operator, Administrator |
statserver | Displays status, configuration, and workload information for a specific metadata server in the cluster, if the command is issued from the master metadata server. Lists status, configuration, and workload information for the local metadata server, if the command is issued from a subordinate metadata server. | Monitor, Backup, Operator, Administrator |
stopautorestart | Disables the metadata server from restart automatically if it is down. | Administrator |
stopserver | Shuts down one or more subordinate metadata servers gracefully. | Operator, Administrator |
Policies | ||
catpolicy | Displays the rules of the specified policies. | Monitor, Backup, Operator, Administrator |
lspolicy | Lists the active and inactive policies. | Monitor, Backup, Operator, Administrator |
mkpolicy | Creates a policy. | Administrator |
rmpolicy | Deletes one or more inactive policies. | Administrator |
statpolicy | Displays policy statistics for each fileset. | Monitor, Backup, Operator, Administrator |
usepolicy | Directs the metadata server to make an existing policy the active policy and applies its rules to all subsequent file creations. | Administrator |
Processes | ||
lsproc | Displays a list of long-running processes that are not yet complete and their attributes. | Monitor, Backup, Operator, Administrator |
Storage pools | ||
chpool | Modifies the settings of one or more storage pools. | Administrator |
disabledefaultpool | Disables the use of the default storage pool and makes the current default storage pool a regular user storage pool. | Administrator |
lspool | Displays a list of the existing storage pools and their attributes. | Monitor, Backup, Operator, Administrator |
mkpool | Defines one or more new user storage pools. | Administrator |
rmpool | Deletes one or more empty, unreferenced storage pools. | Administrator |
setdefaultpool | Changes a user storage pool to the default storage pool, and changes the previous default storage pool to a regular, nondefault user storage pool. | Administrator |
User mappings | ||
chdomain | Modifies the name of a domain for use with user mappings. | Administrator |
lsdomain | Lists domains for use with user mappings. | Operator, Administrator |
lsusermap | Lists the UNIX® and Windows® user mappings. A user mapping makes a user name on Windows and a user name on UNIX equivalent for file access purposes. | Monitor, Backup, Operator, Administrator |
mkdomain | Creates a domain for use with user mappings. | Administrator |
mkusermap | Creates a user mapping to make a user on Windows and a user on UNIX equivalent for file access purposes. | Administrator |
refreshusermap | Reloads a specified user mapping or all user mappings with the latest information. | Administrator |
rmdomain | Removes a domain for use with user mapping. | Administrator |
rmusermap | Removes a specified user mapping or all user mappings. | Administrator |
Users | ||
lsadmuser | Displays a list of administrative users and their attributes. | Monitor, Backup, Operator, Administrator |
resetadmuser | Forces all administrative users to log in again. | Administrator |
Volumes and LUNs | ||
activatevol | Activates a suspended volume so that the metadata server can allocate new data on the volume. | Administrator |
chvol | Modifies the settings of one or more volumes. | Administrator |
expandvol | Expands the size of one or more specified volumes. | Administrator |
lslun | Lists the logical unit numbers (LUNs) that are accessible from SAN File System. | Monitor, Backup, Operator, Administrator |
lsvol | Displays a list of available volumes. | Monitor, Backup, Operator, Administrator |
mkvol | Adds a volume to a storage pool. | Administrator |
rediscoverluns | Rediscovers logical unit numbers (LUNs) on the SAN that are visible to SAN File System. The metadata LUNs are rediscovered if no parameters are specified. | Monitor, Backup, Operator, Administrator |
reportvolfiles | Displays a list of files, and their attributes, in the specified volume. | Backup, Operator, Administrator |
rmvol | Removes one or more volumes from a storage pool and redistributes the contents to other volumes in the same storage pool. | Administrator |
suspendvol | Suspends one or more volumes so that the metadata server cannot allocate new data on the volumes. | Administrator |
activatevol
Activates a suspended volume so that the metadata server can allocate new data on the volume.addprivclient
Grants privileged access to the SAN File System global namespace to the specified clients.addsnmpmgr
Adds an SNMP manager to receive SNMP traps. To generate traps, you must add an SNMP manager and set the SNMP traps to be generated (using the settrap command).attachfileset
Attaches an existing detached fileset to a specific point in the global namespace or moves an already attached fileset to a new attach location.autofilesetserver
Makes a fileset that is statically assigned to a metadata server become a dynamic fileset. This might result in the fileset being reassigned to another metadata server if required by dynamic load-balancing.builddrscript
Converts the system-metadata disaster-recovery file into a set of recovery scripts used to re-create the system metadata in the event of a disaster.catlog
Displays the contents of the various log files maintained by the administrative server and the cluster.clearlog
Clears the audit log and cluster log files. Because the event log is a subset of the cluster log, the event log is also cleared when you clear the cluster log.collectdiag
Collects data on all SAN File System components running in the system and saves the diagnostic results to various files on the local file system of one or more specified engines. This command is used to assist in problem determination.disabledefaultpool
Disables the use of the default storage pool and makes the current default storage pool a regular user storage pool.lsclient
Displays a list of clients that are currently being served by one or more metadata servers in the cluster.lsserver
Displays a list of all metadata servers in the cluster and their attributes if issued from the master metadata server, or displays attributes about the local metadata server if issued from a subordinate metadata server.lsusermap
Lists the UNIX and Windows user mappings. A user mapping makes a user name on Windows and a user name on UNIX equivalent for file access purposes.mkimage
Creates a near-instantaneous FlashCopy image of the file layout and contents of the specified fileset and stores it in that fileset.mkusermap
Creates a user mapping to make a user on Windows and a user on UNIX equivalent for file access purposes.mvfile
Moves one or more files from the current storage pool to a different, specified storage pool. You can also use this command to defragment a file rather than move it by specifying the same storage pool as its current storage pool.quiescecluster
Changes the state of all metadata servers in the cluster to one of three quiescent states.rediscoverluns
Rediscovers logical unit numbers (LUNs) on the SAN that are visible to SAN File System. The metadata LUNs are rediscovered if no parameters are specified.reportclient
Displays a list of clients that have access to the specified volume or logical unit number (LUN).reportfilesetuse
Displays the usage statistics for pools that currently store data for the specified fileset.reverttoimage
Reverts the specified fileset to a specified FlashCopy image of the file layout and contents.rmfileset
Removes one or more empty, detached filesets and optionally the files in the filesets, including any FlashCopy images.rmprivclient
Revokes privileged access to the SAN File System global namespace from the specified clients.rmvol
Removes one or more volumes from a storage pool and redistributes the contents to other volumes in the same storage pool.setdefaultpool
Changes a user storage pool to the default storage pool, and changes the previous default storage pool to a regular, nondefault user storage pool.settrap
Specifies SNMP events to be trapped. When the event occurs, a message is sent to all SNMP managers.startcluster
Starts all metadata servers in the cluster and brings them to the full online or offline state.startmetadatacheck
Starts the utility that performs a consistency check on the metadata for the entire system or a set of filesets, generates messages in the cluster log, and optionally repairs inconsistencies in the metadata.statserver
Displays status, configuration, and workload information for a specific metadata server in the cluster, if the command is issued from the master metadata server. Lists status, configuration, and workload information for the local metadata server, if the command is issued from a subordinate metadata server.suspendvol
Suspends one or more volumes so that the metadata server cannot allocate new data on the volumes.upgradecluster
Verifies that all the engines in the cluster have been upgraded to the new version of the software and then initiates the cluster upgrade process.usepolicy
Directs the metadata server to make an existing policy the active policy and applies its rules to all subsequent file creations.
Parent topic: Commands