admin

Configure admin user account details for management access to the ACOS device.

admin Specification

Type Collection
Object Key(s) user
Collection Name admin-list
Collection URI /axapi/v3/admin/
Element Name admin
Element URI /axapi/v3/admin/{user}
Element Attributes admin_attributes
Schema admin schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/admin/

admin Attributes

Create List

POST

/axapi/v3/admin/

admin Attributes

Get Object

GET

/axapi/v3/admin/{user}

admin Attributes

Get List

GET

/axapi/v3/admin/

admin-list

Modify Object

POST

/axapi/v3/admin/{user}

admin Attributes

Replace Object

PUT

/axapi/v3/admin/{user}

admin Attributes

Replace List

PUT

/axapi/v3/admin/

admin-list

Delete Object

DELETE

/axapi/v3/admin/{user}

admin Attributes

admin-list

admin-list is JSON List of admin Attributes

admin-list : [

admin Attributes

access

Description: access is a JSON Block . Please see below for access

Type: Object

Reference Object: /axapi/v3/admin/{user}/access

access-list

Description: Specifies an ACL to classify a trusted host. For use with trusted-host-acl-id .

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: access-list and trusted-host-addr are mutually exclusive

action

Description: By default, admin accounts are enabled when they are added.
  • disable : Disables the account.
  • enable : Enables the account.

Type: string

Supported Values: enable, disable

Default: enable

passwd-string

Description: Sets the password. Passwords are case sensitive and can contain special characters.

Type: string

Format: password

password

Description: password is a JSON Block . Please see below for password

Type: Object

Reference Object: /axapi/v3/admin/{user}/password

password-key

Description: Config admin user password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

privilege-global

Description: Sets the privilege level for the account.
  • read : The admin has read-only access.
  • write : The admin can write configuration changes.

Type: string

Supported Values: read, write

privilege-list

Description: privilege-list is a JSON List . Please see below for privilege-list

Type: List

ssh-pubkey

Description: ssh-pubkey is a JSON Block . Please see below for ssh-pubkey

Type: Object

Reference Object: /axapi/v3/admin/{user}/ssh-pubkey

trusted-host

Description: Enables an admin to log in from only certain IP addresses or subnets. For use with trusted-host-addr or access-list . These are mutually exclusive, so you will only configure one or the other.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trusted-host-acl-id

Description: Specifies the ACL ID of the access list. For use with access-list .

Type: number

Range: 1-99

trusted-host-addr

Description: Specifies the ipv4 host address from which the admin is allowed to log onto the ACOS device. The default trusted host is 0.0.0.0, which allows access from any host. For use with trusted-host-netmask .

Type: string

Format: ipv4-address

Mutual Exclusion: trusted-host-addr and access-list are mutually exclusive

trusted-host-netmask

Description: Specifies the ipv4 netmask from which the admin is allowed to log onto the ACOS device. The default trusted netmask is 0.0.0.0, which allows access from any subnet. For use with trusted-host-addr .

Type: string

Format: ipv4-netmask

unlock

Description: Unlocks the account. Use this option if the admin has been locked out due to too many login attempts with an incorrect password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user

Description: Specifies the user name of an admin.

Type: string

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

privilege-list

Specification
Type list
Block object keys

partition-name

Description: Partition Name

Type: string

privilege-partition

Description: ‘partition-enable-disable’: Set per-partition enable/disable privilege; ‘partition-read’: Set per-partition read privilege; ‘partition-write’: Set per-partition write privilege;

Type: string

Supported Values: partition-enable-disable, partition-read, partition-write

access

Specification
Type object

access-type

Description: Specifies the management interfaces through which the admin is allowed to access the ACOS device.
  • axapi : Allows logins from aXAPI.
  • cli : Allows logins from cli.
  • web : Allows logins from web.

Type: string

Format: enum-list

Default: axapi,cli,web

uuid

Description: uuid of the object

Type: string

ssh-pubkey

Specification
Type object

delete

Description: Delete an authorized public key (SSH key index)

Type: number

Range: 1-1000000

file-url

Description: The url specifies the file transfer protocol, username (if required), and directory path for importing the public key.

Type: string

Format: url

import

Description: Import an authorized public key onto the ACOS device.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

list

Description: Verifies installation of the public key.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description: Use the management port as the source port for importing the public key.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

password

Specification
Type object

encrypted-in-module

Description: Specify an ENCRYPTED password string (System admin user password)

password-in-module

Description: Sets the password. Passwords are case sensitive and can contain special characters.

Type: string

Format: password

uuid

Description: uuid of the object

Type: string