admin

System admin user configuration

admin Specification

Parameter Value
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
Partition Visibility shared
Schema admin schema

Operations Allowed:

OperationMethodURIPayload

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 Specify an ACL to classify a trusted host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

action

Description ‘enable’: Enable user; ‘disable’: Disable user;

Type: string

Supported Values: enable, disable

Default: enable

aws-accesskey

Description: aws-accesskey is a JSON Block. Please see below for aws-accesskey

Type: Object

Reference Object: /axapi/v3/admin/{user}/aws-accesskey

azure-cred

Description: azure-cred is a JSON Block. Please see below for azure-cred

Type: Object

Reference Object: /axapi/v3/admin/{user}/azure-cred

cloud-cred

Description: cloud-cred is a JSON Block. Please see below for cloud-cred

Type: Object

Reference Object: /axapi/v3/admin/{user}/cloud-cred

encrypted

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

gcp-cred

Description: gcp-cred is a JSON Block. Please see below for gcp-cred

Type: Object

Reference Object: /axapi/v3/admin/{user}/gcp-cred

passwd-string

Description Config admin user password

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

privilege-global

Description ‘read’: Set read privilege; ‘write’: Set write privilege; ‘hm’: Set external health monitor script content operations privilege;

Type: string

Supported Values: read, write, hm

privilege-list

Type: List

privilege-shell-root

Description Set shell root privilege

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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 Set trusted network administrator can login in

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

trusted-host-acl-id

Description ACL ID

Type: number

Range: 1-99

trusted-host-cidr

Description Trusted IP Address with network mask

Type: string

Format: ipv4-cidr

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

user

Description System admin user name

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

azure-cred

Specification Value
Type object

delete

Description Delete an authorized Azure credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

file-url

Description File URL

Type: string

Format: url

import

Description Import an azure-credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

show

Description Show authorized azure credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cloud-cred

Specification Value
Type object

delete

Description Delete an authorized cloud credentials and cloud configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

file-url

Description File URL

Type: string

Format: url

import

Description Import an Cloud-Cred and Cloud-Config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

show

Description Show authorized cloud credentials and cloud configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

type

Description ‘aws-cred’: aws-cred; ‘aws-config’: aws-config; ‘azure-cred’: azure-cred; ‘vmware-cred’: vmware-cred;

Type: string

Supported Values: aws-cred, aws-config, azure-cred, vmware-cred

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

privilege-list

Specification Value
Type list
Block object keys  

partition-name

Description Partition Name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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

aws-accesskey

Specification Value
Type object

delete

Description Delete an authorized aws accesskey

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

file-url

Description File URL

Type: string

Format: url

import

Description Import an aws-accesskey

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

show

Description Show authorized aws accesskey

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

access

Specification Value
Type object

access-type

Description

Type: string

Format: enum-list

Default: axapi,cli,web

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ssh-pubkey

Specification Value
Type object

delete

Description Delete an authorized public key (SSH key index)

Type: number

Range: 1-1000000

file-url

Description File URL

Type: string

Format: url

import

Description Import an authorized public key

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

list

Description List all authorized public keys

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gcp-cred

Specification Value
Type object

delete

Description Delete an authorized GCP credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

file-url

Description File URL

Type: string

Format: url

import

Description Import an GCP-credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

show

Description Show authorized GCP credentials

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

password

Specification Value
Type object

encrypted-in-module

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

password-in-module

Description Config admin user password

Type: string

Format: password

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters