Get OVS bridges.
Since Product Version: 3.1
Resource URL
/webacs/api/v1/op/nfv/getOvsBridgesRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
deviceIp optional |
query |
|
Response Parameters
Type | Attribute Name | Description |
---|---|---|
Boolean |
admin_state |
Specifies whether the admin state is up or down. Set to true for up and false for down. If down, the network does not forward packets. |
String |
akey_name |
Name of the network to be created. The name will be appended with the deployment id during actual creation during deployment to maintain uniqueness. These are given before vm_group so that ESC can create the network before actually deploying any VMs on the network in one pass. |
String |
bridge |
Attach this network to a bridge. |
Boolean |
mirror |
Mirror traffic to this network from other network. |
String |
mirror_src |
Mirror traffic from a specific source. |
String |
provider_network_type |
Specifies the physical mechanism by which the virtual network is implemented. |
String |
provider_physical_network |
Specifies the name of the physical network over which the virtual network is implemented. |
Integer |
provider_segmentation_id |
ID or tunnel ID of the underlying physical network. |
Boolean |
router_external |
Indicates whether this netework is externally accessible. |
Boolean |
shared |
Whether the network is shared among other tenants. |
String |
sriov |
Attach this network using SR-IOV. |
subnet |
Subnet DTO. |
|
Boolean |
trunk |
Set to trunk mode. |
Short[] |
vlan |
The list of vLANs for this network. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://172.25.123.114/webacs/api/v1/op/nfv/getOvsBridges
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <network> <admin_state>true</admin_state> <akey_name>String value</akey_name> <bridge>String value</bridge> <mirror>true</mirror> <mirror_src>String value</mirror_src> <provider_network_type>String value</provider_network_type> <provider_physical_network>String value</provider_physical_network> <provider_segmentation_id>15</provider_segmentation_id> <router_external>true</router_external> <shared>true</shared> <sriov>String value</sriov> <subnets> <subnet> <address>String value</address> <akey_name>String value</akey_name> <dhcp>true</dhcp> <gateway>String value</gateway> <ipversion>String value</ipversion> <netmask>String value</netmask> </subnet> </subnets> <trunk>true</trunk> <vlans> <vlan>15</vlan> </vlans> </network> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/nfv/getOvsBridges.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/nfv\/getOvsBridges", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "network" : { "admin_state" : true, "akey_name" : "String value", "bridge" : "String value", "mirror" : true, "mirror_src" : "String value", "provider_network_type" : "String value", "provider_physical_network" : "String value", "provider_segmentation_id" : 15, "router_external" : true, "shared" : true, "sriov" : "String value", "subnets" : { "subnet" : { "address" : "String value", "akey_name" : "String value", "dhcp" : true, "gateway" : "String value", "ipversion" : "String value", "netmask" : "String value" } }, "trunk" : true, "vlans" : { "vlan" : 15 } } } }