Technical References

Description

The nrcmd commands fall into two basic groups: regular and

irregular. The regular commands manipulate configuration objects such

as DHCP Scopes and DNS Zones in a standard fashion. The irregular

commands do everything else that is useful. This man page will

describe the general pattern of the regular commands. The

behavior of the irregular commands will be described in their

individual man pages.

Regular Command form

Regular commands provide common functions for creating, deleting,

viewing and editing objects of a given class.

Create

<cmd> <name> create [<required args>] [<prop>=<val>]

Delete

<cmd> <name> delete

List

<cmd> list

Modify

<cmd> <name> set <prop>=<value> [<prop>=<value> ...]

The set command takes two forms: 'set <prop> <value>' for setting

a single properties's value, and 'set <prop>=<value> ...' for

setting multiple values in a single command.

Errors include:

unknown property

- if <prop> is not an property name for the object

invalid format

- if <value> is not in a valid format

invalid value

- if <value> is not semantically valid

The get command returns the value of the named property.

<cmd> <name> unset <prop> [<prop> ...]

The unset command makes the named properties have no value.

<cmd> <name> enable <feature>

The enable command sets the value of the named feature to true.

<cmd> <name> disable <feature>

The enable command sets the value of the named feature to false.

<cmd> <name> show

The show command displays the value of the object.

Class specific commands (methods)

The configuration behavior of some objects may be enhanced by the

addition of class specific commands to perform a useful action such

as modifying complex properties, or controlling the objects

behavior.