Configuring EPBR

Enhanced Policy-based Routing (EPBR) in Elastic Services Re-direction (ESR) provides traffic redirection and service chaining across the standalone and fabric topologies by leveraging policy-based routing solution and achieves service chaining without adding additional headers, and avoids latency in using additional headers.

For more information, see the Cisco Nexus 9000 Series NX-OS ePBR Configuration Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-installation-and-configuration-guides-list.html/

Enabling EPBR

Enabling EPBR

POST http://<mgmt0_IP>/api/mo/sys/fm.json

{
  "fmEntity": {
    "children": [
      {
        "fmEpbr": {
          "attributes": {
            "adminSt": "enabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <epbr-items>
      <adminSt>enabled</adminSt>
    </epbr-items>
  </fm-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

feature epbr

Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MO	DN
fmEntity	sys/fm
fmEpbr	sys/fm/epbr

fmEpbr Properties

The following table contains information about the fmEpbr properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling EPBR

Disabling EPBR

POST http://<mgmt0_IP>/api/mo/sys/fm.json

{
  "fmEntity": {
    "children": [
      {
        "fmEpbr": {
          "attributes": {
            "adminSt": "disabled"
}}}]}}

{
    imdata:[]
}

<System>
  <fm-items>
    <epbr-items>
      <adminSt>disabled</adminSt>
    </epbr-items>
  </fm-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

no feature epbr

Verifying a DME Configuration

MO	DN
fmEntity	sys/fm
fmEpbr	sys/fm/epbr

fmEpbr Properties

Property Name	Data Type	Description	Values
adminSt	fm:AdminState (scalar:Enum8)	Admin status	SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Policy

Configuring an EPBR Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol</name>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol

epbrPolicyMap Properties

The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an EPBR Policy

Deleting an EPBR Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list nc:operation="delete">
          <name>epbr_pol</name>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

no epbr policy epbr_pol

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Service Name

Configuring an EPBR Service Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an EPBR Service Name

Deleting an EPBR Service Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list nc:operation="delete">
          <name>epbr_serv</name>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

no epbr service epbr_serv

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Policy Logging Level

Configuring an EPBR Policy Logging Level

POST http://<mgmt0_IP>/api/mo/sys/logging/loglevel.json

{
  "loggingLogLevel": {
    "children": [
      {
        "loggingFacility": {
          "attributes": {
            "facilityName": "epbr",
            "severityLevel": "debugging"
}}}]}}

{
    imdata:[]
}

<System>
  <logging-items>
    <loglevel-items>
      <facility-items>
        <Facility-list>
          <facilityName>epbr</facilityName>
          <severityLevel>debugging</severityLevel>
        </Facility-list>
      </facility-items>
    </loglevel-items>
  </logging-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

logging level epbr 7

Verifying a DME Configuration

MO	DN
loggingLogLevel	sys/logging/loglevel
loggingFacility	sys/logging/loglevel/facility-[epbr]

loggingFacility Properties

The following table contains information about the loggingFacility properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
facilityName	comp:DelimitedString (string:Basic)	Facility Name of individual processes subscribed for logging level	A sequence of characters
severityLevel	syslog:Severity (scalar:Enum8)	Logging severity level for individual facility name	SELECTION: 0 - emergencies 1 - alerts 2 - critical 3 - errors 4 - warnings 5 - notifications 6 - information 7 - debugging DEFAULT: notifications

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an EPBR Policy Logging Level

Deleting an EPBR Policy Logging Level

POST http://<mgmt0_IP>/api/mo/sys/logging/loglevel.json

{
  "loggingLogLevel": {
    "children": [
      {
        "loggingFacility": {
          "attributes": {
            "facilityName": "epbr",
            "severityLevel": "notifications"
}}}]}}

{
    imdata:[]
}

<System>
  <logging-items>
    <loglevel-items>
      <facility-items>
        <Facility-list>
          <facilityName>epbr</facilityName>
          <severityLevel>notifications</severityLevel>
        </Facility-list>
      </facility-items>
    </loglevel-items>
  </logging-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

no logging level epbr 7

Verifying a DME Configuration

MO	DN
loggingLogLevel	sys/logging/loglevel
loggingFacility	sys/logging/loglevel/facility-[epbr]

loggingFacility Properties

Property Name	Data Type	Description	Values
facilityName	comp:DelimitedString (string:Basic)	Facility Name of individual processes subscribed for logging level	A sequence of characters
severityLevel	syslog:Severity (scalar:Enum8)	Logging severity level for individual facility name	SELECTION: 0 - emergencies 1 - alerts 2 - critical 3 - errors 4 - warnings 5 - notifications 6 - information 7 - debugging DEFAULT: notifications

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring EPBR Policy Refresh based on ACL Changes

Configuring EPBR Policy Refresh based on ACL Changes

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrAclAction": {
          "attributes": {
            "aclName": "Acl-name"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <refreshacl-items>
        <AclAction-list>
          <aclName>Acl-name</aclName>
        </AclAction-list>
      </refreshacl-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session access-list Acl-name refresh

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrAclAction	sys/epbr/inst/refreshacl-Acl-name

epbrAclAction Properties

The following table contains information about the epbrAclAction properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
aclName	epbr:AclNameType (string:Basic)	MAX SIZE: 50

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Session

Configuring an EPBR Session

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session

epbrSessionInst Properties

The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Policy

Configuring an IP Access-List Name

Configuring an IP Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "delete": "no",
                  "isIPv6": "no",
                  "name": "ip-access-list-name"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>ip-access-list-name</name>
              <delete>false</delete>
              <isIPv6>false</isIPv6>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
match ip address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an IP Access-List Name

Deleting an IP Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "name": "ip-access-list-name",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <match-items>
            <EpbrMatch-list nc:operation="delete">
              <name>ip-access-list-name</name>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
no match ip address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
name	string:Basic	The name of the object.	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an IPv6 Access-List Name

Configuring an IPv6 Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "delete": "no",
                  "isIPv6": "yes",
                  "name": "ip-access-list-name"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>ip-access-list-name</name>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
match ipv6 address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an IPv6 Access-List Name

Deleting an IPv6 Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "name": "ip-access-list-name",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <match-items>
            <EpbrMatch-list nc:operation="delete">
              <name>ip-access-list-name</name>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
no match ipv6 address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
name	string:Basic	The name of the object.	A sequence of characters
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring EPBR Statistics

Configuring EPBR Statistics

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1",
            "statistics": "yes"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <statistics>true</statistics>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
statistics

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
statistics	scalar:Bool	SELECTION: true or false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting EPBR Statistics

Deleting EPBR Statistics

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "epbr_pol1",
            "statistics": "no"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>epbr_pol1</name>
          <statistics>false</statistics>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy epbr_pol1
no statistics

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-epbr_pol1

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
statistics	scalar:Bool	SELECTION: true or false

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Adding a Service to a Policy

Adding a Service to a Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "R5-_ZZJ"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "delete": "no",
                  "isIPv6": "yes",
                  "name": "acl2"
                },
                "children": [
                  {
                    "epbrEpbrMatchSeq": {
                      "attributes": {
                        "delete": "no",
                        "failaction": "nofailaction",
                        "name": "ser6_1",
                        "seqno": "15"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>R5-_ZZJ</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl2</name>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <seq-items>
                <EpbrMatchSeq-list>
                  <seqno>15</seqno>
                  <delete>false</delete>
                  <failaction>nofailaction</failaction>
                  <name>ser6_1</name>
                </EpbrMatchSeq-list>
              </seq-items>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy R5-_ZZJ
match ipv6 address acl2
15 set service ser6_1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-R5-_ZZJ
epbrEpbrMatch	sys/epbr/inst/pmap-R5-_ZZJ/match-acl2
epbrEpbrMatchSeq	sys/epbr/inst/pmap-R5-_ZZJ/match-acl2/seq-15

epbrEpbrMatchSeq Properties

The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
failaction	epbr:FailactionType (scalar:Enum8)	SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
seqno	scalar:Uint32	RANGE: [0, 4294967295]

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Service to a Policy

Deleting a Service to a Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "R5-_ZZJ"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "delete": "no",
                  "isIPv6": "yes",
                  "name": "acl2"
                },
                "children": [
                  {
                    "epbrEpbrMatchSeq": {
                      "attributes": {
                        "seqno": "15",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>R5-_ZZJ</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl2</name>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <seq-items>
                <EpbrMatchSeq-list nc:operation="delete">
                  <seqno>15</seqno>
                </EpbrMatchSeq-list>
              </seq-items>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy R5-_ZZJ
match ipv6 address acl2
no 15 set service ser6_1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-R5-_ZZJ
epbrEpbrMatch	sys/epbr/inst/pmap-R5-_ZZJ/match-acl2
epbrEpbrMatchSeq	sys/epbr/inst/pmap-R5-_ZZJ/match-acl2/seq-15

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
seqno	scalar:Uint32	RANGE: [0, 4294967295]
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Source-IP Based Load Balancing

Configuring Source-IP Based Load Balancing

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "bucket": "16",
                  "delete": "no",
                  "isIPv6": "yes",
                  "lbMethod": "src",
                  "name": "acl-v6"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl-v6</name>
              <bucket>16</bucket>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <lbMethod>src</lbMethod>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy pol1
match ipv6 address acl-v6
load-balance buckets 16 method src-ip

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-pol1
epbrEpbrMatch	sys/epbr/inst/pmap-pol1/match-acl-v6

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Source-IP Based Load Balancing

Deleting Source-IP Based Load Balancing

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "bucket": "0",
                  "delete": "no",
                  "isIPv6": "yes",
                  "lbMethod": "noLBMethod",
                  "name": "acl-v6"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl-v6</name>
              <bucket>0</bucket>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <lbMethod>noLBMethod</lbMethod>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy pol1
match ipv6 address acl-v6
no load-balance buckets 16 method src-ip

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-pol1
epbrEpbrMatch	sys/epbr/inst/pmap-pol1/match-acl-v6

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Action to be Taken on Failure of this Service

Configuring the Action to be Taken on Failure of this Service

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "bucket": "16",
                  "delete": "no",
                  "isIPv6": "yes",
                  "lbMethod": "src",
                  "name": "acl-v6"
                },
                "children": [
                  {
                    "epbrEpbrMatchSeq": {
                      "attributes": {
                        "delete": "no",
                        "failaction": "bypass",
                        "name": "ser6_1",
                        "seqno": "10"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl-v6</name>
              <bucket>16</bucket>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <lbMethod>src</lbMethod>
              <seq-items>
                <EpbrMatchSeq-list>
                  <seqno>10</seqno>
                  <delete>false</delete>
                  <failaction>bypass</failaction>
                  <name>ser6_1</name>
                </EpbrMatchSeq-list>
              </seq-items>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy pol1
  match ipv6 address acl-v6
   load-balance buckets 16 method src-ip
    10 set service ser6_1 fail-action bypass

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-pol1
epbrEpbrMatch	sys/epbr/inst/pmap-pol1/match-acl-v6
epbrEpbrMatchSeq	sys/epbr/inst/pmap-pol1/match-acl-v6/seq-10

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
failaction	epbr:FailactionType (scalar:Enum8)	SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
seqno	scalar:Uint32	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Action to be Taken on Failure of this Service

Deleting the Action to be Taken on Failure of this Service

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrPolicyMap": {
          "attributes": {
            "name": "pol1"
          },
          "children": [
            {
              "epbrEpbrMatch": {
                "attributes": {
                  "bucket": "16",
                  "delete": "no",
                  "isIPv6": "yes",
                  "lbMethod": "src",
                  "name": "acl-v6"
                },
                "children": [
                  {
                    "epbrEpbrMatchSeq": {
                      "attributes": {
                        "seqno": "10",
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <pmap-items>
        <PolicyMap-list>
          <name>pol1</name>
          <match-items>
            <EpbrMatch-list>
              <name>acl-v6</name>
              <bucket>16</bucket>
              <delete>false</delete>
              <isIPv6>true</isIPv6>
              <lbMethod>src</lbMethod>
              <seq-items>
                <EpbrMatchSeq-list nc:operation="delete">
                  <seqno>10</seqno>
                </EpbrMatchSeq-list>
              </seq-items>
            </EpbrMatch-list>
          </match-items>
        </PolicyMap-list>
      </pmap-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr policy pol1
  match ipv6 address acl-v6
   load-balance buckets 16 method src-ip
    no 10 set service ser6_1 fail-action bypass

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrPolicyMap	sys/epbr/inst/pmap-pol1
epbrEpbrMatch	sys/epbr/inst/pmap-pol1/match-acl-v6
epbrEpbrMatchSeq	sys/epbr/inst/pmap-pol1/match-acl-v6/seq-10

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
seqno	scalar:Uint32	RANGE: [0, 4294967295]
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Session

Configuring an IP Access-List Name

Configuring an IP Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "no",
                        "isIPv6": "no",
                        "name": "ip-access-list-name"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>ip-access-list-name</name>
                <delete>false</delete>
                <isIPv6>false</isIPv6>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
epbr policy epbr_pol1
match ip address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an IP Access-List Name

Deleting an IP Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "yes",
                        "name": "ip-access-list-name"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>ip-access-list-name</name>
                <delete>true</delete>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
epbr policy epbr_pol1
no match ip address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an IPv6 Access-List Name

Configuring an IPv6 Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "no",
                        "isIPv6": "yes",
                        "name": "ip-access-list-name"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>ip-access-list-name</name>
                <delete>false</delete>
                <isIPv6>true</isIPv6>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
epbr policy epbr_pol1
match ipv6 address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an IPv6 Access-List Name

Deleting an IPv6 Access-List Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "yes",
                        "name": "ip-access-list-name"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>ip-access-list-name</name>
                <delete>true</delete>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
epbr policy epbr_pol1
no match ipv6 address ip-access-list-name

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Abort EPBR Session

Configuring Abort EPBR Session

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "abort"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>abort</action>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
abort

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Commit EPBR Session

Configuring Commit EPBR Session

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "commit"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>commit</action>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
commit

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Adding a Service to a Policy

Adding a Service to a Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "no",
                        "isIPv6": "yes",
                        "name": "acl2"
                      },
                      "children": [
                        {
                          "epbrEpbrMatchSeq": {
                            "attributes": {
                              "delete": "no",
                              "failaction": "nofailaction",
                              "name": "ser6_1",
                              "seqno": "15"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl2</name>
                <delete>false</delete>
                <isIPv6>true</isIPv6>
                <seq-items>
                  <EpbrMatchSeq-list>
                    <seqno>15</seqno>
                    <delete>false</delete>
                    <failaction>nofailaction</failaction>
                    <name>ser6_1</name>
                  </EpbrMatchSeq-list>
                </seq-items>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy epbr_pol1
   match ipv6 address acl2
    15 set service ser6_1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-acl2
epbrEpbrMatchSeq	sys/epbr/inst/session/pmap-epbr_pol1/match-acl2/seq-15

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
failaction	epbr:FailactionType (scalar:Enum8)	SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
seqno	scalar:Uint32	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Service to a Policy

Deleting a Service to a Policy

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "epbr_pol1"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "delete": "no",
                        "isIPv6": "yes",
                        "name": "acl2"
                      },
                      "children": [
                        {
                          "epbrEpbrMatchSeq": {
                            "attributes": {
                              "delete": "yes",
                              "seqno": "15"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>epbr_pol1</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl2</name>
                <delete>false</delete>
                <isIPv6>true</isIPv6>
                <seq-items>
                  <EpbrMatchSeq-list>
                    <seqno>15</seqno>
                    <delete>true</delete>
                  </EpbrMatchSeq-list>
                </seq-items>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy epbr_pol1
   match ipv6 address acl2
    no 15 set service ser6_1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-epbr_pol1
epbrEpbrMatch	sys/epbr/inst/session/pmap-epbr_pol1/match-acl2
epbrEpbrMatchSeq	sys/epbr/inst/session/pmap-epbr_pol1/match-acl2/seq-15

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
seqno	scalar:Uint32	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Load Balance with Fail Action

Configuring Load Balance with Fail Action

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "pol2"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "bucket": "16",
                        "delete": "no",
                        "isIPv6": "no",
                        "lbMethod": "src",
                        "name": "acl1"
                      },
                      "children": [
                        {
                          "epbrEpbrMatchSeq": {
                            "attributes": {
                              "delete": "no",
                              "failaction": "bypass",
                              "name": "ser2",
                              "seqno": "10"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>pol2</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl1</name>
                <bucket>16</bucket>
                <delete>false</delete>
                <isIPv6>false</isIPv6>
                <lbMethod>src</lbMethod>
                <seq-items>
                  <EpbrMatchSeq-list>
                    <seqno>10</seqno>
                    <delete>false</delete>
                    <failaction>bypass</failaction>
                    <name>ser2</name>
                  </EpbrMatchSeq-list>
                </seq-items>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy pol2
   match ip address acl1
    load-balance buckets 16 method src-ip
     10 set service ser2 fail-action bypass

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-pol2
epbrEpbrMatch	sys/epbr/inst/session/pmap-pol2/match-acl1
epbrEpbrMatchSeq	sys/epbr/inst/session/pmap-pol2/match-acl1/seq-10

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
failaction	epbr:FailactionType (scalar:Enum8)	SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
seqno	scalar:Uint32	RANGE: [0, 4294967295]

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Example: <description>

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "pol2"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "bucket": "16",
                        "delete": "no",
                        "isIPv6": "no",
                        "lbMethod": "src",
                        "name": "acl1"
                      },
                      "children": [
                        {
                          "epbrEpbrMatchSeq": {
                            "attributes": {
                              "delete": "yes",
                              "seqno": "10"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>pol2</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl1</name>
                <bucket>16</bucket>
                <delete>false</delete>
                <isIPv6>false</isIPv6>
                <lbMethod>src</lbMethod>
                <seq-items>
                  <EpbrMatchSeq-list>
                    <seqno>10</seqno>
                    <delete>true</delete>
                  </EpbrMatchSeq-list>
                </seq-items>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy pol2
   match ip address acl1
    load-balance buckets 16 method src-ip
     no 10 set service ser2 fail-action bypass

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-pol2
epbrEpbrMatch	sys/epbr/inst/session/pmap-pol2/match-acl1
epbrEpbrMatchSeq	sys/epbr/inst/session/pmap-pol2/match-acl1/seq-10

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

epbrEpbrMatchSeq Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
seqno	scalar:Uint32	RANGE: [0, 4294967295]

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a User-Defined Probe

Configuring a User-Defined Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "ctrlStatusEnable": "disable",
                              "delete": "no",
                              "dnshost": "",
                              "frequency": "0",
                              "httpGetStr": "",
                              "port": "0",
                              "protocol": "noProtocol",
                              "retryDownCount": "0",
                              "retryUpCount": "0",
                              "sourceIntf": "unspecified",
                              "timeout": "0",
                              "trackID": "305"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <ctrlStatusEnable>disable</ctrlStatusEnable>
                  <delete>false</delete>
                  <dnshost></dnshost>
                  <frequency>0</frequency>
                  <httpGetStr></httpGetStr>
                  <port>0</port>
                  <protocol>noProtocol</protocol>
                  <retryDownCount>0</retryDownCount>
                  <retryUpCount>0</retryUpCount>
                  <sourceIntf>unspecified</sourceIntf>
                  <timeout>0</timeout>
                  <trackID>305</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    probe track 305

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrProbe Properties

The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
delete	scalar:Bool	SELECTION: true or false
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a User-Defined Probe

Deleting a User-Defined Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "delete": "yes",
                              "protocol": "noProtocol",
                              "trackID": "305"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <delete>true</delete>
                  <protocol>noProtocol</protocol>
                  <trackID>305</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    no probe track 305

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a DNS Probe with Frquency, Retry Up and Down Count

Configuring a DNS Probe with Frquency, Retry Up and Down Count

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "ctrlStatusEnable": "disable",
                              "delete": "no",
                              "dnshost": "Hostname",
                              "frequency": "267668",
                              "httpGetStr": "",
                              "port": "0",
                              "protocol": "DNS",
                              "retryDownCount": "3",
                              "retryUpCount": "3",
                              "sourceIntf": "unspecified",
                              "timeout": "1",
                              "trackID": "0"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <ctrlStatusEnable>disable</ctrlStatusEnable>
                  <delete>false</delete>
                  <dnshost>Hostname</dnshost>
                  <frequency>267668</frequency>
                  <httpGetStr></httpGetStr>
                  <port>0</port>
                  <protocol>DNS</protocol>
                  <retryDownCount>3</retryDownCount>
                  <retryUpCount>3</retryUpCount>
                  <sourceIntf>unspecified</sourceIntf>
                  <timeout>1</timeout>
                  <trackID>0</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:Hostname

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
delete	scalar:Bool	SELECTION: true or false
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a DNS Probe with Frquency, Retry Up and Down Count

Deleting a DNS Probe with Frquency, Retry Up and Down Count

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "delete": "yes",
                              "protocol": "DNS",
                              "trackID": "0"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <delete>true</delete>
                  <protocol>DNS</protocol>
                  <trackID>0</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    no probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Source Interface in a Probe

Configuring a Source Interface in a Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "ctrlStatusEnable": "disable",
                              "delete": "no",
                              "dnshost": "",
                              "frequency": "267668",
                              "httpGetStr": "",
                              "port": "0",
                              "protocol": "ICMP",
                              "retryDownCount": "3",
                              "retryUpCount": "3",
                              "sourceIntf": "lo123",
                              "timeout": "1",
                              "trackID": "0"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <ctrlStatusEnable>disable</ctrlStatusEnable>
                  <delete>false</delete>
                  <dnshost></dnshost>
                  <frequency>267668</frequency>
                  <httpGetStr></httpGetStr>
                  <port>0</port>
                  <protocol>ICMP</protocol>
                  <retryDownCount>3</retryDownCount>
                  <retryUpCount>3</retryUpCount>
                  <sourceIntf>lo123</sourceIntf>
                  <timeout>1</timeout>
                  <trackID>0</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
delete	scalar:Bool	SELECTION: true or false
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Source Interface in a Probe

Deleting a Source Interface in a Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "epbr_serv"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1.2.3.4",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "delete": "yes",
                              "protocol": "ICMP",
                              "trackID": "0"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>epbr_serv</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>1.2.3.4</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <delete>true</delete>
                  <protocol>ICMP</protocol>
                  <trackID>0</trackID>
                </probe-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service epbr_serv
   service-end-point ip 1.2.3.4
    no probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Probe for Reverse IP

Configuring a Probe for Reverse IP

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "ser1"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "10.1.1.1",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrSvcEndPointReverse": {
                            "attributes": {
                              "delete": "no",
                              "ip": "20.2.2.2",
                              "svcIntf": "unspecified"
                            },
                            "children": [
                              {
                                "epbrProbe": {
                                  "attributes": {
                                    "ctrlStatusEnable": "disable",
                                    "delete": "no",
                                    "dnshost": "",
                                    "frequency": "0",
                                    "httpGetStr": "",
                                    "port": "0",
                                    "protocol": "ICMP",
                                    "retryDownCount": "0",
                                    "retryUpCount": "0",
                                    "sourceIntf": "unspecified",
                                    "timeout": "0",
                                    "trackID": "0"
}}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>ser1</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>10.1.1.1</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <epreverse-items>
                  <delete>false</delete>
                  <ip>20.2.2.2</ip>
                  <svcIntf>unspecified</svcIntf>
                  <probe-items>
                    <ctrlStatusEnable>disable</ctrlStatusEnable>
                    <delete>false</delete>
                    <dnshost></dnshost>
                    <frequency>0</frequency>
                    <httpGetStr></httpGetStr>
                    <port>0</port>
                    <protocol>ICMP</protocol>
                    <retryDownCount>0</retryDownCount>
                    <retryUpCount>0</retryUpCount>
                    <sourceIntf>unspecified</sourceIntf>
                    <timeout>0</timeout>
                    <trackID>0</trackID>
                  </probe-items>
                </epreverse-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service ser1
   service-end-point ip 10.1.1.1
    reverse ip 20.2.2.2
     probe icmp

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-ser1
epbrSvcEndPoint	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]
epbrSvcEndPointReverse	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse
epbrProbe	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse/probe

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Probe for Reverse IP

Deleting a Probe for Reverse IP

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "ser1"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "10.1.1.1",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrSvcEndPointReverse": {
                            "attributes": {
                              "delete": "no",
                              "ip": "20.2.2.2",
                              "svcIntf": "unspecified"
                            },
                            "children": [
                              {
                                "epbrProbe": {
                                  "attributes": {
                                    "delete": "yes",
                                    "protocol": "ICMP",
                                    "trackID": "0"
}}}]}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>ser1</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>10.1.1.1</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <epreverse-items>
                  <delete>false</delete>
                  <ip>20.2.2.2</ip>
                  <svcIntf>unspecified</svcIntf>
                  <probe-items>
                    <delete>true</delete>
                    <protocol>ICMP</protocol>
                    <trackID>0</trackID>
                  </probe-items>
                </epreverse-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service ser1
   service-end-point ip 10.1.1.1
    reverse ip 20.2.2.2
     no probe icmp

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-ser1
epbrSvcEndPoint	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]
epbrSvcEndPointReverse	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse
epbrProbe	sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse/probe

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Reverse IP

Configuring Reverse IP

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "ser6_1"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "10::1",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrSvcEndPointReverse": {
                            "attributes": {
                              "delete": "no",
                              "ip": "10::1",
                              "svcIntf": "unspecified"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>ser6_1</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>10::1</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <epreverse-items>
                  <delete>false</delete>
                  <ip>10::1</ip>
                  <svcIntf>unspecified</svcIntf>
                </epreverse-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service ser6_1
   service-end-point ipv6 10::1
    reverse ipv6 10::1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-ser6_1
epbrSvcEndPoint	sys/epbr/inst/session/service-ser6_1/ep-[10::1]
epbrSvcEndPointReverse	sys/epbr/inst/session/service-ser6_1/ep-[10::1]/epreverse

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Reverse IP

Deleting Reverse IP

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrService": {
                "attributes": {
                  "name": "ser6_1"
                },
                "children": [
                  {
                    "epbrSvcEndPoint": {
                      "attributes": {
                        "delete": "no",
                        "ip": "10::1",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrSvcEndPointReverse": {
                            "attributes": {
                              "delete": "yes",
                              "ip": "10::1"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <service-items>
          <Service-list>
            <name>ser6_1</name>
            <ep-items>
              <SvcEndPoint-list>
                <ip>10::1</ip>
                <delete>false</delete>
                <svcIntf>unspecified</svcIntf>
                <epreverse-items>
                  <delete>true</delete>
                  <ip>10::1</ip>
                </epreverse-items>
              </SvcEndPoint-list>
            </ep-items>
          </Service-list>
        </service-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr service ser6_1
   service-end-point ipv6 10::1
    no reverse ipv6 10::1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrService	sys/epbr/inst/session/service-ser6_1
epbrSvcEndPoint	sys/epbr/inst/session/service-ser6_1/ep-[10::1]
epbrSvcEndPointReverse	sys/epbr/inst/session/service-ser6_1/ep-[10::1]/epreverse

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Load Balance Method

Configuring a Load Balance Method

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "pol2"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "bucket": "16",
                        "delete": "no",
                        "isIPv6": "no",
                        "lbMethod": "src",
                        "name": "acl1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>pol2</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl1</name>
                <bucket>16</bucket>
                <delete>false</delete>
                <isIPv6>false</isIPv6>
                <lbMethod>src</lbMethod>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy pol2
   match ip address acl1
    load-balance buckets 16 method src-ip

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-pol2
epbrEpbrMatch	sys/epbr/inst/session/pmap-pol2/match-acl1

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Load Balance Method

Deleting a Load Balance Method

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrSessionInst": {
          "attributes": {
            "action": "noAction"
          },
          "children": [
            {
              "epbrPolicyMap": {
                "attributes": {
                  "name": "pol2"
                },
                "children": [
                  {
                    "epbrEpbrMatch": {
                      "attributes": {
                        "bucket": "0",
                        "delete": "no",
                        "isIPv6": "no",
                        "lbMethod": "noLBMethod",
                        "name": "acl1"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <session-items>
        <action>noAction</action>
        <pmap-items>
          <PolicyMap-list>
            <name>pol2</name>
            <match-items>
              <EpbrMatch-list>
                <name>acl1</name>
                <bucket>0</bucket>
                <delete>false</delete>
                <isIPv6>false</isIPv6>
                <lbMethod>noLBMethod</lbMethod>
              </EpbrMatch-list>
            </match-items>
          </PolicyMap-list>
        </pmap-items>
      </session-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr session
  epbr policy pol2
   match ip address acl1
    no load-balance buckets 16 method src-ip

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrSessionInst	sys/epbr/inst/session
epbrPolicyMap	sys/epbr/inst/session/pmap-pol2
epbrEpbrMatch	sys/epbr/inst/session/pmap-pol2/match-acl1

epbrSessionInst Properties

Property Name	Data Type	Description	Values
action	itd:sessActionType (scalar:Enum8)	The action required when the condition is met.	SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction

epbrPolicyMap Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrEpbrMatch Properties

Property Name	Data Type	Description	Values
bucket	itd:BucketNumType (scalar:Uint32)	RANGE: [0 , 256] DEFAULT: 0
delete	scalar:Bool	SELECTION: true or false
isIPv6	scalar:Bool	SELECTION: true or false
lbMethod	itd:LBMethod (scalar:Enum8)	SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod
name	string:Basic	The name of the object.	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Service

Configuring Probe for Service Health-Checks

Configuring Probe for Service Health-Checks

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "0",
                        "httpGetStr": "",
                        "port": "0",
                        "protocol": "noProtocol",
                        "retryDownCount": "0",
                        "retryUpCount": "0",
                        "sourceIntf": "unspecified",
                        "timeout": "0",
                        "trackID": "305"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>0</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <protocol>noProtocol</protocol>
                <retryDownCount>0</retryDownCount>
                <retryUpCount>0</retryUpCount>
                <sourceIntf>unspecified</sourceIntf>
                <timeout>0</timeout>
                <trackID>305</trackID>
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
probe track 305

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Probe for Service Health-Checks

Deleting Probe for Service Health-Checks

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items nc:operation="delete">
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe track 305

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Retry Count When the Node Goes Down for service-end-point

Configuring the Retry Count When the Node Goes Down for service-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "Hostname",
                        "frequency": "267668",
                        "httpGetStr": "",
                        "port": "0",
                        "protocol": "DNS",
                        "retryDownCount": "3",
                        "retryUpCount": "3",
                        "sourceIntf": "unspecified",
                        "timeout": "1",
                        "trackID": "0"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost>Hostname</dnshost>
                <frequency>267668</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <protocol>DNS</protocol>
                <retryDownCount>3</retryDownCount>
                <retryUpCount>3</retryUpCount>
                <sourceIntf>unspecified</sourceIntf>
                <timeout>1</timeout>
                <trackID>0</trackID>
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:Hostname

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Retry Count When the Node Goes Down for service-end-point

Deleting the Retry Count When the Node Goes Down for service-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items nc:operation="delete">
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an HTTP-Get Probe for service-end-point

Configuring an HTTP-Get Probe for service-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "680",
                        "httpGetStr": "",
                        "port": "0",
                        "protocol": "HTTP",
                        "retryDownCount": "3",
                        "retryUpCount": "3",
                        "sourceIntf": "unspecified",
                        "timeout": "1",
                        "trackID": "0"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>680</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <protocol>HTTP</protocol>
                <retryDownCount>3</retryDownCount>
                <retryUpCount>3</retryUpCount>
                <sourceIntf>unspecified</sourceIntf>
                <timeout>1</timeout>
                <trackID>0</trackID>
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
probe http get frequency 680 timeout 1 retry-up-count 3 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an HTTP-Get Probe for service-end-point

Deleting an HTTP-Get Probe for service-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items nc:operation="delete">
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe http get frequency 680 timeout 1 retry-up-count 3 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Source Interface for Probe

Configuring a Source Interface for Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "267668",
                        "httpGetStr": "",
                        "port": "0",
                        "protocol": "ICMP",
                        "retryDownCount": "3",
                        "retryUpCount": "3",
                        "sourceIntf": "lo123",
                        "timeout": "1",
                        "trackID": "0"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>267668</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <protocol>ICMP</protocol>
                <retryDownCount>3</retryDownCount>
                <retryUpCount>3</retryUpCount>
                <sourceIntf>lo123</sourceIntf>
                <timeout>1</timeout>
                <trackID>0</trackID>
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Source Interface for Probe

Deleting a Source Interface for Probe

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items nc:operation="delete">
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an ICMP Probe Retry Count Frequency

Configuring an ICMP Probe Retry Count Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "ctrlStatusEnable": "disable",
                        "dnshost": "",
                        "frequency": "267668",
                        "httpGetStr": "",
                        "port": "0",
                        "protocol": "ICMP",
                        "retryDownCount": "3",
                        "retryUpCount": "3",
                        "sourceIntf": "unspecified",
                        "timeout": "1",
                        "trackID": "0"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items>
                <ctrlStatusEnable>disable</ctrlStatusEnable>
                <dnshost></dnshost>
                <frequency>267668</frequency>
                <httpGetStr></httpGetStr>
                <port>0</port>
                <protocol>ICMP</protocol>
                <retryDownCount>3</retryDownCount>
                <retryUpCount>3</retryUpCount>
                <sourceIntf>unspecified</sourceIntf>
                <timeout>1</timeout>
                <trackID>0</trackID>
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
probe icmp timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an ICMP Probe Retry Count Frequency

Deleting an ICMP Probe Retry Count Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrProbe": {
                      "attributes": {
                        "status": "deleted"
}}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <probe-items nc:operation="delete">
              </probe-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrProbe	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an Reverse Service-End-Point Instance

Configuring an Reverse Service-End-Point Instance

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json


{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrService": {
                      "attributes": {
                        "name": "epbr_serv"
                      },
                      "children": [
                        {
                          "epbrSvcEndPoint": {
                            "attributes": {
                              "delete": "no",
                              "ip": "1.2.3.4",
                              "svcIntf": "unspecified"
                            },
                            "children": [
                              {
                                "epbrSvcEndPointReverse": {
                                  "attributes": {
                                    "delete": "no",
                                    "ip": "1.2.3.4",
                                    "svcIntf": "eth1/2"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}


<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <epreverse-items>
                <delete>false</delete>
                <ip>1.2.3.4</ip>
                <svcIntf>eth1/2</svcIntf>
              </epreverse-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
reverse ip 1.2.3.4 interface Ethernet1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrSvcEndPointReverse	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/epreverse

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an Reverse Service-End-Point Instance

Deleting an Reverse Service-End-Point Instance

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json


{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrService": {
                      "attributes": {
                        "name": "epbr_serv"
                      },
                      "children": [
                        {
                          "epbrSvcEndPoint": {
                            "attributes": {
                              "delete": "no",
                              "ip": "1.2.3.4",
                              "svcIntf": "unspecified"
                            },
                            "children": [
                              {
                                "epbrSvcEndPointReverse": {
                                  "attributes": {
                                    "status": "deleted"
                                  }
                                }
                              }
                            ]
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <epreverse-items nc:operation="delete">
              </epreverse-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4
no reverse ip 1.2.3.4 interface Ethernet1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]
epbrSvcEndPointReverse	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/epreverse

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an EPBR Service VRF Name

Configuring an EPBR Service VRF Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv",
            "vrf": "VRF1"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <vrf>VRF1</vrf>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
vrf VRF1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
vrf	l3:VrfName (string:Basic)	Identifies the VRF for the NTP providers	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an EPBR Service VRF Name

Deleting an EPBR Service VRF Name

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv",
            "vrf": "default"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <vrf></vrf>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no vrf VRF1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
vrf	l3:VrfName (string:Basic)	Identifies the VRF for the NTP providers	A sequence of characters

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a DNS Probe Retry Count Frequency

Configuring a DNS Probe Retry Count Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "Hostname",
                  "frequency": "497177",
                  "httpGetStr": "",
                  "port": "0",
                  "protocol": "DNS",
                  "retryDownCount": "1",
                  "retryUpCount": "1",
                  "sourceIntf": "unspecified",
                  "timeout": "1",
                  "trackID": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost>Hostname</dnshost>
            <frequency>497177</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <protocol>DNS</protocol>
            <retryDownCount>1</retryDownCount>
            <retryUpCount>1</retryUpCount>
            <sourceIntf>unspecified</sourceIntf>
            <timeout>1</timeout>
            <trackID>0</trackID>
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
probe dns host Hostname timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe
dnshost:Hostname

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a DNS Probe Retry Count Frequency

Deleting a DNS Probe Retry Count Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items nc:operation="delete">
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no probe dns host Hostname timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an HTTP-Get Probe Retrycount for sevice-end-point

Configuring an HTTP-Get Probe Retrycount for sevice-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "",
                  "frequency": "372077",
                  "httpGetStr": "",
                  "port": "0",
                  "protocol": "HTTP",
                  "retryDownCount": "1",
                  "retryUpCount": "1",
                  "sourceIntf": "unspecified",
                  "timeout": "1",
                  "trackID": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>372077</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <protocol>HTTP</protocol>
            <retryDownCount>1</retryDownCount>
            <retryUpCount>1</retryUpCount>
            <sourceIntf>unspecified</sourceIntf>
            <timeout>1</timeout>
            <trackID>0</trackID>
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
probe http get frequency 372077 timeout 1 retry-up-count 1 retry-down-count 1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an HTTP-Get Probe Retrycount for service-end-point

Deleting an HTTP-Get Probe Retrycount for service-end-point

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items nc:operation="delete">
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no probe http get frequency 372077 timeout 1 retry-up-count 1 retry-down-count 1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an ICMP Probe Retrycount

Configuring an ICMP Probe Retrycount

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "",
                  "frequency": "497177",
                  "httpGetStr": "",
                  "port": "0",
                  "protocol": "ICMP",
                  "retryDownCount": "1",
                  "retryUpCount": "1",
                  "sourceIntf": "lo123",
                  "timeout": "1",
                  "trackID": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>497177</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <protocol>ICMP</protocol>
            <retryDownCount>1</retryDownCount>
            <retryUpCount>1</retryUpCount>
            <sourceIntf>lo123</sourceIntf>
            <timeout>1</timeout>
            <trackID>0</trackID>
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
probe icmp timeout 1 retry-up-count 1 frequency 497177 source-interface loopback 123 retry-down-count 1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an ICMP Probe Retrycount

Deleting an ICMP Probe Retrycount

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items nc:operation="delete">
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no probe icmp timeout 1 retry-up-count 1 frequency 497177 source-interface loopback 123 retry-down-count 1

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an ICMP Retrycount Frequency

Configuring an ICMP Retrycount Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "ctrlStatusEnable": "disable",
                  "dnshost": "",
                  "frequency": "497177",
                  "httpGetStr": "",
                  "port": "0",
                  "protocol": "ICMP",
                  "retryDownCount": "1",
                  "retryUpCount": "1",
                  "sourceIntf": "unspecified",
                  "timeout": "1",
                  "trackID": "0"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items>
            <ctrlStatusEnable>disable</ctrlStatusEnable>
            <dnshost></dnshost>
            <frequency>497177</frequency>
            <httpGetStr></httpGetStr>
            <port>0</port>
            <protocol>ICMP</protocol>
            <retryDownCount>1</retryDownCount>
            <retryUpCount>1</retryUpCount>
            <sourceIntf>unspecified</sourceIntf>
            <timeout>1</timeout>
            <trackID>0</trackID>
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
probe icmp timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an ICMP Retrycount Frequency

Deleting an ICMP Retrycount Frequency

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrProbe": {
                "attributes": {
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <probe-items nc:operation="delete">
          </probe-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no probe icmp timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrProbe	sys/epbr/inst/service-epbr_serv/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Interface Through Which Service is Connected (IP)

Configuring the Interface Through Which Service is Connected (IP)

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1.2.3.4",
                  "svcIntf": "eth1/2"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1.2.3.4</ip>
              <delete>false</delete>
              <svcIntf>eth1/2</svcIntf>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ip 1.2.3.4 interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Interface Through Which Service is Connected (IP)

Deleting the Interface Through Which Service is Connected (IP)

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "ip": "1.2.3.4",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list nc:operation="delete">
              <ip>1.2.3.4</ip>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no service-end-point ip 1.2.3.4 interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Interface Through Which Service is Connected (IPv6)

Configuring the Interface Through Which Service is Connected (IPv6)

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1:2::3:4",
                  "svcIntf": "eth1/2"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1:2::3:4</ip>
              <delete>false</delete>
              <svcIntf>eth1/2</svcIntf>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-end-point ipv6 1:2::3:4 interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1:2::3:4]

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Interface Through Which Service is Connected (IPv6)

Deleting the Interface Through Which Service is Connected (IPv6)

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "ip": "1:2::3:4",
                  "status": "deleted"
}}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <ep-items>
            <SvcEndPoint-list nc:operation="delete">
              <ip>1:2::3:4</ip>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no service-end-point ipv6 1:2::3:4 interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv
epbrSvcEndPoint	sys/epbr/inst/service-epbr_serv/ep-[1:2::3:4]

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an Interface Through Which All End Points of Service are Connected

Configuring an Interface Through Which All End Points of Service are Connected

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv",
            "svcIntf": "eth1/2"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <svcIntf>eth1/2</svcIntf>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
service-interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an Interface Through Which All End Points of Service are Connected

Deleting an Interface Through Which All End Points of Service are Connected

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "epbr_serv",
            "svcIntf": "unspecified"
}}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>epbr_serv</name>
          <svcIntf>unspecified</svcIntf>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service epbr_serv
no service-interface ethernet 1/2

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-epbr_serv

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configure Probe for Reverse Endpoint

Configure Probe for Reverse Endpoint

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "ser6_1"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1000::1000",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrSvcEndPointReverse": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1001::1001",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "ctrlStatusEnable": "disable",
                              "delete": "no",
                              "dnshost": "",
                              "frequency": "0",
                              "httpGetStr": "",
                              "port": "0",
                              "protocol": "ICMP",
                              "retryDownCount": "0",
                              "retryUpCount": "0",
                              "sourceIntf": "unspecified",
                              "timeout": "0",
                              "trackID": "0"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>ser6_1</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1000::1000</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <epreverse-items>
                <delete>false</delete>
                <ip>1001::1001</ip>
                <svcIntf>unspecified</svcIntf>
                <probe-items>
                  <ctrlStatusEnable>disable</ctrlStatusEnable>
                  <delete>false</delete>
                  <dnshost></dnshost>
                  <frequency>0</frequency>
                  <httpGetStr></httpGetStr>
                  <port>0</port>
                  <protocol>ICMP</protocol>
                  <retryDownCount>0</retryDownCount>
                  <retryUpCount>0</retryUpCount>
                  <sourceIntf>unspecified</sourceIntf>
                  <timeout>0</timeout>
                  <trackID>0</trackID>
                </probe-items>
              </epreverse-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service ser6_1
  service-end-point ipv6 1000::1000
   reverse ipv6 1001::1001
    probe icmp

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-ser6_1
epbrSvcEndPoint	sys/epbr/inst/service-ser6_1/ep-[1000::1000]
epbrSvcEndPointReverse	sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse
epbrProbe	sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse/probe
dnshost:

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
ctrlStatusEnable	itd:ctrlType (scalar:Enum8)	SELECTION: 0 - disable 1 - enable DEFAULT: disable
delete	scalar:Bool	SELECTION: true or false
dnshost	itd:DnsHostType (string:Basic)	MAX SIZE: 99
frequency	scalar:Uint32	RANGE: [0 , 604800] DEFAULT: 0
httpGetStr	itd:HttpStringType (string:Basic)	MAX SIZE: 99
port	address:PortNumber (scalar:Uint16)	The service port number for the LDAP service.	RANGE: [0 , 65535] DEFAULT: 0
protocol	itd:protocolType (scalar:Enum8)	The transfer protocol to be used for data export.	SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol
retryDownCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
retryUpCount	scalar:Uint32	RANGE: [0 , 5] DEFAULT: 0
sourceIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
timeout	scalar:Uint32	The amount of time between authentication attempts.	RANGE: [0 , 604800] DEFAULT: 0
trackID	scalar:Uint32	RANGE: [0 , 512] DEFAULT: 0

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Probe for Reverse Endpoint

Deleting Probe for Reverse Endpoint

POST http://<mgmt0_IP>/api/mo/sys/epbr/inst.json

{
  "epbrInst": {
    "children": [
      {
        "epbrService": {
          "attributes": {
            "name": "ser6_1"
          },
          "children": [
            {
              "epbrSvcEndPoint": {
                "attributes": {
                  "delete": "no",
                  "ip": "1000::1000",
                  "svcIntf": "unspecified"
                },
                "children": [
                  {
                    "epbrSvcEndPointReverse": {
                      "attributes": {
                        "delete": "no",
                        "ip": "1001::1001",
                        "svcIntf": "unspecified"
                      },
                      "children": [
                        {
                          "epbrProbe": {
                            "attributes": {
                              "status": "deleted"
}}}]}}]}}]}}]}}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <service-items>
        <Service-list>
          <name>ser6_1</name>
          <ep-items>
            <SvcEndPoint-list>
              <ip>1000::1000</ip>
              <delete>false</delete>
              <svcIntf>unspecified</svcIntf>
              <epreverse-items>
                <delete>false</delete>
                <ip>1001::1001</ip>
                <svcIntf>unspecified</svcIntf>
                <probe-items nc:operation="delete">
                </probe-items>
              </epreverse-items>
            </SvcEndPoint-list>
          </ep-items>
        </Service-list>
      </service-items>
    </inst-items>
  </epbr-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

epbr service ser6_1
  service-end-point ipv6 1000::1000
   reverse ipv6 1001::1001
    no probe icmp

Verifying a DME Configuration

MO	DN
epbrInst	sys/epbr/inst
epbrService	sys/epbr/inst/service-ser6_1
epbrSvcEndPoint	sys/epbr/inst/service-ser6_1/ep-[1000::1000]
epbrSvcEndPointReverse	sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse
epbrProbe	sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse/probe

epbrService Properties

Property Name	Data Type	Description	Values
name	itd:SvcNameType (string:Basic)	The name of the object.	MAX SIZE: 31

epbrSvcEndPoint Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrSvcEndPointReverse Properties

Property Name	Data Type	Description	Values
delete	scalar:Bool	SELECTION: true or false
ip	address:Ip	The IP address.	Value must match ipv4 or ipv6 known format
svcIntf	nw:IfId (base:IfIndex)	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

epbrProbe Properties

Property Name	Data Type	Description	Values
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring an Ethernet Interface

Configuring an EPBR Policy

Configuring an EPBR Policy

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrEpbrIntf": {
                      "attributes": {
                        "ipType": "ipv4",
                        "name": "eth1/2",
                        "policyName": "pol1",
                        "reverse": "no-reverse"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <if-items>
        <EpbrIntf-list>
          <name>eth1/2</name>
          <ipType>ipv4</ipType>
          <reverse>no-reverse</reverse>
          <policyName>pol1</policyName>
        </EpbrIntf-list>
      </if-items>
    </inst-items>
  </epbr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
epbr ip policy pol1

Verifying a DME Configuration

MO	DN
topSystem	sys
epbrEntity	sys/epbr
epbrInst	sys/epbr/inst
epbrEpbrIntf	sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-no-reverse
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

epbrEpbrIntf Properties

The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
ipType	epbr:IpType (scalar:Enum8)	SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4
name	nw:IfId (base:IfIndex)	The name of the object.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
policyName	itd:SvcNameType (string:Basic)	The name of the EPBR policy.	MAX SIZE: 31
reverse	epbr:ReverseType (scalar:Enum8)	SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse

l1PhysIf Properties

The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting an EPBR Policy

Deleting an EPBR Policy

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrEpbrIntf": {
                      "attributes": {
                        "ipType": "ipv4",
                        "name": "eth1/2",
                        "reverse": "no-reverse",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <if-items>
        <EpbrIntf-list nc:operation="delete">
          <name>eth1/2</name>
          <ipType>ipv4</ipType>
          <reverse>no-reverse</reverse>
        </EpbrIntf-list>
      </if-items>
    </inst-items>
  </epbr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet1/2
no epbr ip policy pol1

Verifying a DME Configuration

MO	DN
topSystem	sys
epbrEntity	sys/epbr
epbrInst	sys/epbr/inst
epbrEpbrIntf	sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-no-reverse
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

epbrEpbrIntf Properties

Property Name	Data Type	Description	Values
ipType	epbr:IpType (scalar:Enum8)	SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4
name	nw:IfId (base:IfIndex)	The name of the object.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
reverse	epbr:ReverseType (scalar:Enum8)	SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Policy in the Reverse Direction (IP)

Configuring the Policy in the Reverse Direction (IP)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrEpbrIntf": {
                      "attributes": {
                        "ipType": "ipv4",
                        "name": "eth1/2",
                        "policyName": "pol2",
                        "reverse": "reverse"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <if-items>
        <EpbrIntf-list>
          <name>eth1/2</name>
          <ipType>ipv4</ipType>
          <reverse>reverse</reverse>
          <policyName>pol2</policyName>
        </EpbrIntf-list>
      </if-items>
    </inst-items>
  </epbr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
epbr ip policy pol2 reverse

Verifying a DME Configuration

MO	DN
topSystem	sys
epbrEntity	sys/epbr
epbrInst	sys/epbr/inst
epbrEpbrIntf	sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-reverse
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

epbrEpbrIntf Properties

Property Name	Data Type	Description	Values
ipType	epbr:IpType (scalar:Enum8)	SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4
name	nw:IfId (base:IfIndex)	The name of the object.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
policyName	itd:SvcNameType (string:Basic)	The name of the EPBR policy.	MAX SIZE: 31
reverse	epbr:ReverseType (scalar:Enum8)	SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Policy in the Reverse Direction (IP)

Deleting the Policy in the Reverse Direction (IP)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrEpbrIntf": {
                      "attributes": {
                        "ipType": "ipv4",
                        "name": "eth1/2",
                        "reverse": "reverse",
                        "status": "deleted"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <if-items>
        <EpbrIntf-list nc:operation="delete">
          <name>eth1/2</name>
          <ipType>ipv4</ipType>
          <reverse>reverse</reverse>
        </EpbrIntf-list>
      </if-items>
    </inst-items>
  </epbr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
no epbr ip policy pol2 reverse

Verifying a DME Configuration

MO	DN
topSystem	sys
epbrEntity	sys/epbr
epbrInst	sys/epbr/inst
epbrEpbrIntf	sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-reverse
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

epbrEpbrIntf Properties

Property Name	Data Type	Description	Values
ipType	epbr:IpType (scalar:Enum8)	SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4
name	nw:IfId (base:IfIndex)	The name of the object.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
reverse	epbr:ReverseType (scalar:Enum8)	SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse
status	mo:ModificationStatus (scalar:Bitmask32)	The upgrade status. This property is for internal use only.	SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Policy in the Reverse Direction (IPv6)

Configuring the Policy in the Reverse Direction (IPv6)

POST http://<mgmt0_IP>/api/mo/sys.json

{
  "topSystem": {
    "children": [
      {
        "epbrEntity": {
          "children": [
            {
              "epbrInst": {
                "children": [
                  {
                    "epbrEpbrIntf": {
                      "attributes": {
                        "ipType": "ipv6",
                        "name": "eth1/2",
                        "policyName": "pol1",
                        "reverse": "reverse"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "interfaceEntity": {
          "children": [
            {
              "l1PhysIf": {
                "attributes": {
                  "id": "eth1/2"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

{
    imdata:[]
}

<System>
  <epbr-items>
    <inst-items>
      <if-items>
        <EpbrIntf-list>
          <name>eth1/2</name>
          <ipType>ipv6</ipType>
          <reverse>reverse</reverse>
          <policyName>pol1</policyName>
        </EpbrIntf-list>
      </if-items>
    </inst-items>
  </epbr-items>
  <intf-items>
    <phys-items>
      <PhysIf-list>
        <id>eth1/2</id>
      </PhysIf-list>
    </phys-items>
  </intf-items>
</System>

Note: This example was added in Release 9.3(5).

CLI Commands

interface ethernet 1/2
epbr ipv6 policy pol1 reverse

Verifying a DME Configuration

MO	DN
topSystem	sys
epbrEntity	sys/epbr
epbrInst	sys/epbr/inst
epbrEpbrIntf	sys/epbr/inst/if-[eth1/2]-type-ipv6-reverse-reverse
interfaceEntity	sys/intf
l1PhysIf	sys/intf/phys-[eth1/2]

epbrEpbrIntf Properties

Property Name	Data Type	Description	Values
ipType	epbr:IpType (scalar:Enum8)	SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4
name	nw:IfId (base:IfIndex)	The name of the object.	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
policyName	itd:SvcNameType (string:Basic)	The name of the EPBR policy.	MAX SIZE: 31
reverse	epbr:ReverseType (scalar:Enum8)	SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse

l1PhysIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	An identifier .	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100

Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html