GoSwitch (2.5.5)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: http://www.extremenetworks.com License: Apache license

GoSwitch is the SBI to abstract device calls across different versions of Network OS and different Types of Network OSs by providing different connectors for Getting/Setting Configuration and State data

Vlan

Vlan operations

Configure a single or range of Vlans

Request Body schema: application/json

Vlan configuration

required	object (DeviceInfo)
required	object (vlanModel) Vlan model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"VlanIDs": "20-40, 50, 80-100",
"Config": {"Name": "GOSW",
"Description": "Goswitch vlan",
"RouterInterface": 10,
"SuppressArp": true,
"SuppressNd": true
},
"State": {"Type": "static",
"Name": "VLAN0450",
"State": "suspend",
"Interfaces": [{"Type": "string",
"Name": "string",
"Tagging": "string"
}
]
}
}
}

Delete a single or range of Vlans

Request Body schema: application/json

Vlan unconfiguration

required	object (DeviceInfo)
required	object (vlanModel) Vlan model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"VlanIDs": "20-40, 50, 80-100",
"Config": {"Name": "GOSW",
"Description": "Goswitch vlan",
"RouterInterface": 10,
"SuppressArp": true,
"SuppressNd": true
},
"State": {"Type": "static",
"Name": "VLAN0450",
"State": "suspend",
"Interfaces": [{"Type": "string",
"Name": "string",
"Tagging": "string"
}
]
}
}
}

Get single or multiple vlans

Request Body schema: application/json

User can specify a vlan id(e.g. 10), a mix of id and range (e.g. 10, 20-30) and all vlan by specifying ""

required	object (DeviceInfo)
required	object (vlanModel) Vlan model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"VlanIDs": "20-40, 50, 80-100",
"Config": {"Name": "GOSW",
"Description": "Goswitch vlan",
"RouterInterface": 10,
"SuppressArp": true,
"SuppressNd": true
},
"State": {"Type": "static",
"Name": "VLAN0450",
"State": "suspend",
"Interfaces": [{"Type": "string",
"Name": "string",
"Tagging": "string"
}
]
}
}
}

Configure Vlan interface parameters

Request Body schema: application/json

Vlan configuration and unconfiguration.

required	object (DeviceInfo)
required	object (vlanModel) Vlan model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"VlanIDs": "20-40, 50, 80-100",
"Config": {"Name": "GOSW",
"Description": "Goswitch vlan",
"RouterInterface": 10,
"SuppressArp": true,
"SuppressNd": true
},
"State": {"Type": "static",
"Name": "VLAN0450",
"State": "suspend",
"Interfaces": [{"Type": "string",
"Name": "string",
"Tagging": "string"
}
]
}
}
}

Delete Vlan parameters

Request Body schema: application/json

Vlan unconfiguration

required	object (DeviceInfo)
required	object (vlanModel) Vlan model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"VlanIDs": "20-40, 50, 80-100",
"Config": {"Name": "GOSW",
"Description": "Goswitch vlan",
"RouterInterface": 10,
"SuppressArp": true,
"SuppressNd": true
},
"State": {"Type": "static",
"Name": "VLAN0450",
"State": "suspend",
"Interfaces": [{"Type": "string",
"Name": "string",
"Tagging": "string"
}
]
}
}
}

Device

Device operations

Connect to a specific Device

Request Body schema: application/json

Establish a device connection

device_ip_address	string Device IP Address
username	string
password	string
sessionid	string Encoded string identifying the device connection information. For /Device/Connection, sessionid = ""

Responses

Request samples

Payload

Content type

application/json

{"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
}

Close a device connection

Request Body schema: application/json

Close a device connection

device_ip_address	string Device IP Address
username	string
password	string
sessionid	string Encoded string identifying the device connection information. For /Device/Connection, sessionid = ""

Responses

Request samples

Payload

Content type

application/json

{"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
}

Ethernet Interface

Ethernet operations

Configure Ethernet interface parameters

Request Body schema: application/json

Ethernet interface configuration and unconfiguration

required	object (DeviceInfo)
required	object (ethernetModel) Ethernet model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Eth 0/24-28",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwitchPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "GOSW",
"Mtu": 2300,
"ChannelGroupID": 0,
"ChannelGroupMode": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": {"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
},
"AdminState": "down",
"OperationalState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 2300,
"Mac": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Unconfiguring Ethernet interface parameters

Request Body schema: application/json

Ethernet unconfiguration

required	object (DeviceInfo)
required	object (ethernetModel) Ethernet model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Eth 0/24-28",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwitchPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "GOSW",
"Mtu": 2300,
"ChannelGroupID": 0,
"ChannelGroupMode": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": {"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
},
"AdminState": "down",
"OperationalState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 2300,
"Mac": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

SendConfigCommand

Sending config commands to the switch

Send range of commands to switch for sequential execution

Request Body schema: application/json

Send range of commands to switch for sequential execution

required	object (DeviceInfo)
Commands required	Array of strings A single command or a sequence of commands can be sent to the switch The commands are executed in a sequential order

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Commands": "Ethernet Interface 0/2, switchport, swithport mode trunk"
}

Evpn

Evpn operations

Create an EVPN Instance.

Request Body schema: application/json

EVPN Instance configuration

required	object (DeviceInfo)
required	object (EVPNInstance) Evpn model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"BridgeDomain": "20-40",
"Vlan": "20-40, 50, 80-100",
"Rd": "auto",
"RouteTarget": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
],
"DfDelayTimer": 5,
"DuplicateMacTimer": 30,
"DuplicateMacTimerMaxCount": 5,
"BridgeDomainCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
],
"VlanCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
]
}
}
}

Delete the EVPN Instance

Request Body schema: application/json

EVPN Instance unconfiguration

required	object (DeviceInfo)
required	object (EVPNInstance) Evpn model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"BridgeDomain": "20-40",
"Vlan": "20-40, 50, 80-100",
"Rd": "auto",
"RouteTarget": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
],
"DfDelayTimer": 5,
"DuplicateMacTimer": 30,
"DuplicateMacTimerMaxCount": 5,
"BridgeDomainCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
],
"VlanCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
]
}
}
}

Update the Evpn Instance parameters

Request Body schema: application/json

Updating the Evpn Instance configuration and unconfiguration

required	object (DeviceInfo)
required	object (EVPNInstance) Evpn model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"BridgeDomain": "20-40",
"Vlan": "20-40, 50, 80-100",
"Rd": "auto",
"RouteTarget": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
],
"DfDelayTimer": 5,
"DuplicateMacTimer": 30,
"DuplicateMacTimerMaxCount": 5,
"BridgeDomainCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
],
"VlanCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
]
}
}
}

Delete the EVPN Instance parameters

Request Body schema: application/json

EVPN Instance unconfiguration

required	object (DeviceInfo)
required	object (EVPNInstance) Evpn model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"BridgeDomain": "20-40",
"Vlan": "20-40, 50, 80-100",
"Rd": "auto",
"RouteTarget": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
],
"DfDelayTimer": 5,
"DuplicateMacTimer": 30,
"DuplicateMacTimerMaxCount": 5,
"BridgeDomainCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
],
"VlanCfg": [{"ID": 0,
"RDValue": "100:10",
"RTValues": [{"RTType": "both",
"RTValue": "100:10",
"IgnoreAs": false
}
]
}
]
}
}
}

