Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Configuring the Percentage of Bandwidth for Unicast Flow

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/nbm/conf.json
{
  "nbmGlobalConf": {
    "children": [
      {
        "nbmGlobalConfDom": {
          "attributes": {
            "name": "default"
          },
          "children": [
            {
              "nbmGlobalConfig": {
                "attributes": {
                  "unicastBwPercent": "75"
}}}]}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <nbm-items>
    <conf-items>
      <global-items>
        <dom-items>
          <GlobalConfDom-list>
            <name>default</name>
            <global-items>
              <unicastBwPercent>75</unicastBwPercent>
            </global-items>
          </GlobalConfDom-list>
        </dom-items>
      </global-items>
    </conf-items>
  </nbm-items>
</System>

Configuring NBM in PIM Active Mode

This section describes how to configure Non-blocking Multicast (NBM) in PIM Active mode, which ensures that the bandwidth coming into the fabric is the same as the bandwidth that is going out.

NOTE: IPFM is not supported on Nexus 3000 Series of switches.

This section contains payload examples and CLIs to demonstrate how to use the NX-API REST API to configure NBM on Cisco Nexus 9000 Series switches and to show how the REST APIs correspond to the CLI commands. For more information, see the Cisco Nexus 9000 Series NX-OS IP Fabric for Media Solution Guide, Releases 7.0(3)I4(5), 7.0(3)F2(1), and Later Releases configuration guide:

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

Configuring the Percentage of Bandwidth for Unicast Flow

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.

nbm reserve unicast fabric bandwidth 75

Note: The property information for this example was added in Release 9.3(3).

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
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

The following table contains information about the nbmGlobalConfDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

The following table contains information about the nbmGlobalConfig 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
unicastBwPercent	scalar:UByte	Unicast Bandwidth Reservation.	RANGE: [0 , 100] 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 Percentage of Bandwidth for Unicast Flow

CLI Commands

no nbm reserve unicast fabric bandwidth

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
unicastBwPercent	scalar:UByte	Unicast Bandwidth Reservation.	RANGE: [0 , 100] 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 Explicit Group Ranges

CLI Commands

nbm flow asm range 237.1.1.0/24

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGroupRangeList	sys/nbm/conf/grouprangelist
nbmGroupRangeDom	sys/nbm/conf/grouprangelist/dom-{name}
nbmGroupRange	sys/nbm/conf/grouprangelist/dom-{name}/g-{[group]}-m-{groupMask}

nbmGroupRangeDom Properties

The following table contains information about the nbmGroupRangeDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGroupRange Properties

The following table contains information about the nbmGroupRange 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
group	nbm:nbmMcastIpAddr (address:Ip)	ASM Range Multicast Group.	Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	ASM Range Group Mask as integer.	IP Addr mask between 5 and 32. RANGE: [0 , 32]

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 More than 1 Explicit Group Range in a Line

CLI Commands

nbm flow asm range 237.1.1.0/24 225.0.0.0/8 225.0.0.1/8

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nbmNbmTop	sys/nbm
nbmConfTables	sys/nbm/conf
nbmGroupRangeList	sys/nbm/conf/grouprangelist
nbmGroupRangeDom	sys/nbm/conf/grouprangelist/dom-{name}
nbmGroupRange	sys/nbm/conf/grouprangelist/dom-{name}/g-{[group]}-m-{groupMask}

nbmGroupRangeDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGroupRange Properties

Property Name	Data Type	Description	Values
group	nbm:nbmMcastIpAddr (address:Ip)	ASM Range Multicast Group.	Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	ASM Range Group Mask as integer.	IP Addr mask between 5 and 32. RANGE: [0 , 32]

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 Explicit Group Ranges

CLI Commands

no nbm flow asm range 237.1.1.0/24

Note: The property information for this example was added in Release 9.3(3).

MO	DN
topSystem	sys
nbmNbmTop	sys/nbm
nbmConfTables	sys/nbm/conf
nbmGroupRangeList	sys/nbm/conf/grouprangelist
nbmGroupRangeDom	sys/nbm/conf/grouprangelist/dom-{name}
nbmGroupRange	sys/nbm/conf/grouprangelist/dom-{name}/g-{[group]}-m-{groupMask}

nbmGroupRangeDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGroupRange Properties

Property Name	Data Type	Description	Values
group	nbm:nbmMcastIpAddr (address:Ip)	ASM Range Multicast Group.	Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	ASM Range Group Mask as integer.	IP Addr mask between 5 and 32. RANGE: [0 , 32]
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

Deleting Custom Flow Policies

CLI Commands

no nbm flow-policy

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}

nbmFlowPolicyDom Properties

The following table contains information about the nbmFlowPolicyDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63
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 Default Flow Bandwidth Value in Kbps

CLI Commands

nbm flow bandwidth 123 kbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultflowBw	scalar:Uint32	Flow Policy Default BW.	RANGE: [0, 4294967295] DEFAULT: 0
defaultflowBwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS

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 Default Flow Bandwidth Value in Mbps

CLI Commands

nbm flow bandwidth 123 mbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultflowBw	scalar:Uint32	Flow Policy Default BW.	RANGE: [0, 4294967295] DEFAULT: 0
defaultflowBwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS

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 Default Flow Bandwidth Value in Gbps

You can define specific bandwidth requirements for given multicast groups. Multicast groups without a specific flow bandwidth definition are specified as having a default flow bandwidth.

CLI Commands

nbm flow bandwidth 12 gbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultflowBw	scalar:Uint32	Flow Policy Default BW.	RANGE: [0, 4294967295] DEFAULT: 0
defaultflowBwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS

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 Flow Bandwidth Policy

CLI Commands

no nbm flow bandwidth

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultflowBw	scalar:Uint32	Flow Policy Default BW.	RANGE: [0, 4294967295] DEFAULT: 0
defaultflowBwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS

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 Link Connected to an External Router

You can install an NBM fabric in a Multisite topology where different fabrics are interconnected to each other. For a given fabric, all other fabrics are considered to be external routers, and the interfaces used to connect two fabrics are called, and should be configured as, external links.

CLI Commands

interface ethernet 1/2
nbm external-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmInterfaces	sys/nbm/conf/interfaces
nbmInterfacesDom	sys/nbm/conf/interfaces/dom-{name}
nbmIf	sys/nbm/conf/interfaces/dom-{name}/if-{if}

nbmInterfacesDom Properties

The following table contains information about the nbmInterfacesDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmIf Properties

The following table contains information about the nbmIf 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
if	nbm:nbmIf (scalar:Uint32)	Interface if-index.	RANGE: [0, 4294967295]
role	nbm:nbmLinkRole (scalar:Enum8)	Link Role.	EXTERNAL_LINK, FABRIC_LINK and NONE SELECTION: 0 - EXTERNAL_LINK 1 - FABRIC_LINK 255 - NONE DEFAULT: NONE

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

Un-Configuring a Link Connected to an External Router

CLI Commands

interface ethernet 1/2
no nbm external-link

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmInterfaces	sys/nbm/conf/interfaces
nbmInterfacesDom	sys/nbm/conf/interfaces/dom-{name}
nbmIf	sys/nbm/conf/interfaces/dom-{name}/if-{if}

nbmInterfacesDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmIf Properties

Property Name	Data Type	Description	Values
if	nbm:nbmIf (scalar:Uint32)	Interface if-index.	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 a Custom Flow Policy

CLI Commands

nbm flow-policy
policy name_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

The following table contains information about the nbmFlowPolicy 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	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 Custom Flow Policy

CLI Commands

nbm flow-policy
no policy name_1

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 a Custom IP Multicast Group

CLI Commands

nbm flow-policy
policy POL_1
ip group 237.1.1.0

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}
nbmFlowPolicyRange	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}/bgn-{[groupBegin]}-end-{[groupEnd]}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters

nbmFlowPolicyRange Properties

The following table contains information about the nbmFlowPolicyRange 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
groupBegin	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range start.	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupEnd	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range end.	Multicast Group Range IP only. Must be same as groupBegin in case of specific group policy. i.e when range is not desired. 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

Deleting a Custom Multicast Group

CLI Commands

no ip group 237.1.1.0

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}
nbmFlowPolicyRange	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}/bgn-{[groupBegin]}-end-{[groupEnd]}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters

nbmFlowPolicyRange Properties

Property Name	Data Type	Description	Values
groupBegin	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range start.	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupEnd	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range end.	Multicast Group Range IP only. Must be same as groupBegin in case of specific group policy. i.e when range is not desired. 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 a Custom Multicast Group Address Range

CLI Commands

nbm flow-policy
policy POL_1
ip group-range 237.1.1.0 to 238.1.1.0

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}
nbmFlowPolicyRange	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}/bgn-{[groupBegin]}-end-{[groupEnd]}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters

nbmFlowPolicyRange Properties

Property Name	Data Type	Description	Values
groupBegin	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range start.	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupEnd	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range end.	Multicast Group Range IP only. Must be same as groupBegin in case of specific group policy. i.e when range is not desired. 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

Deleting a Custom Multicast Group Address Range

CLI Commands

nbm flow-policy
policy POL_1
no ip group-range 237.1.1.0 to 238.1.1.0

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}
nbmFlowPolicyRange	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}/bgn-{[groupBegin]}-end-{[groupEnd]}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters

nbmFlowPolicyRange Properties

Property Name	Data Type	Description	Values
groupBegin	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range start.	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupEnd	nbm:nbmMcastIpAddr (address:Ip)	Flow Policy Group range end.	Multicast Group Range IP only. Must be same as groupBegin in case of specific group policy. i.e when range is not desired. 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 a Custom Bandwidth Value in Kbps for a Flow Policy

