System information

Manual:API

158

Command word

First word in sentence has to be command followed by attribute words and zero length word or terminating word.

Name of command word should begin with '/'. Names of commands closely follow CLI, with spaces replaced with '/'.

There are commands that are specific to API;

Command word structure in strict order:

•• encoded length

• content prefix /

•• CLI converted command

API specific commands:

getall

cancel

Command word concent examples:

/login

/ip/address/getall

/user/active/listen

/interface/vlan/remove

/system/reboot

Attribute word

Each command wordhave its own list of attribute words depending on content.

Atribute word structure consists of 5 parts in this order:

•• encoded length

• content prefix equals sigh - =

•• attribute name

• separating equals sign - =

•• value of attribute if there is one. It is possible that attribute does not have a value

Note: Value can hold multiple equal signs in the value of attribute word since the way word is encoded

Note: Value can be empty

Examples without encoded length prefix:

=address=10.0.0.1

=name=iu=c3Eeg