OverlayGateway

Overlay gateway operations

Create an Overlay Gateway

Request Body schema: application/json

Overlay Gateway configuration

required	object (DeviceInfo)
required	object (OverlayGateway) Overlay gateway model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"OverlayGatewayName": "test",
"OverlayGatewayType": "layer2-extension",
"Config": {"VLANVniMapping": [{"VLANID": 10,
"VNI": 10
}
],
"BDVniMapping": [{"BridgeDomain": 20,
"VNI": 20
}
],
"VlanVNIAuto": true,
"IPInterfaceType": "ethernet",
"IPInterfaceName": "1",
"VeInterfaceVrrp": "3",
"ServicePolicy": "test",
"Activate": true,
"Sites": [{"ID": "S1",
"DestIPAddress": "10.10.10.3",
"ExtendVlan": "10",
"ExtendBD": "20",
"Description": "overlay gateway site",
"BFDEnable": true,
"MinBFDTx": 500,
"MinBFDRx": 500,
"Multiplier": 5
}
]
},
"State": { }
}
}

Delete an Overlay Gateway

Request Body schema: application/json

Deleting an overlay gateway

required	object (DeviceInfo)
required	object (OverlayGateway) Overlay gateway model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"OverlayGatewayName": "test",
"OverlayGatewayType": "layer2-extension",
"Config": {"VLANVniMapping": [{"VLANID": 10,
"VNI": 10
}
],
"BDVniMapping": [{"BridgeDomain": 20,
"VNI": 20
}
],
"VlanVNIAuto": true,
"IPInterfaceType": "ethernet",
"IPInterfaceName": "1",
"VeInterfaceVrrp": "3",
"ServicePolicy": "test",
"Activate": true,
"Sites": [{"ID": "S1",
"DestIPAddress": "10.10.10.3",
"ExtendVlan": "10",
"ExtendBD": "20",
"Description": "overlay gateway site",
"BFDEnable": true,
"MinBFDTx": 500,
"MinBFDRx": 500,
"Multiplier": 5
}
]
},
"State": { }
}
}

Update Overlay Gateway

Request Body schema: application/json

Updating the Overlay Gateway configuration and unconfiguration

required	object (DeviceInfo)
required	object (OverlayGateway) Overlay gateway model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"OverlayGatewayName": "test",
"OverlayGatewayType": "layer2-extension",
"Config": {"VLANVniMapping": [{"VLANID": 10,
"VNI": 10
}
],
"BDVniMapping": [{"BridgeDomain": 20,
"VNI": 20
}
],
"VlanVNIAuto": true,
"IPInterfaceType": "ethernet",
"IPInterfaceName": "1",
"VeInterfaceVrrp": "3",
"ServicePolicy": "test",
"Activate": true,
"Sites": [{"ID": "S1",
"DestIPAddress": "10.10.10.3",
"ExtendVlan": "10",
"ExtendBD": "20",
"Description": "overlay gateway site",
"BFDEnable": true,
"MinBFDTx": 500,
"MinBFDRx": 500,
"Multiplier": 5
}
]
},
"State": { }
}
}

Delete an Overlay Gateway

Request Body schema: application/json

Deleting an overlay gateway

required	object (DeviceInfo)
required	object (OverlayGateway) Overlay gateway model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"OverlayGatewayName": "test",
"OverlayGatewayType": "layer2-extension",
"Config": {"VLANVniMapping": [{"VLANID": 10,
"VNI": 10
}
],
"BDVniMapping": [{"BridgeDomain": 20,
"VNI": 20
}
],
"VlanVNIAuto": true,
"IPInterfaceType": "ethernet",
"IPInterfaceName": "1",
"VeInterfaceVrrp": "3",
"ServicePolicy": "test",
"Activate": true,
"Sites": [{"ID": "S1",
"DestIPAddress": "10.10.10.3",
"ExtendVlan": "10",
"ExtendBD": "20",
"Description": "overlay gateway site",
"BFDEnable": true,
"MinBFDTx": 500,
"MinBFDRx": 500,
"Multiplier": 5
}
]
},
"State": { }
}
}

BridgeDomain

Bridge domain operations

Create a BridgeDomain

Request Body schema: application/json

Bridge domain configuration

required	object (DeviceInfo)
required	object (BridgeDomain) Bridge domain model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ID": 100,
"Type": "P2MP",
"Config": {"LogicalInterfaceType": "ethernet",
"LogicalInterfaceName": "0/1.100",
"RouterInterface": 100,
"SuppressArp": true,
"SuppressNd": true,
"PseudoWireProfile": "string",
"Description": "string"
},
"State": {"Description": "string",
"RouterInterface": 0,
"LIF": [{"VlanID": 10,
"UntaggedLifName": ["string"
],
"TaggedLifName": ["string"
]
}
]
}
}
}

Delete a Bridge Domain

Request Body schema: application/json

Bridge domain unconfiguration

required	object (DeviceInfo)
required	object (BridgeDomain) Bridge domain model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ID": 100,
"Type": "P2MP",
"Config": {"LogicalInterfaceType": "ethernet",
"LogicalInterfaceName": "0/1.100",
"RouterInterface": 100,
"SuppressArp": true,
"SuppressNd": true,
"PseudoWireProfile": "string",
"Description": "string"
},
"State": {"Description": "string",
"RouterInterface": 0,
"LIF": [{"VlanID": 10,
"UntaggedLifName": ["string"
],
"TaggedLifName": ["string"
]
}
]
}
}
}

Update the Bridge Domain parameters

Request Body schema: application/json

Updating the bridge domain configuration and unconfiguration.

required	object (DeviceInfo)
required	object (BridgeDomain) Bridge domain model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ID": 100,
"Type": "P2MP",
"Config": {"LogicalInterfaceType": "ethernet",
"LogicalInterfaceName": "0/1.100",
"RouterInterface": 100,
"SuppressArp": true,
"SuppressNd": true,
"PseudoWireProfile": "string",
"Description": "string"
},
"State": {"Description": "string",
"RouterInterface": 0,
"LIF": [{"VlanID": 10,
"UntaggedLifName": ["string"
],
"TaggedLifName": ["string"
]
}
]
}
}
}

Delete the Bridge Domain parameters

Request Body schema: application/json

Bridge domain unconfiguration

required	object (DeviceInfo)
required	object (BridgeDomain) Bridge domain model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ID": 100,
"Type": "P2MP",
"Config": {"LogicalInterfaceType": "ethernet",
"LogicalInterfaceName": "0/1.100",
"RouterInterface": 100,
"SuppressArp": true,
"SuppressNd": true,
"PseudoWireProfile": "string",
"Description": "string"
},
"State": {"Description": "string",
"RouterInterface": 0,
"LIF": [{"VlanID": 10,
"UntaggedLifName": ["string"
],
"TaggedLifName": ["string"
]
}
]
}
}
}

LoopbackInterface

Loopback interface operations

Create a Loopback Interface

Request Body schema: application/json

