HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

/system/vsx

put
https://switch-ip/rest/v10.16/system/vsx
Body Params
string
required

Reference Resource: VSX
VSX configuration and status. If not configured, VSX functionality is disabled.

boolean

Specifies whether the VSX configuration synchronization is enabled or not.

config_sync_features
array of strings
length ≤ 9223372036854776000

Feature configurations to be globally synchronized between VSX peers: aaa: Everything related to aaa. acl-log-timer: Everything related to access-list log timer. 'arp-security' : ARP SECURITY feature. bfd-global: Enable, disable and remove bfd, enable and disable bfd echo, configure transmit and receive intervals, detect multiplier, etc. bgp: BGP, ip aspath list, community list, prefix list, route map configurations. client-track-ip: Global configurations for client IP tracker. control-plane-acls: Control-plane Access-lists copp-policy: CoPP policies. dcb-global: Global configurations for features related to Data Center Bridging (DCBx, PFC and ETS). Only applicable to 8325 platforms. dhcp-relay: Everything related to DHCP relay. dhcp-server: Everything related to DHCPv4 and DHCPv6 server. dhcp-snooping: Everything related to DHCPv4 and DHCPv6 snooping. dns: Name servers, host names, etc. dsm: Distributed services module associated with VRF. evpn: EVPN related configurations. firewall-mode: Firewall Mode related configurations. forwarding-mode-global: forwarding-mode related global configuration. gbp: gbp related configuration gbp-acl-global: gbp acl applied to global context hardware-high-capacity-tcam: Feature configured in high capacity TCAM ip-ecmp Configurations related to IP ECMP icmp-tcp: Configurations related to ICMP and TCP. internal-vlan-range: Configurations related to internal VLAN range. keychain: Everything related to keychain configurations. l2-vlan-mac-cfg-mode: L2 VLAN MAC configuration mode. Only applicable to 8320 and 8325 platforms. lldp: Everything related to LLDP. loop-protect-global: Loop-protect global configurations. mac-lockout: mac lockout configurations. macsec: Configurations related to MACsec. mclag-interfaces: Features on multi-chassis LAGs that have to be identical on both peers: QoS, LACP, Loop-Protect, LAG description, sFlow, STP, Rate-Limits, Vlans, ACLs, etc. mgmd-global: Sync MGMD global configurations. msdp-global: Sync MSDP global configurations. nd-snooping : Everything related to ND snooping. neighbor : Everything related to IPv4 and IPv6 neighbors mostly static neighbors ospf: OSPF, route map and keychain configurations. pim: Configurations related to PIM. policy-global: Classifier policy applied to the global context. private-vlan-global: Private VLAN global configuration. rip: Everything related to RIP and RIPng configurations. qos-global: DSCP-Maps, CoS-Maps, QoS-Trust. route-map: IP aspath list, community list, prefix list, route map configurations. sflow-global: Everything related to sFlow. snmp: SNMPv3 contexts, SNMPv3 users, SNMP traps, SNMP communities, etc. ssh: Secure shell configurations. static-routes: Static routes. stp-global: Global (not per-interface) STP configurations. telnet: Telnet server configurations. time: Everything related to time - NTP, time zone, etc. udp-forwarder: UDP forwarder feature. vrrp: VRRP configurations, except anything realted to BFD. vsx-global : Sync inter-switch-link timers, Keepalive timers, keepalive udp-port, system-mac, split-recovery and linkup delay timer. port-access: Configurations related to port-access.

config_sync_features
string
enum

Specifies whether the device will act as primary or secondary for VSX. VSX operation requires one peer switch to be primary and the other secondary. If not configured, then the device will not participate in VSX role election.

Allowed:
string

Reference Resource: Port
References port to be used as inter switch link. If not configured, then the device will not participate in VSX formation.

isl_timers
object
string
length ≤ 45

IPv4/IPv6 address of the peer device. If not configured, keepalive functionality is disabled.

string
length ≤ 45

IPv4/IPv6 address of the device. If not configured, keepalive functionality is disabled.

keepalive_timers
object
integer
1024 to 65535

UDP port number of peer device.

string

Reference Resource: VRF
VRF to be used for keepalive routing. If not configured, then the default VRF is used.

integer
0 to 600

Number of seconds that multi-chassis LAGs should be held down after the ISL is considered to be fully established and VSX switches are synchronized. Comes into effect on new ISL deployments, ISL flaps or full device reboot.

int64
0 to 4294967295

Number of times a software update process was requested to be aborted. The abort operation takes effect only when the update operation is in progress.

int64

Time (in seconds from epoch) when the update should be performed. When the software update parameters (URL, VRF, schedule_time[optional] are added/updated, the new image is downloaded to alternate bank of both, primary and secondary. Post download, the secondary is rebooted and then followed by the primary.

string
length ≤ 512

URL for downloading software from connected storage or remote host. TFTP and USB are the only download methods supported. For pre-staged software upgrade use usb://boot_bank=primary or usb://boot_bank=secondary For remote download, use tftp://tftpserver_address/absolute_path_of_file, tftp server address can be an IPv4, IPv6 or a fully qualified domain address. Example: tftp://15.119.49.148/halon/new_image.swi Example: usb://boot_bank=primary

string

Reference Resource: VRF
VRF that is used for downloading the image. If the VRF is not specified then the default VRF is used.

boolean

Disables split brain recovery.

string
length between 17 and 17

System MAC address to be used by L2 control plane protocols like STP and LACP as their Bridge Identifier. A pair of VSX switches must have the same system MAC. If system MAC is not configured, L2 control plane protocols will use the VSX Primary device MAC address as their Bridge Identifier. MAC address will be in xx:xx:xx:xx:xx:xx format.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated over 4 years ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated over 4 years ago