/snmp
SNMP settings
edit
Edit items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
value-name | enum (contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-version) | Name of editable property |
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 | |
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
Parameter | Type | Description | Additional Notes |
---|---|---|---|
value-name | enum (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 values of item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
as-value | Type: switch value: True | Prints out output as value (used in scripting) | |
default-config | Type: switch sysc: 3 value: True | ||
file | Type: string | Print the content of the submenu into specific file | |
interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval | |
without-paging | Type: switch value: True | Displays information in one piece |
send-trap
Parameter | Type | Description | Additional Notes |
---|---|---|---|
oid | Type: string | ||
type | enum (counter32 | integer | ip-address | nullobj | obj-id | string | timeticks | unsigned) | ||
value | Type: string |
set
Change item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
contact | Type: string | 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 | enum ({'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{34,1}'}]}) | ||
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} | ||
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 | enum (1 | 2 | 3) |
/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': []}}]}}]}}]} | ||
authentication-password | Type: string sensitive: True | ||
authentication-protocol | enum (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 | enum (AES | DES) | ||
name | Type: string | Community name | |
read-access | Type: bool | Enables or disables the read access for the community | |
security | enum (authorized | none | private) | ||
write-access | Type: bool |
edit
Edit items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
number | Type: arg_node | Item number | |
value-name | enum (addresses | authentication-password | authentication-protocol | encryption-password | encryption-protocol | name | read-access | security | write-access) | Name of editable property |
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 | |
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
Parameter | Type | Description | Additional Notes |
---|---|---|---|
where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) |
get
Gets value of item's property
Parameter | Type | Description | Additional Notes |
---|---|---|---|
number | Type: arg_node | Item number | |
value-name | enum (addresses | authentication-password | authentication-protocol | default | encryption-password | encryption-protocol | name | read-access | security | write-access) | Name of the value you want to get |
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 | |
as-value | Type: switch interesting: False value: True | Prints out output as value (used in scripting) | |
brief | Type: switch value: True | Displays brief description | |
count-only | Type: switch value: True | Shows only the count of special login users | |
default-config | Type: switch sysc: 3 value: True | ||
detail | Type: switch value: True | Displays detailed information | |
file | Type: string | Print the content of the submenu into specific file | |
follow | Type: switch value: True | Updates output in real-time | |
follow-only | Type: switch value: True | Will output changes that have occured after invoking command | |
follow-strict | Type: switch value: True | ¯_(ツ)_/¯ (Requires: Option.npk) | |
from | Type: arg_node noexport: True | Print parameters only from specified item | |
interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval | |
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 | |
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
Parameter | Type | Description | Additional Notes |
---|---|---|---|
numbers | Type: arg_node | List of item numbers |
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': []}}]}}]}}]} | ||
authentication-password | Type: string sensitive: True | ||
authentication-protocol | enum (MD5 | SHA1) | ||
encryption-password | Type: string sensitive: True | ||
encryption-protocol | enum (AES | DES) | ||
name | Type: string | Community name | |
numbers | Type: arg_node | List of item numbers | |
read-access | Type: bool | Enables or disables the read access for the community | |
security | enum (authorized | none | private) | ||
write-access | Type: bool |