Loopback Interface Configuration

required	object (DeviceInfo)
required	object (LoopbackInterface) Loopback interface model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "250",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"Name": "string"
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string"
}
}
}

Delete a loopback interface

Request Body schema: application/json

Loopback interface unconfiguation

required	object (DeviceInfo)
required	object (LoopbackInterface) Loopback interface model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "250",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"Name": "string"
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string"
}
}
}

Update the Loopback Interface parameters

Request Body schema: application/json

Update the loopback interface configuration and unconfiguration

required	object (DeviceInfo)
required	object (LoopbackInterface) Loopback interface model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "250",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"Name": "string"
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string"
}
}
}

Delete the loopback interface parameters

Request Body schema: application/json

Loopback interface unconfiguation

required	object (DeviceInfo)
required	object (LoopbackInterface) Loopback interface model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "250",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"Name": "string"
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string"
}
}
}

VeInterface

Ve interface operations

Create a Ve Interface

Request Body schema: application/json

Ve interface configuration

required	object (DeviceInfo)
required	object (VeInterface) Ve interface model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Ve99",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AnycastIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"VrrpeIP": {"Vrid": 20,
"VirtualIP": "99.99.99.99"
},
"Vrf": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Delete a Ve interface.

Request Body schema: application/json

Ve interface configuration

required	object (DeviceInfo)
required	object (VeInterface) Ve interface model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Ve99",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AnycastIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"VrrpeIP": {"Vrid": 20,
"VirtualIP": "99.99.99.99"
},
"Vrf": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Update the Ve Interface parameters

Request Body schema: application/json

Updating the Ve interface configuration and unconfiguration

required	object (DeviceInfo)
required	object (VeInterface) Ve interface model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Ve99",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AnycastIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"VrrpeIP": {"Vrid": 20,
"VirtualIP": "99.99.99.99"
},
"Vrf": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Delete the Ve interface parameters

Request Body schema: application/json

Ve interface configuration

required	object (DeviceInfo)
required	object (VeInterface) Ve interface model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Ve99",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AnycastIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"VrrpeIP": {"Vrid": 20,
"VirtualIP": "99.99.99.99"
},
"Vrf": "string",
"BFDIntervals": {"BFDMinTx": 300,
"BFDMinRx": 300,
"BFDMultiplier": 3
}
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"AdminState": "down",
"OperState": "down",
"Description": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Vrf

Vrf operations

Create a Vrf

Request Body schema: application/json

Vrf configuration

required	object (DeviceInfo)
required	object (Vrf) Vrf model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"ResilientHashMaxPath": 20,
"ResilientHashEcmpEnable": true,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrbVe": 200,
"AfiType": "ipv4",
"AfiRtType": "both",
"AfiRtValue": "100:100",
"EvpnIrb": null,
"RouterIP": "string",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
]
},
"State": {"VrfID": 0,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrb": "string",
"AfiType": "ipv4",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouterIP": "string",
"VrfInterfaces": ["string"
]
}
}
}

Delete a Vrf

Request Body schema: application/json

Vrf unconfiguration

required	object (DeviceInfo)
required	object (Vrf) Vrf model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"ResilientHashMaxPath": 20,
"ResilientHashEcmpEnable": true,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrbVe": 200,
"AfiType": "ipv4",
"AfiRtType": "both",
"AfiRtValue": "100:100",
"EvpnIrb": null,
"RouterIP": "string",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
]
},
"State": {"VrfID": 0,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrb": "string",
"AfiType": "ipv4",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouterIP": "string",
"VrfInterfaces": ["string"
]
}
}
}

Update the Vrf parameters

Request Body schema: application/json

Updating Vrf configuration and unconfiguration

required	object (DeviceInfo)
required	object (Vrf) Vrf model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"ResilientHashMaxPath": 20,
"ResilientHashEcmpEnable": true,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrbVe": 200,
"AfiType": "ipv4",
"AfiRtType": "both",
"AfiRtValue": "100:100",
"EvpnIrb": null,
"RouterIP": "string",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
]
},
"State": {"VrfID": 0,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrb": "string",
"AfiType": "ipv4",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouterIP": "string",
"VrfInterfaces": ["string"
]
}
}
}

Delete the Vrf parameters

Request Body schema: application/json

Vrf unconfiguration

required	object (DeviceInfo)
required	object (Vrf) Vrf model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "test",
"Config": {"ResilientHashMaxPath": 20,
"ResilientHashEcmpEnable": true,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrbVe": 200,
"AfiType": "ipv4",
"AfiRtType": "both",
"AfiRtValue": "100:100",
"EvpnIrb": null,
"RouterIP": "string",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
]
},
"State": {"VrfID": 0,
"RouteDistinguisher": "10.10.10.1:10",
"EvpnIrb": "string",
"AfiType": "ipv4",
"RouteTargets": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouteTargetsV6": ["Holds route target information for the Vlan/BD in Evpn Instance"
],
"RouterIP": "string",
"VrfInterfaces": ["string"
]
}
}
}

GlobalSetting

Global setting operations

Create a Global Setting

Request Body schema: application/json

Global Setting configuration

required	object (DeviceInfo)
required	object (GlobalSetting) Global Setting model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ConversationalArpAgingTimeout": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0,
"MacAgingTimeOut": 0,
"PersistSwitchCfg": true,
"GlobalL2MTU": 0,
"GlobalIPMTU": 0,
"GlobalIPV6MTU": 0,
"NodeID": 0,
"ProtocolVrrpe": true,
"Hostname": "string",
"IPAnyCastGat": {"Ipv4AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMacSupported": "string"
}
},
"State": {"ConversationalArpAgingTimeout": 0,
"ConversationalArpAgingMode": true,
"MacLearningMode": "string",
"MacAgingTimeOut": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0
}
}
}

Update Global Setting

Request Body schema: application/json

Updating the Global Setting configuration and unconfiguration

required	object (DeviceInfo)
required	object (GlobalSetting) Global Setting model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ConversationalArpAgingTimeout": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0,
"MacAgingTimeOut": 0,
"PersistSwitchCfg": true,
"GlobalL2MTU": 0,
"GlobalIPMTU": 0,
"GlobalIPV6MTU": 0,
"NodeID": 0,
"ProtocolVrrpe": true,
"Hostname": "string",
"IPAnyCastGat": {"Ipv4AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMacSupported": "string"
}
},
"State": {"ConversationalArpAgingTimeout": 0,
"ConversationalArpAgingMode": true,
"MacLearningMode": "string",
"MacAgingTimeOut": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0
}
}
}

Delete a Global Setting

Request Body schema: application/json

Deleting a GlobalSetting

required	object (DeviceInfo)
required	object (GlobalSetting) Global Setting model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ConversationalArpAgingTimeout": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0,
"MacAgingTimeOut": 0,
"PersistSwitchCfg": true,
"GlobalL2MTU": 0,
"GlobalIPMTU": 0,
"GlobalIPV6MTU": 0,
"NodeID": 0,
"ProtocolVrrpe": true,
"Hostname": "string",
"IPAnyCastGat": {"Ipv4AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMac": "string",
"Ipv6AnycastGatewayMacSupported": "string"
}
},
"State": {"ConversationalArpAgingTimeout": 0,
"ConversationalArpAgingMode": true,
"MacLearningMode": "string",
"MacAgingTimeOut": 0,
"ConversationalMACAgingTimeout": 0,
"ConversationalMoveLimit": 0
}
}
}

