Tenant Service (2.5.5)

Download OpenAPI specification:Download

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

This is the spec that defines the APIs provided by the tenant service to create a tenant and add the networks to the tenant, configure network parameters and configure switches with the tenant network's specific configurations.

Port Channel

getPortchannels

This API helps to get all Portchannels configured with Tenant service

query Parameters

tenant_name

required

string

Tenant to which this Portchannel belongs

Responses

getPortchannel

This API helps to get the specified Portchannel details

query Parameters

name	string Unique name of the Portchannel to fetch
tenant_name	string Tenant to which this Portchannel belongs
po_id	string Filter by Portchannel id allocated on device. This should be combined with device_ip param.
device_ip	string Device Management IP Address to which the po_id belongs

Responses

createPortchannel

This API helps to create a new Portchannel

Request Body schema: application/json

Create Portchannel parameter

name required	string Identifier of the Portchannel unique to the tenant service
description	string Description of the Portchannel
speed required	string Enum: "100Mbps" "1Gbps" "10Gbps" "25Gbps" "40Gbps" "100Gbps" Configure speed for the Portchannel and its Member ports
negotiation required	string Enum: "active" "passive" "static" Configure LACP negotiation mode for Portchannel
required	Array of objects (Device) unique
tenantName required	string Name of the tenant to which this Portchannel belongs
lacpTimeout required	string Enum: "short" "long" Configure LACP timeout for Portchannel
minLinkCount	string Minimum number of links provided for a Portchannel
mtu	integer MTU for a Portchannel

Responses

Request samples

Payload

Content type

application/json

{"name": "po101",
"description": "po101",
"speed": "100Mbps | 1Gbps | 10Gbps | 25Gbps | 40Gbps | 100Gbps",
"negotiation": "active | passive | static",
"memberinterfaces": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"tenantName": "Tenant-1",
"lacpTimeout": "short | long",
"minLinkCount": 2,
"mtu": 9100
}

deletePortchannel

This API helps to delete the given Portchannel

query Parameters

name required	string Unique name of the Portchannel to delete
force	boolean Use force parameter to remove the tenant network forcefully. This will remove the relevant configurations from the devices in this tenant network and update the record with tenant service.
tenant_name required	string Tenant to which this Portchannel belongs

Responses

updatePortchannel

This API helps to update the parameters of the Portchannel

Request Body schema: application/json

Update the Portchannel parameter

name required	string Identifier of the Portchannel unique to the tenant service
operation required	string Enum: "port-add" "port-delete" "lacp-timeout" "description" "min-link-count" "mtu-add" "mtu-delete" Add ports, Delete ports, modify lacp-timeout, description, minimum links, add mtu and delete mtu for Portchannel
required	Array of objects (Device) unique
tenantName required	string Tenant to which this Portchannel belongs
lacpTimeout	string Enum: "short" "long" Configure LACP timeout for Portchannel
description	string Description of the Portchannel
minLinkCount	string Minimum number of links provided for a Portchannel
mtu	integer MTU for a Portchannel

Responses

Request samples

Payload

Content type

application/json

{"name": "po101",
"operation": "port-add | port-delete | lacp-timeout | description | min-link-count | mtu-add | mtu-delete",
"memberinterfaces": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"tenantName": "Tenant-1",
"lacpTimeout": "short | long",
"description": "po101",
"minLinkCount": 2,
"mtu": 9100
}

configurePortchannel

This API helps to configure the given Portchannel

query Parameters

name required	string Name of the Portchannel to configure
tenant_name required	string Tenant to which this Portchannel belongs

Responses

Vrf

getVrfs

This API helps to get all Vrfs configured with tenant service

query Parameters

tenant_name

required

string

Tenant to which this Vrf belongs

Responses

getVrf

This API helps to get specified Vrf details

query Parameters

name required	string Vrf name to delete
tenant_name required	string Tenant to which this Vrf belongs

Responses

createVrf

This API helps to create a new Vrf for a tenant

Request Body schema: application/json

Create Vrf

