Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET nfv/getOvsBridges

Get OVS bridges.

Since Product Version: 3.1

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/op/nfv/getOvsBridges

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

deviceIp String

query

Optional

Device management address

Response Parameters

Attribute Description

admin_state Boolean

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.

akey_name String

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.

bridge String

Attach this network to a bridge.

mirror Boolean

Mirror traffic to this network from other network.

mirror_src String

Mirror traffic from a specific source.

provider_network_type String

Specifies the physical mechanism by which the virtual network is implemented.

provider_physical_network String

Specifies the name of the physical network over which the virtual network is implemented.

provider_segmentation_id Integer

ID or tunnel ID of the underlying physical network.

router_external Boolean

Indicates whether this netework is externally accessible.

shared Boolean

Whether the network is shared among other tenants.

sriov String

Attach this network using SR-IOV.

subnet Arrow image Subnet[]

Subnet DTO.

trunk Boolean

Set to trunk mode.

vlan Short[]

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.20.127.108/webacs/api/v4/op/nfv/getOvsBridges

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v4/op/nfv/getOvsBridges.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.20.127.108/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 ]
      }
    } ]
  }
}