PortChannel

Port channel operations

Create a port channel

Request Body schema: application/json

PortChannel configuration

required	object (DeviceInfo)
required	object (portChannel) port channel model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Po64",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "string",
"Mtu": 0
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LACP": {"AggregatorID": 0,
"AggregatorType": "string",
"IsVlag": "string",
"AggregatorMode": "string",
"SystemPriority": 0,
"ActorSystemID": "string",
"PartnerOperPriority": 0,
"PartnerSystemID": "string",
"AdminKey": 0,
"OperKey": 0,
"PartnerOperKey": 0,
"RxLinkCount": 0,
"TxLinkCount": 0,
"IndividualAgg": 0,
"ReadyAgg": 0
},
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"OperState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 0,
"MAC": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Delete a Port Channel

Request Body schema: application/json

Port Channel unconfiguration

required	object (DeviceInfo)
required	object (portChannel) port channel model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Po64",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "string",
"Mtu": 0
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LACP": {"AggregatorID": 0,
"AggregatorType": "string",
"IsVlag": "string",
"AggregatorMode": "string",
"SystemPriority": 0,
"ActorSystemID": "string",
"PartnerOperPriority": 0,
"PartnerSystemID": "string",
"AdminKey": 0,
"OperKey": 0,
"PartnerOperKey": 0,
"RxLinkCount": 0,
"TxLinkCount": 0,
"IndividualAgg": 0,
"ReadyAgg": 0
},
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"OperState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 0,
"MAC": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Update the port channel parameters

Request Body schema: application/json

Updating the port channel configuration and unconfiguration

required	object (DeviceInfo)
required	object (portChannel) port channel model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Po64",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "string",
"Mtu": 0
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LACP": {"AggregatorID": 0,
"AggregatorType": "string",
"IsVlag": "string",
"AggregatorMode": "string",
"SystemPriority": 0,
"ActorSystemID": "string",
"PartnerOperPriority": 0,
"PartnerSystemID": "string",
"AdminKey": 0,
"OperKey": 0,
"PartnerOperKey": 0,
"RxLinkCount": 0,
"TxLinkCount": 0,
"IndividualAgg": 0,
"ReadyAgg": 0
},
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"OperState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 0,
"MAC": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

Delete the port channel parameters

Request Body schema: application/json

Port Channel unconfiguration

required	object (DeviceInfo)
required	object (portChannel) port channel model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "Po64",
"Config": {"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"AdminState": "down",
"Speed": "Speed10Gbps",
"Description": "string",
"Mtu": 0
},
"State": {"IfName": "string",
"IP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"SwPort": {"SwPortMode": "access",
"Vlans": "10,20,30",
"NativeVlan": 20
},
"LACP": {"AggregatorID": 0,
"AggregatorType": "string",
"IsVlag": "string",
"AggregatorMode": "string",
"SystemPriority": 0,
"ActorSystemID": "string",
"PartnerOperPriority": 0,
"PartnerSystemID": "string",
"AdminKey": 0,
"OperKey": 0,
"PartnerOperKey": 0,
"RxLinkCount": 0,
"TxLinkCount": 0,
"IndividualAgg": 0,
"ReadyAgg": 0
},
"Members": [{"InterfaceType": "ethernet",
"InterfaceName": "0/28",
"Description": "Port-channel Member interface 1",
"Speed": "Speed10Gbps",
"PoMode": "standard",
"AdminState": "down",
"PoProtocol": "modeon",
"ActorPort": 0,
"Sync": 0
}
],
"LogicalIf": [{"Instance": "64.2",
"Description": "GoSwitch Lif64.2",
"AdminState": "down",
"Vlan": 302,
"VlanType": "tagged"
}
],
"AdminState": "down",
"OperState": "down",
"Speed": "Speed10Gbps",
"ActualLineSpeed": "Speed10Gbps",
"Description": "string",
"Mtu": 0,
"MAC": "string",
"PortRole": "string",
"Vrrp": [{"Vrid": 0,
"Extended": "string",
"Enabled": "string",
"PreemptMode": "string",
"ShortPathForwarding": "string",
"SPFRevertPriority": 0,
"Priority": 0,
"VirtualIP": "string",
"VirtualMac": "string"
}
]
}
}
}

MctCluster

MctCluster operations

Create a MctCluster

Request Body schema: application/json

MctCluster configuration

required	object (DeviceInfo)
required	object (MctCluster) MctCluster model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ClusterID": 102,
"ClusterName": "test",
"Config": {"ControlVlan": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"ClusterDeploy": true,
"DfLoadBalance": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": true,
"InterfaceType": "ethernet",
"InterfaceName": "string"
}
]
},
"State": {"ControlVlan": 0,
"ControlVe": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"PeerState": "string",
"TunnelType": "string",
"ClusterDeploy": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": "string",
"InterfaceType": "ethernet",
"InterfaceName": "string",
"InterfaceState": "string"
}
]
}
}
}

Delete a MctCluster

Request Body schema: application/json

MctCluster unconfiguration

required	object (DeviceInfo)
required	object (MctCluster) MctCluster model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ClusterID": 102,
"ClusterName": "test",
"Config": {"ControlVlan": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"ClusterDeploy": true,
"DfLoadBalance": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": true,
"InterfaceType": "ethernet",
"InterfaceName": "string"
}
]
},
"State": {"ControlVlan": 0,
"ControlVe": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"PeerState": "string",
"TunnelType": "string",
"ClusterDeploy": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": "string",
"InterfaceType": "ethernet",
"InterfaceName": "string",
"InterfaceState": "string"
}
]
}
}
}

Update the MctCluster parameters

Request Body schema: application/json

Updating MctCluster configuration and unconfiguration

required	object (DeviceInfo)
required	object (MctCluster) MctCluster model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ClusterID": 102,
"ClusterName": "test",
"Config": {"ControlVlan": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"ClusterDeploy": true,
"DfLoadBalance": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": true,
"InterfaceType": "ethernet",
"InterfaceName": "string"
}
]
},
"State": {"ControlVlan": 0,
"ControlVe": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"PeerState": "string",
"TunnelType": "string",
"ClusterDeploy": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": "string",
"InterfaceType": "ethernet",
"InterfaceName": "string",
"InterfaceState": "string"
}
]
}
}
}

Delete the MctCluster parameters

Request Body schema: application/json

MctCluster unconfiguration

required	object (DeviceInfo)
required	object (MctCluster) MctCluster model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"ClusterID": 102,
"ClusterName": "test",
"Config": {"ControlVlan": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"ClusterDeploy": true,
"DfLoadBalance": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": true,
"InterfaceType": "ethernet",
"InterfaceName": "string"
}
]
},
"State": {"ControlVlan": 0,
"ControlVe": 0,
"PeerInfo": {"InterfaceType": "ethernet",
"InterfaceName": "string",
"PeerIP": "string",
"Source": {"IP": "string",
"SourceLoopbackInterfaceName": "string"
}
},
"PeerState": "string",
"TunnelType": "string",
"ClusterDeploy": true,
"ClientIntfShutdown": true,
"ClientIsolationModeStrict": true,
"Clients": [{"ClientID": 0,
"ClientName": "string",
"ESI": "string",
"Deployed": "string",
"InterfaceType": "ethernet",
"InterfaceName": "string",
"InterfaceState": "string"
}
]
}
}
}