tenant_name required	string Tenant Name
	Array of objects (Vrf)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"vrf-list": [{"name": "vrf-red",
"tenantName": "Tenant-1",
"routing-type": "distributed",
"centralized-router": [{"mgmt-ip": "10.25.25.100"
}
],
"vrf-type": "shared | private",
"dev-state": "provisioned | provisioning-failed | not-provisioned",
"app-state": "cfg-ready | cfg-in-sync | cfg-refreshed | cfg-refresh-err",
"local-asn": 1024,
"route-target": [{"route-target": "100:100",
"route-target-type": "both | import | export"
}
],
"static-route": [{"mgmt-ip": "10.25.25.100",
"static-route-list": [{"afi": "ipv4 | ipv6",
"network": "20.0.0.0/24 | 2001:1::/64",
"nexthopIP": "16.0.0.2 | 3001::2",
"distance": 3
}
]
}
],
"static-route-bfd": [{"mgmt-ip": "10.25.25.100",
"static-route-bfd-list": [{"afi": "ipv4 | ipv6",
"DestIPAddr": "16.0.0.2 | 3001::2",
"SrcIPAddr": "16.0.0.2 | 3001::2",
"interval": 300,
"minRx": 300,
"multiplier": 3
}
]
}
],
"max-path": 8,
"redistribute": ["static | connected"
],
"rh-max-path": 8,
"rh-ecmp-enable": true,
"graceful-restart-enable": true
}
]
}

deleteVrf

This API helps to delete the given Vrf

Request Body schema: application/json

Delete Vrf

tenant_name	string Tenant Name
vrf-name-list	Array of strings List of Vrfs

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"vrf-name-list": "VRF-GREEN | VRF-RED"
}

updateVrf

This API helps to update the parameters of the Vrf

Request Body schema: application/json

Update the Vrf parameter

name required	string Identifier of the Vrf unique to the tenant service
operation required	string Enum: "local-asn-add" "local-asn-delete" "static-route-bfd-add" "static-route-bfd-delte" "static-route-add" "static-route-delete" "max-path-add" "max-path-delete" "redistribute-add" "redistribute-delete" "rh-max-path-add" "rh-max-path-delete" "centralized-router-add" "centralized-router-delete" "rh-ecmp-update" "graceful-restart-update" Below operations are supported - local-asn-add: Add local-asn in Vrf. local-asn-delete: Delete local-asn from Vrf. static-route-bfd-add: Add static-route-bfd in Vrf. static-route-bfd-delete: Delete static-route-bfd from Vrf. static-route-add: Add static-route in Vrf. static-route-delete: Delete static-route from Vrf. max-path-add: Add max-path in Vrf. max-path-delete: Delete max-path from Vrf. redistribute-add: Add redistribute in Vrf. redistribute-delete: Delete redistribute from Vrf. rh-max-path-add: Add rh-max-path in Vrf. rh-max-path-delete: Delete rh-max-path from Vrf. centralized-router-add: Add centralized-router devices to Vrf. centralized-router-delete: Delete centralized-router devices from Vrf. rh-ecmp-update: Update rh-ecmp for Vrf. graceful-restart-update: Update graceful-restart for Vrf.
localAsn	integer <int64> Local Asn for Vrf
tenantName required	string Tenant to which this Vrf belongs
	Array of objects (StaticRouteBfd)
	Array of objects (StaticRoute)
max-path	integer <int> Maximum-path for Vrf
redistribute	Array of strings Items Enum: "static" "connected"
rh-max-path	integer <int> Resilient hashing maximum-path for Vrf
rh-ecmp-enable	boolean Enable/disable resilient hashing for Vrf
	Array of objects Users can provide only one multi-homed BL pair or one single-homed BL device as centralized-routers
graceful-restart-enable	boolean Enable/disable graceful restart for Vrf

Responses

Request samples

Payload

Content type

application/json

