/radius
Radius client settings
add
Create a new item
Parameter | Type | Description | Additional Notes |
---|---|---|---|
accounting-backup | Type: bool | Radius accounting backup /td | |
accounting-port | num [1 .. 65535] | Radius accounting port /td | |
address | Type: alt ip-address: ip_arg ipv6-address: ip6_arg | The address of radius /td | |
authentication-port | num [1 .. 65535] | Default port 1645 to RFC /td | |
called-id | Type: string | Called identity /td | |
certificate | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'checkId1', 'value': 'u5b'}, {'key': 'checkValue1', 'value': 1}, {'key': 'path', 'value': '{19,1}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'checkId1', 'value': 'u5b'}, {'key': 'checkValue1', 'value': 1}, {'key': 'path', 'value': '{19,1}'}]}] | Certificate file to use for communicating with RADIUS Server with RadSec enabled /td | |
comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
copy-from | Type: arg_node noexport: True | ID of item to make a copy from /td | |
disabled | Type: bool | Defines whether item is ignored or used /td | |
domain | Type: string | The domain of the radius /td | |
place-before | Type: arg_node noexport: True | Item number /td | |
protocol | Type: enum const_mapping: radsec | udp Type: enum mapping: [{'type': 'const', 'name': 'radsec'}, {'type': 'const', 'name': 'udp', 'help': 'user datagram protocol'}] constant: True | Specifies the protocol to use when communicating with RADIUS Server /td | |
realm | Type: string | Explicitly stated realm (user domain) The users do not have to provide proper ISP domain name in user name if this is specified /td | |
secret | Type: string sensitive: True | PPP secret name /td | |
service | Type: ubit_arg bitspec: {'producer': '', 'sub': [{'key': 'dhcp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4096}, {'key': 'ormask', 'value': 4096}]}}, {'key': 'dot1x', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16384}, {'key': 'ormask', 'value': 16384}]}}, {'key': 'hotspot', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 512}, {'key': 'ormask', 'value': 512}]}}, {'key': 'ipsec', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8192}, {'key': 'ormask', 'value': 8192}]}}, {'key': 'login', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'ppp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'wireless', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1024}, {'key': 'ormask', 'value': 1024}]}}]} | Name of the service /td | |
src-address | Type: alt ip-address: ip_arg ipv6-address: ip6_arg | Source IP/IPv6 address of the packets sent to RADIUS server /td | |
timeout | time [10000000 .. 60000000000] unit: 1000000 | Time limit how long the radius client will try to connect to the radius server /td |
comment
Set comment for items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
numbers | Type: arg_node | List of item numbers /td |
disable
Disable items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
numbers | Type: arg_node | List of item numbers /td |
edit
Edit items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
number | Type: arg_node | Item number /td | |
value-name | Type: enum const_mapping: accounting-backup | accounting-port | address | authentication-port | called-id | certificate | comment | domain | protocol | realm | secret | service | src-address | timeout Type: enum mapping: [{'type': 'const', 'name': 'accounting-backup', 'help': 'Radius accounting backup'}, {'type': 'const', 'name': 'accounting-port', 'help': 'Radius accounting port'}, {'type': 'const', 'name': 'address', 'help': 'The address of radius'}, {'type': 'const', 'name': 'authentication-port', 'help': 'Default port 1645 to RFC'}, {'type': 'const', 'name': 'called-id', 'help': 'Called identity'}, {'type': 'const', 'name': 'certificate', 'help': 'Certificate file to use for communicating with RADIUS Server with RadSec enabled'}, {'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'domain', 'help': 'The domain of the radius'}, {'type': 'const', 'name': 'protocol', 'help': 'Specifies the protocol to use when communicating with RADIUS Server'}, {'type': 'const', 'name': 'realm', 'help': 'Explicitly stated realm (user domain)'}, {'type': 'const', 'name': 'secret', 'help': 'PPP secret name'}, {'type': 'const', 'name': 'service', 'help': 'Name of the service'}, {'type': 'const', 'name': 'src-address', 'help': 'Source IP/IPv6 address of the packets sent to RADIUS server'}, {'type': 'const', 'name': 'timeout', 'help': 'Time limit how long the radius client will try to connect to the radius server'}] | Name of editable property Enum parameters: /td
|
enable
Enable items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
numbers | Type: arg_node | List of item numbers /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: accounting-backup | accounting-port | address | authentication-port | called-id | certificate | comment | disabled | domain | protocol | realm | secret | service | src-address | timeout Type: enum mapping: [{'type': 'const', 'name': 'accounting-backup', 'help': 'Radius accounting backup'}, {'type': 'const', 'name': 'accounting-port', 'help': 'Radius accounting port'}, {'type': 'const', 'name': 'address', 'help': 'The address of radius'}, {'type': 'const', 'name': 'authentication-port', 'help': 'Default port 1645 to RFC'}, {'type': 'const', 'name': 'called-id', 'help': 'Called identity'}, {'type': 'const', 'name': 'certificate', 'help': 'Certificate file to use for communicating with RADIUS Server with RadSec enabled'}, {'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'disabled', 'help': 'Defines whether item is ignored or used'}, {'type': 'const', 'name': 'domain', 'help': 'The domain of the radius'}, {'type': 'const', 'name': 'protocol', 'help': 'Specifies the protocol to use when communicating with RADIUS Server'}, {'type': 'const', 'name': 'realm', 'help': 'Explicitly stated realm (user domain)'}, {'type': 'const', 'name': 'secret', 'help': 'PPP secret name'}, {'type': 'const', 'name': 'service', 'help': 'Name of the service'}, {'type': 'const', 'name': 'src-address', 'help': 'Source IP/IPv6 address of the packets sent to RADIUS server'}, {'type': 'const', 'name': 'timeout', 'help': 'Time limit how long the radius client will try to connect to the radius server'}] | Name of the value you want to get Enum parameters: /td
|
monitor
Radius monitoring
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 value: True | Prints out output as value (used in scripting) /td | |
do | Type: arg_node | Execute given script after each time it prints stats on the screen /td | |
duration | time [-9223372036854775808 .. 9223372036854775807] unit: 1000000 | /td | |
file | Type: string interesting: False | File name where to print output /td | |
interval | time [20000000 .. 5000000000] unit: 1000000 | Delay between messages in seconds /td | |
numbers | Type: arg_node | List of item numbers /td | |
once | Type: switch value: True | Execute and print commands output just once /td | |
without-paging | Type: switch value: True | Prints out each update as new output instead of overwriting previous one on each update /td |
move
Change order of items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
destination | Type: arg_node noexport: True | Target to where the file should be moved /td | |
numbers | Type: arg_node | List of item numbers /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': 'accounting-backup', 'value': 8}, {'key': 'accounting-port', 'value': 6}, {'key': 'address', 'value': 3}, {'key': 'authentication-port', 'value': 5}, {'key': 'called-id', 'value': 1}, {'key': 'certificate', 'value': 12}, {'key': 'comment', 'value': 23}, {'key': 'disabled', 'value': 22}, {'key': 'domain', 'value': 2}, {'key': 'protocol', 'value': 11}, {'key': 'realm', 'value': 9}, {'key': 'secret', 'value': 4}, {'key': 'service', 'value': 0}, {'key': 'src-address', 'value': 10}, {'key': 'timeout', 'value': 7}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Name of the service'}, {'key': 1, 'value': 'Called identity'}, {'key': 2, 'value': 'The domain of the radius'}, {'key': 3, 'value': 'The address of radius'}, {'key': 4, 'value': 'PPP secret name'}, {'key': 5, 'value': 'Default port 1645 to RFC'}, {'key': 6, 'value': 'Radius accounting port'}, {'key': 7, 'value': 'Time limit how long the radius client will try to connect to the radius server'}, {'key': 8, 'value': 'Radius accounting backup'}, {'key': 9, 'value': 'Explicitly stated realm (user domain)'}, {'key': 10, 'value': 'Source IP/IPv6 address of the packets sent to RADIUS server'}, {'key': 11, 'value': 'Specifies the protocol to use when communicating with RADIUS Server'}, {'key': 12, 'value': 'Certificate file to use for communicating with RADIUS Server with RadSec enabled'}, {'key': 22, 'value': 'Defines whether item is ignored or used'}, {'key': 23, 'value': 'Short description of the item'}]}}]}}]}}, {'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 |
reset-counters
Reset all counters
set
Change item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
accounting-backup | Type: bool | Radius accounting backup /td | |
accounting-port | num [1 .. 65535] | Radius accounting port /td | |
address | Type: alt ip-address: ip_arg ipv6-address: ip6_arg | The address of radius /td | |
authentication-port | num [1 .. 65535] | Default port 1645 to RFC /td | |
called-id | Type: string | Called identity /td | |
certificate | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'checkId1', 'value': 'u5b'}, {'key': 'checkValue1', 'value': 1}, {'key': 'path', 'value': '{19,1}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'checkId1', 'value': 'u5b'}, {'key': 'checkValue1', 'value': 1}, {'key': 'path', 'value': '{19,1}'}]}] | Certificate file to use for communicating with RADIUS Server with RadSec enabled /td | |
comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
disabled | Type: bool | Defines whether item is ignored or used /td | |
domain | Type: string | The domain of the radius /td | |
numbers | Type: arg_node | List of item numbers /td | |
protocol | Type: enum const_mapping: radsec | udp Type: enum mapping: [{'type': 'const', 'name': 'radsec'}, {'type': 'const', 'name': 'udp', 'help': 'user datagram protocol'}] constant: True | Specifies the protocol to use when communicating with RADIUS Server /td | |
realm | Type: string | Explicitly stated realm (user domain) The users do not have to provide proper ISP domain name in user name if this is specified /td | |
secret | Type: string sensitive: True | PPP secret name /td | |
service | Type: ubit_arg bitspec: {'producer': '', 'sub': [{'key': 'dhcp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4096}, {'key': 'ormask', 'value': 4096}]}}, {'key': 'dot1x', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16384}, {'key': 'ormask', 'value': 16384}]}}, {'key': 'hotspot', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 512}, {'key': 'ormask', 'value': 512}]}}, {'key': 'ipsec', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8192}, {'key': 'ormask', 'value': 8192}]}}, {'key': 'login', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'ppp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'wireless', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1024}, {'key': 'ormask', 'value': 1024}]}}]} | Name of the service /td | |
src-address | Type: alt ip-address: ip_arg ipv6-address: ip6_arg | Source IP/IPv6 address of the packets sent to RADIUS server /td | |
timeout | time [10000000 .. 60000000000] unit: 1000000 | Time limit how long the radius client will try to connect to the radius server /td |
/radius/incoming
Incoming messages management
edit
Edit items
Parameter | Type | Description | Additional Notes |
---|---|---|---|
value-name | Type: enum const_mapping: accept | port Type: enum mapping: [{'type': 'const', 'name': 'accept'}, {'type': 'const', 'name': 'port'}] | 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: accept | port Type: enum mapping: [{'type': 'const', 'name': 'accept'}, {'type': 'const', 'name': 'port'}] | Name of the value you want to get /td |
monitor
Monitor incoming requests
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 value: True | Prints out output as value (used in scripting) /td | |
do | Type: arg_node | Execute given script after each time it prints stats on the screen /td | |
duration | time [-9223372036854775808 .. 9223372036854775807] unit: 1000000 | /td | |
file | Type: string interesting: False | File name where to print output /td | |
interval | time [20000000 .. 5000000000] unit: 1000000 | Delay between messages in seconds /td | |
once | Type: switch value: True | Execute and print commands output just once /td | |
without-paging | Type: switch value: True | Prints out each update as new output instead of overwriting previous one on each update /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 |
reset-counters
Reset monitoring counters
set
Change item properties
Parameter | Type | Description | Additional Notes |
---|---|---|---|
accept | Type: bool | Whether to accept the unsolicited messages /td | |
port | num [1 .. 65535] | The port number to listen for the requests on /td |