MctClusterManagement

MctClusterManagement operations

Create a MctClusterManagement

Request Body schema: application/json

MctClusterManagement configuration

required	object (DeviceInfo)
required	object (MctClusterManagement) MctClusterManagement model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": null,
"State": {"PrincipalMac": "string",
"NumNodes": 0,
"DisconnectedNodes": 0,
"Nodes": [{"NodeNum": 0,
"SerialNum": "string",
"Condition": "string",
"Status": "string",
"NodeID": 0,
"IsPrincipal": true,
"SwitchMac": "string",
"InternalIP": "string",
"PublicIP": "string",
"PublicIPV6": "string",
"FirmwareVersion": "string",
"SwitchType": "string",
"IsLocal": true
}
]
}
}
}

Get all mct cluster management

Request Body schema: application/json

get all mct cluster management configurations

required	object (DeviceInfo)
required	object (MctClusterManagement) MctClusterManagement model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": null,
"State": {"PrincipalMac": "string",
"NumNodes": 0,
"DisconnectedNodes": 0,
"Nodes": [{"NodeNum": 0,
"SerialNum": "string",
"Condition": "string",
"Status": "string",
"NodeID": 0,
"IsPrincipal": true,
"SwitchMac": "string",
"InternalIP": "string",
"PublicIP": "string",
"PublicIPV6": "string",
"FirmwareVersion": "string",
"SwitchType": "string",
"IsLocal": true
}
]
}
}
}

Delete a MctClusterManagement

Request Body schema: application/json

MctClusterManagement unconfiguration

required	object (DeviceInfo)
required	object (MctClusterManagement) MctClusterManagement model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": null,
"State": {"PrincipalMac": "string",
"NumNodes": 0,
"DisconnectedNodes": 0,
"Nodes": [{"NodeNum": 0,
"SerialNum": "string",
"Condition": "string",
"Status": "string",
"NodeID": 0,
"IsPrincipal": true,
"SwitchMac": "string",
"InternalIP": "string",
"PublicIP": "string",
"PublicIPV6": "string",
"FirmwareVersion": "string",
"SwitchType": "string",
"IsLocal": true
}
]
}
}
}

bgpAddressFamily

bgpAddressFamily operations

BGP address family configuration

Request Body schema: application/json

BGP address family configuration

required	object (DeviceInfo)
required	object (bgpAddressFamily) bgpAddressFamily model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"AddressFamilyIpv4": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": [{"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
}
],
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true,
"DeActivate": false
}
]
}
],
"AddressFamilyIpv6": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": {"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
},
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true
}
]
}
],
"AddressFamilyEvpn": [{"RetainRtAll": true,
"GracefulRestart": true,
"NeighborInfo": [{"Neighbor": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"Encapsulation": "vxlan",
"EnablePeerAsCheck": true,
"Activate": true,
"NhopUnchanged": true,
"AlloweAsIn": 10
}
]
}
]
}
}
}

BGP address family unconfiguration

Request Body schema: application/json

BGP address family unconfiguration

required	object (DeviceInfo)
required	object (bgpAddressFamily) bgpAddressFamily model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"AddressFamilyIpv4": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": [{"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
}
],
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true,
"DeActivate": false
}
]
}
],
"AddressFamilyIpv6": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": {"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
},
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true
}
]
}
],
"AddressFamilyEvpn": [{"RetainRtAll": true,
"GracefulRestart": true,
"NeighborInfo": [{"Neighbor": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"Encapsulation": "vxlan",
"EnablePeerAsCheck": true,
"Activate": true,
"NhopUnchanged": true,
"AlloweAsIn": 10
}
]
}
]
}
}
}

Update the bgp address family parameters

Request Body schema: application/json

Updating bgp address family configuration and unconfiguration

required	object (DeviceInfo)
required	object (bgpAddressFamily) bgpAddressFamily model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"AddressFamilyIpv4": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": [{"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
}
],
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true,
"DeActivate": false
}
]
}
],
"AddressFamilyIpv6": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": {"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
},
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true
}
]
}
],
"AddressFamilyEvpn": [{"RetainRtAll": true,
"GracefulRestart": true,
"NeighborInfo": [{"Neighbor": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"Encapsulation": "vxlan",
"EnablePeerAsCheck": true,
"Activate": true,
"NhopUnchanged": true,
"AlloweAsIn": 10
}
]
}
]
}
}
}

Deleting Bgp address family parameters

Request Body schema: application/json

BGP address family unconfiguration

required	object (DeviceInfo)
required	object (bgpAddressFamily) bgpAddressFamily model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"AddressFamilyIpv4": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": [{"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
}
],
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true,
"DeActivate": false
}
]
}
],
"AddressFamilyIpv6": [{"Vrf": "default-vrf",
"Network": [{"NetworkAddress": "10.10.10.10/22",
"RouteMap": "test-map",
"Weight": 2,
"Backdoor": true
}
],
"GracefulRestart": false,
"MaxPathInfo": {"MaxPath": 8,
"MaxPatheBgp": 8,
"MaxPathiBgp": 8
},
"Redistribute": {"Redistribute": "connected",
"Metric": 20,
"RouteMap": "test-map"
},
"NeighborInfo": [{"Neighbor": {"BgpNeighborConfig": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"UpdateSource": {"IP": "10.10.10.1",
"InterfaceType": "ethernet",
"InterfaceName": "test"
}
},
"Activate": true
}
]
}
],
"AddressFamilyEvpn": [{"RetainRtAll": true,
"GracefulRestart": true,
"NeighborInfo": [{"Neighbor": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"Encapsulation": "vxlan",
"EnablePeerAsCheck": true,
"Activate": true,
"NhopUnchanged": true,
"AlloweAsIn": 10
}
]
}
]
}
}
}

BgpNeighbor

BgpNeighbor operations

Get all bgp neighbor configs

Request Body schema: application/json

get all bgp neighbor configurations

required	object (DeviceInfo)
required	object (BgpNeighbor) Bgp Neighbor model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"PeerGroupName": "test-1",
"NeighborAddress": "1.1.1.1",
"EnablePeerAsCheck": true,
"RemoteAsn": 99,
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"EbgpMhop": 99
},
"State": {"NeighborAddress": "1.1.1.1",
"RemoteAsn": 99,
"State": "string",
"TimeSinceUp": "string",
"Vrf": "vrf1",
"Afi": "bgp-ipv4",
"Safi": "evpn"
}
}
}

bgpGlobal

bgpGlobal operations

BGP global configuration

Request Body schema: application/json

BGP global configuration

