overlay

Resource URIs

URI Description
<base_URI>/config/running/overlay Configures VxLAN visibility.
GET URIs Description
<base_URI>/config/running/overlay Retrieves VxLAN visibility configuration information.
<base_URI>/config/running/overlay/access-list/type/vxlan/ Retrieves the VXLAN tunnel endpoint (VTEP) IP address and VXLAN Network Identifier (VNI) that match.
<base_URI>/config/running/overlay-transit/ Retrieves an overlay transit.
POST URIs Payload Description
<base_URI>/config/running/ <overlay-transit><user-transit-name>{string}</user-transit-name></overlay-transit> Configures overlay transit.
<base_URI>/config/running/{user-transit-name} <overlay><access-group>{string}</access-group><in>{enumeration}</in></overlay> Configures overlay and binding.
<base_URI>/config/running/overlay/access-list/type/vxlan <extended><ext-user-acl-name>{string}</ext-user-acl-name></extended> Creates extended ACL.
<base_URI>/config/running/overlay/access-list/type/vxlan <standard><user-acl-name>{string}</user-acl-name></standard> Creates standard ACL.
<base_URI>/config/running/overlay/access-list/type/vxlan/standard/{acl-name}/ <seq><seq-num>{uint32}</seq-num><permit-deny>{enumeration}</permit-deny><dst-vtep-ip-host>{ip-address}</dst-vtep-ip-host><src-vtep-ip-host>{ip-address}</src-vtep-ip-host><vni>{uint32}</vni><vni-mask>{uint32}</vni-mask></seq> Creates standard ACL rules.
<base_URI>/config/running/overlay/access-list/type/vxlan/extended/{ext-user-acl-name} <seq><ext-seq-num>{uint32}</ext-seq-num><ext-permit-deny>{enumeration}</ext-permit-deny><dst-vtep-ip-host>{ip-address}</dst-vtep-ip-host><src-vtep-ip-host>{{ip-address}</src-vtep-ip-host><vni>{uint32}</vni><vni-mask>{string}</vni-mask><count>{enumeration}</count></seq> Creates extended ACL rules.
DELETE URIs
<base_URI>/config/running/overlay/access-list/type/vxlan/extended/{acl-name}/seq/{seq-id}
<base_URI>/config/running/{user-transit-name}

Parameters

acl-name
Specifies the ACL name.
seq-num
Specifies the sequence ID.
dst-vtep-ip-host
Specifies the destination host IP address.
src-vtep-ip-host
Specifies the source host IP address.
vni
Specifies VNI.
vni-mask
Specifies the VNI mask.

Usage Guidelines

GET, POST, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/overlay

None

<overlay xmlns="urn:brocade.com:mgmt:brocade-vxlan-visibility" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/overlay">
  <access-list y:self="/rest/config/running/overlay/access-list">
    <type y:self="/rest/config/running/overlay/access-list/type">
      <vxlan y:self="/rest/config/running/overlay/access-list/type/vxlan">
        <standard y:self="/rest/config/running/overlay/access-list/type/vxlan/standard/abc">
          <user-acl-name>abc</user-acl-name>
          <seq y:self="/rest/config/running/overlay/access-list/type/vxlan/standard/abc/seq/30">
            <seq-num>30</seq-num>
            <permit-deny>permit</permit-deny>
            <dst-vtep-ip-host>10.5.5.10</dst-vtep-ip-host>
            <src-vtep-ip-host>20.5.5.20</src-vtep-ip-host>
            <vni>200</vni>
            <vni-mask>fffff</vni-mask>
          </seq>
        </standard>
      </vxlan>
    </type>
  </access-list>
</overlay>

URI

The following example uses the POST option to create extended ACL.

http://host:80/rest/config/running/overlay/access-list/type/vxlan

<extended>
  <ext-user-acl-name>acl-1</ext-user-acl-name>
</extended>

None

URI

The following example uses the DELETE option to remove extended ACL.

http://host:80/rest/config/running/overlay/access-list/type/vxlan/extended/acl-1/seq/1

None

None