CLI Commands

nbm flow-policy
policy POL_1
bandwidth 123 kbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
bw	scalar:Uint64	Flow bandwidth.	RANGE: [0, 18446744073709551615]
bwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 Custom Bandwidth Value in Mbps for a Flow Policy

CLI Commands

nbm flow-policy
policy POL_1
bandwidth 123 mbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
bw	scalar:Uint64	Flow bandwidth.	RANGE: [0, 18446744073709551615]
bwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 Custom Bandwidth Value in Gbps for a Flow Policy

CLI Commands

nbm flow-policy
policy POL_1
bandwidth 12 gbps

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
bw	scalar:Uint64	Flow bandwidth.	RANGE: [0, 18446744073709551615]
bwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 DSCP for a Custom Flow Policy

The default DSCP value is 0.

CLI Commands

nbm flow-policy
policy POL_1
dscp 10

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
dscp	scalar:Uint32	DSCP value for the flow.	RANGE: [0 , 63] DEFAULT: 0
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 DSCP Configuration for a Custom Flow Policy

The default DSCP value is 0.

CLI Commands

nbm flow-policy
policy POL_1
no dscp

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
dscp	scalar:Uint32	DSCP value for the flow.	RANGE: [0 , 63] DEFAULT: 0
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 Bandwidth for a Custom Flow Policy

CLI Commands

nbm flow-policy
policy POL_1
no bandwidth

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
bw	scalar:Uint64	Flow bandwidth.	RANGE: [0, 18446744073709551615]
bwUnit	nbm:nbmBwUnitEn (scalar:Enum8)	bandwidth units - Mbps, Kbps, or Gbps	SELECTION: 0 - UNSPECIFIED 1 - KBPS 2 - MBPS 3 - GBPS DEFAULT: KBPS
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 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 Default Host Admission Permit Policy for Senders

The default value is "ALLOWED."

CLI Commands

nbm host-policy
sender
default permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultSenderHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for Sender hosts.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Default Host Admission Deny Policy for Senders

CLI Commands

nbm host-policy
sender
default deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultSenderHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for Sender hosts.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Default Host Admission Permit Policy for Receivers

CLI Commands

nbm host-policy
receiver
default permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultReceiverHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for Receiver hosts.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Default Host Admission Deny Policy for Receivers

CLI Commands

nbm host-policy
receiver
default deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultReceiverHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for Receiver hosts.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Default Host Admission Permit Policy for an External Receiver

CLI Commands

nbm host-policy
pim
default permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultPimHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for PIM groups.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Default Host Admission Deny Policy for an External Receiver

CLI Commands

nbm host-policy
pim
default deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultPimHostPolicy	nbm:nbmPermit (scalar:Enum8)	Default Allow or Deny policy for PIM groups.	SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: ALLOWED

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 Custom Host Admission Permit Policy for the Group Range of a Sender

default

10 232.1.0.0 16 1.1.1.1 ALLOWED

```

CLI Commands

nbm host-policy
sender
default permit
10 host 1.1.1.1 group 232.1.0.0/16 permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmSenderHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/sender
nbmSenderHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/sender/seq-{seqNum}

nbmHostPolicyDom Properties

The following table contains information about the nbmHostPolicyDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmSenderHostPolicy Properties

The following table contains information about the nbmSenderHostPolicy 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
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
host	nbm:nbmIpAddr (address:Ip)	Host IP Address	Non-Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED. SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]

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 Custom Host Admission Deny Policy for the Group Range of a Sender

CLI Commands

nbm host-policy
sender
10 host 1.1.1.1 group 232.1.0.0/16 deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmSenderHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/sender
nbmSenderHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/sender/seq-{seqNum}

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmSenderHostPolicy Properties

Property Name	Data Type	Description	Values
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
host	nbm:nbmIpAddr (address:Ip)	Host IP Address	Non-Multicast Group Range IP only. Value must match ipv4 or ipv6 known format
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED. SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]

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 Custom Host Admission Policy for Senders

default

```

