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 shared Schema vcs schemaOperations 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}
discovery-mode
Description: discovery-mode is a JSON Block. Please see below for discovery-mode
Type: Object
Reference Object: /axapi/v3/vcs/discovery-mode
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
unicast-election
Description: unicast-election is a JSON Block. Please see below for unicast-election
Type: Object
Reference Object: /axapi/v3/vcs/unicast-election
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
discovery-mode¶
Specification Value Type object action
Description ‘Unicast’: enable VCS Unicast election; ‘Mcast’: enable VCS Multicast election; ‘Mixed’: enable VCS Multicast/Unicastelection;
Type: string
Supported Values: Unicast, Mcast, Mixed
Default: Mcast
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 chassis-id
Description Chassis ID
Type: number
Range: 1-8
config-info
Description Configuration information (Configuration tag)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
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: 0-240
Default: 10
dead-interval-mseconds
Description The node will be considered dead as lack of hearbeats after this time (milisecond) (in unit of msecond, default is 0)
Type: number
Range: 100-900
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: Listfloating-ipv6-cfg
Type: Listforce-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
memory-stat-interval
Description Interval of aVCS memory statistics record (minutes)
Type: number
Range: 0-120
Default: 30
multicast-ip
Description Multicast (group) IP address (Multicast IP address)
Type: string
Format: ipv4-address
Default: 224.0.1.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
size
Description file size (MBytes) to transmit to monitor the TCP channel
Type: number
Range: 10-2000
slog-level
Description Set the level of slog for aVCS
Type: number
Range: 1-8
Default: 7
slog-method
Description Set the print method of slog for aVCS
Type: number
Range: 0-2
Default: 1
speed_limit
Description speed (KByte/s) limitation for the transmit monitor
Type: number
Range: 5-1000
ssl-enable
Description Enable SSL
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
tcp-channel-monitor
Description Enable vBlade TCP channel monitor
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: 0-60
Default: 3
time-interval-mseconds
Description how long between heartbeats (mseconds) (in unit of milisecond, default is 0)
Type: number
Range: 200-900
transmit-fragment-size
Description Set the fragment size (KByte) of the aVCS transmit
Type: number
Range: 500-20000
Default: 6000
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 cluster-discovery
Description apply the configuration change on the aVCS cluster
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
complete
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
db-safe
Description keep database safe
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
device
Description Reload a specific device when VCS is enabled (device id)
Type: number
disable-merge
Description don’t merge this vBlade’s configuration to aVCS chassis
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
force
Description force to complete
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
timeout
Description automatically complete the db-safe mode when timeout
Type: number
Range: 5-300
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 sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
stat_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘elect_recv_err’: Receive error counter of aVCS election; ‘elect_send_err’: Send error counter of aVCS election; ‘elect_recv_byte’: Receive bytes counter of aVCS election; ‘elect_send_byte’: Send bytes counter of aVCS election; ‘elect_pdu_master_recv’: Received vMaster-PDU counter of aVCS election; ‘elect_pdu_master_cand_recv’: Received MC-PDU counter of aVCS election; ‘elect_pdu_slave_recv’: Received vBlade-PDU counter of aVCS election; ‘elect_pdu_master_take_over_recv’: Received MTO-PDU counter of aVCS election; ‘elect_pdu_unknown_recv’: Received Unknown-PDU counter of aVCS election; ‘elect_pdu_master_sent’: Sent vMaster-PDU counter of aVCS election; ‘elect_pdu_master_cand_sent’: Sent MC-PDU counter of aVCS election; ‘elect_pdu_slave_sent’: Sent vBlade-PDU counter of aVCS election; ‘elect_pdu_master_take_over_sent’: Sent MTO-PDU counter of aVCS election; ‘elect_pdu_unknown_sent’: Sent Unknown-PDU counter of aVCS election; ‘elect_pdu_inval’: Invalid PDU counter of aVCS election; ‘elect_pdu_hw_mismatch’: PDU HW mismatch counter of aVCS election; ‘elect_pdu_cluster_mismatch’: PDU Chassis-ID mismatch counter of aVCS election; ‘elect_pdu_dev_id_collision’: PDU Device-ID collision counter of aVCS election; ‘elect_mc_discard_master’: MC discarded vMaster-PDU counter of aVCS election; ‘elect_mc_replace_master’: MC replaced vMaster-PDU counter of aVCS election; ‘elect_mc_dup_masterr’: MC duplicate vMaster-PDU counter of aVCS election; ‘elect_mc_reset_timer_by_mc’: MC timers reset by MC-PDU counter of aVCS election; ‘elect_mc_reset_timer_by_mto’: MC timers reset by MTO-PDU counter of aVCS election; ‘elect_slave_dup_master’: vBlade duplicate vMaster-PDU counter of aVCS election; ‘elect_slave_discard_challenger’: vBlade discard challenger counter of aVCS election; ‘elect_slave_replace_challenger’: vBlade replace challenger counter of aVCS election; ‘elect_slave_dup_challenger’: vBlade duplicate challenger counter of aVCS election; ‘elect_slave_discard_neighbour’: vBlade discard neighbour counter of aVCS election; ‘elect_slave_too_many_neighbour’: vBlade too many neighbours counter of aVCS election; ‘elect_slave_dup_neighbour’: send vBlade duplicate neighbours of aVCS election; ‘elect_master_discard_challenger’: vMaster discard challenger counter of aVCS election; ‘elect_master_new_challenger’: vMaster new challenger counter of aVCS election; ‘elect_master_replace_challenger’: vMaster replace challenger counter of aVCS election; ‘elect_master_dup_challenger’: vMaster duplicate challenger counter of aVCS election; ‘elect_master_discard_neighbour’: vMaster discard neighbour counter of aVCS election; ‘elect_master_too_many_neighbour’: vMaster too many neighbours counter of aVCS election; ‘elect_master_dup_neighbour’: vMaster duplicate neighbours counter of aVCS election; ‘elect_enter_master_cand_stat’: Enter MC counter of aVCS election; ‘elect_enter_slave’: Enter vBlade counter of aVCS election; ‘elect_enter_master’: Enter vMaster counter of aVCS election; ‘elect_enter_master_take_over’: Enter MTO counter of aVCS election; ‘elect_leave_master_cand’: Leave MC counter of aVCS election; ‘elect_leave_slave’: Leave vBlade counter of aVCS election; ‘elect_leave_master’: Leave vMaster counter of aVCS election; ‘elect_leave_master_take_over’: Leave MTO counter of aVCS election; ‘master_slave_start_err’: vMaster Start vBlade Errors counter of aVCS election; ‘master_slave_start’: vMaster vBlades Started counter of aVCS election; ‘master_slave_stop’: vMaster vBlades stopped counter of aVCS election; ‘master_cfg_upd’: Received vMaster Configuration Updates counter of aVCS election; ‘master_cfg_upd_l_fail’: vMaster Local Configuration Update Errors counter of aVCS election; ‘master_cfg_upd_r_fail’: vMaster Remote Configuration Update Errors counter of aVCS election; ‘master_cfg_upd_notif_err’: vMaster Configuration Update Notif Errors counter of aVCS election; ‘master_cfg_upd_result_err’: vMaster Configuration Update Result Errors counter of aVCS election; ‘slave_recv_err’: vBlade Receive Errors counter of aVCS election; ‘slave_send_err’: vBlade Send Errors counter of aVCS election; ‘slave_recv_bytes’: vBlade Received Bytes counter of aVCS election; ‘slave_sent_bytes’: vBlade Sent Bytes counter of aVCS election; ‘slave_n_recv’: vBlade Received Messages counter of aVCS election; ‘slave_n_sent’: vBlade Sent Messages counter of aVCS election; ‘slave_msg_inval’: vBlade Invalid Messages counter of aVCS election; ‘slave_keepalive’: vBlade Received Keepalives counter of aVCS election; ‘slave_cfg_upd’: vBlade Received Configuration Updates counter of aVCS election; ‘slave_cfg_upd_fail’: vBlade Configuration Update Failures counter of aVCS election; ‘daemon_n_elec_start’: times of aVCS election start; ‘daemon_n_elec_stop’: times of aVCS election stop; ‘daemon_recv_err’: counter of aVCS daemon receive error; ‘daemon_send_err’: counter of aVCS daemon sent error; ‘daemon_recv_bytes’: bytes of aVCS daemon receive; ‘daemon_sent_bytes’: bytes of aVCS daemon sent; ‘daemon_n_recv’: counter of aVCS daemon receive; ‘daemon_n_sent’: counter of aVCS daemon sent; ‘daemon_msg_inval’: counter of aVCS daemon invalid message; ‘daemon_msg_handle_failure’: counter of aVCS daemon message handle failure;
Type: string
Supported Values: all, elect_recv_err, elect_send_err, elect_recv_byte, elect_send_byte, elect_pdu_master_recv, elect_pdu_master_cand_recv, elect_pdu_slave_recv, elect_pdu_master_take_over_recv, elect_pdu_unknown_recv, elect_pdu_master_sent, elect_pdu_master_cand_sent, elect_pdu_slave_sent, elect_pdu_master_take_over_sent, elect_pdu_unknown_sent, elect_pdu_inval, elect_pdu_hw_mismatch, elect_pdu_cluster_mismatch, elect_pdu_dev_id_collision, elect_mc_discard_master, elect_mc_replace_master, elect_mc_dup_masterr, elect_mc_reset_timer_by_mc, elect_mc_reset_timer_by_mto, elect_slave_dup_master, elect_slave_discard_challenger, elect_slave_replace_challenger, elect_slave_dup_challenger, elect_slave_discard_neighbour, elect_slave_too_many_neighbour, elect_slave_dup_neighbour, elect_master_discard_challenger, elect_master_new_challenger, elect_master_replace_challenger, elect_master_dup_challenger, elect_master_discard_neighbour, elect_master_too_many_neighbour, elect_master_dup_neighbour, elect_enter_master_cand_stat, elect_enter_slave, elect_enter_master, elect_enter_master_take_over, elect_leave_master_cand, elect_leave_slave, elect_leave_master, elect_leave_master_take_over, master_slave_start_err, master_slave_start, master_slave_stop, master_cfg_upd, master_cfg_upd_l_fail, master_cfg_upd_r_fail, master_cfg_upd_notif_err, master_cfg_upd_result_err, slave_recv_err, slave_send_err, slave_recv_bytes, slave_sent_bytes, slave_n_recv, slave_n_sent, slave_msg_inval, slave_keepalive, slave_cfg_upd, slave_cfg_upd_fail, daemon_n_elec_start, daemon_n_elec_stop, daemon_recv_err, daemon_send_err, daemon_recv_bytes, daemon_sent_bytes, daemon_n_recv, daemon_n_sent, daemon_msg_inval, daemon_msg_handle_failure
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: Listmanagement
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: Listttl
Description TTL of the VCS packet
Type: number
Range: 1-128
Default: 64
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
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-4096
images¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
unicast-election¶
Specification Value Type object members
Description: members is a JSON Block. Please see below for unicast-election_members
Type: Object
Reference Object: /axapi/v3/vcs/unicast-election/members
port
Description Destination port for unicast election packet (Destination port for unicast election packet (default 41217))
Type: number
Range: 1024-65000
Default: 41217
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
unicast-election_members¶
Specification Value Type object ip-address-cfg
Type: Listipv6-address-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
unicast-election_members_ip-address-cfg¶
Specification Value Type list Block object keys ip-address
Description IP Address of the member
Type: string
Format: ipv4-address
Mutual Exclusion: ip-address and ipv6-address are mutually exclusive
use-mgmt-port
Description Use management port for connections in different subnet
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
unicast-election_members_ipv6-address-cfg¶
Specification Value Type list Block object keys ipv6-address
Description IPV6 address of the member
Type: string
Format: ipv6-address
Mutual Exclusion: ipv6-address and ip-address are mutually exclusive
use-mgmt-port
Description Use management port for connections in different subnet
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
action¶
Specification Value Type object action
Description ‘enable’: enable VCS; ‘disable’: disable VCS;
Type: string
Supported Values: disable, enable
Default: disable
database-distribution
Description ‘enable’: enable database cluster distribution; ‘disable’: disable database cluster distribution;
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