Versions Compared

Old Version 4

changes.mady.by.user Māris B.

Saved on

compared with

New Version 5

changes.mady.by.user Māris B.

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterTypeDescriptionAdditional Notes
value-name
Type: enum
const_mapping: contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-version
Type: enum
mapping: [{'type': 'const', 'name': 'contact'}, {'type': 'const', 'name': 'enabled'}, {'type': 'const', 'name': 'engine-id'}, {'type': 'const', 'name': 'location'}, {'type': 'const', 'name': 'src-address'}, {'type': 'const', 'name': 'trap-community'}, {'type': 'const', 'name': 'trap-generators'}, {'type': 'const', 'name': 'trap-interfaces'}, {'type': 'const', 'name': 'trap-target'}, {'type': 'const', 'name': 'trap-version'}]
Name of editable property
/td

export

Print or save an export script that can be used to restore configuration
Name of editable property

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults
file
Type: string
File name
Name of the file that will be stored in FTP access area.
hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed
terse
Type: switch
value: True
Creates export with output without line wraps
verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
value-name
Type: enum
const_mapping: contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-version
Name of the value you want to get

print

Print values of item properties
ParameterParameterTypeDescriptionAdditional Notes
compactas-value
Type: switch
value: True
Only exports user-changed settings without defaults
/td
Prints out output as value (used in scripting)
default-config
Type: switch
sysc: 3
value: True
file
Type: string
File name
Name Print the content of the file that will be stored in FTP access area.
/td
submenu into specific file
intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval
without-paginghide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed
/td		terse
Type: switch
value: True
Creates export with output without line wraps
/td		verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)
/td

get

Displays information in one piece

send-trap

ParameterTypeDescriptionAdditional Notes
oid
Type: string
type
Type: enum
const_mapping: counter32 | integer | ip-address | nullobj | obj-id | string | timeticks | unsigned
value
Type: string

set

Change item propertiesGets value of item's property
ParameterTypeDescriptionAdditional Notes
value-namecontact
Type: enumconst_mapping: contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-versionstring
Informative only settings for the NMS
enabled
Type: bool
Defines whether SNMP service is enabled or not
SNMP service is disabled by default
engine-id
Type: string
location
Type: string
Informative only settings for the NMS
src-address
Type: alt
ip: ip_arg
ip6: ip6_arg
trap-community
Type: enum
other_mapping: [ {'typeproducer': 'constremote_mapping', 'namesub': 'contact'}, [{'typekey': 'constpath', 'namevalue': 'enabled '}, {34,1}'}]}
trap-generators
Type: multi_arg
+arg: {'producer'type': 'constenum_arg', 'name'sub': [{'key': 'engine-id#mapping'}, 'value': {'typeproducer': 'const', 'namesub': 'location'}, [{'typekey': 'const', 'namevalue': 'src-address'}, {'type{'producer': 'constremote_mapping', 'namesub': 'trap-community'}, [{'typekey': 'constpath', 'namevalue': 'trap-generators'{34,2}'}]}}]}}, {'typekey': 'constacc', 'namevalue': 'trap-interfaces'}, {'typeproducer': 'const"u0"', 'name': 'trap-target'}, {'type': 'const', 'name': 'trap-version'}]
Name of the value you want to get
/td

print

Print values of item properties

...

Type: switch
value: True

...

Prints out output as value (used in scripting)

...

Type: switch
sysc: 3
value: True

...

Type: string

...

Print the content of the submenu into specific file

...

Displays information and refreshes it in selected time interval

...

sub': []}}]}
switchIds: {4294967295}
trap-interfaces
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u19"', 'sub': []}}]}
trap-target
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"be u10"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"ae"', 'sub': []}}, {'key': 'sysc', 'value': 0}]}}]}}]}
trap-version
Type: enum
const_mapping: 1 | 2 | 3

/snmp/community

SNMP community management

add

Create a new item

...

Type: switch
value: True

...

Displays information in one piece

...

send-trap

...

Type: string

...

Type: enum
const_mapping: counter32 | integer | ip-address | nullobj | obj-id | string | timeticks | unsigned
Type: enum
mapping: [{'type': 'const', 'name': 'counter32'}, {'type': 'const', 'name': 'integer'}, {'type': 'const', 'name': 'ip-address'}, {'type': 'const', 'name': 'nullobj'}, {'type': 'const', 'name': 'obj-id'}, {'type': 'const', 'name': 'string'}, {'type': 'const', 'name': 'timeticks'}, {'type': 'const', 'name': 'unsigned'}]
constant: True

...

Type: string

...

set

