terminal

Set terminal startup display parameters.

terminal Specification

Type Configuration Resource
Element Name terminal
Element URI /axapi/v3/terminal
Element Attributes terminal_attributes
Schema terminal schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/terminal

terminal Attributes

Get Object

GET

/axapi/v3/terminal

terminal Attributes

Modify Object

POST

/axapi/v3/terminal

terminal Attributes

Replace Object

PUT

/axapi/v3/terminal

terminal Attributes

Delete Object

DELETE

/axapi/v3/terminal

terminal Attributes

terminal Attributes

auto-size

Description: Enable terminal length and width automatically (not work if width or length set to 0)

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

Mutual Exclusion: auto-size length and width are mutually exclusive

editing

Description: Enable command line editing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gslb-cfg

Description: gslb-cfg is a JSON Block . Please see below for gslb-cfg

Type: Object

history-cfg

Description: history-cfg is a JSON Block . Please see below for history-cfg

Type: Object

idle-timeout

Description: Set interval for closing connection when there is no input detected (Timeout in minutes, 0 means never timeout, default is 15)

Type: number

Range: 0-60

Default: 15

length

Description: Set number of lines on a screen(0 for no pausing) (Number of lines on screen, 0 for no pausing, default is 24)

Type: number

Range: 0-512

Default: 24

Mutual Exclusion: length and auto-size are mutually exclusive

prompt-cfg

Description: prompt-cfg is a JSON Block . Please see below for prompt-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

width

Description: Set width of the display terminal (Number of characters on a screen line, 0 means infinite, default is 80)

Type: number

Range: 0-512

Default: 80

Mutual Exclusion: width and auto-size are mutually exclusive

gslb-cfg

Specification
Type object

disable

Description: Group status show disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

group-role

Description: Show GSLB group role on CLI prompt

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

gslb-prompt

Description: The gslb status prompt function set

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

symbol

Description: Show “gslb” symbol on CLI prompt

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

history-cfg

Specification
Type object

enable

Description: Enable terminal history

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

size

Description: Set history buffer size (Size of history buffer, default is 256)

Type: number

Range: 0-1000

Default: 256

prompt-cfg

Specification
Type object

hostname

Description: Display hostname in prompt

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prompt

Description: Configure the normal prompt format

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vcs-cfg

Description: vcs-cfg is a JSON Block . Please see below for l13_vcs-cfg

Type: Object

prompt-cfg.vcs-cfg

Specification
Type object

vcs-status

Description: Display VCS status in prompt, eg. vMaster, vBlade

Type: boolean

Supported Values: true, false, 1, 0

Default: 0