vcs

Virtual Chassis System

vcs Specification

Parameter	Value
Type	Intermediate Resource
Element Name	vcs
Element URI	/axapi/v3/vcs
Element Attributes	vcs_attributes
Partition Visibility	None
Schema	vcs schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/vcs	vcs_attributes

vcs attributes

action

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

Type: Object

Reference Object: /axapi/v3/vcs/action

debug

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

Type: Object

Reference Object: /axapi/v3/vcs/debug

device-list

Type: List

Reference Object: /axapi/v3/vcs/device/{device}

images

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

Type: Object

Reference Object: /axapi/v3/vcs/images

reload

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

Type: Object

Reference Object: /axapi/v3/vcs/reload

showdebug

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

Type: Object

Reference Object: /axapi/v3/vcs/showdebug

stat

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

Type: Object

Reference Object: /axapi/v3/vcs/stat

vMaster-maintenance

Description: vMaster-maintenance is a JSON Block. Please see below for vMaster-maintenance

Type: Object

Reference Object: /axapi/v3/vcs/vMaster-maintenance

vcs-para

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

Type: Object

Reference Object: /axapi/v3/vcs/vcs-para

vcs-summary

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

Type: Object

Reference Object: /axapi/v3/vcs/vcs-summary

vmaster-take-over

Description: vmaster-take-over is a JSON Block. Please see below for vmaster-take-over

Type: Object

Reference Object: /axapi/v3/vcs/vmaster-take-over

vcs-summary

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vmaster-take-over

Specification	Value
Type	object

vmaster-take-over

Description vMaster take over priority

Type: number

Range: 1-255

vcs-para

Specification	Value
Type	object

config-seq

Description Configuration sequence number

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

dead-interval

Description The node will be considered dead as lack of hearbeats after this time (in unit of second, 10 by default)

Type: number

Range: 5-240

Default: 10

failure-retry-count-value

Description 0-255, default is 2

Type: number

Range: 0-255

Default: 2

Mutual Exclusion: failure-retry-count-value and forever are mutually exclusive

floating-ip-cfg

Type: List

floating-ipv6-cfg

Type: List

force-wait-interval

Description The node will wait the specified time interval before it start aVCS (in unit of second (default is 5))

Type: number

Range: 5-240

Default: 5

forever

Description VCS retry forever if fails to join the chassis

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: forever and failure-retry-count-value are mutually exclusive

multicast-ip

Description Multicast (group) IP address (Multicast IP address)

Type: string

Format: ipv4-address

Default: 224.0.0.210

Mutual Exclusion: multicast-ip and multicast-ipv6 are mutually exclusive

multicast-ipv6

Description Multicast (group) IPv6 address (Multicast IPv6 address)

Type: string

Format: ipv6-address

Mutual Exclusion: multicast-ipv6 and multicast-ip are mutually exclusive

multicast-port

Description Port used in multicast communication (Port number)

Type: number

Range: 1-65535

Default: 41217

ssl-enable

Description Enable SSL

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

time-interval

Description how long between heartbeats (in unit of second, default is 3)

Type: number

Range: 1-60

Default: 3

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vcs-para_floating-ipv6-cfg

Specification	Value
Type	list
Block object keys

floating-ipv6

Description Floating IPv6 address

Type: string

Format: ipv6-address-plen

vcs-para_floating-ip-cfg

Specification	Value
Type	list
Block object keys

floating-ip

Description Floating IP address (IPv4 address)

Type: string

Format: ipv4-address

floating-ip-mask

Description Netmask

Type: string

Format: ipv4-netmask

showdebug

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

reload

Specification	Value
Type	object

disable-merge

Description don’t merge this vBlade’s configuration to aVCS chassis

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

debug

Specification	Value
Type	object

daemon

Description Daemon component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

daemon_msg

Description Daemon message component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

election

Description Election component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

election_pdu

Description Election pdu component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

encoder

Description Encoder component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

handler

Description Handler component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

info

Description Information component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lib

Description Lib component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

net

Description Net component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ssl

Description SSL component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

util

Description Utility component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vblade

Description vBlade component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vblade_msg

Description vBlade Message component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vmaster

Description vMaster component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vmaster_msg

Description vMaster Message component

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stat

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

device-list

Specification	Value
Type	list
Block object keys

affinity-vrrp-a-vrid

Description vrid-group

Type: number

Range: 0-31

device

Description Device ID

Type: number

enable

Description Enable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet-cfg

Type: List

management

Description Management interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

priority

Description Device priority

Type: number

Range: 1-255

trunk-cfg

Type: List

unicast-port

Description Port used in unicast communication (Port number)

Type: number

Range: 1024-65535

Default: 41216

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

ve-cfg

Type: List

device-list_ethernet-cfg

Specification	Value
Type	list
Block object keys

ethernet

Description Ethernet (Ethernet interface number)

Type: number

Format: interface

Range: 4-112

device-list_ve-cfg

Specification	Value
Type	list
Block object keys

ve

Description VE interface (VE interface number)

Type: number

Range: 2-4094

device-list_trunk-cfg

Specification	Value
Type	list
Block object keys

trunk

Description Trunk interface (Trunk interface number)

Type: number

Range: 1-16

images

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

action

Specification	Value
Type	object

action

Description ‘enable’: enable VCS; ‘disable’: disable VCS;

Type: string

Supported Values: enable, disable

Default: disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vMaster-maintenance

Specification	Value
Type	object

vMaster-maintenance

Description the seconds vMaster will be maintained, 60 by default

Type: number

Range: 0-3600

Default: 60