Change item properties
ParameterTypeDescriptionAdditional Notes
contactaddresses
Type: string
Informative only settings for the NMS
/td		enabled
Type: bool
Defines whether SNMP service is enabled or not
SNMP service is disabled by default
/td
obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value':
engine-id
Type: string
/tdlocation
Type: string
Informative only settings for the NMS
/td		src-address
Type: alt
ip: ip_arg
ip6: ip6_arg
/tdtrap-community
Type: enum
other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'pathip', 'value': ' {34,1}'}]}
Type: enum
mapping: [{'producer': 'remoteip_prefix_mappingarg', 'sub': [{'key': 'pathacc1', 'value': '{34,1}'}]}]
/tdtrap-generators
Type: multi_arg
+arg: {'producer': 'enum_arg"be u8"', 'sub': []}}, {'key': '#mappingacc2', 'value': {'producer': '"be u9"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'remoteip6_prefix_mappingarg', 'sub': [{'key': 'pathacc1', 'value': {'producer': '"a16"'{34, 2}'}]}}'sub': []}}, {'key': 'accacc2', 'value': {'producer': '"u0u17"', 'sub': []}}]}}]}switchIds: {4294967295}]}
/td
trap-interfacesauthentication-password
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u19"', 'sub': []}}]}
/tdtrap-target
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"be u10"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"ae"', 'sub': []}}, {'key': 'sysc', 'value': 0}]}}]}}]}
/tdtrap-version
Type: enum
const_mapping: 1 | 2 | 3
Type: enum
mapping: [{'type': 'const', 'name': '1'}, {'type': 'const', 'name': '2'}, {'type': 'const', 'name': '3'}]
constant: True
/td

/snmp/community

SNMP community management

add

Create a new item

...

Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u8"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u9"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a16"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u17"', 'sub': []}}]}}]}}]}

...

Type: string
sensitive: True

...

Type: enum
const_mapping: MD5 | SHA1
Type: enum
mapping: [{'type': 'const', 'name': 'MD5'}, {'type': 'const', 'name': 'SHA1'}]
constant: True

...

Type: arg_node
noexport: True

...

ID of item to make a copy from

...

Type: string
sensitive: True

...

Type: enum
const_mapping: AES | DES
Type: enum
mapping: [{'type': 'const', 'name': 'AES'}, {'type': 'const', 'name': 'DES'}]
constant: True

...

Type: string

...

Community name

...

Type: bool

...

Enables or disables the read access for the community

...

Type: enum
const_mapping: authorized | none | private
Type: enum
mapping: [{'type': 'const', 'name': 'authorized'}, {'type': 'const', 'name': 'none'}, {'type': 'const', 'name': 'private'}]
constant: True

...

Type: bool

...

edit

Edit items

...

Type: arg_node

...

Item number

...

Type: enum
const_mapping: addresses | authentication-password | authentication-protocol | encryption-password | encryption-protocol | name | read-access | security | write-access
Type: enum
mapping: [{'type': 'const', 'name': 'addresses'}, {'type': 'const', 'name': 'authentication-password'}, {'type': 'const', 'name': 'authentication-protocol'}, {'type': 'const', 'name': 'encryption-password'}, {'type': 'const', 'name': 'encryption-protocol'}, {'type': 'const', 'name': 'name', 'help': 'Community name'}, {'type': 'const', 'name': 'read-access', 'help': 'Enables or disables the read access for the community'}, {'type': 'const', 'name': 'security'}, {'type': 'const', 'name': 'write-access'}]

...

Name of editable property

...

export

Print or save an export script that can be used to restore configuration

...

Type: switch
value: True

...

Only exports user-changed settings without defaults

...

Type: string

...

File name
Name of the file that will be stored in FTP access area.

...

Type: switch
value: True

...

Hides sensitive information like passwords from beeing printed

...

Type: switch
value: True

...

Creates export with output without line wraps

...

Type: switch
value: True

...

Creates output with all RouterOS settings (including the default ones)

...

find

Find items by value

...

Type: query_arg
query: True

...

Generates output depending on values supplied (used mainly for scripting)

...

string
sensitive: True
authentication-protocol
Type: enum
const_mapping: MD5 | SHA1
copy-from
Type: arg_node
noexport: True
ID of item to make a copy from
encryption-password
Type: string
sensitive: True
encryption-protocol
Type: enum
const_mapping: AES | DES
name
Type: string
Community name
read-access
Type: bool
Enables or disables the read access for the community
security
Type: enum
const_mapping: authorized | none | private
write-access
Type: bool

edit

