Tenant Service (3.1.0)

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.

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Health

getHealth

This API helps to get the health of the Tenant service

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"Service": "string",
"MessageBus": "string"
}

Tenant

getTenants

This API helps to get all tenants configured with tenant service

Authorizations:

bearerAuth

query Parameters

	object {"group_by":"name"} Responses grouped by name {"filter":[{"name":"name","value":"Tenant1"},{"name":"id',"value":"1"}] Responses searched by name="Tenant1" and id="1" {"fuzzy":"tenant"} Responses searched using fuzzy search "tenant"
	object {"sort_by":"asc\|desc"} Responses with id in ascending or descending order {"offset" : "lt:30"} Responses searched with id less than 30 {"page_size":20} Responses searched with limit of 20 entries

Responses

Response samples

200
401
500
default

Content type

application/json

{"paginationResponse": {"remaining_count": 0,
"first_id": 0,
"last_id": 0
},
"tenant": [{"id": 1,
"name": "Tenant-A",
"type": "shared | private",
"description": "Tenant-A's Description",
"enable-bd": true,
"vlan-range": "10-20,50-60",
"l2-vni-range": "1-100",
"num-of-vrf": 20,
"l3-vni-range": "4096-5000",
"fabric-list": ["string"
],
"port-list": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"mirror-destination-port-list": [{"mgmt-ip": "10.25.25.100",
"port": [{"int-type": "ethernet",
"name": "0/1"
}
]
}
],
"port-channel-list": ["string"
],
"vrf-list": ["string"
],
"epg-list": ["string"
],
"bgp-peer-group-list": ["string"
],
"bgp-peer-list": ["string"
],
"mirror-session-list": ["string"
]
}
]
}

getTenant

This API helps to get the specified Tenant details

Authorizations:

bearerAuth

query Parameters

name

required

string

Name of the tenant to retrieve details

Responses

Response samples

Content type

application/json

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

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.

Authorizations:

bearerAuth

Request Body schema: application/json

Create a new tenant

name required	string Unique name of the tenant
type	string Enum: "shared" "private" POs or VRFs of shared tenant are available to other tenants. Default tenant type is private.
description	string Description about tenant
enable-bd	boolean Enable bridge-domain so that overlapping vlans can be supported
vlan-range	string Range of VLANs to reserve for the 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.
num-of-vrf	integer Number of VRFs to reserve for the tenant
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.
fabric-list	Array of strings unique