CLI Commands

nbm host-policy
no sender

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmSenderHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/sender

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmSenderHostPolicyTable Properties

The following table contains information about the nbmSenderHostPolicyTable 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
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 Custom Host Admission Permit Policy for the Group Range of a Local Receiver

CLI Commands

nbm host-policy
receiver
123 host 1.2.3.4 source 1.2.3.4 group 237.1.1.0/24 permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmReceiverHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/receiver
nbmReceiverHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/receiver/seq-{seqNum}

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmReceiverHostPolicy Properties

The following table contains information about the nbmReceiverHostPolicy 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
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
host	nbm:nbmIpAddr (address:Ip)	Host IP Address	Non-Multicast Group Range IP only Value must match ipv4 or ipv6 known format
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]
source	nbm:nbmIpAddr (address:Ip)	Host 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 Custom Host Admission Deny Policy for the Group Range of a Local Receiver

CLI Commands

nbm host-policy
receiver
123 host 1.2.3.4 source 1.2.3.4 group 237.1.1.0/24 deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmReceiverHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/receiver
nbmReceiverHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/receiver/seq-{seqNum}

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmReceiverHostPolicy Properties

Property Name	Data Type	Description	Values
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
host	nbm:nbmIpAddr (address:Ip)	Host IP Address	Non-Multicast Group Range IP only Value must match ipv4 or ipv6 known format
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]
source	nbm:nbmIpAddr (address:Ip)	Host 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

Deleting a Custom Host Admission Policy for a Local Receiver

CLI Commands

nbm host-policy
no receiver

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmReceiverHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/receiver

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmReceiverHostPolicyTable Properties

The following table contains information about the nbmReceiverHostPolicyTable 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
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 Custom Host Admission Permit Policy for an External Receiver Group Range

CLI Commands

nbm host-policy
pim
123 source 1.2.3.4 group 237.1.1.0/24 permit

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmPimHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/pim
nbmPimHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/pim/seq-{seqNum}

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmPimHostPolicy Properties

The following table contains information about the nbmPimHostPolicy 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
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]
source	nbm:nbmIpAddr (address:Ip)	Host 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 Custom Host Admission Deny Policy for an External Receiver Group Range

CLI Commands

nbm host-policy
pim
123 source 1.2.3.4 group 237.1.1.0/24 deny

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmPimHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/pim
nbmPimHostPolicy	sys/nbm/conf/hostpolicytable/dom-{name}/pim/seq-{seqNum}

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmPimHostPolicy Properties

Property Name	Data Type	Description	Values
group	nbm:nbmMcastIpAddr (address:Ip)	Multicast Group	Multicast Group Range IP only Value must match ipv4 or ipv6 known format
groupMask	nbm:nbmIpMask (scalar:Uint16)	Group Mask as integer	IP Addr mask between 0 and 32 RANGE: [0 , 32]
permission	nbm:nbmPermit (scalar:Enum8)	Is the given policy to Allow or Deny a host	ALLOWED or DENIED SELECTION: 0 - UNDEFINED 1 - DENIED 2 - ALLOWED DEFAULT: DENIED
seqNum	nbm:nbmHostPolicySeq (scalar:Uint32)	Unique Sequence Number for Policies	1-19999999 RANGE: [1 , 19999999]
source	nbm:nbmIpAddr (address:Ip)	Host 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

Deleting a Custom Host Admission Policy for an External Receiver

CLI Commands

nbm host-policy
no pim

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmHostPolicyTable	sys/nbm/conf/hostpolicytable
nbmHostPolicyDom	sys/nbm/conf/hostpolicytable/dom-{name}
nbmPimHostPolicyTable	sys/nbm/conf/hostpolicytable/dom-{name}/pim

nbmHostPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmPimHostPolicyTable Properties

The following table contains information about the nbmPimHostPolicyTable 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
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 Flow Rate Limiter Installed in the Hardware

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow policer

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultFlowPolicer	nbm:nbmFlowPolicerEn (scalar:Enum8)	Enable or Disable Policer for default Flow Policy	SELECTION: 0 - DISABLED 1 - ENABLED DEFAULT: ENABLED

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 Flow Rate Limiter Installed in the Hardware

Note: This example was added in Release 9.2(3).

CLI Commands

no nbm flow policer

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmGlobalConf	sys/nbm/conf/global
nbmGlobalConfDom	sys/nbm/conf/global/dom-{name}
nbmGlobalConfig	sys/nbm/conf/global/dom-{name}/global

nbmGlobalConfDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmGlobalConfig Properties

Property Name	Data Type	Description	Values
defaultFlowPolicer	nbm:nbmFlowPolicerEn (scalar:Enum8)	Enable or Disable Policer for default Flow Policy	SELECTION: 0 - DISABLED 1 - ENABLED DEFAULT: ENABLED

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 Multicast Flow

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}

nbmConfFlowsDom Properties

The following table contains information about the nbmConfFlowsDom 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	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

The following table contains information about the nbmConfFlow 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
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source 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

Deleting a Multicast Flow

Note: This example was added in Release 9.2(3).

CLI Commands

no nbm flow-definition 239.255.255.255

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source 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 a Multicast Flow with the Source IP

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255 1.2.3.4

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source 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

Deleting a Multicast Flow with the Source IP

Note: This example was added in Release 9.2(3).

CLI Commands

no nbm flow-definition 239.255.255.255 1.2.3.4

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source 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 Egress Host IP for the Flow

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
egress-host 1.2.3.4

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowHost	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/host-{[host]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowHost Properties

The following table contains information about the nbmConfFlowHost 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
host	nbm:nbmIpAddr (address:Ip)	reporter IP Address	Non-Multicast Group Range IP only. 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

Deleting the Egress Host IP for the Flow

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
no egress-host 1.2.3.4

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowHost	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/host-{[host]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowHost Properties

Property Name	Data Type	Description	Values
host	nbm:nbmIpAddr (address:Ip)	reporter IP Address	Non-Multicast Group Range IP only. 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 Egress Interface for the Flow

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
egress-interface ethernet 1/2

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowIf	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/if-{[id]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowIf Properties

The following table contains information about the nbmConfFlowIf 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)	OIF Interface	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 Egress Interface for the Flow

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
no egress-interface ethernet 1/2

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowIf	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/if-{[id]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowIf Properties

Property Name	Data Type	Description	Values
id	nw:IfId (base:IfIndex)	OIF Interface	Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100
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 Flow on the Switch Without a Valid Egress Interface

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
stage-flow

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowHost	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/host-{[host]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowHost Properties

Property Name	Data Type	Description	Values
host	nbm:nbmIpAddr (address:Ip)	reporter IP Address	Non-Multicast Group Range IP only. 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

Deleting the Flow on the Switch Without a Valid Egress Interface

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-definition 239.255.255.255
no stage-flow

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlows	sys/nbm/conf/flows
nbmConfFlowsDom	sys/nbm/conf/flows/dom-{name}
nbmConfFlow	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}
nbmConfFlowHost	sys/nbm/conf/flows/dom-{name}/s-{[source]}-g-{[group]}/host-{[host]}

nbmConfFlowsDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmConfFlow Properties

Property Name	Data Type	Description	Values
group	nbm:nbmIpAddr (address:Ip)	Group being sent	Value must match ipv4 or ipv6 known format
source	nbm:nbmIpAddr (address:Ip)	source IP Address	Value must match ipv4 or ipv6 known format

nbmConfFlowHost Properties

Property Name	Data Type	Description	Values
host	nbm:nbmIpAddr (address:Ip)	reporter IP Address	Non-Multicast Group Range IP only. 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 Flow Rate Limiter Installed in the Hardware

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-policy
policy POL_1
policer

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters
policer	nbm:nbmFlowPolicerEn (scalar:Enum8)	Enable or Disable Policer for this Flow Policy	SELECTION: 0 - DISABLED 1 - ENABLED DEFAULT: ENABLED

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 Flow Rate Limiter Installed in the Hardware

Note: This example was added in Release 9.2(3).

CLI Commands

nbm flow-policy
policy POL_1
no policer

Note: The property information for this example was added in Release 9.3(3).

MO	DN
nbmFlowPolicyTable	sys/nbm/conf/flowpolicytable
nbmFlowPolicyDom	sys/nbm/conf/flowpolicytable/dom-{name}
nbmFlowPolicy	sys/nbm/conf/flowpolicytable/dom-{name}/name-{name}

nbmFlowPolicyDom Properties

Property Name	Data Type	Description	Values
name	naming:Name256 (string:Basic)	The name of the object.	MAX SIZE: 63

nbmFlowPolicy Properties

Property Name	Data Type	Description	Values
name	string:Basic	Flow Policy Name String.	Must be an alphanumerical string of max size 63 A sequence of characters
policer	nbm:nbmFlowPolicerEn (scalar:Enum8)	Enable or Disable Policer for this Flow Policy	SELECTION: 0 - DISABLED 1 - ENABLED DEFAULT: ENABLED

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