Get OVS bridges.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/nfv/getOvsBridges
Request Parameters
deviceIp
String
|
query
|
Optional
|
Response Parameters
admin_state
Boolean
|
|
akey_name
String
|
|
bridge
String
|
|
mirror
Boolean
|
|
mirror_src
String
|
|
provider_network_type
String
|
|
provider_physical_network
String
|
|
provider_segmentation_id
Integer
|
|
router_external
Boolean
|
|
shared
Boolean
|
|
sriov
String
|
|
subnet
Subnet[]
|
|
address
String
|
|
akey_name
String
|
|
dhcp
Boolean
|
|
gateway
String
|
|
ipversion
String
|
|
netmask
String
|
|
|
trunk
Boolean
|
|
vlan
Short[]
|
|
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://localhost/webacs/api/v1/op/nfv/getOvsBridges
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/nfv/getOvsBridges" rootUrl="https://localhost/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://localhost/webacs/api/v1/op/nfv/getOvsBridges.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/nfv\/getOvsBridges",
"@rootUrl" : "https : \/\/localhost\/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
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/nfv/getOvsBridges
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
deviceIp
String
|
query
|
Optional
|
Response Parameters
admin_state
Boolean
|
|
akey_name
String
|
|
bridge
String
|
|
mirror
Boolean
|
|
mirror_src
String
|
|
provider_network_type
String
|
|
provider_physical_network
String
|
|
provider_segmentation_id
Integer
|
|
router_external
Boolean
|
|
shared
Boolean
|
|
sriov
String
|
|
subnet
Subnet[]
|
|
address
String
|
|
akey_name
String
|
|
dhcp
Boolean
|
|
gateway
String
|
|
ipversion
String
|
|
netmask
String
|
|
|
trunk
Boolean
|
|
vlan
Short[]
|
|
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://localhost/webacs/api/v2/op/nfv/getOvsBridges
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/nfv/getOvsBridges" rootUrl="https://localhost/webacs/api/v2/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://localhost/webacs/api/v2/op/nfv/getOvsBridges.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/nfv/getOvsBridges",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/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 ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/nfv/getOvsBridges
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
deviceIp
String
|
query
|
Optional
|
Response Parameters
admin_state
Boolean
|
|
akey_name
String
|
|
bridge
String
|
|
mirror
Boolean
|
|
mirror_src
String
|
|
provider_network_type
String
|
|
provider_physical_network
String
|
|
provider_segmentation_id
Integer
|
|
router_external
Boolean
|
|
shared
Boolean
|
|
sriov
String
|
|
subnet
Subnet[]
|
|
address
String
|
|
akey_name
String
|
|
dhcp
Boolean
|
|
gateway
String
|
|
ipversion
String
|
|
netmask
String
|
|
|
trunk
Boolean
|
|
vlan
Short[]
|
|
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://localhost/webacs/api/v3/op/nfv/getOvsBridges
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/nfv/getOvsBridges" rootUrl="https://localhost/webacs/api/v3/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>
<subnet>
<address>Another string value</address>
<akey_name>Another string value</akey_name>
<dhcp>false</dhcp>
<gateway>Another string value</gateway>
<ipversion>Another string value</ipversion>
<netmask>Another string value</netmask>
</subnet>
</subnets>
<trunk>true</trunk>
<vlans>
<vlan>15</vlan>
<vlan>25</vlan>
</vlans>
</network>
<network>
<admin_state>false</admin_state>
<akey_name>Another string value</akey_name>
<bridge>Another string value</bridge>
<mirror>false</mirror>
<mirror_src>Another string value</mirror_src>
<provider_network_type>Another string value</provider_network_type>
<provider_physical_network>Another string value</provider_physical_network>
<provider_segmentation_id>25</provider_segmentation_id>
<router_external>false</router_external>
<shared>false</shared>
<sriov>Another 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>
<subnet>
<address>Another string value</address>
<akey_name>Another string value</akey_name>
<dhcp>false</dhcp>
<gateway>Another string value</gateway>
<ipversion>Another string value</ipversion>
<netmask>Another string value</netmask>
</subnet>
</subnets>
<trunk>false</trunk>
<vlans>
<vlan>15</vlan>
<vlan>25</vlan>
</vlans>
</network>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/nfv/getOvsBridges.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/nfv/getOvsBridges",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/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"
}, {
"address" : "Another string value",
"akey_name" : "Another string value",
"dhcp" : false,
"gateway" : "Another string value",
"ipversion" : "Another string value",
"netmask" : "Another string value"
} ]
},
"trunk" : true,
"vlans" : {
"vlan" : [ 15, 25 ]
}
}, {
"admin_state" : false,
"akey_name" : "Another string value",
"bridge" : "Another string value",
"mirror" : false,
"mirror_src" : "Another string value",
"provider_network_type" : "Another string value",
"provider_physical_network" : "Another string value",
"provider_segmentation_id" : 25,
"router_external" : false,
"shared" : false,
"sriov" : "Another string value",
"subnets" : {
"subnet" : [ {
"address" : "String value",
"akey_name" : "String value",
"dhcp" : true,
"gateway" : "String value",
"ipversion" : "String value",
"netmask" : "String value"
}, {
"address" : "Another string value",
"akey_name" : "Another string value",
"dhcp" : false,
"gateway" : "Another string value",
"ipversion" : "Another string value",
"netmask" : "Another string value"
} ]
},
"trunk" : false,
"vlans" : {
"vlan" : [ 15, 25 ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/nfv/getOvsBridges
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
deviceIp
String
|
query
|
Optional
|
Response Parameters
admin_state
Boolean
|
|
akey_name
String
|
|
bridge
String
|
|
mirror
Boolean
|
|
mirror_src
String
|
|
provider_network_type
String
|
|
provider_physical_network
String
|
|
provider_segmentation_id
Integer
|
|
router_external
Boolean
|
|
shared
Boolean
|
|
sriov
String
|
|
subnet
Subnet[]
|
|
address
String
|
|
akey_name
String
|
|
dhcp
Boolean
|
|
gateway
String
|
|
ipversion
String
|
|
netmask
String
|
|
|
trunk
Boolean
|
|
vlan
Short[]
|
|
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://localhost/webacs/api/v4/op/nfv/getOvsBridges
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/nfv/getOvsBridges" rootUrl="https://localhost/webacs/api/v4/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>
<subnet>
<address>Another string value</address>
<akey_name>Another string value</akey_name>
<dhcp>false</dhcp>
<gateway>Another string value</gateway>
<ipversion>Another string value</ipversion>
<netmask>Another string value</netmask>
</subnet>
</subnets>
<trunk>true</trunk>
<vlans>
<vlan>15</vlan>
<vlan>25</vlan>
</vlans>
</network>
<network>
<admin_state>false</admin_state>
<akey_name>Another string value</akey_name>
<bridge>Another string value</bridge>
<mirror>false</mirror>
<mirror_src>Another string value</mirror_src>
<provider_network_type>Another string value</provider_network_type>
<provider_physical_network>Another string value</provider_physical_network>
<provider_segmentation_id>25</provider_segmentation_id>
<router_external>false</router_external>
<shared>false</shared>
<sriov>Another 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>
<subnet>
<address>Another string value</address>
<akey_name>Another string value</akey_name>
<dhcp>false</dhcp>
<gateway>Another string value</gateway>
<ipversion>Another string value</ipversion>
<netmask>Another string value</netmask>
</subnet>
</subnets>
<trunk>false</trunk>
<vlans>
<vlan>15</vlan>
<vlan>25</vlan>
</vlans>
</network>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/nfv/getOvsBridges.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/nfv/getOvsBridges",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/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"
}, {
"address" : "Another string value",
"akey_name" : "Another string value",
"dhcp" : false,
"gateway" : "Another string value",
"ipversion" : "Another string value",
"netmask" : "Another string value"
} ]
},
"trunk" : true,
"vlans" : {
"vlan" : [ 15, 25 ]
}
}, {
"admin_state" : false,
"akey_name" : "Another string value",
"bridge" : "Another string value",
"mirror" : false,
"mirror_src" : "Another string value",
"provider_network_type" : "Another string value",
"provider_physical_network" : "Another string value",
"provider_segmentation_id" : 25,
"router_external" : false,
"shared" : false,
"sriov" : "Another string value",
"subnets" : {
"subnet" : [ {
"address" : "String value",
"akey_name" : "String value",
"dhcp" : true,
"gateway" : "String value",
"ipversion" : "String value",
"netmask" : "String value"
}, {
"address" : "Another string value",
"akey_name" : "Another string value",
"dhcp" : false,
"gateway" : "Another string value",
"ipversion" : "Another string value",
"netmask" : "Another string value"
} ]
},
"trunk" : false,
"vlans" : {
"vlan" : [ 15, 25 ]
}
} ]
}
}