Openstack Service (3.2.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 API provided by the application to provide APIs that act as proxy for openstack neutron APIS

Authentication

efaAuthKey

Security Scheme Type	API Key
Header parameter name:	Authorization

openstackUser

This parameter is mandatory for client implementation where efa login is not possible. In this case, the client has to pass user name. Example - openstack plugin

Security Scheme Type	API Key
Header parameter name:	X-OpenStack-User

Network

getNetwork

Get one or All Networks

Authorizations:

efaAuthKeyopenstackUser

query Parameters

net_id	string Network-id of the Neutron Network to retrieve
tenant_name	string tenant to which this network belongs

Responses

Response samples

200
404
500
default

Content type

application/json

{"items": [{"name": "GREEN_NETWORK",
"net_id": "123e4567-e89b-12d3-a456-426655440012",
"efa_net_id": 1,
"description": "Green Network",
"segments": [{"segment_id": "1",
"network_type": "vlan"
}
],
"tenant_name": "Customer-A",
"admin_state_up": true,
"mtu": 1400,
"enable_bd": true,
"error": [{"code": 0,
"message": "message"
}
]
}
]
}

createNetwork

Authorizations:

efaAuthKeyopenstackUser

Request Body schema: application/json

Create Network

name required	string
net_id	string
description	string
	Array of objects (Segment) unique
tenant_name	string Unique Name of the tenant
admin_state_up	boolean
mtu	integer
enable_bd	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "GREEN_NETWORK",
"net_id": "123e4567-e89b-12d3-a456-426655440012",
"description": "Bengaluru DC IP Network",
"tenant_name": "Customer-A",
"segments": [{"segment_id": "1",
"network_type": "vlan"
}
],
"admin_state_up": true,
"mtu": 1400
}

Response samples

200
401
409
500
default

Content type

application/json

{"name": "GREEN_NETWORK",
"net_id": "123e4567-e89b-12d3-a456-426655440012",
"efa_net_id": 1,
"description": "Green Network",
"segments": [{"segment_id": "1",
"network_type": "vlan"
}
],
"tenant_name": "Customer-A",
"admin_state_up": true,
"mtu": 1400,
"enable_bd": true,
"error": [{"code": 0,
"message": "message"
}
]
}

deleteNetwork

Delete Network

Authorizations:

efaAuthKeyopenstackUser

query Parameters

net_id

string

Network ID to be deleted

Responses

Response samples

200
401
404
500
default

Content type

application/json

{"net_id": "123e4567-e89b-12d3-a456-42665544001",
"error": [{"code": 0,
"message": "message"
}
]
}

Subnet

getSubnet

Get All Subnets

Authorizations:

efaAuthKeyopenstackUser

query Parameters

subnet_id

string

ID of the Subnet to retrieve

Responses

Response samples

200
404
500
default

Content type

application/json

{"items": [{"name": "MY_SUBNET",
"description": "MY_GREEN_SUBNET",
"net_id": "123e4567-e89b-12d3-a456-426655440012",
"subnet_id": "b0e7435c-1512-45fb-aa9e-9a7c5932fb30",
"segment_id": "1",
"efa_subnet_id": 1,
"ip_version": 4,
"cidr": "10.56.4.0/22",
"gateway_ip": "10.56.4.1",
"ipv6_address_mode": "slaac",
"ipv6_ra_mode": "slaac",
"error": [{"code": 0,
"message": "message"
}
]
}
]
}

createSubnet

Authorizations:

efaAuthKeyopenstackUser

Request Body schema: application/json

Create Subnet

name required	string
description	string Description of the Subnet
net_id required	string
subnet_id	string
segment_id