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

Compare with Current View Page History

« Previous Version 7 Next »

/user

User management

add

Create a new item
ParameterTypeDescriptionAdditional Notes
address
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]}
Network address part of addresses user is allowed to use
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
group
Type: enum
other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}
Group management
Manage user groups. Set up groups for accessing separate services and rebooting router.
name
Type: string
User name
password
Type: string
User password

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: address | comment | group | name | password
Name of editable property
Enum parameters:
  • address - Network address part of addresses user is allowed to use

    • 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: address | comment | disabled | group | last-logged-in | name | password
    Name of the value you want to get
    Enum parameters:
  • address - Network address part of addresses user is allowed to use

    • 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': 'address', 'value': 3}, {'key': 'comment', 'value': 14}, {'key': 'disabled', 'value': 13}, {'key': 'group', 'value': 1}, {'key': 'last-logged-in', 'value': 4}, {'key': 'name', 'value': 0}, {'key': 'password', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'User name'}, {'key': 1, 'value': 'Group management'}, {'key': 2, 'value': 'User password'}, {'key': 3, 'value': 'Network address part of addresses user is allowed to use'}, {'key': 13, 'value': 'Defines whether item is ignored or used'}, {'key': 14, '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

    set

    Change item properties
    ParameterTypeDescriptionAdditional Notes
    address
    Type: obj_arg
    +arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]}
    Network address part of addresses user is allowed to use
    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
    group
    Type: enum
    other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}
    Group management
    Manage user groups. Set up groups for accessing separate services and rebooting router.
    name
    Type: string
    User name
    numbers
    Type: arg_node
    List of item numbers
    password
    Type: string
    User password

    /user/aaa

    Authentication Authorization and Accounting

    edit

    Edit items
    ParameterTypeDescriptionAdditional Notes
    value-name
    Type: enum
    const_mapping: accounting | default-group | exclude-groups | interim-update | use-radius
    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: accounting | default-group | exclude-groups | interim-update | use-radius
    Name of the value you want to get

    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

    set

    Change item properties
    ParameterTypeDescriptionAdditional Notes
    accounting
    Type: bool
    Status of aaa (yes/no)
    default-group
    Type: enum
    other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}
    Set type of the default group
    exclude-groups
    Type: multi_arg
    +arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}
    switchIds: {4294967295}
    List of groups to exclude
    interim-updatetime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
    Defines time interval between communications with the router
    use-radius
    Type: bool
    Use or not radius

    /user/active

    Active users

    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: address | by-romon | group | name | radius | via | when
    Name of the value you want to get

    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': 'address', 'value': 2}, {'key': 'by-romon', 'value': 3}, {'key': 'group', 'value': 5}, {'key': 'name', 'value': 1}, {'key': 'radius', 'value': 14}, {'key': 'via', 'value': 4}, {'key': 'when', 'value': 0}]}}]}}]}}, {'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

    /user/group

    Group management

    add

    Create a new item
    ParameterTypeDescriptionAdditional Notes
    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
    name
    Type: string
    New group name
    policy
    Type: multi_arg
    +arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': 'acc_present', 'value': {'producer': '"b2709"', 'sub': []}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'optional', 'value': True}, {'key': 'prefix', 'value': '!'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,3}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'policy'}]}}]}}]}
    switchIds: {4294967295,9993}
    Group policy
    skin
    Type: enum
    other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]}
    Default Webfig skin for group

    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

    edit

    Edit items
    ParameterTypeDescriptionAdditional Notes
    number
    Type: arg_node
    Item number
    value-name
    Type: enum
    const_mapping: comment | name | policy | skin
    Name of editable property
    Enum parameters:
  • comment - Short description of the item

    • 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: comment | name | policy | skin
    Name of the value you want to get
    Enum parameters:
  • comment - Short description of the item

    • 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': 'comment', 'value': 11}, {'key': 'name', 'value': 0}, {'key': 'policy', 'value': 1}, {'key': 'skin', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'New group name'}, {'key': 1, 'value': 'Group policy'}, {'key': 2, 'value': 'Default Webfig skin for group'}, {'key': 11, '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

    set

    Change item properties
    ParameterTypeDescriptionAdditional Notes
    comment
    Type: string
    noprint: True
    Short description of the item
    Adds short description to one or several specified items.
    name
    Type: string
    New group name
    numbers
    Type: arg_node
    List of item numbers
    policy
    Type: multi_arg
    +arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': 'acc_present', 'value': {'producer': '"b2709"', 'sub': []}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'optional', 'value': True}, {'key': 'prefix', 'value': '!'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,3}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'policy'}]}}]}}]}
    switchIds: {4294967295,9993}
    Group policy
    skin
    Type: enum
    other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]}
    Default Webfig skin for group
    • No labels