{"name": "vrf-red",
"operation": "local-asn-add | local-asn-delete | static-route-bfd-add | static-route-bfd-delete | static-route-add | static-route-delete | max-path-add | max-path-delete | redistribute-add | redistribute-delete | rh-max-path-add | rh-max-path-delete | centralized-router-add | centralized-router-delete | rh-ecmp-update | graceful-restart-update",
"localAsn": 1024,
"tenantName": "Tenant-1",
"static-route-bfd": [{"mgmt-ip": "10.25.25.100",
"static-route-bfd-list": [{"afi": "ipv4 | ipv6",
"DestIPAddr": "16.0.0.2 | 3001::2",
"SrcIPAddr": "16.0.0.2 | 3001::2",
"interval": 300,
"minRx": 300,
"multiplier": 3
}
]
}
],
"static-route": [{"mgmt-ip": "10.25.25.100",
"static-route-list": [{"afi": "ipv4 | ipv6",
"network": "20.0.0.0/24 | 2001:1::/64",
"nexthopIP": "16.0.0.2 | 3001::2",
"distance": 3
}
]
}
],
"max-path": 8,
"redistribute": ["static | connected"
],
"rh-max-path": 8,
"rh-ecmp-enable": true,
"centralized-router": [{"mgmt-ip": "10.25.25.100"
}
],
"graceful-restart-enable": true
}

Tenant

getTenants

This API helps to get all tenants configured with tenant service

Responses

getTenant

This API helps to get the specified Tenant details

query Parameters

name

required

string

Name of the tenant to retrieve details

Responses

createTenant

This API helps to create a tenant and reserve resources like Physical Ports, L2VNI, L3VNI, VLAN and Number of VRFs for the tenant. Tenant Name must be a unique key while creating a tenant with the tenant service.

Request Body schema: application/json

Create a new tenant

name required	string Unique name of the tenant
description	string Description about tenant
l2-vni-range	string Contiguous Range of L2 VNIs in ascending order will be reserved for the tenant within the scope of a fabric. L2 networks will consume the VNIs from this range.
l3-vni-range	string Contiguous Range of L3 VNIs in ascending order will be reserved for the tenant within the scope of a fabric. L3 networks will consume the VNIs from this range.
vlan-range	string Range of VLANs to reserve for the tenant
num-of-vrf	integer Number of VRFs to reserve for the tenant
enable-bd	boolean Enable bridge-domain so that overlapping vlans can be supported
type	string Enum: "shared" "private" POs or VRFs of shared tenant are available to other tenants. Default tenant type is private.
	Array of objects (Device) unique

Responses

Request samples

Payload

Content type

application/json

{"name": "Tenant-A",
"description": "Tenant-A's Description",
"l2-vni-range": "1-100",
"l3-vni-range": "4096-5000",
"vlan-range": "10-20,50-60",
"num-of-vrf": 20,
"enable-bd": true,
"type": "shared | private",
"port-list": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
]
}

deleteTenant

This API helps to delete the tenant if no tenant network is created by this tenant. If it has any tenant network, a force option is required to delete this tenant. The delete request with force parameter will trigger a delete operation for all its networks.

query Parameters

name required	string Name of the tenant to delete
force	boolean Use force parameter to remove the tenant forcefully. This will remove the relevant configurations from the devices for its tenant network and delete the relevant record with tenant service.

Responses

updateTenant

This API helps to update existing tenant for non-conflicting changes of its resources like L2VNI, L3VNI, vlan range, port, number of vrf, description, type etc for the tenant.

path Parameters

tenant_name

required

string

Name of the tenant to update parameter

Request Body schema: application/json

Update the Tenant parameter

operation required	string Enum: "desc-update" "vni-update" "port-add" "port-delete" "vlan-add" "vlan-delete" "vlan-update" "num-vrf-update" "enable-bd-update" Add, delete or update tenant configuration
force	boolean Use force parameter to delete the assets forcefully. Valid only when operation is set to port-delete
	object (Tenant)

Responses

Request samples

Payload

Content type

application/json

{"operation": "desc-update | vni-update | port-add | port-delete | vlan-add | vlan-delete | vlan-update | num-vrf-update | enable-bd-update",
"force": true,
"tenant": {"name": "Tenant-A",
"description": "Tenant-A's Description",
"l2-vni-range": "1-100",
"l3-vni-range": "4096-5000",
"vlan-range": "10-20,50-60",
"num-of-vrf": 20,
"enable-bd": true,
"type": "shared | private",
"port-list": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
]
}
}

Endpoint Group

getEndpointGroups

This API helps to get all EndpointGroups configured with tenant service

query Parameters

tenant_name

string

Tenant to which this EndpointGroup belongs

Responses

createEndpointGroup

This API helps to create EndpointGroup which is a collection of ports and Portchannels on which a tenant can apply policies - port-property and network-policy. The validation includes that the port should belong to only one fabric. The parameters like ctag, swithport mode must be non-conflicting.

Request Body schema: application/json

Create EndpointGroup

tenant_name required	string Tenant Name
	Array of objects (EndpointGroup)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"endpoint-group-list": [{"name": "EndpointGroup-1",
"description": "EndpointGroup-Sales",
"type": "l3-hand-off | extension",
"port-group": {"physical-port": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"port-channel": "po101 | po102"
},
"port-property": {"switchport-mode": "trunk | access | trunk-no-default-native",
"enable-switchport-native-vlan": false,
"single-homed-bfd-session-type": "auto | hardware | software"
},
"network-policy": {"ctag-range": "101-102",
"vrf": "VRF-GREEN",
"dev-state": "provisioned | provisioning-failed | not-provisioned",
"app-state": "cfg-ready | cfg-in-sync | cfg-refreshed | cfg-refresh-err",
"l3-vni": 201,
"network-property": [{"ctag": 101,
"is-native-vlan": true,
"l2-vni": 101,
"bridge-domain-name": "BD-101-201",
"ctag-description": "Tenant L3 Hand-off VLAN | Tenant L3 Hand-off BD | Tenant L2 Extended VLAN | Tenant L3 Extended VLAN | Tenant L2 Extended BD | Tenant L3 Extended BD | Tenant L3 Hand-off BR BD | Tenant L3 Hand-off IRB BD | Tenant L3 Extended BR BD | Tenant L3 Extended IRB BD",
"suppress-arp": true,
"suppress-nd": true,
"ip-mtu": 9100,
"anycast": {"ipv4-address": "20.0.0.0/24",
"ipv6-address": "2000:1::/64"
},
"local-ip-address": [{"mgmt-ip": "10.10.10.10",
"ip-address": [{"afi": null,
"ip-address": null
}
]
}
],
"ipv6-nd": {"ipv6-nd-mtu": 101,
"ipv6-nd-managed-config": true,
"ipv6-nd-other-config": true,
"ipv6-nd-prefix": [{"ipv6-address": "2000:1::/64",
"valid-lifetime": 259200,
"preferred-lifetime": 259200,
"no-advertise": true,
"config-type": "no-autoconfig | no-onlink | off-link"
}
]
}
}
]
}
}
]
}

getEndpointGroup

This API helps to fetch the configured details and not the operational state of the ports belonging to this EndpointGroup

query Parameters

name required	string Name of the EndpointGroup to retrieve
tenant_name required	string Tenant to which this EndpointGroup belongs

Responses

deleteEndpointGroup

This API helps to delete the endpoint if EndpointGroup is not attached to a tenant network. If it is attached to a tenant network then a force option is required to delete this EndpointGroup. The delete request with force parameter will trigger a delete operation for the network to which this EndpointGroup was attached.

Request Body schema: application/json

tenant_name required	string Tenant Name
force	boolean Set to true if EndpointGroup delete will require deconfiguring networks also
required	Array of objects (EndpointGroupName)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"force": true,
"endpoint-group-list": [{"name": "EPG-1"
}
]
}

updateEndpointGroupPortGroup

This API helps in addition of new port(s) and/or Portchannel(s) to EndpointGroup or deletion of port(s) and/or Portchannel(s) from EndpointGroup. If the EndpointGroup is linked to any tenant network, the newly added port or Portchannel will become the part of the tenant network and its appropriate L2/L3 configurations will be applied on the newly added port, Portchannel and record will be updated with tenant automation service. For deleted port and/or Portchannel from EndpointGroup, appropriate configurations will be removed from the device and record will be updated with tenant automation service.

Request Body schema: application/json

Update the EndpointGroup PortGroup

tenant_name	string Tenant Name
operation required	string Enum: "port-group-add" "port-group-delete" Add or delete ports from the port group
	Array of objects (EndpointGroupPortGroup)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"operation": "port-group-add | port-group-delete",
"endpoint-group-list": [{"name": "EndpointGroup-1",
"port-group": {"physical-port": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"port-channel": "po101 | po102"
},
"port-property": {"switchport-mode": "trunk | access | trunk-no-default-native",
"enable-switchport-native-vlan": false,
"single-homed-bfd-session-type": "auto | hardware | software"
}
}
]
}

updateEndpointGroupNetworkPolicy

This API helps in updating networks belonging to EndpointGroups. Below operations are supported -

ctag-range-add: Add provided l2/l3 network(s) to EndpointGroup.
ctag-range-delete: Delete provided l2/l3 network(s) from the EndpointGroup.
vrf-add: Attach the networks to the provided Vrf. Required parameters like anycast for each network should be provided in network-properties block.
vrf-delete: Migrate L3 networks to L2 networks. This operation doesn't expect any other parameters other than operation itself.

Request Body schema: application/json

Update the EndpointGroup NetworkPolicy

tenant_name	string Tenant Name
operation	string Enum: "ctag-range-add" "ctag-range-delete" "vrf-add" "vrf-delete" Add or delete ctag-range and/or vrf
	Array of objects (EndpointGroupNetworkPolicy)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"operation": "ctag-range-add | ctag-range-delete | vrf-add | vrf-delete",
"endpoint-group-list": [{"name": "EndpointGroup-1",
"network-policy": {"ctag-range": "101-102",
"vrf": "VRF-GREEN",
"dev-state": "provisioned | provisioning-failed | not-provisioned",
"app-state": "cfg-ready | cfg-in-sync | cfg-refreshed | cfg-refresh-err",
"l3-vni": 201,
"network-property": [{"ctag": 101,
"is-native-vlan": true,
"l2-vni": 101,
"bridge-domain-name": "BD-101-201",
"ctag-description": "Tenant L3 Hand-off VLAN | Tenant L3 Hand-off BD | Tenant L2 Extended VLAN | Tenant L3 Extended VLAN | Tenant L2 Extended BD | Tenant L3 Extended BD | Tenant L3 Hand-off BR BD | Tenant L3 Hand-off IRB BD | Tenant L3 Extended BR BD | Tenant L3 Extended IRB BD",
"suppress-arp": true,
"suppress-nd": true,
"ip-mtu": 9100,
"anycast": {"ipv4-address": "20.0.0.0/24",
"ipv6-address": "2000:1::/64"
},
"local-ip-address": [{"mgmt-ip": "10.10.10.10",
"ip-address": [{"afi": null,
"ip-address": null
}
]
}
],
"ipv6-nd": {"ipv6-nd-mtu": 101,
"ipv6-nd-managed-config": true,
"ipv6-nd-other-config": true,
"ipv6-nd-prefix": [{"ipv6-address": "2000:1::/64",
"valid-lifetime": 259200,
"preferred-lifetime": 259200,
"no-advertise": true,
"config-type": "no-autoconfig | no-onlink | off-link"
}
]
}
}
]
}
}
]
}

updateEndpointGroupNetworkProperty

This API helps in updating properties of the networks belonging to the EndpointGroups. Below operation are supported -

local-ip-add: Configure local ip v4/v6 to Ve Interface of the network.
local-ip-delete: De-Configure local ip v4/v6 from Ve Interface of the network. For local-ip-delete without specifying payload will deconfigure local-ip from all the nodes which has local-ip configured.
anycast-ip-add: Configure anycast ip v4/v6 to Ve Interface of the network.
anycast-ip-delete: De-Configure anycast ip v4/v6 from Ve Interface of the network.

Request Body schema: application/json

Update the EndpointGroup NetworkProperty

tenant_name	string Tenant Name
operation	string Enum: "local-ip-add" "local-ip-delete" "anycast-ip-add" "anycast-ip-delete" Add or delete local-ip and/or anycast-ip
	Array of objects (EndpointGroupNetworkProperty)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"operation": "local-ip-add | local-ip-delete | anycast-ip-add | anycast-ip-delete",
"endpoint-group-list": [{"name": "EndpointGroup-1",
"network-property": [{"ctag": 101,
"suppress-arp": true,
"suppress-nd": true,
"ip-mtu": 9100,
"anycast": {"ipv4-address": "20.0.0.0/24",
"ipv6-address": "2000:1::/64"
},
"local-ip-address": [{"mgmt-ip": "10.10.10.10",
"ip-address": [{"afi": "ipv4 | ipv6",
"ip-address": "20.0.0.0/24 | 2001:1::/64"
}
]
}
],
"ipv6-nd": {"ipv6-nd-mtu": 101,
"ipv6-nd-managed-config": true,
"ipv6-nd-other-config": true,
"ipv6-nd-prefix": [{"ipv6-address": "2000:1::/64",
"valid-lifetime": 259200,
"preferred-lifetime": 259200,
"no-advertise": true,
"config-type": "no-autoconfig | no-onlink | off-link"
}
]
}
}
]
}
]
}

detachNetworkFromEndpointGroup

This API helps user to split network or range of networks from the EndpointGroup into another EndpointGroup for allowing user to do operations on the newly created EndpointGroup

Request Body schema: application/json

Detach EndpointGroup

tenant_name required	string Name of the tenant to which this EndpointGroup belongs
from-epg required	string Unique name of the EndpointGroup
to-epg required	string New EndpointGroup name on which these network(s) will be created
to-epg-description	string Description about EndpointGroup
ctag-range	string Range of Ctags to detach

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-1",
"from-epg": "EndpointGroup-1",
"to-epg": "EndpointGroup-2",
"to-epg-description": "EndpointGroup-Finance",
"ctag-range": "2-30"
}

configureEndpointGroup

This API helps to configure EndpointGroup

query Parameters

name required	string Name of the EndpointGroup to configure
tenant_name required	string Tenant to which this EndpointGroup belongs

Responses

Debug

setDebug

This API helps to set Debug Level for modules

query Parameters

debug_level

string

Set debug level. If empty reset to default level (info).

Responses

deviceInventorySync

This API helps to sync devices for the given Device IP Addresses with inventory

query Parameters

device_ips

required

Array of strings non-empty unique

Device Management IP Addresses to sync with inventory

Responses

deviceConfigDriftReconcile

This API helps to generate the config-drift between EFA intended configuration and device configuration. If reconcile flag is set then generated config-drift will be pushed to the device.

query Parameters

device_ip required	string Device Management IP Address for which config drift will be generated
reconcile	boolean If flag is set to true, then generated config-drift will be pushed to the device

Responses

Get lock detail

This API helps user to get lock details

query Parameters

type	string Enum: "service" "device" "port" "vlan" "vrf" "epg" Object type for locks to show

Responses

Vrf Error

getVrfError

This API helps to fetch Vrf errors

query Parameters

name required	string Name of the Vrf to retrieve errors
tenant_name required	string Tenant to which this Vrf belongs

Responses

Endpoint Group Error

getEndpointGroupError

This API helps to fetch EndpointGroup errors

query Parameters

name required	string Name of the EndpointGroup to retrieve errors
tenant_name required	string Tenant to which this EndpointGroup belongs

Responses

Trouble Shooting

getExecutionDetail

This API helps to get the detailed output of the given execution ID

query Parameters

id

required

string

Detailed output of the given execution ID

Responses

getExecutionList

This API helps to get the list of all the previous executions

query Parameters

limit required	integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10
status	string Default: "all" Filter the executions based on the status(failed/succeeded/all)

Responses

deleteExecutions

This API helps to delete the execution older than specific number of days

query Parameters

days_older_by

