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

Latest

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Changing Sequence Numbers in a Time Range

DME

YANG

Copy
POST http://<mgmt0_IP>/api/mo/sys/acl/timerange.json
 
POST: /api/mo/sys.json
{
  "topSystem": {
    "children": [
      {
        "aclEntity": {
          "children": [
            {
              "timerangeTimerange": {
                "children": [
                  {
                    "timerangeTr": {
                      "attributes": {
                        "name": "tr4"
                      },
                      "children": [
                        {
                          "aclResequence": {
                            "attributes": {
                              "start": "5",
                              "step": "5"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
Response
{
    imdata:[]
}

Copy
<System>
<acl-items>
    <timerange-items>
      <tr-items>
        <Tr-list>
          <name>tr4</name>
          <reseq-items>
            <start>5</start>
            <step>5</step>
          </reseq-items>
        </Tr-list>
      </tr-items>
    </timerange-items>
  </acl-items>
</System>

Changing Sequence Numbers in a Time Range

Note: This example was added in Release 10.5(1).

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.

resequence time-range tr4 5 5

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
resequence	sys/acl/timerange/tr-[]/reseq

Properties

The following table contains information about the 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
start	Uint32	starting sequence number	1-4294967295
step	Uint32	step to increase the sequence number	1-4294967295

Related Documentation

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

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

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

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

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

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

Configuring Time Ranges

Configuring the Periodic Time and Date

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

CLI Commands

time-r testing
37 periodic thursday 3:35:3 to wednesday 3:3:36

Verifying a DME Configuration

MO	DN
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-37
timerangeTrePeriodic	sys/acl/timerange/tr-testing/seq-37/periodic
endPeriod:Wednesday

timerangeSEQ Properties

The following table contains information about the timerangeSEQ 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
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	RANGE: [0 , 4294967295]

timerangeTr Properties

The following table contains information about the timerangeTr 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	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeTrePeriodic Properties

The following table contains information about the timerangeTrePeriodic 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
endPeriod	timerange:period (string:Basic)	End Period for periodic rule of timerange	A sequence of characters
endTime	timerange:HourMinSec (string:Basic)	End Time for periodic rule of timerange	A sequence of characters
startPeriod	timerange:period (string:Basic)	Start Period for periodic rule of timerange	A sequence of characters
startTime	timerange:HourMinSec (string:Basic)	Start Time for periodic rule of timerange	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 Periodic Time and Date

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

CLI Commands

time-r testing
no 37 periodic thursday 3:35:3 to wednesday 3:3:36

Verifying a DME Configuration

MO	DN
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-37

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	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 the Absolute Time and Date

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

CLI Commands

time-r testing
57 absolute start 1:34:3 23 march 2019

Verifying a DME Configuration

MO	DN
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-57
timerangeTreAbsolute	sys/acl/timerange/tr-testing/seq-57/absolute

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	RANGE: [0 , 4294967295]

timerangeTreAbsolute Properties

The following table contains information about the timerangeTreAbsolute 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
startDay	timerange:Day (scalar:Uint32)	Start Day of the Month (1-31) for absolute rule of timerange	RANGE: [1 , 31]
startMonth	timerange:Month (scalar:UByte)	Start Month for absolute rule of timerange	RANGE: [1 , 12]
startTime	timerange:HourMinSec (string:Basic)	Start Time (hh:mm:ss) for absolute rule of timerange	A sequence of characters
startYear	timerange:Year (scalar:Uint32)	Start Year (2000-3000) for absolute rule of timerange	RANGE: [2000 , 3000]

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 Absolute Time and Date

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

CLI Commands

time-r testing
no 57 absolute start 1:34:3 23 march 2019

Verifying a DME Configuration

MO	DN
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-57

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	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 the Periodic Time and Date for an Access List

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

CLI Commands

mpls access-list AcL1
  30 permit mpls 34 45 56 redirect Ethernet1/1
   time-r testing
    37 periodic thursday 3:35:3 to wednesday 3:3:36

Verifying a DME Configuration

MO	DN
topSystem	sys
aclEntity	sys/acl
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-37
timerangeTrePeriodic	sys/acl/timerange/tr-testing/seq-37/periodic
endPeriod:Wednesday	mplsaclAF
sys/acl/mpls	mplsaclACL
sys/acl/mpls/name-AcL1	mplsaclSEQ
sys/acl/mpls/name-AcL1/seq-30	mplsaclACE
sys/acl/mpls/name-AcL1/seq-30/ace

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	RANGE: [0 , 4294967295]

timerangeTrePeriodic Properties

Property Name	Data Type	Description	Values
endPeriod	timerange:period (string:Basic)	End Period for periodic rule of timerange	A sequence of characters
endTime	timerange:HourMinSec (string:Basic)	End Time for periodic rule of timerange	A sequence of characters
startPeriod	timerange:period (string:Basic)	Start Period for periodic rule of timerange	A sequence of characters
startTime	timerange:HourMinSec (string:Basic)	Start Time for periodic rule of timerange	A sequence of characters

mplsaclACL Properties

The following table contains information about the mplsaclACL 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	acl:Name (string:Basic)	Name of Access lists	MAX SIZE: 63

mplsaclSEQ Properties

The following table contains information about the mplsaclSEQ 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
seqNum	acl:SequenceNumber (scalar:Uint32)	Defines the Sequence number	RANGE: [0 , 4294967295]

mplsaclACE Properties

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

Property Name	Data Type	Description	Values
action	acl:ActionType (scalar:Enum8)	Specify packets to forward or reject	SELECTION: 0 - invalid 1 - permit 2 - deny DEFAULT: invalid
labelOne	acl:LabelRange (scalar:Uint32)	Defines Mpls Label One	RANGE: [0 , 1048575]
labelThree	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Three	RANGE: [0 , 1048575]
labelTwo	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Two	RANGE: [0 , 1048575]
redirect	string:Basic	redirect to interface	eth1/1(Etherenet1/1) or pc1(Port-channel1), interface in a short form 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 Periodic Time and Date for an Access List

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

CLI Commands

mpls access-list AcL1
  30 permit mpls 34 45 56 redirect Ethernet1/1
   time-r testing
    no 37 periodic thursday 3:35:3 to wednesday 3:3:36

Verifying a DME Configuration

MO	DN
topSystem	sys
aclEntity	sys/acl
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-37
mplsaclAF	sys/acl/mpls
mplsaclACL	sys/acl/mpls/name-AcL1
mplsaclSEQ	sys/acl/mpls/name-AcL1/seq-30
mplsaclACE	sys/acl/mpls/name-AcL1/seq-30/ace

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	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

mplsaclACL Properties

Property Name	Data Type	Description	Values
name	acl:Name (string:Basic)	Name of Access lists	MAX SIZE: 63

mplsaclSEQ Properties

Property Name	Data Type	Description	Values
seqNum	acl:SequenceNumber (scalar:Uint32)	Defines the Sequence number	RANGE: [0 , 4294967295]

mplsaclACE Properties

Property Name	Data Type	Description	Values
action	acl:ActionType (scalar:Enum8)	Specify packets to forward or reject	SELECTION: 0 - invalid 1 - permit 2 - deny DEFAULT: invalid
labelOne	acl:LabelRange (scalar:Uint32)	Defines Mpls Label One	RANGE: [0 , 1048575]
labelThree	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Three	RANGE: [0 , 1048575]
labelTwo	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Two	RANGE: [0 , 1048575]
redirect	string:Basic	redirect to interface	eth1/1(Etherenet1/1) or pc1(Port-channel1), interface in a short form 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 Absolute Time and Date for an Access List

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

CLI Commands

mpls access-list AcL1
  30 permit mpls 34 45 56 redirect Ethernet1/1
   time-r testing
    57 absolute start 1:34:3 23 march 2019

Verifying a DME Configuration

MO	DN
topSystem	sys
aclEntity	sys/acl
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-57
timerangeTreAbsolute	sys/acl/timerange/tr-testing/seq-57/absolute
mplsaclAF	sys/acl/mpls
mplsaclACL	sys/acl/mpls/name-AcL1
mplsaclSEQ	sys/acl/mpls/name-AcL1/seq-30
mplsaclACE	sys/acl/mpls/name-AcL1/seq-30/ace

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	RANGE: [0 , 4294967295]

timerangeTreAbsolute Properties

Property Name	Data Type	Description	Values
startDay	timerange:Day (scalar:Uint32)	Start Day of the Month (1-31) for absolute rule of timerange	RANGE: [1 , 31]
startMonth	timerange:Month (scalar:UByte)	Start Month for absolute rule of timerange	RANGE: [1 , 12]
startTime	timerange:HourMinSec (string:Basic)	Start Time (hh:mm:ss) for absolute rule of timerange	A sequence of characters
startYear	timerange:Year (scalar:Uint32)	Start Year (2000-3000) for absolute rule of timerange	RANGE: [2000 , 3000]

mplsaclACL Properties

Property Name	Data Type	Description	Values
name	acl:Name (string:Basic)	Name of Access lists	MAX SIZE: 63

mplsaclSEQ Properties

Property Name	Data Type	Description	Values
seqNum	acl:SequenceNumber (scalar:Uint32)	Defines the Sequence number	RANGE: [0 , 4294967295]

mplsaclACE Properties

Property Name	Data Type	Description	Values
action	acl:ActionType (scalar:Enum8)	Specify packets to forward or reject	SELECTION: 0 - invalid 1 - permit 2 - deny DEFAULT: invalid
labelOne	acl:LabelRange (scalar:Uint32)	Defines Mpls Label One	RANGE: [0 , 1048575]
labelThree	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Three	RANGE: [0 , 1048575]
labelTwo	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Two	RANGE: [0 , 1048575]
redirect	string:Basic	redirect to interface	eth1/1(Etherenet1/1) or pc1(Port-channel1), interface in a short form 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 Absolute Time and Date for an Access List

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

CLI Commands

mpls access-list AcL1
  30 permit mpls 34 45 56 redirect Ethernet1/1
   time-r testing
    no 57 absolute start 1:34:3 23 march 2019

Verifying a DME Configuration

MO	DN
topSystem	sys
aclEntity	sys/acl
timerangeTimerange	sys/acl/timerange
timerangeTr	sys/acl/timerange/tr-testing
timerangeSEQ	sys/acl/timerange/tr-testing/seq-57
mplsaclAF	sys/acl/mpls
mplsaclACL	sys/acl/mpls/name-AcL1
mplsaclSEQ	sys/acl/mpls/name-AcL1/seq-30
mplsaclACE	sys/acl/mpls/name-AcL1/seq-30/ace

timerangeTr Properties

Property Name	Data Type	Description	Values
name	timerange:Name (string:Basic)	Timerange Name configuration	MAX SIZE: 63

timerangeSEQ Properties

Property Name	Data Type	Description	Values
seqNum	timerange:SequenceNumber (scalar:Uint32)	Sequence number for timerange rule	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

mplsaclACL Properties

Property Name	Data Type	Description	Values
name	acl:Name (string:Basic)	Name of Access lists	MAX SIZE: 63

mplsaclSEQ Properties

Property Name	Data Type	Description	Values
seqNum	acl:SequenceNumber (scalar:Uint32)	Defines the Sequence number	RANGE: [0 , 4294967295]

mplsaclACE Properties

Property Name	Data Type	Description	Values
action	acl:ActionType (scalar:Enum8)	Specify packets to forward or reject	SELECTION: 0 - invalid 1 - permit 2 - deny DEFAULT: invalid
labelOne	acl:LabelRange (scalar:Uint32)	Defines Mpls Label One	RANGE: [0 , 1048575]
labelThree	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Three	RANGE: [0 , 1048575]
labelTwo	acl:LabelRange (scalar:Uint32)	Defines Mpls Label Two	RANGE: [0 , 1048575]
redirect	string:Basic	redirect to interface	eth1/1(Etherenet1/1) or pc1(Port-channel1), interface in a short form 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