Tivoli command syntax

The following special characters define Tivoli® command syntax:

[ ]

Identifies elements that are optional. Required elements do not have brackets around them.

...

Indicates that you can specify multiple values for the previous element. Separate multiple values by a space, unless otherwise directed by command information.

If the ellipsis for an element follows a closing bracket, use the syntax within the brackets to specify multiple values. For example, to specify two administrators for the option [–a admin]..., use –a admin1 –a admin2.

If the ellipsis for an element is within the brackets, use the syntax of the last element to specify multiple values. For example, to specify two hosts for the option [–h host...], use –h host1 host2.

|

Indicates mutually exclusive information. You can use the element on either the left or right of the vertical bar.

{ }

Delimits a set of mutually exclusive elements when a command requires one of them. Brackets ([ ]) are around elements that are optional.

The following example illustrates the typeface conventions used in Tivoli command syntax:

itmcmd agent [-l] [ -h install_dir ] [ -o instance ] [ -p option ] [-c] [-s] start|stop {pc|all}

The start|stop and {pc|all} parameters are the only required parameters for the itmcmd agent command. The brackets around the -l, -h, -o, -p, -c, and -s parameters indicate that they are optional. The braces around {pc|all} indicate that you must either specify a product code (pc) or choose to start or stop all components.

[ Top of Page | Previous Page | Next Page | Contents | Index ]