setoutput

Sets the output format for the administrative command-line interface (CLI).

Read syntax diagramSkip visual syntax diagram
>>-setoutput--+----------+--+-------------------------------+--->
              +- –?----+  |          .-default----------. |
              +- –h----+  '- –fmt--+-delim--character-+-'
              '- –help-'             '-xml--------------'

>--+----------------+--+------------------+--------------------->
   |        .-off-. |  |          .-on--. |
   '- –p--+-on--+-'  '- –hdr--+-off-+-'

>--+---------------+--+----------------+-----------------------><
   '- –r--number-'  |        .-off-. |
                      '- –v--+-on--+-'

Parameters

–? | –h | –help
Displays a detailed description of this command, including syntax, parameter descriptions, and examples. If you specify a help option, all other command options are ignored.
–fmt
Specifies the format of the output. You can specify one of the following values:
default
Specifies to display output in a tabular format using spaces as the delimiter between the columns. This is the default value. For example:
Name      Type     Size (GB)   Used (GB)   Used (%)   Alert (%)
===============================================================
DEFAULT   Default      10000        2500         25          80

Volumes   Partition Size (MB)   Description
====================================================
     10                    64   Default Storage Pool
delim character
Specifies to display output in a tabular format using the specified character to separate the columns. If you use a shell metacharacter (for example, * or \t) as the delimiting character, enclose the character in single quotation mark (') or double quotation mark ("). A blank space is not a valid character. For example:
DEFAULT,Default,10000,2500,25,80,10,64,Default Storage Pool
xml
Specifies to display output using XML format, for example:
<IRETURNVALUE>
<INSTANCE CLASSNAME="STC_StoragePool">
<PROPERTY NAME="Name" TYPE="string"><VALUE>DEFAULT_POOL</VALUE>
</PROPERTY>
<PROPERTY NAME="PoolType" TYPE="uint32"><VALUE>1</VALUE>
</PROPERTY>
<PROPERTY NAME="PartitionSize" TYPE="uint64"><VALUE>16</VALUE>
</PROPERTY>
<PROPERTY NAME="AlertPercentage" TYPE="uint16"><VALUE>80</VALUE>
</PROPERTY>
<PROPERTY NAME="Size" TYPE="uint64"><VALUE>0</VALUE></PROPERTY>
<PROPERTY NAME="SizeAllocated" TYPE="uint64"><VALUE>0</VALUE>
</PROPERTY>
<PROPERTY NAME="SizeAllocatedPercentage" TYPE="uint16"><VALUE>0
</VALUE></PROPERTY>
<PROPERTY NAME="NumberOfVolumes" TYPE="uint32"><VALUE>0</VALUE>
</PROPERTY>
<PROPERTY NAME="Description" TYPE="string"><VALUE>Default storage pool
</VALUE></PROPERTY>
</INSTANCE>
</IRETURNVALUE>
–p
Specifies whether to display one page of text at a time or all text at once.
off
Displays all text at one time. This is the default value when the cli command is run in single-shot mode.
on
Displays one page of text at time. Pressing any key displays the next page. This is the default value when the cli command is run in interactive mode.
–hdr
Specifies whether to display the table header.
on
Displays the table header. This is the default value.
off
Does not display the table header.
–r number
Specifies the number of rows per page to display when the –p parameter is on. The default is 24 rows. You can specify a value from 1 to 100.
–v
Specifies whether to enable verbose mode.
off
Disables verbose mode. This is the default value.
on
Enables verbose mode.

Description

The output format set by this command remains in effect for the duration of the administrative command-line interface (CLI) session or until the options are reset either by using this command or by specifying a output-format parameter as part of a command.

Running this command with no parameters displays the current output settings in the default output format, for example:
Paging   Rows   Format    Header   Verbose
==========================================
off      -      default   on       off
Note: The output formats do not apply to help pages.

Example

Set the output format The following example sets the output format to display in tabular form using a comma as the delimiter without header information:
admin_cli_utility>setoutput -fmt delim , -hdr off
admin_cli_utility>lspool -l -type default
DEFAULT,Default,10000,2500,25,80,10,64,Default Storage Pool

Parent topic: Common commands

Terms of use | Feedback
(C) Copyright IBM Corporation 2003, 2004. All Rights Reserved.