required	object (DeviceInfo)
required	object (BgpGlobalModel) Bgpglobal model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"RouterID": "1.1.1.1",
"BgpInfo": {"LocalAsn": 101,
"SwitchRole": "string",
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"CapabilityAS4Enable": true,
"FastExternalFallover": true
},
"PeerGroupInfo": [{"Name": "test-1",
"Description": "test-1",
"Password": "xxxxxxx",
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"RemoteAsn": 99,
"GracefulShutdownTimer": 0
}
]
},
"State": null
}
}

BGP global unconfiguration

Request Body schema: application/json

bgpGlobal unconfiguration

required	object (DeviceInfo)
required	object (BgpGlobalModel) Bgpglobal model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"RouterID": "1.1.1.1",
"BgpInfo": {"LocalAsn": 101,
"SwitchRole": "string",
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"CapabilityAS4Enable": true,
"FastExternalFallover": true
},
"PeerGroupInfo": [{"Name": "test-1",
"Description": "test-1",
"Password": "xxxxxxx",
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"RemoteAsn": 99,
"GracefulShutdownTimer": 0
}
]
},
"State": null
}
}

Update the bgp global parameters

Request Body schema: application/json

Updating bgp global configuration and unconfiguration

required	object (DeviceInfo)
required	object (BgpGlobalModel) Bgpglobal model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"RouterID": "1.1.1.1",
"BgpInfo": {"LocalAsn": 101,
"SwitchRole": "string",
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"CapabilityAS4Enable": true,
"FastExternalFallover": true
},
"PeerGroupInfo": [{"Name": "test-1",
"Description": "test-1",
"Password": "xxxxxxx",
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"RemoteAsn": 99,
"GracefulShutdownTimer": 0
}
]
},
"State": null
}
}

Deleting Bgp global parameters

Request Body schema: application/json

BGP global unconfiguration

required	object (DeviceInfo)
required	object (BgpGlobalModel) Bgpglobal model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"RouterID": "1.1.1.1",
"BgpInfo": {"LocalAsn": 101,
"SwitchRole": "string",
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"CapabilityAS4Enable": true,
"FastExternalFallover": true
},
"PeerGroupInfo": [{"Name": "test-1",
"Description": "test-1",
"Password": "xxxxxxx",
"BfdEnable": true,
"BfdTx": 300,
"BfdRx": 300,
"BfdMultiplier": 3,
"RemoteAsn": 99,
"GracefulShutdownTimer": 0
}
]
},
"State": null
}
}

IPPrefix

IP Prefix operations

Create an ip prefix

Request Body schema: application/json

IPPrefix configuration

required	object (DeviceInfo)
required	object (ipPrefix) IP Prefix model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_prefix_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"GreaterThanIPPrefixLength": 31,
"LessThanIPPrefixLength": 31,
"IPPrefix": "0.0.0.0/0"
},
"State": null
}
}

Delete an IP Prefix config

Request Body schema: application/json

Deleting IP Prefix config

required	object (DeviceInfo)
required	object (ipPrefix) IP Prefix model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_prefix_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"GreaterThanIPPrefixLength": 31,
"LessThanIPPrefixLength": 31,
"IPPrefix": "0.0.0.0/0"
},
"State": null
}
}

Update an ip prefix setting

Request Body schema: application/json

Updating the IP Prefix configuration and unconfiguration

required	object (DeviceInfo)
required	object (ipPrefix) IP Prefix model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_prefix_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"GreaterThanIPPrefixLength": 31,
"LessThanIPPrefixLength": 31,
"IPPrefix": "0.0.0.0/0"
},
"State": null
}
}

RouteMap

Route Map operations

Create a Route Map

Request Body schema: application/json

Route Map configuration

required	object (DeviceInfo)
required	object (RouteMap) Route Map model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_map_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"IPAddressPrefixListName": "10.10.10.10/0"
},
"State": null
}
}

Delete a Route Map config

Request Body schema: application/json

Deleting Route Map config

required	object (DeviceInfo)
required	object (RouteMap) Route Map model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_map_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"IPAddressPrefixListName": "10.10.10.10/0"
},
"State": null
}
}

Update RouteMap settings

Request Body schema: application/json

Updating the Route Map configuration settings

required	object (DeviceInfo)
required	object (RouteMap) Route Map model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Name": "test_map_permit",
"InstanceNumber": 100,
"ActionName": "permit",
"IPAddressPrefixListName": "10.10.10.10/0"
},
"State": null
}
}

StaticRoute

Static Route operations

Create a Static Route

Request Body schema: application/json

Static Route configuration

required	object (DeviceInfo)
required	object (StaticRoute) Static Route model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Vrf": "default-vrf",
"Afi": "ipv4",
"Config": {"LocalRoute": {"DestinationPrefix": {"Address": "99.99.99.1",
"Prefix": 22
},
"NextHops": [{"InterfaceType": "ethernet",
"InterfaceName": "string",
"IP": "string",
"Vrf": "string",
"LRAttributes": {"Metric": 0,
"Distance": 0,
"Tag": 0
}
}
]
}
},
"State": null
}
}

Delete a Static Route

Request Body schema: application/json

Static Route unconfiguration

required	object (DeviceInfo)
required	object (StaticRoute) Static Route model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Vrf": "default-vrf",
"Afi": "ipv4",
"Config": {"LocalRoute": {"DestinationPrefix": {"Address": "99.99.99.1",
"Prefix": 22
},
"NextHops": [{"InterfaceType": "ethernet",
"InterfaceName": "string",
"IP": "string",
"Vrf": "string",
"LRAttributes": {"Metric": 0,
"Distance": 0,
"Tag": 0
}
}
]
}
},
"State": null
}
}

Update the static route parameters

Request Body schema: application/json

Updating static route configuration and unconfiguration

required	object (DeviceInfo)
required	object (StaticRoute) Static Route model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Vrf": "default-vrf",
"Afi": "ipv4",
"Config": {"LocalRoute": {"DestinationPrefix": {"Address": "99.99.99.1",
"Prefix": 22
},
"NextHops": [{"InterfaceType": "ethernet",
"InterfaceName": "string",
"IP": "string",
"Vrf": "string",
"LRAttributes": {"Metric": 0,
"Distance": 0,
"Tag": 0
}
}
]
}
},
"State": null
}
}

Delete the Static Route parameters

Request Body schema: application/json

StaticRoute unconfiguration

required	object (DeviceInfo)
required	object (StaticRoute) Static Route model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Vrf": "default-vrf",
"Afi": "ipv4",
"Config": {"LocalRoute": {"DestinationPrefix": {"Address": "99.99.99.1",
"Prefix": 22
},
"NextHops": [{"InterfaceType": "ethernet",
"InterfaceName": "string",
"IP": "string",
"Vrf": "string",
"LRAttributes": {"Metric": 0,
"Distance": 0,
"Tag": 0
}
}
]
}
},
"State": null
}
}

TunnelInterface

Tunnel Interface operations

Get VXLAN tunnel info

Request Body schema: application/json

User can specify tunnel ID to get Tunnel info

