vpstat command syntax

To issue a vpstat tool command, type the number for the command preceded by the minus sign. You can optionally use a parameter list, which is specific for a command. Output from the vpstat tool can be redirected through a standard output stream redirection using the '> filename' option at the command line.

For example, to get System, Memory, Disk, Network, and Security Info for the local node written to the file MyNode.txt, type:

vpstat -1 >MyNode.txt

Common command syntax

You can pass more than one command with appropriate parameters (if any) to the vpstat tool. The common vpstat command line syntax is:

vpstat.exe [-f CfgFile] '-command' [-?|]

-f NewCfg.conf: parameter specifies a configuration file other than the default. The letter 'f', preceded by a minus sign, followed by a space, followed by the file name (path), instructs vpstat to load this file as a new configuration file. Note: When used, specify this parameter as a first parameter at the command line. This parameter is optional.
-command: command number preceded by the minus sign (number from 1 to 9). If no command is specified, all possible commands are displayed to the screen.
-?: The question mark, preceded by the minus sign in combination with the command number (example: vpstat -3 -?), prints out a command line help for the command. If used without the command number, all possible commands of the tool are listed. This parameter is not valid for the '-1' command. (No help is available for this command.)
<parameter_list>: parameter list is specific for each command. All commands, with the exception of the '-1' command, have the ability to take additional parameters. To list possible parameters for individual commands, use:
vpstat -command -?

Detailed descriptions of the <parameter_list> for each of the commands are shown in the examples.

Related Topics: