Bridge Domains

Resource Summary for Bridge Domain

HTTP Method
Resource
URL (BaseURL)
GET
POST
PUT
DELETE

Bridge Domain

/api/v1/ bridge-domain

Y

Y

N

N

/api/v1/bridge-domain/{bd-id}

Y

N

Y

Y

/api/v1/bridge-domain/{bd-id}/state

Y

N

Y

N

Bridge Domain Resource

History

 

Release
Modification

IOS XE 3.13

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties: Bridge Domain Schema

Property
Type
Required for POST and PUT
Description

kind

string

Not Applicable

Object type

bd-id

number

Mandatory

Bridge domain ID

Range: 1 to 4096

vxlan-vni

number

Optional

The field is optional if this bridge domain is not in VxLAN

VXLAN VNI number

Range: 4096 to 16777215

The number must be uniquely assigned under one bridge domain. (The number cannot have been configured under another bridge domain.)

Example : Incorrect repetition

After using the bridge-domain API to create a bridge domain (10) with vxlan-vni 5010...

{'bd-id': 10, 'vxlan-vni': 5010, ….}.
 

... cannot then create another bridge domain (20) with the same vxlan-vni 5010.

('bd-id': 20, 'vxlan-vni': 5010, …}
 

Doing so returns an error.

member-list

array

Optional

List of members in this bridge domain.

If the bridge domain is for a corresponding BDI:

  • The bd-id and bdi-id must match.
  • The member-list should not be configured.

l2if-name

string

Mandatory

(sub-property of member-list)

L2 Ethernet interface name

Example: gigabitethernet2

svc-instance

number

Mandatory

(sub-property of member-list)

Service instance number

Range: 1 to 8000

enabled

boolean

Optional

"true": Enable (up) the bridge domain.

"false": Disable (down) the bridge-domain

If this property is not present, the default behavior is to enable the bridge domain.

JSON Representation: Bridge Domain Schema

{
"kind": "object#bridge-domain"
"bd-id": {number},
"vxlan-vni": {number},
"member-list":
[
{
"l2if-name": "{string}",
"svc-instance": {number}
},
],
"enabled": {boolean}
}
 

Properties: Bridge Domain State Schema

Property
Type
Required for POST and PUT
Description

kind

string

Not Applicable

Object type

bd-id

number

Mandatory

Bridge domain ID

Range: 1 to 4096

enabled

boolean

Mandatory

"true": Bring up the bridge domain

"false": Bring down the bridge domain

JSON Representation: Bridge Domain State Schema

{
"kind": "object#bridge-domain-state
"bd-id": {number},
"enabled": {boolean}
}
 

Create a Bridge Domain

Resource URI

Verb
URI

POST

/api/v1/bridge-domain

Example

JSON Request

POST /api/v1/bridge-domain
Content-Type: application/json
Accept: application/json
 
{
"bd-id": 1001,
"vxlan-vni": 5001
"member-list":
[
{
"l2if-name": "gigabitEthernet2",
"svc-instance": 1001
},
{
"l2if-name": "gigabitEthernet4",
"svc-instance": 2001
},
]
}
 

JSON Response

201 Created
Location: https://host/api/v1/bridge-domain/1001
 

Retrieve All Bridge Domains

Resource URI

Verb
URI

GET

/api/v1/bridge-domain

Example

JSON Request

GET /api/v1/bridge-domain
Accept: application/json
 

JSON Response

200 ok
Content-Type: application/json
 
{
"kind": "collection#bridge-domain"
"items":
[
{
"kind": "object#bridge-domain",
"bd-id": 1001,
"vxlan-vni": 5001,
"member-list":
[
{
"l2if-name": "gigabitEthernet2",
"svc-instance": 1001
}
],
"enabled": true
},
{
"kind": "object#bridge-domain",
"vxlan-vni": 5002
"bd-id": 1002,
"enabled": true
},
],
}
 

Modify a Bridge Domain

Resource URI

Verb
URI

PUT

/api/v1/bridge-domain/{bd-id}

Example

JSON Request

PUT /api/v1/bridge-domain/1002
Content-Type: application/json
Accept: application/json
 
{
"bd-id": 1002,
"vxlan-vni": 5003
}
 

JSON Response

204 No Content
 

Retrieve a Bridge Domain

Resource URI

Verb
URI

GET

/api/v1/bridge-domain/{bd-id}

Example

JSON Request

GET /api/v1/bridge-domain/1001
Accept: application/json
 

JSON Response

200 ok
Content-Type: application/json
 
{
"kind": "object#bridge-domain",
"bd-id": 1001,
"member-list":
[
{
"l2if-name": "gigabitethernet2",
"svc-instance": 1001
},
],
"enabled": true
}
 

Delete a Bridge Domain

Resource URI

Verb
URI

DELETE

/api/v1/bridge-domain/{bd-id}

Example

JSON Request

DELETE /api/v1/brdige-domain/1001
 

JSON Response

204 No Content
 

Modify a Bridge Domain State

Resource URI

Verb
URI

PUT

/api/v1/bridge-domain/{bd-id}/state

Example

JSON Request

PUT /api/v1/bridge-domain/1001/state
Content-Type: application/json
Accept: application/json
 
{
"bd-id": 1001,
"enabled": true
}
 

JSON Response

204 No Content
 

Retrieve a Bridge Domain State

Resource URI

Verb
URI

GET

/api/v1/bridge-domain/{bd-id}/state

Example

JSON Request

GET /api/v1/bridge-domain/1001/state
Accept: application/json
 

JSON Response

200 OK
 
Content-Type: application/json
Accept: application/json
 
{
"kind": "object#bridge-domain-state"
"bd-id": 1001,
"enabled": true
}