required	object (DeviceInfo)
required	object (TunnelInterface) TunnelInterface structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"TunnelID": 10,
"Config": null,
"State": {"TunnelID": 0,
"TunnelMode": "vxlan-tunnel",
"TunnelSourceVtepIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"TunnelDestVtepIP": {"IPMtu": 1500,
"IPAddress": [{"Address": "99.99.99.1",
"Prefix": 22
}
],
"IPAddressUnnumbered": [{"DonorName": "ethernet",
"DonorID": "0/29"
}
],
"AnycastAddress": "string",
"ARPAgingTimeout": 0
},
"VRFName": "string",
"TunnelConfigurationSource": "string",
"TunnelAdminState": "down",
"TunnelOperState": "down",
"TunnelBFDState": "down",
"TunnelNodes": [{"NodeID": "string"
}
]
}
}
}

LldpInterface

Lldp Interface operations

Configure the Lldp Interface

Request Body schema: application/json

Lldp Interface configuration

required	object (DeviceInfo)
required	object (LldpInterface) LldpInterface structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"LocalInterfaceName": "lldp",
"Config": null,
"State": {"LocalInterfaceMac": "string",
"LldpNeighbor": {"RemoteInterfaceName": "string",
"RemoteInterfaceMac": "string",
"RemoteChassisID": "string",
"RemoteManagementAddress": "string",
"RemoteSystemName": "string",
"RemoteSystemDescription": "string",
"TTL": 0
}
}
}
}

Delete a Lldp Interface

Request Body schema: application/json

Lldp Interface unconfiguration

required	object (DeviceInfo)
required	object (LldpInterface) LldpInterface structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"LocalInterfaceName": "lldp",
"Config": null,
"State": {"LocalInterfaceMac": "string",
"LldpNeighbor": {"RemoteInterfaceName": "string",
"RemoteInterfaceMac": "string",
"RemoteChassisID": "string",
"RemoteManagementAddress": "string",
"RemoteSystemName": "string",
"RemoteSystemDescription": "string",
"TTL": 0
}
}
}
}

Ntp

Ntp operations

Configure the Ntp

Request Body schema: application/json

Ntp configuration

required	object (DeviceInfo)
required	object (Ntp) Ntp master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
},
"State": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
}
}
}

Delete a Ntp

Request Body schema: application/json

Ntp unconfiguration

required	object (DeviceInfo)
required	object (Ntp) Ntp master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
},
"State": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
}
}
}

Update the Ntp parameters

Request Body schema: application/json

Updating Ntp configuration and unconfiguration

required	object (DeviceInfo)
required	object (Ntp) Ntp master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
},
"State": {"ServerIP": "192.168.2.13",
"SourceIP": "chassis-ip",
"Vrf": "mgmt-vrf",
"AuthenticationKey": 0
}
}
}

PseudoWire

PseudoWire In operations

Configure the PseudoWire

Request Body schema: application/json

create pseudo wire

required	object (DeviceInfo)
required	object (PseudoWire) Pseudo wire master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "string",
"Config": {"VcMode": "tag"
},
"State": null
}
}

Delete a PseudoWire

Request Body schema: application/json

PseudoWire unconfiguration

required	object (DeviceInfo)
required	object (PseudoWire) Pseudo wire master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "string",
"Config": {"VcMode": "tag"
},
"State": null
}
}

Update the Pseudo Wire parameters

Request Body schema: application/json

Updating PseudoWire configuration and unconfiguration.

required	object (DeviceInfo)
required	object (PseudoWire) Pseudo wire master structure

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "string",
"Config": {"VcMode": "tag"
},
"State": null
}
}

SwitchDetails

Switch operations

Get config details for switch info

Request Body schema: application/json

User can specify switch name to get config details

required	object (DeviceInfo)
required	object (SwitchDetails) Switch details model.

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"SwitchName": "string"
},
"State": {"ChassisName": "string",
"SwitchName": "string",
"SwitchModel": "string",
"FirmwareVer": "string",
"StackMac": "string",
"BgpLocalAS": "string",
"ManagmentIP": "string",
"WWNFactorySerialNum": "string",
"WWNFactoryPartNum": "string",
"IsVirtualDevice": true
}
}
}

RadiusServer

Radius Server operations

Configure the Radius Server

Request Body schema: application/json

Radius Server configuration

required	object (DeviceInfo)
required	object (RadiusServer) Radius Server model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
},
"State": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
}
}
}

Delete a RadiusServer

Request Body schema: application/json

Radius Server unconfiguration.

required	object (DeviceInfo)
required	object (RadiusServer) Radius Server model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
},
"State": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
}
}
}

Update the Radius Server

Request Body schema: application/json

Updating Radius Server configuration and unconfiguration

required	object (DeviceInfo)
required	object (RadiusServer) Radius Server model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
},
"State": {"Hostname": "192.168.1.13",
"AuthPort": 1,
"Protocol": "pap",
"Key": "string",
"EncryptionLevel": 0,
"Retries": 0,
"Timeout": 1,
"Vrf": "default-vrf"
}
}
}

MacACL

MacACL operations

Configure macACL

Request Body schema: application/json

Mac ACL configuration

required	object (DeviceInfo)
required	object (macACL) Mac ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "mac_acl_std_1",
"Type": "acl-standard",
"Config": {"Data": {"MacStandardACL": [{"SeqNo": 10,
"Action": "permit",
"Rule": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": "0500.0100.0000"
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": "0600.0100.0000",
"MacMask": "0255.0255.0255"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"MacExtendedACL": [{"SeqNo": 20,
"Action": "permit",
"Rule": {"SrcAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"DestAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"EtherType": "arp",
"VlanID": 20,
"Pcp": 3,
"VlanTagFormat": "mac-untagged"
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"PcpForce": 3,
"Mirror": false,
"DropPrecedenceForce": 1
}
}
]
}
},
"State": { }
}
}

Delete a macACL

Request Body schema: application/json

Mac ACL unconfiguration.

required	object (DeviceInfo)
required	object (macACL) Mac ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "mac_acl_std_1",
"Type": "acl-standard",
"Config": {"Data": {"MacStandardACL": [{"SeqNo": 10,
"Action": "permit",
"Rule": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": "0500.0100.0000"
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": "0600.0100.0000",
"MacMask": "0255.0255.0255"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"MacExtendedACL": [{"SeqNo": 20,
"Action": "permit",
"Rule": {"SrcAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"DestAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"EtherType": "arp",
"VlanID": 20,
"Pcp": 3,
"VlanTagFormat": "mac-untagged"
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"PcpForce": 3,
"Mirror": false,
"DropPrecedenceForce": 1
}
}
]
}
},
"State": { }
}
}

Get single or multiple Mac ACL

Request Body schema: application/json

Gets a single or all Mac ACL

required	object (DeviceInfo)
required	object (macACL) Mac ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Name": "mac_acl_std_1",
"Type": "acl-standard",
"Config": {"Data": {"MacStandardACL": [{"SeqNo": 10,
"Action": "permit",
"Rule": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": "0500.0100.0000"
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": "0600.0100.0000",
"MacMask": "0255.0255.0255"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"MacExtendedACL": [{"SeqNo": 20,
"Action": "permit",
"Rule": {"SrcAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"DestAddr": {"Type": "host",
"Param": {"MacACLAddressTypeHostParam": {"HostMac": null
},
"MacACLAddressTypeMacPrefixParam": {"MacAddress": null,
"MacMask": null
}
}
},
"EtherType": "arp",
"VlanID": 20,
"Pcp": 3,
"VlanTagFormat": "mac-untagged"
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"PcpForce": 3,
"Mirror": false,
"DropPrecedenceForce": 1
}
}
]
}
},
"State": { }
}
}