required

integer

Default: 30

Deletes execution entries older than specified number of days

Responses

GetRunningConfig

This API helps to get the list of all CLIs in Running Config

Responses

getEventHistoryList

This API helps to get the list of all the event histories

query Parameters

execution_uuid	string Execution UUID for filtering
device_ip	string Device IP for filtering

Responses

BGP Service

getBgpServicePeerGroups

This API helps to get all BGP Peer-Group configured with tenant service

query Parameters

tenant_name

string

Tenant to which this BGP Peer-Group belongs

Responses

createBgpServicePeerGroup

This API helps to create BGP Peer-Group which is a collection of BGP Peer-Group configuration done on router bgp instance of a device

Request Body schema: application/json

Create BGP Peer-Group

tenant_name required	string Tenant Name
	Array of objects (BgpServicePeerGroup)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"bgp-service-peer-group-list": [{"name": "bgp-peer-group-1",
"description": "bgp-peer-group-ext-gw1",
"bgp-service-peer-group": [{"mgmt-ip": "10.25.25.100",
"peer-group-list": [{"peer-group-name": "bgp-peer-group-1",
"remote-as": 65000,
"bfd-enable": true,
"bfd-interval": 300,
"bfd-rx": 300,
"bfd-multiplier": 5,
"next-hop-self": true,
"update-source-type": "ip",
"update-source-value": "192.168.1.1",
"md5-password": "password",
"encrypted-md5-password": "$9$MCgKGaNt6OASX68/7TC6Lw=="
}
]
}
]
}
]
}

updateBgpServicePeerGroup

This API helps to add and delete of BGP Peer-Group config on router bgp instance on device(s). Below operation are supported -

peer-group-add: Add Peer-Group configuration on router bgp instance of the device.
peer-group-delete: Delete Peer-Group configuration for the specified router bgp instance from the device.
desc-update: Update the description BGP Peer-Group.

Request Body schema: application/json

Update the BGP Peer-Group

tenant_name required	string Tenant Name
operation required	string Enum: "peer-group-add" "peer-group-delete" "desc-update"
	object (BgpServicePeerGroup)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"operation": "peer-group-add | peer-group-delete | desc-update",
"bgp-service-peer-group-update": {"name": "bgp-peer-group-1",
"description": "bgp-peer-group-ext-gw1",
"bgp-service-peer-group": [{"mgmt-ip": "10.25.25.100",
"peer-group-list": [{"peer-group-name": "bgp-peer-group-1",
"remote-as": 65000,
"bfd-enable": true,
"bfd-interval": 300,
"bfd-rx": 300,
"bfd-multiplier": 5,
"next-hop-self": true,
"update-source-type": "ip",
"update-source-value": "192.168.1.1",
"md5-password": "password",
"encrypted-md5-password": "$9$MCgKGaNt6OASX68/7TC6Lw=="
}
]
}
]
}
}

deleteBgpServicePeerGroup

This API helps to delete the BGP Peer-Group

query Parameters

name required	string Name of the BGP Peer-Group to delete
tenant_name required	string Tenant to which this BGP Peer-Group belongs
force	boolean Use force parameter to remove the BGP Peer-Group forcefully. This parameters allow user to ignore the error thrown by devices during BGP Peer-Group config delete. Useful to delete this object when device is not reachable. If force is used some configuration can be left on the device if deconfiguration fails.

Responses

getBgpServicePeerGroup

This API helps to fetch the configured details of the peer-config belonging to this BGP Service

query Parameters

name required	string Name of the BGP Peer-Group to retrieve
tenant_name required	string Tenant to which this BGP Peer-Group belongs

Responses

configureBgpServicePeerGroup

This API helps to configure BGP Peer-Group

query Parameters

name required	string Name of the BGP Peer-Group to configure
tenant_name required	string Tenant to which this BGP Peer-Group belongs

Responses

getBgpPeers

This API helps to get all BGP Peer configured with tenant service

query Parameters

tenant_name

string

Tenant to which this BGP Peer-Group belongs

Responses

creatBgpPeer