Edit items
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
value-name
Type: enum
const_mapping: addresses | authentication-password | authentication-protocol |

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
/td		value-name
Type: enum
const_mapping: addresses | authentication-password | authentication-protocol | default | encryption-password | encryption-protocol | name | read-access | security | write-accesswrite-access
Name of editable property

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: enumswitch
value: True
Only exports user-changed settings without defaults
file
Type: string
File name
Name of the file that will be stored in FTP access area.
hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed
terse
Type: switch
value: True
Creates export with output without line wraps
verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
value-name
Type: enum
const_mapping: addresses | authentication-password | authentication-protocol | default | encryption-password | encryption-protocol | name | read-access | security | write-accessmapping: [{'type': 'const', 'name': 'addresses'}, {'type': 'const', 'name': 'authentication-password'}, {'type': 'const', 'name': 'authentication-protocol'}, {'type': 'const', 'name': 'default'}, {'type': 'const', 'name': 'encryption-password'}, {'type': 'const', 'name': 'encryption-protocol'}, {'type': 'const', 'name': 'name', 'help': 'Community name'}, {'type': 'const', 'name': 'read-access', 'help': 'Enables or disables the read access for the community'}, {'type': 'const', 'name': 'security'}, {'type': 'const', 'name': 'write-access'}]
Name of the value you want to get
/td

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file
/td
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)
/td
brief
Type: switch
value: True
Displays brief description
/td
count-only
Type: switch
value: True
Shows only the count of special login users
/td
default-config
Type: switch
sysc: 3
value: True
/td
detail
Type: switch
value: True
Displays detailed information
/td
file
Type: string
Print the content of the submenu into specific file
/td
follow
Type: switch
value: True
Updates output in real-time
/td
follow-only
Type: switch
value: True
Will output changes that have occured after invoking command
/td
follow-strict
Type: switch
value: True
¯_(ツ)_/¯ (Requires: Option.npk)
/td
from
Type: arg_node
noexport: True
Print parameters only from specified item
/td
item
intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval
/td
proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'addresses', 'value': 1}, {'key': 'authentication-password', 'value': 7}, {'key': 'authentication-protocol', 'value': 5}, {'key': 'default', 'value': 17}, {'key': 'encryption-password', 'value': 8}, {'key': 'encryption-protocol', 'value': 6}, {'key': 'name', 'value': 0}, {'key': 'read-access', 'value': 3}, {'key': 'security', 'value': 2}, {'key': 'write-access', 'value': 4}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Community name'}, {'key': 3access', 'value': 'Enables or disables the read access for the community'}]}}]}4}]}}, {'key': 'acchelp', 'value': {'producer': '"ufd0007"', 'sub': []}{'key': 0, 'value': 'Community name'}, {'key': 'hint'3, 'value': 'Name of the value you want to get'Enables or disables the read access for the community'}]}}]}}]}}, {'key': 'setUnsetAccacc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties
/td		show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)
/td		terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format
/td		value-list
Type: switch
interesting: False
value: True
Show properties one per line
/td		where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)
/td		without-paging
Type: switch
value: True
Displays information in one piece
/td

remove

Remove item

...

ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties
show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)
terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format
value-list
Type: switch
interesting: False
value: True
Show properties one per line
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)
without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbers
Type: arg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
addresses
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg

...

Type: arg_node

...

List of item numbers

...

set

Change item properties
ParameterTypeDescriptionAdditional Notes
addresses
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u8"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u9"', 'sub': []}}]}}, {'key': 'ipv6ip', 'value': {'producer': 'ip6ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a16be u8"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u17be u9"', 'sub': []}}]}}]}}]}
/td
, {'key': 'ipv6', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a16"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u17"', 'sub': []}}]}}]}}]}
authenticationauthentication-password
Type: string
sensitive: True
/tdauthentication-protocol
Type: enum
const_mapping: MD5 | SHA1
Type: enum
mapping: [{'type': 'const', 'name': 'MD5'}, {'type': 'const', 'name': 'SHA1'}]
constant: True
/tdencryption-password
Type: string
sensitive: True
/td
encryptionauthentication-protocol
Type: enum
const_mapping: AES MD5 | DES
Type: enum
mapping: [{'type': 'const', 'name': 'AES'}, {'type': 'const', 'name': 'DES'}]
constant: True
SHA1
encryption-password
Type: string
sensitive: True
encryption-protocol
Type: enum
const_mapping: AES | DES
/td
name
Type: string
Community name
/td
numbers
Type: arg_node
List of item numbers
/td
read-access
Type: bool
Enables or disables the read access for the community
/td
security
Type: enum
const_mapping: authorized | none | private
Type: enum
mapping: [{'type': 'const', 'name': 'authorized'}, {'type': 'const', 'name': 'none'}, {'type': 'const', 'name': 'private'}]
constant: True
/td
Type: enum
const_mapping: authorized | none | private
write-access
Type: bool
/td