IpAcl

IP ACL operations

Configure an IP ACL

Request Body schema: application/json

IP ACL Configuration

required	object (DeviceInfo)
required	object (IpAcl) IPACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ip_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPStandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": "10.10.10.10"
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": "20.20.20.20",
"mask": "255.255.255.0"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Delete an IP ACL

Request Body schema: application/json

IPACL unconfiguration.

required	object (DeviceInfo)
required	object (IpAcl) IPACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ip_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPStandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": "10.10.10.10"
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": "20.20.20.20",
"mask": "255.255.255.0"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Get single or multiple IP ACL

Request Body schema: application/json

Gets a single or all IP ACL

required	object (DeviceInfo)
required	object (IpAcl) IPACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ip_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPStandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": "10.10.10.10"
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": "20.20.20.20",
"mask": "255.255.255.0"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPACLAddressTypeHostParam": {"host-ip-address": null
},
"IPACLAddressTypeIPPrefixParam": {"ip-address": null,
"mask": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Ipv6Acl

IPv6 ACL operations

Configure an IPv6 ACL

Request Body schema: application/json

IPv6 ACL Configuration

required	object (DeviceInfo)
required	object (Ipv6Acl) IPv6ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ipv6_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPv6StandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": "2001:db8:3333:4444:5555:6666:7777:8888"
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": "2001:db8:0:12::/64"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPv6ExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Delete an IPv6 ACL

Request Body schema: application/json

IPv6ACL unconfiguration.

required	object (DeviceInfo)
required	object (Ipv6Acl) IPv6ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ipv6_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPv6StandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": "2001:db8:3333:4444:5555:6666:7777:8888"
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": "2001:db8:0:12::/64"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPv6ExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Get single or multiple IPv6 ACL

Request Body schema: application/json

Gets a single or all IPv6 ACL

required	object (DeviceInfo)
required	object (Ipv6Acl) IPv6ACL model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"name": "ipv6_acl_std_1",
"type": "acl-standard",
"Config": {"Data": {"IPv6StandardACL": [{"seq-no": 30,
"action": "permit",
"Rule": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": "2001:db8:3333:4444:5555:6666:7777:8888"
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": "2001:db8:0:12::/64"
}
}
},
"Option": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
}
}
],
"IPv6ExtendedACL": [{"seq-no": 20,
"action": "permit",
"Rule": {"ip-proto": "ip",
"SrcAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"SrcPort": {"logical-op": "string",
"port-value": "string"
},
"DestAddr": {"type": "type-host",
"Param": {"IPv6ACLAddressTypeHostParam": {"host-ipv6-address": null
},
"IPv6ACLAddressTypeIPPrefixParam": {"ipv6-address": null
}
}
},
"DestPort": {"logical-op": "string",
"port-value": "string"
},
"vlan-id": "20",
"dscp": "5",
"tcp-flags": ["ack"
]
},
"Option": {"ACLStandardOption": {"Log": false,
"Count": true,
"Sync": true,
"CopySflow": false
},
"dscp-force": 3,
"mirror": false,
"drop-precedence-force": 2
}
}
]
}
},
"State": { }
}
}

Logging

Logging operations

Configure logging for GoSwitch

Request Body schema: application/json

Logging Configuration

required	object (DeviceInfo)
required	object (Logging) Logging model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Raslog": {"Interface": {"description": true
},
"Message": [{"msg-id": "NSM-1020",
"severity": "ms-info",
"suppress": true,
"syslog": true
}
],
"Module": [{"mod-id": "string"
}
],
"console": "info"
},
"SyslogServer": [{"SyslogIP": {"ip-address": "10.10.10.10"
},
"use-vrf": "mgmt-vrf",
"SyslogSecure": {"secure": true,
"port": 514
}
}
],
"AuditLog": [{"class": "security"
}
],
"SyslogFacility": {"local": "log-local7"
},
"SyslogClient": {"local-ip": "chassis-ip"
}
},
"State": { }
}
}

Delete Logging

Request Body schema: application/json

Logging unconfiguration.

required	object (DeviceInfo)
required	object (Logging) Logging model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Raslog": {"Interface": {"description": true
},
"Message": [{"msg-id": "NSM-1020",
"severity": "ms-info",
"suppress": true,
"syslog": true
}
],
"Module": [{"mod-id": "string"
}
],
"console": "info"
},
"SyslogServer": [{"SyslogIP": {"ip-address": "10.10.10.10"
},
"use-vrf": "mgmt-vrf",
"SyslogSecure": {"secure": true,
"port": 514
}
}
],
"AuditLog": [{"class": "security"
}
],
"SyslogFacility": {"local": "log-local7"
},
"SyslogClient": {"local-ip": "chassis-ip"
}
},
"State": { }
}
}

Update log parameters

Request Body schema: application/json

update logging configuration

required	object (DeviceInfo)
required	object (Logging) Logging model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Raslog": {"Interface": {"description": true
},
"Message": [{"msg-id": "NSM-1020",
"severity": "ms-info",
"suppress": true,
"syslog": true
}
],
"Module": [{"mod-id": "string"
}
],
"console": "info"
},
"SyslogServer": [{"SyslogIP": {"ip-address": "10.10.10.10"
},
"use-vrf": "mgmt-vrf",
"SyslogSecure": {"secure": true,
"port": 514
}
}
],
"AuditLog": [{"class": "security"
}
],
"SyslogFacility": {"local": "log-local7"
},
"SyslogClient": {"local-ip": "chassis-ip"
}
},
"State": { }
}
}

Delete Logging parameters

Request Body schema: application/json

Logging parameters unconfiguration.

required	object (DeviceInfo)
required	object (Logging) Logging model

Responses

Request samples

Payload

Content type

application/json

{"DeviceInfo": {"device_ip_address": "10.25.225.221",
"username": "admin",
"password": "password",
"sessionid": "10.25.225.221:c00006a240:1583ac14c8d30aa0"
},
"Model": {"Config": {"Raslog": {"Interface": {"description": true
},
"Message": [{"msg-id": "NSM-1020",
"severity": "ms-info",
"suppress": true,
"syslog": true
}
],
"Module": [{"mod-id": "string"
}
],
"console": "info"
},
"SyslogServer": [{"SyslogIP": {"ip-address": "10.10.10.10"
},
"use-vrf": "mgmt-vrf",
"SyslogSecure": {"secure": true,
"port": 514
}
}
],
"AuditLog": [{"class": "security"
}
],
"SyslogFacility": {"local": "log-local7"
},
"SyslogClient": {"local-ip": "chassis-ip"
}
},
"State": { }
}
}

Health

Get health of the service

Request Body schema: application/json

Gets health of the service

ServiceName

string

Responses

Request samples

Payload

Content type

application/json

{"ServiceName": "GoSwitch"
}