This API helps to create BGP Peer which is a collection of BGP Peer configuration done on router bgp instance of a device for a provided Vrf. This provides the means to extend networks created by EndpointGroup to establish bgp session with its peer towards the external gateway and compute.

Request Body schema: application/json

Create BGP Peer

tenant_name required	string Tenant Name
	Array of objects (BgpPeer)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"peer-list": [{"name": "bgp-peer-1",
"tenantName": "Tenant-1",
"description": "bgp-peer-ext-gw1",
"peer": [{"mgmt-ip": "10.25.25.100",
"vrf-list": [{"vrf": "VRF-GREEN",
"afi": "ipv4 | ipv6",
"safi": "unicast",
"af-ip-neighbor": [{"neighbor-address": "10.25.25.100",
"remote-as": 65000,
"next-hop-self": "true | false | always",
"update-source-ip": "10.25.25.100",
"bfd-enable": true,
"bfd-interval": 300,
"bfd-rx": 300,
"bfd-multiplier": 5,
"md5-password": "password",
"encrypted-md5-password": "$9$MCgKGaNt6OASX68/7TC6Lw=="
}
],
"af-ip-dynamic-neighbor": [{"listen-range": "10.10.10.10/24",
"peer-group-name": "pg1",
"listen-limit": 10
}
]
}
]
}
]
}
]
}

updateBgpPeer

This API helps to add and delete of BGP Peer config on a Vrf for device(s). Below operation are supported -

peer-add: Add neighbor configuration for the specified Vrf on device of BGP Peer.
peer-delete: Add neighbor configuration for the specified Vrf on device of BGP Peer.
desc-update: Update the description BGP Peer.

Request Body schema: application/json

Update the BGP Peer

tenant_name required	string Tenant Name
operation required	string Enum: "peer-add" "peer-delete" "desc-update"
	object (BgpPeer)

Responses

Request samples

Payload

Content type

application/json

{"tenant_name": "Tenant-A",
"operation": "peer-add | peer-delete | desc-update",
"peer-list": {"name": "bgp-peer-1",
"tenantName": "Tenant-1",
"description": "bgp-peer-ext-gw1",
"peer": [{"mgmt-ip": "10.25.25.100",
"vrf-list": [{"vrf": "VRF-GREEN",
"afi": "ipv4 | ipv6",
"safi": "unicast",
"af-ip-neighbor": [{"neighbor-address": "10.25.25.100",
"remote-as": 65000,
"next-hop-self": "true | false | always",
"update-source-ip": "10.25.25.100",
"bfd-enable": true,
"bfd-interval": 300,
"bfd-rx": 300,
"bfd-multiplier": 5,
"md5-password": "password",
"encrypted-md5-password": "$9$MCgKGaNt6OASX68/7TC6Lw=="
}
],
"af-ip-dynamic-neighbor": [{"listen-range": "10.10.10.10/24",
"peer-group-name": "pg1",
"listen-limit": 10
}
]
}
]
}
]
}
}

deleteBgpPeer

This API helps to delete the BGP Peer

query Parameters

name required	string Name of the BGP Peer to delete
tenant_name required	string Tenant to which this BGP Peer belongs
force	boolean Use force parameter to remove the BGP Peer forcefully. This parameters allow user to ignore the error thrown by devices during BGP Peer config delete. Useful to delete this object when device is not reachable. If force is used some configuration can be left on the device if deconfiguration fails.

Responses

getBgpPeer

This API helps to fetch the configured details state of the peer-config belonging to this BGP Service

query Parameters

name required	string Name of the BGP Peer to retrieve
tenant_name required	string Tenant to which this BGP Peer belongs

Responses

configureBgpPeer

This API helps to configure BGP Peer

query Parameters

name required	string Name of the BGP Peer to configure
tenant_name required	string Tenant to which this BGP Peer belongs

Responses

getOperationalBgpPeer

This API helps to fetch the operational details state of the peer-config belonging to this BGP Service

query Parameters

tenant_name required	string Tenant to which this BGP Peer belongs
vrf_name	string Name of the Vrf