You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

/radius

Radius client settings

add

Create a new item
ParameterTypeDescriptionAdditional Notes
accounting-backup
Type: bool
Radius accounting backup
accounting-portnum [1 .. 65535]
Radius accounting port
address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
The address of radius
authentication-portnum [1 .. 65535]
Default port 1645 to RFC
called-id
Type: string
Called identity
certificate
Type: enum
other_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
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.
copy-from
Type: arg_node
noexport: True
ID of item to make a copy from
disabled
Type: bool
Defines whether item is ignored or used
domain
Type: string
The domain of the radius
place-before
Type: arg_node
noexport: True
Item number
protocol
Type: enum
const_mapping: radsec | udp
Specifies the protocol to use when communicating with RADIUS Server
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
secret
Type: string
sensitive: True
PPP secret name
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
src-address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
Source IP/IPv6 address of the packets sent to RADIUS server
timeouttime [10000000 .. 60000000000] unit: 1000000
Time limit how long the radius client will try to connect to the radius server

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.
numbers
Type: arg_node
List of item numbers

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbers
Type: arg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
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
Name of editable property
Enum parameters:
  • accounting-backup - Radius accounting backup

    • enable

    Enable items
    ParameterTypeDescriptionAdditional Notes
    numbers
    Type: arg_node
    List of item numbers

    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)

    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: accounting-backup | accounting-port | address | authentication-port | called-id | certificate | comment | disabled | domain | protocol | realm | secret | service | src-address | timeout
    Name of the value you want to get
    Enum parameters:
  • accounting-backup - Radius accounting backup

    • monitor

    Radius monitoring
    ParameterTypeDescriptionAdditional Notes
    append
    Type: switch
    value: True
    Controls if print to file overwrites or appends to content of an existing file
    as-value
    Type: switch
    value: True
    Prints out output as value (used in scripting)
    do
    Type: arg_node
    Execute given script after each time it prints stats on the screen
    durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
    file
    Type: string
    interesting: False
    File name where to print output
    intervaltime [20000000 .. 5000000000] unit: 1000000
    Delay between messages in seconds
    numbers
    Type: arg_node
    List of item numbers
    once
    Type: switch
    value: True
    Execute and print commands output just once
    without-paging
    Type: switch
    value: True
    Prints out each update as new output instead of overwriting previous one on each update

    move

    Change order of items
    ParameterTypeDescriptionAdditional Notes
    destination
    Type: arg_node
    noexport: True
    Target to where the file should be moved
    numbers
    Type: arg_node
    List of item numbers

    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
    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
    intervaltime [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': '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
    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

    reset-counters

    Reset all counters

    set

    Change item properties
    ParameterTypeDescriptionAdditional Notes
    accounting-backup
    Type: bool
    Radius accounting backup
    accounting-portnum [1 .. 65535]
    Radius accounting port
    address
    Type: alt
    ip-address: ip_arg
    ipv6-address: ip6_arg
    The address of radius
    authentication-portnum [1 .. 65535]
    Default port 1645 to RFC
    called-id
    Type: string
    Called identity
    certificate
    Type: enum
    other_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
    comment
    Type: string
    noprint: True
    Short description of the item
    Adds short description to one or several specified items.
    disabled
    Type: bool
    Defines whether item is ignored or used
    domain
    Type: string
    The domain of the radius
    numbers
    Type: arg_node
    List of item numbers
    protocol
    Type: enum
    const_mapping: radsec | udp
    Specifies the protocol to use when communicating with RADIUS Server
    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
    secret
    Type: string
    sensitive: True
    PPP secret name
    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
    src-address
    Type: alt
    ip-address: ip_arg
    ipv6-address: ip6_arg
    Source IP/IPv6 address of the packets sent to RADIUS server
    timeouttime [10000000 .. 60000000000] unit: 1000000
    Time limit how long the radius client will try to connect to the radius server

    /radius/incoming

    Incoming messages management

    edit

    Edit items
    ParameterTypeDescriptionAdditional Notes
    value-name
    Type: enum
    const_mapping: accept | port
    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: accept | port
    Name of the value you want to get

    monitor

    Monitor incoming requests
    ParameterTypeDescriptionAdditional Notes
    append
    Type: switch
    value: True
    Controls if print to file overwrites or appends to content of an existing file
    as-value
    Type: switch
    value: True
    Prints out output as value (used in scripting)
    do
    Type: arg_node
    Execute given script after each time it prints stats on the screen
    durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
    file
    Type: string
    interesting: False
    File name where to print output
    intervaltime [20000000 .. 5000000000] unit: 1000000
    Delay between messages in seconds
    once
    Type: switch
    value: True
    Execute and print commands output just once
    without-paging
    Type: switch
    value: True
    Prints out each update as new output instead of overwriting previous one on each update

    print

    Print values of item properties
    ParameterTypeDescriptionAdditional 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
    intervaltime [200000000 .. 9223372036854775807] unit: 1000000
    Displays information and refreshes it in selected time interval
    without-paging
    Type: switch
    value: True
    Displays information in one piece

    reset-counters

    Reset monitoring counters

    set

    Change item properties
    ParameterTypeDescriptionAdditional Notes
    accept
    Type: bool
    Whether to accept the unsolicited messages
    portnum [1 .. 65535]
    The port number to listen for the requests on
    • No labels