/snmp
SNMP settings
edit
Edit items
Parameter | Type | Description | Additional 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
Parameter | Type | Description | Additional Notes |
---|---|---|---|
compact | Type: switch value: True | Only exports user-changed settings without defaults /td | |
file | Type: string | File name Name of the file that will be stored in FTP access area. /td | |
hide-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
Gets value of item's property
Parameter | Type | Description | Additional 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 the value you want to get /td |
Print values of item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
as-value | Type: switch value: True | Prints out output as value (used in scripting) /td | |
default-config | Type: switch sysc: 3 value: True | /td | |
file | Type: string | Print the content of the submenu into specific file /td | |
interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval /td | |
without-paging | Type: switch value: True | Displays information in one piece /td |
send-trap
Parameter | Type | Description | Additional Notes |
---|---|---|---|
oid | Type: string | /td | |
type | 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 | /td | |
value | Type: string | /td |
set
Change item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
contact | 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 | |
engine-id | Type: string | /td | |
location | Type: string | Informative only settings for the NMS /td | |
src-address | Type: alt ip: ip_arg ip6: ip6_arg | /td | |
trap-community | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{34,1}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{34,1}'}]}] | /td | |
trap-generators | Type: multi_arg +arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{34,2}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]} switchIds: {4294967295} | /td | |
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': []}}]} | /td | |
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}]}}]}}]} | /td | |
trap-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
Parameter | Type | Description | Additional 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': 'ipv6', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a16"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u17"', 'sub': []}}]}}]}}]} | /td | |
authentication-password | Type: string sensitive: True | /td | |
authentication-protocol | Type: enum const_mapping: MD5 | SHA1 Type: enum mapping: [{'type': 'const', 'name': 'MD5'}, {'type': 'const', 'name': 'SHA1'}] constant: True | /td | |
copy-from | Type: arg_node noexport: True | ID of item to make a copy from /td | |
encryption-password | Type: string sensitive: True | /td | |
encryption-protocol | Type: enum const_mapping: AES | DES Type: enum mapping: [{'type': 'const', 'name': 'AES'}, {'type': 'const', 'name': 'DES'}] constant: True | /td | |
name | Type: string | Community name /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 | |
write-access | Type: bool | /td |
edit
Edit items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
number | Type: arg_node | Item number /td | |
value-name | 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 /td |
export
Print or save an export script that can be used to restore configuration
Parameter | Type | Description | Additional Notes |
---|---|---|---|
compact | Type: switch value: True | Only exports user-changed settings without defaults /td | |
file | Type: string | File name Name of the file that will be stored in FTP access area. /td | |
hide-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 |
find
Find items by value
Parameter | Type | Description | Additional Notes |
---|---|---|---|
where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td |
get
Gets value of item's property
Parameter | Type | Description | Additional 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-access Type: enum mapping: [{'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 values of item properties
Parameter | Type | Description | Additional 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 | |
interval | time [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': 3, 'value': 'Enables or disables the read access for the community'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', '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
Parameter | Type | Description | Additional Notes |
---|---|---|---|
numbers | Type: arg_node | List of item numbers /td |
set
Change item properties
Parameter | Type | Description | Additional 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': 'ipv6', 'value': {'producer': 'ip6_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"a16"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"u17"', 'sub': []}}]}}]}}]} | /td | |
authentication-password | Type: string sensitive: True | /td | |
authentication-protocol | Type: enum const_mapping: MD5 | SHA1 Type: enum mapping: [{'type': 'const', 'name': 'MD5'}, {'type': 'const', 'name': 'SHA1'}] constant: True | /td | |
encryption-password | Type: string sensitive: True | /td | |
encryption-protocol | Type: enum const_mapping: AES | DES Type: enum mapping: [{'type': 'const', 'name': 'AES'}, {'type': 'const', 'name': 'DES'}] constant: True | /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 | |
write-access | Type: bool | /td |