N1 Service Provisioning System 4.1 Reference Guide

Required Arguments and Optional Arguments

This command descriptions in this manual and the description of each command available through its help flag use the following notation to describe required arguments and optional arguments for commands.

Table 4–5 O/R Notation for Arguments


Notation	What It Means
[O]	Argument is optional
[R]	Argument is required.
[O/R]	Argument is usually optional, but may be required in some cases.

For example, the help information for the hdb.h.add command lists the following arguments:

-u [O/R]: The user username
for authentication: String -p [O/R]: The user password
for authentication: String
-s [O/R]: The session ID for authentication: SessionID
-name: The host name: String
-desc [O]: The host description: String
-tID: The ID of the host type: HostTypeID
-attr [O/R]: The host attributes; required if the host
type requires them: Hashtable

In this example, the only required arguments are the host name (-name) and the host type ID (-tID), in addition to the arguments required to authenticate the user or the session. However, if the host type of the new host requires host attributes to be specified, then the -attr argument must be used as well.

Note –

As the example above shows, the help information for command does not use the notation [R] to identify required arguments. Arguments that are required are simply listed without [O] or [O/R]. See the -name argument above for an example.