Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Enabling Fabric Wide Distribution

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/cfs.json
{
  "cfsEntity": {
    "children": [
      {
        "cfsInst": {
          "attributes": {
            "distribute": "enabled"
}}}]}}
Response
{
    imdata:[]
}

Copy
<System>
  <cfs-items>
    <inst-items>
      <distribute>enabled</distribute>
    </inst-items>
  </cfs-items>
</System>

Configuring CFS

Enabling Fabric Wide Distribution

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

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.

cfs distribute

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
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

The following table contains information about the cfsInst 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
distribute	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution	SELECTION: 1 - enabled 2 - disabled 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

Disabling Fabric Wide Distribution

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

CLI Commands

no cfs distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
distribute	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution	SELECTION: 1 - enabled 2 - disabled 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

Enabling CFS Distribution Over Ethernet

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

CLI Commands

cfs eth distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ethDist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over Ethernet	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 CFS Distribution Over Ethernet

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

CLI Commands

no cfs eth distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ethDist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over Ethernet	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 CFS Distribution Over IPv4

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

CLI Commands

cfs ipv4 distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ipv4Dist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over IPv4	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

Deleting CFS Distribution Over IPv4

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

CLI Commands

no cfs ipv4 distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ipv4Dist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over IPv4	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 CFS Distribution Over IPv6

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

CLI Commands

cfs ipv6 distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ipv6Dist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over IPv6	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

Deleting CFS Distribution Over IPv6

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

CLI Commands

no cfs ipv6 distribute

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

MO	DN
cfsEntity	sys/cfs
cfsInst	sys/cfs/inst

cfsInst Properties

Property Name	Data Type	Description	Values
ipv6Dist	cfs:AdminSt (scalar:Enum8)	Enable CFS distribution over IPv6	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 Regions to Limit the Distribution Scope of Application(s)

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

CLI Commands

cfs region 153

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
cfsInst	sys/cfs/inst
cfsRegion	sys/cfs/inst/region-153

cfsRegion Properties

The following table contains information about the cfsRegion 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
regId	cfs:RegId (scalar:Uint32)	CFS Region ID	RANGE: [1 , 200]

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 Regions to Limit the Distribution Scope of Application(s)

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

CLI Commands

no cfs region 153

Verifying a DME Configuration

MO	DN
cfsInst	sys/cfs/inst
cfsRegion	sys/cfs/inst/region-153

cfsRegion Properties

Property Name	Data Type	Description	Values
regId	cfs:RegId (scalar:Uint32)	CFS Region ID	RANGE: [1 , 200]
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 Registered Name of the Local Application

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

CLI Commands

cfs region 153
AppName

Verifying a DME Configuration

MO	DN
cfsInst	sys/cfs/inst
cfsRegion	sys/cfs/inst/region-153
cfsApp	sys/cfs/inst/region-153/app-AppName

cfsRegion Properties

Property Name	Data Type	Description	Values
regId	cfs:RegId (scalar:Uint32)	CFS Region ID	RANGE: [1 , 200]

cfsApp Properties

The following table contains information about the cfsApp 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
appName	string:Basic	CFS Appname ID	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 the Registered Name of the Local Application

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

CLI Commands

cfs region 153
no AppName

Verifying a DME Configuration

MO	DN
cfsInst	sys/cfs/inst
cfsRegion	sys/cfs/inst/region-153
cfsApp	sys/cfs/inst/region-153/app-AppName

cfsRegion Properties

Property Name	Data Type	Description	Values
regId	cfs:RegId (scalar:Uint32)	CFS Region ID	RANGE: [1 , 200]

cfsApp Properties

Property Name	Data Type	Description	Values
appName	string:Basic	CFS Appname ID	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