{ "id":"/axapi/v3/vcs", "type":"object", "node-type":"intermediate", "title":"vcs", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"Virtual Chassis System", "properties":{ "action":{ "type":"object", "$ref":"/axapi/v3/vcs/action", "properties":{ "database-distribution":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': enable database cluster distribution; 'disable': disable database cluster distribution; ", "enum":[ "enable", "disable" ] }, "action":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'disable': disable VCS; 'enable': enable VCS; ", "enum":[ "disable", "enable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "vcs-para":{ "type":"object", "$ref":"/axapi/v3/vcs/vcs-para", "properties":{ "floating-ip-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "floating-ip":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Floating IP address (IPv4 address)" }, "floating-ip-mask":{ "type":"string", "format":"ipv4-netmask", "partition-visibility":"shared", "description":"Netmask" } } } ] }, "floating-ipv6-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "floating-ipv6":{ "type":"string", "format":"ipv6-address-plen", "partition-visibility":"shared", "description":"Floating IPv6 address" } } } ] }, "ssl-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSL" }, "multicast-ip":{ "type":"string", "format":"ipv4-address", "default":"224.0.1.210", "partition-visibility":"shared", "not":"multicast-ipv6", "description":"Multicast (group) IP address (Multicast IP address)" }, "multicast-ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"multicast-ip", "description":"Multicast (group) IPv6 address (Multicast IPv6 address)" }, "multicast-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":41217, "partition-visibility":"shared", "description":"Port used in multicast communication (Port number)" }, "failure-retry-count-value":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":2, "partition-visibility":"shared", "not":"forever", "description":"0-255, default is 2" }, "forever":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"failure-retry-count-value", "description":"VCS retry forever if fails to join the chassis" }, "dead-interval-mseconds":{ "type":"number", "format":"number", "minimum":100, "maximum":900, "partition-visibility":"shared", "description":"The node will be considered dead as lack of hearbeats after this time (milisecond) (in unit of msecond, default is 0)" }, "time-interval-mseconds":{ "type":"number", "format":"number", "minimum":200, "maximum":900, "partition-visibility":"shared", "description":"how long between heartbeats (mseconds) (in unit of milisecond, default is 0)" }, "dead-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":240, "default":10, "partition-visibility":"shared", "description":"The node will be considered dead as lack of hearbeats after this time (in unit of second, 10 by default)" }, "time-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":60, "default":3, "partition-visibility":"shared", "description":"how long between heartbeats (in unit of second, default is 3)" }, "chassis-id":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "partition-visibility":"shared", "description":"Chassis ID" }, "config-info":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Configuration information (Configuration tag)" }, "config-seq":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Configuration sequence number" }, "tcp-channel-monitor":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable vBlade TCP channel monitor" }, "size":{ "type":"number", "format":"number", "minimum":10, "maximum":2000, "partition-visibility":"shared", "description":"file size (MBytes) to transmit to monitor the TCP channel" }, "speed_limit":{ "type":"number", "format":"number", "minimum":5, "maximum":1000, "partition-visibility":"shared", "description":"speed (KByte/s) limitation for the transmit monitor" }, "force-wait-interval":{ "type":"number", "format":"number", "minimum":5, "maximum":240, "default":5, "partition-visibility":"shared", "description":"The node will wait the specified time interval before it start aVCS (in unit of second (default is 5))" }, "slog-level":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "default":7, "partition-visibility":"shared", "description":"Set the level of slog for aVCS" }, "slog-method":{ "type":"number", "format":"number", "minimum":0, "maximum":2, "default":1, "partition-visibility":"shared", "description":"Set the print method of slog for aVCS" }, "transmit-fragment-size":{ "type":"number", "format":"number", "minimum":500, "maximum":20000, "default":6000, "partition-visibility":"shared", "description":"Set the fragment size (KByte) of the aVCS transmit" }, "memory-stat-interval":{ "type":"number", "format":"number", "minimum":0, "maximum":120, "default":30, "partition-visibility":"shared", "description":"Interval of aVCS memory statistics record (minutes)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "vcs-summary":{ "type":"object", "$ref":"/axapi/v3/vcs/vcs-summary", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "images":{ "type":"object", "$ref":"/axapi/v3/vcs/images", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "showdebug":{ "type":"object", "$ref":"/axapi/v3/vcs/showdebug", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "vMaster-maintenance":{ "type":"object", "$ref":"/axapi/v3/vcs/vMaster-maintenance", "properties":{ "vMaster-maintenance":{ "type":"number", "format":"number", "minimum":0, "maximum":3600, "default":60, "partition-visibility":"shared", "description":"the seconds vMaster will be maintained, 60 by default" } } }, "vmaster-take-over":{ "type":"object", "$ref":"/axapi/v3/vcs/vmaster-take-over", "properties":{ "vmaster-take-over":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"vMaster take over priority" } } }, "reload":{ "type":"object", "$ref":"/axapi/v3/vcs/reload", "properties":{ "disable-merge":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"don't merge this vBlade's configuration to aVCS chassis" }, "db-safe":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"keep database safe" }, "start":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "timeout":{ "type":"number", "format":"number", "minimum":5, "maximum":300, "partition-visibility":"shared", "description":"automatically complete the db-safe mode when timeout" }, "complete":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared" }, "force":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"force to complete" }, "cluster-discovery":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"apply the configuration change on the aVCS cluster" }, "device":{ "type":"number", "format":"number", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Reload a specific device when VCS is enabled (device id)" } } }, "debug":{ "type":"object", "$ref":"/axapi/v3/vcs/debug", "properties":{ "daemon":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Daemon component" }, "election":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Election component" }, "info":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Information component" }, "daemon_msg":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Daemon message component" }, "election_pdu":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Election pdu component" }, "lib":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Lib component" }, "util":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Utility component" }, "ssl":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"SSL component" }, "net":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Net component" }, "vmaster_msg":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"vMaster Message component" }, "vblade_msg":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"vBlade Message component" }, "encoder":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Encoder component" }, "handler":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Handler component" }, "vmaster":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"vMaster component" }, "vblade":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"vBlade component" } } }, "device-list":{ "type":"array", "minItems":1, "items":{ "type":"device" }, "uniqueItems":true, "$ref":"/axapi/v3/vcs/device/{device}", "array":[ { "properties":{ "device":{ "type":"number", "format":"number", "platform-specific-range":1, "platform-specific-default":1, "partition-visibility":"shared", "description":"Device ID", "optional":false }, "priority":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Device priority", "optional":true }, "unicast-port":{ "type":"number", "format":"number", "minimum":1024, "maximum":65535, "default":41216, "partition-visibility":"shared", "description":"Port used in unicast communication (Port number)", "optional":true }, "management":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Management interface", "optional":true }, "ve-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ve":{ "type":"number", "format":"number", "minimum":2, "maximum":4094, "partition-visibility":"shared", "description":"VE interface (VE interface number)" } } } ] }, "trunk-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "trunk":{ "type":"number", "format":"number", "minimum":1, "maximum":4096, "partition-visibility":"shared", "description":"Trunk interface (Trunk interface number)" } } } ] }, "ethernet-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ethernet":{ "type":"number", "format":"interface", "partition-visibility":"shared", "description":"Ethernet (Ethernet interface number)" } } } ] }, "affinity-vrrp-a-vrid":{ "type":"number", "format":"number", "minimum":0, "maximum":31, "partition-visibility":"shared", "description":"vrid-group", "optional":true }, "ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":128, "default":64, "partition-visibility":"shared", "description":"TTL of the VCS packet", "optional":true }, "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "device" ] } ] }, "unicast-election":{ "type":"object", "$ref":"/axapi/v3/vcs/unicast-election", "properties":{ "port":{ "type":"number", "format":"number", "minimum":1024, "maximum":65000, "default":41217, "partition-visibility":"shared", "description":"Destination port for unicast election packet (Destination port for unicast election packet (default 41217))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "members":{ "type":"object", "$ref":"/axapi/v3/vcs/unicast-election/members", "properties":{ "ip-address-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ip-address":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not":"ipv6-address", "description":"IP Address of the member" }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use management port for connections in different subnet" } } } ] }, "ipv6-address-cfg":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "ipv6-address":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"ip-address", "description":"IPV6 address of the member" }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use management port for connections in different subnet" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "discovery-mode":{ "type":"object", "$ref":"/axapi/v3/vcs/discovery-mode", "properties":{ "action":{ "type":"string", "format":"enum", "default":"Mcast", "partition-visibility":"shared", "description":"'Unicast': enable VCS Unicast election; 'Mcast': enable VCS Multicast election; 'Mixed': enable VCS Multicast/Unicastelection; ", "enum":[ "Unicast", "Mcast", "Mixed" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "stat":{ "type":"object", "$ref":"/axapi/v3/vcs/stat", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] } } } ] } } } } }