- Cisco Nexus 3000 and 9000 Series NX-API REST Documentation
- includes/_header
- Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 9.3(x)
- Getting Started with the Cisco Nexus 3000 and 9000 Series NX-API REST SDK
- Related Documentation
- New and Changed Information
- Features Added for Release 9.3(5)
- Support PIP (Portable IP) routes with Gateway IPs in EVPN
- Loop prevention and detection in VxLAN EVPN
- VNF Multipath Enhancements (Proportional VNF) Some parts are CIA-OUT
- Configuring Critical Flow Prioritization for Multicast Groups
- Enabling MAB for the Authentication of the Data Traffic with the RADIUS Server
- Configuring LLFC Watch-Dog Interval Globally
- Configuring DSCP Wildcard Mask
- Configuring GRPC
- Configuring Netconf
- Logging System Messages to a File
- Secure VXLAN EVPN Multi-Site using CloudSec
- Optimizing Bandwidth Utilization
- Configuring iCAM Monitoring
- Configuring Forward Link-Level PDUs
- Configuring License Reservation
- Configuring UDP Relay
- MVPN Configuration for the Handoff Node
- Configuring a MACsec Keychain and Keys
- Configuring EPBR
- Enabling EPBR
- Disabling EPBR
- Configuring an EPBR Policy
- Deleting an EPBR Policy
- Configuring an EPBR Service Name
- Deleting an EPBR Service Name
- Configuring an EPBR Policy Logging Level
- Deleting an EPBR Policy Logging Level
- Configuring EPBR Policy Refresh based on ACL Changes
- Configuring an EPBR Session
- Configuring an EPBR Policy
- Configuring an IP Access-List Name
- Deleting an IP Access-List Name
- Configuring an IPv6 Access-List Name
- Deleting an IPv6 Access-List Name
- Configuring EPBR Statistics
- Deleting EPBR Statistics
- Adding a Service to a Policy
- Deleting a Service to a Policy
- Configuring Source-IP Based Load Balancing
- Deleting Source-IP Based Load Balancing
- Configuring the Action to be Taken on Failure of this Service
- Deleting the Action to be Taken on Failure of this Service
- Configuring an EPBR Session
- Configuring an IP Access-List Name
- Deleting an IP Access-List Name
- Configuring an IPv6 Access-List Name
- Deleting an IPv6 Access-List Name
- Configuring Abort EPBR Session
- Configuring Commit EPBR Session
- Adding a Service to a Policy
- Deleting a Service to a Policy
- Configuring Load Balance with Fail Action
- Manageability
- Configuring Fundamentals
- High Availability and Redundancy
- Configuring ITD
- Configuring Interfaces
- Configuring Ethernet Interfaces
- Configuring a MAC Address Limitation
- Configuring VLAN Interfaces
- Configuring Loopback Interfaces
- Configuring MGMT Interfaces
- Configuring Breakout Profiles
- Configuring System Default Switchport
- Configuring UDLD
- Configuring BFD
- Configuring LACP
- Configuring Hostname Loopback
- Configuring Breakout on High-Bandwidth Interfaces
- Configuring Port-Channel Interfaces
- Configuring Virtual Port Channels
- Configuring Tunnel Interfaces
- Configuring Layer 2 Protocol Tunneling
- Configuring Network Address Translation (NAT)
- Configuring IP TCP MSS
- Configuring Hardware Profile Settings
- Querying Interface Information
- Clearing Statistics
- Configuring IP SLAs
- Configuring Label Switching
- Configuring Static MPLS
- Configuring MPLS Layer 3 VPN Load Balancing
- Configuring Segment Routing
- Configuring MPLS LDP
- Configuring Label Advertisement
- Configuring Label Allocation
- Configuring MPLS
- Disabling MPLS Forwarding for IP
- Configuring LDP Session Backoff
- Configuring a Router ID
- Configuring LDP Discovery
- Configuring Explicit Null Label Advertisement
- Configuring LDP Graceful Restart
- Configuring LDP Holdtime
- Configuring a Neighbor
- Configuring an LDP Password
- Configuring LDP Logging
- Configuring LDP Labels
- Configuring an LDP Session
- Configuring MPLS LDP on an Interface
- Configuring Segment Routing for Traffic Engineering
- Configuring MVPNs
- Configuring MPLS Segment Routing OAM
- Ephemeral (MOTL) MOs for FIB
- Ephemeral (MOTL) MOs for URIB
- Configuring Netstack
- Configuring Layer 2 Switching
- Configuring Multicast Routing
- Configuring PIM/PIM6
- Configuring NBM in PIM Active Mode
- Configuring NBM in PIM Passive Mode
- Configuring MSDP
- Configuring IGMP
- Configuring MLD Snooping
- Configuring MRIB
- Configuring RPF Routes for Multicast
- Configuring Multicast Service Reflection
- Configuring Hardware Profile Settings
- Setting High Priority to Multicast
- Configuring IPv6 MFWD Event History Buffers
- Configuring Fabric Extender
- Configuring QoS
- Configuring Policing
- Configuring QoS Class Maps
- Configuring QoS Policy Maps
- Configuring a User-Defined Network QoS Policy
- Configuring the Hardware Buffer Utilization Thresholds
- Configuring Hardware QoS
- Configuring Hardware Profile Settings on the Cisco Nexus 3500 Platform
- Configuring Cisco Nexus 9000 (Cisco-ASIC based) Platform QoS
- Configuring Priority Flow Control
- Changing the Bandwidth Allocated to Unicast and Multicast Traffic
- Clearing Statistics
- Configuring TCAM
- Enabling Queue-Based ECN Marking
- Configuring Trust Boundaries
- Configuring Security
- Configuring FIPS Mode
- Configuring AAA
- Configuring RADIUS
- Configuring TACACS+
- Configuring LDAP
- Configuring SSH
- Configuring a Trustpool Policy
- Configuring a Trustpoint Certificate Authority
- Configuring a Trustpoint Certificate Authority
- Configuring Certificate Authority Related Information
- Configuring Telnet
- Configuring the Shell Type for Login
- Configuring User Accounts and RBAC
- Configuring the VSH Roles and Rules
- Configuring ACLs
- Configuring Port Security
- Configuring DHCP
- Configuring Password Encryption
- Configuring VPN Ids
- Configuring Unicast RPF (URPF)
- Configuring System Security Compliance
- Configuring Control Plane Policing
- Configuring Rate Limits
- Configuring MACsec
- Configuring System Management
- Configuring Sup Boot Variables
- Configuring System Cores
- Configuring System Trace Level
- Configuring the Fast Reload Network Stabilization Timer
- Configuring Frequency Synchronization
- Configuring NTP
- Configuring PTP
- Configuring Cisco Discovery Protocol
- Configuring Call Home
- Configuring Checkpoints and Rollback
- Configuring System Logging
- Configuring the Scheduler
- Configuring SNMP
- Configuring RMON
- Configuring Online Diagnostics
- Configuring EVMED
- Configuring Embedded Event Manager
- Configuring Memory Thresholds
- Configuring SPAN
- Configuring ERSPAN
- Configuring LLDP
- Enabling and Disabling LLDP
- Configuring LLDP in Global Mode
- Configuring LLDP on the if-eth-base/if-ethernet-all Command Mode
- Configuring LLDP on the if-gig-ether Command Mode
- Configuring LLDP on the if-gig-ether-all Command Mode
- Configuring LLDP on the if-mgmt-ether Command Mode
- Configuring the DCBXP Version
- Configuring System Interface Shutdown
- Configuring NetFlow
- Configuring sFlow
- Attaching a TAP Aggregation Policy to an Interface
- Configuring MPLS Stripping
- Configuring the Maintenance-Mode Profile
- Configuring Maintenance Mode
- Configuring CFS
- Configuring User-Defined Fields
- Configuring a Fan-Direction Mismatch
- System-Level High Availability
- Configuring NX-OS Container Tracker
- Configuring VXLAN
- VXLAN New and Changed
- Configuring VXLAN BGP EVPN
- Configuring HMM
- VXLAN Configuration Command Examples
- Configuring NVE Interfaces
- Configuring BGP EVPN Filtering
- Configuring VXLAN OAM (NGOAM)
- Executing Ping NVE, Traceroute NVE, and Path Trace NVE
- Configuring System NVE
- Associating NVE Interfaces with VNIs
- Configuring ngMVPN
- Configuring Selective Q-in-VNI
- Ephemeral (MOTL) MOs for NVE
- Configuring Unicast Routing
- Configuring the System Routing Mode
- Configuring ARP
- Configuring ALPM
- Configuring Logging for Software Forwarding of IP Packets
- Configuring DNS
- Configuring OSPF, OSPFv2, and OSPFv3
- Configuring OSPF
- Configuring OSPFv2
- Configuring OSPFv3
- Configuring an IPv6 Unicast Address Family Under an OSPFv3 Instance
- Configuring OSPFv3 Broadcast Network Type
- Configuring OSPFv3 on an Ethernet Interface
- Configuring OSPFv3 on a Loopback Interface
- Configuring OSPFv3 on a MGMT Interface
- Configuring OSPFv3 on a P2P Ethernet Interface
- Configuring OSPFv3 on a Tunnel Interface
- Configuring a Virtual Link Under an OSPFv3 Instance
- Configuring a VRF Under an OSPFv3 Instance
- Configuring IS-IS
- Configuring IS-IS in Global Configuration Command Mode
- Configuring IS-IS in Interface Configuration Mode
- Configuring IS-IS in Router Configuration Mode
- Configuring IS-IS in Router VRF Configuration Mode
- Configuring IS-IS in Router IPv4 Address Family Configuration Mode
- Configuring IS-IS in Router IPv6 Address Family Configuration Mode
- Configuring BGP
- Configuring a BGP Router
- Configuring BGP on a VRF
- Configuring BFD Multihop under a Neighbor
- Configuring an IPv4 Multicast Address Family
- Configuring an IPv4 MVPN Address Family
- Configuring an IPv4 Unicast Address Family
- Configuring an IPv6 MVPN Address Family
- Configuring an IPv6 Unicast Address Family
- Configuring a Link-State Address Family
- Configuring a VPNv4 Unicast Address Family
- Configuring a VPNv6 Unicast Address Family
- Configuring a Peer Policy Template
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template
- Configuring a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Policy Template with Peer Template Inheritance
- Configuring a Peer Template
- Configuring an IPv4 Labeled Subaddress Family for a Peer Template
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template
- Configuring a VPNv4 Subaddress Family for a Peer Template
- Configuring a VPNV6 Subaddress Family for a Peer Template
- Configuring Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for Peer Template Inheritance
- Configuring a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Labeled Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring an IPv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv4 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a VPNv6 Unicast Subaddress Family for a Peer Template with Peer Template Inheritance
- Configuring a BGP Neighbor (IP Address)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Labeled Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Multicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv4 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring an L2VPN EVPN Address Family under a BGP Neighbor (IP Address)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (IP Address)
- Configuring BGP Session Templates Under a BGP Neighbor (IP Address)
- Configuring a BGP Neighbor (Ethernet Interface)
- Configuring an IPv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an IPv6 MVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring an L2VPN EVPN Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a VPNv4 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a VPNv6 Unicast Subaddress Family Under a BGP Neighbor (Ethernet Interface)
- Configuring a BMP Server
- Configuring Mixed ECMP
- About Querying Ephemeral Data
- Configuring DSCP
- Configuring VRFs
- Configuring Route Policy Manager
- First-Hop Redundancy Protocols
- Configuring Hardware Forwarding
- Configuring Hardware Ejector
- Configuring Hardware Profile Settings
- Configuring the Site of Origin
- Configuring AS-4 Dot Notation
- Configuring Static Routing
- Configuring Load Sharing in the Unicast FIB
- Configuring OpenFlow
- Configuring RTP Flow Monitoring
- Configuring Kernel Stack
- Controlling the Guest Shell
- Enabling the Guest Shell and Querying the Result
- Disabling the Guest Shell and Querying the Result
- Destroying the Guest Shell and Querying the Result
- Rebooting the Guest Shell and Querying the Result
- Increasing the Guest Shell Rootfs Size and Querying the Result
- Changing the CPU Memory Size that the Guest Shell Uses and Querying the Result
- Changing the Memory Size the Guest Shell Uses and Querying the Result
- Syncing the Guest Shell Rootfs to the Standby Supervisor and Querying the Result
- Exporting the Guest Shell Rootfs and Querying the Result
- Upgrading the Guest Shell Rootfs and Querying the Result
- Querying Guest Shell Information
- Change Virtual Service Global Configuration
- Managing System Hardware
- Configuring the Baseboard Management Controller
- Configuring Virtual Machine Tracker
- Configuring Virtual Device Contexts
- Configuring iCAM
- Configuring SRv6
- Configuring Smart Software Licensing
- Querying Configurations (Show Commands)
- Querying Advertised Routes
- Querying DHCP Relay Interfaces
- Querying Diagnostic Result Test IDs
- Querying the Environment Settings
- Querying Feature Status
- Querying Inventory Information
- Querying IS-IS Configurations
- Querying IP IGMP Groups
- Querying IP OSPF Neighbor Details
- Querying IP OSPF Neighbor VRF Information
- Querying L2VPN EVPN
- Querying LLDP
- Querying MAC Address Table Info
- Querying Module Information
- Querying NAT ITD
- Querying NTP Peer Status
- Querying an OSPFv2 Instance
- Querying Patterns
- Querying PIM Information
- Querying the Processes Log
- Querying Spanning Tree Information
- Querying a Summary of IP Interface Status and Configuration Information
- Querying TCAM Resource Utilization
- Querying the Version
- Querying VLAN ID Counters
- Querying VRF Information
- Querying VRRP Information
- Querying Forwarding Route Information
- Querying IP Route Details
- Querying the Current MOTD Banner Message
- Querying OSPF Neighbors
- Querying Analytic Information
- Querying Interface and VLAN Counters and Statistics
- Using the Managed Object Browser
- Monitoring the Environment
CopyPOST http://<mgmt0_IP>/api/mo/sys/fm.json
{
"fmEntity": {
"children": [
{
"fmEpbr": {
"attributes": {
"adminSt": "enabled"
}}}]}}
Response
{
imdata:[]
}
Copy<System>
<fm-items>
<epbr-items>
<adminSt>enabled</adminSt>
</epbr-items>
</fm-items>
</System>
Configuring EPBR
Enhanced Policy-based Routing (EPBR) in Elastic Services Re-direction (ESR) provides traffic redirection and service chaining across the standalone and fabric topologies by leveraging policy-based routing solution and achieves service chaining without adding additional headers, and avoids latency in using additional headers.
For more information, see the Cisco Nexus 9000 Series NX-OS ePBR Configuration Guide:
Enabling EPBR
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
feature epbr
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
fmEntity | sys/fm |
fmEpbr | sys/fm/epbr |
fmEpbr Properties
The following table contains information about the fmEpbr properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Disabling EPBR
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no feature epbr
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
MO | DN |
---|---|
fmEntity | sys/fm |
fmEpbr | sys/fm/epbr |
fmEpbr Properties
The following table contains information about the fmEpbr properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
adminSt | fm:AdminState (scalar:Enum8) | Admin status | SELECTION: 1 - enabled 2 - disabled DEFAULT: disabled |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an EPBR Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an EPBR Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no epbr policy epbr_pol
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
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:
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:
Configuring an EPBR Service Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an EPBR Service Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no epbr service epbr_serv
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
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:
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:
Configuring an EPBR Policy Logging Level
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
logging level epbr 7
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 |
---|---|
loggingLogLevel | sys/logging/loglevel |
loggingFacility | sys/logging/loglevel/facility-[epbr] |
loggingFacility Properties
The following table contains information about the loggingFacility properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
facilityName | comp:DelimitedString (string:Basic) | Facility Name of individual processes subscribed for logging level | A sequence of characters |
severityLevel | syslog:Severity (scalar:Enum8) | Logging severity level for individual facility name | SELECTION: 0 - emergencies 1 - alerts 2 - critical 3 - errors 4 - warnings 5 - notifications 6 - information 7 - debugging DEFAULT: notifications |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an EPBR Policy Logging Level
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no logging level epbr 7
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 |
---|---|
loggingLogLevel | sys/logging/loglevel |
loggingFacility | sys/logging/loglevel/facility-[epbr] |
loggingFacility Properties
The following table contains information about the loggingFacility properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
facilityName | comp:DelimitedString (string:Basic) | Facility Name of individual processes subscribed for logging level | A sequence of characters |
severityLevel | syslog:Severity (scalar:Enum8) | Logging severity level for individual facility name | SELECTION: 0 - emergencies 1 - alerts 2 - critical 3 - errors 4 - warnings 5 - notifications 6 - information 7 - debugging DEFAULT: notifications |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring EPBR Policy Refresh based on ACL Changes
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session access-list Acl-name refresh
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrAclAction | sys/epbr/inst/refreshacl-Acl-name |
epbrAclAction Properties
The following table contains information about the epbrAclAction properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
aclName | epbr:AclNameType (string:Basic) | MAX SIZE: 50 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an EPBR Session
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an EPBR Policy
Configuring an IP Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
match ip address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an IP Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
no match ip address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | string:Basic | The name of the object. | A sequence of characters |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an IPv6 Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
match ipv6 address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an IPv6 Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
no match ipv6 address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-epbr_pol1/match-ip-access-list-name |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | string:Basic | The name of the object. | A sequence of characters |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring EPBR Statistics
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
statistics
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
statistics | scalar:Bool | SELECTION: true or false |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting EPBR Statistics
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy epbr_pol1
no statistics
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-epbr_pol1 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
statistics | scalar:Bool | SELECTION: true or false |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Adding a Service to a Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy R5-_ZZJ
match ipv6 address acl2
15 set service ser6_1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-R5-_ZZJ |
epbrEpbrMatch | sys/epbr/inst/pmap-R5-_ZZJ/match-acl2 |
epbrEpbrMatchSeq | sys/epbr/inst/pmap-R5-_ZZJ/match-acl2/seq-15 |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
failaction | epbr:FailactionType (scalar:Enum8) | SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction | |
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Service to a Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy R5-_ZZJ
match ipv6 address acl2
no 15 set service ser6_1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-R5-_ZZJ |
epbrEpbrMatch | sys/epbr/inst/pmap-R5-_ZZJ/match-acl2 |
epbrEpbrMatchSeq | sys/epbr/inst/pmap-R5-_ZZJ/match-acl2/seq-15 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
seqno | scalar:Uint32 | RANGE: [0, 4294967295] | |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Source-IP Based Load Balancing
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy pol1
match ipv6 address acl-v6
load-balance buckets 16 method src-ip
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-pol1/match-acl-v6 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Source-IP Based Load Balancing
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy pol1
match ipv6 address acl-v6
no load-balance buckets 16 method src-ip
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-pol1/match-acl-v6 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Action to be Taken on Failure of this Service
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy pol1
match ipv6 address acl-v6
load-balance buckets 16 method src-ip
10 set service ser6_1 fail-action bypass
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-pol1/match-acl-v6 |
epbrEpbrMatchSeq | sys/epbr/inst/pmap-pol1/match-acl-v6/seq-10 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
failaction | epbr:FailactionType (scalar:Enum8) | SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction | |
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Action to be Taken on Failure of this Service
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr policy pol1
match ipv6 address acl-v6
load-balance buckets 16 method src-ip
no 10 set service ser6_1 fail-action bypass
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrPolicyMap | sys/epbr/inst/pmap-pol1 |
epbrEpbrMatch | sys/epbr/inst/pmap-pol1/match-acl-v6 |
epbrEpbrMatchSeq | sys/epbr/inst/pmap-pol1/match-acl-v6/seq-10 |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
seqno | scalar:Uint32 | RANGE: [0, 4294967295] | |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an EPBR Session
Configuring an IP Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
match ip address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an IP Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
no match ip address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an IPv6 Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
match ipv6 address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an IPv6 Access-List Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
no match ipv6 address ip-access-list-name
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-ip-access-list-name |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Abort EPBR Session
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
abort
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Commit EPBR Session
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
commit
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Adding a Service to a Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
match ipv6 address acl2
15 set service ser6_1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-acl2 |
epbrEpbrMatchSeq | sys/epbr/inst/session/pmap-epbr_pol1/match-acl2/seq-15 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
failaction | epbr:FailactionType (scalar:Enum8) | SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction | |
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Service to a Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy epbr_pol1
match ipv6 address acl2
no 15 set service ser6_1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-epbr_pol1 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-epbr_pol1/match-acl2 |
epbrEpbrMatchSeq | sys/epbr/inst/session/pmap-epbr_pol1/match-acl2/seq-15 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Load Balance with Fail Action
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy pol2
match ip address acl1
load-balance buckets 16 method src-ip
10 set service ser2 fail-action bypass
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-pol2 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-pol2/match-acl1 |
epbrEpbrMatchSeq | sys/epbr/inst/session/pmap-pol2/match-acl1/seq-10 |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
failaction | epbr:FailactionType (scalar:Enum8) | SELECTION: 0 - nofailaction 1 - bypass 2 - forward 3 - drop DEFAULT: nofailaction | |
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy pol2
match ip address acl1
load-balance buckets 16 method src-ip
no 10 set service ser2 fail-action bypass
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-pol2 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-pol2/match-acl1 |
epbrEpbrMatchSeq | sys/epbr/inst/session/pmap-pol2/match-acl1/seq-10 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
epbrEpbrMatchSeq Properties
The following table contains information about the epbrEpbrMatchSeq properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
seqno | scalar:Uint32 | RANGE: [0, 4294967295] |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a User-Defined Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe track 305
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
delete | scalar:Bool | SELECTION: true or false | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a User-Defined Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe track 305
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a DNS Probe with Frquency, Retry Up and Down Count
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost:Hostname |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
delete | scalar:Bool | SELECTION: true or false | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a DNS Probe with Frquency, Retry Up and Down Count
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Source Interface in a Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
delete | scalar:Bool | SELECTION: true or false | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Source Interface in a Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/session/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Probe for Reverse IP
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service ser1
service-end-point ip 10.1.1.1
reverse ip 20.2.2.2
probe icmp
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-ser1 |
epbrSvcEndPoint | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1] |
epbrSvcEndPointReverse | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse |
epbrProbe | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse/probe |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Probe for Reverse IP
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service ser1
service-end-point ip 10.1.1.1
reverse ip 20.2.2.2
no probe icmp
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-ser1 |
epbrSvcEndPoint | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1] |
epbrSvcEndPointReverse | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse |
epbrProbe | sys/epbr/inst/session/service-ser1/ep-[10.1.1.1]/epreverse/probe |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring Reverse IP
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service ser6_1
service-end-point ipv6 10::1
reverse ipv6 10::1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-ser6_1 |
epbrSvcEndPoint | sys/epbr/inst/session/service-ser6_1/ep-[10::1] |
epbrSvcEndPointReverse | sys/epbr/inst/session/service-ser6_1/ep-[10::1]/epreverse |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Reverse IP
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr service ser6_1
service-end-point ipv6 10::1
no reverse ipv6 10::1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrService | sys/epbr/inst/session/service-ser6_1 |
epbrSvcEndPoint | sys/epbr/inst/session/service-ser6_1/ep-[10::1] |
epbrSvcEndPointReverse | sys/epbr/inst/session/service-ser6_1/ep-[10::1]/epreverse |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a Load Balance Method
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy pol2
match ip address acl1
load-balance buckets 16 method src-ip
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-pol2 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-pol2/match-acl1 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Load Balance Method
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr session
epbr policy pol2
match ip address acl1
no load-balance buckets 16 method src-ip
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrSessionInst | sys/epbr/inst/session |
epbrPolicyMap | sys/epbr/inst/session/pmap-pol2 |
epbrEpbrMatch | sys/epbr/inst/session/pmap-pol2/match-acl1 |
epbrSessionInst Properties
The following table contains information about the epbrSessionInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
action | itd:sessActionType (scalar:Enum8) | The action required when the condition is met. | SELECTION: 0 - noAction 1 - commit 2 - abort DEFAULT: noAction |
epbrPolicyMap Properties
The following table contains information about the epbrPolicyMap properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrEpbrMatch Properties
The following table contains information about the epbrEpbrMatch properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
bucket | itd:BucketNumType (scalar:Uint32) | RANGE: [0 , 256] DEFAULT: 0 | |
delete | scalar:Bool | SELECTION: true or false | |
isIPv6 | scalar:Bool | SELECTION: true or false | |
lbMethod | itd:LBMethod (scalar:Enum8) | SELECTION: 0 - noLBMethod 1 - src 2 - dst DEFAULT: noLBMethod | |
name | string:Basic | The name of the object. | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an EPBR Service
Configuring Probe for Service Health-Checks
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe track 305
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Probe for Service Health-Checks
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe track 305
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring the Retry Count When the Node Goes Down for service-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost:Hostname |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Retry Count When the Node Goes Down for service-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe dns host Hostname timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an HTTP-Get Probe for service-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe http get frequency 680 timeout 1 retry-up-count 3 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an HTTP-Get Probe for service-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe http get frequency 680 timeout 1 retry-up-count 3 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring a Source Interface for Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a Source Interface for Probe
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 3 frequency 267668 source-interface loopback 123 retry-down-count 3
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an ICMP Probe Retry Count Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
probe icmp timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an ICMP Probe Retry Count Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no probe icmp timeout 1 retry-up-count 3 retry-down-count 3 frequency 267668
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrProbe | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an Reverse Service-End-Point Instance
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
reverse ip 1.2.3.4 interface Ethernet1/2
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrSvcEndPointReverse | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/epreverse |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an Reverse Service-End-Point Instance
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4
no reverse ip 1.2.3.4 interface Ethernet1/2
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrSvcEndPointReverse | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4]/epreverse |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an EPBR Service VRF Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
vrf VRF1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
vrf | l3:VrfName (string:Basic) | Identifies the VRF for the NTP providers | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an EPBR Service VRF Name
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no vrf VRF1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
vrf | l3:VrfName (string:Basic) | Identifies the VRF for the NTP providers | A sequence of characters |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring a DNS Probe Retry Count Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
probe dns host Hostname timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
dnshost:Hostname |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting a DNS Probe Retry Count Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no probe dns host Hostname timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an HTTP-Get Probe Retrycount for sevice-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
probe http get frequency 372077 timeout 1 retry-up-count 1 retry-down-count 1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an HTTP-Get Probe Retrycount for service-end-point
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no probe http get frequency 372077 timeout 1 retry-up-count 1 retry-down-count 1
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an ICMP Probe Retrycount
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
probe icmp timeout 1 retry-up-count 1 frequency 497177 source-interface loopback 123 retry-down-count 1
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an ICMP Probe Retrycount
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no probe icmp timeout 1 retry-up-count 1 frequency 497177 source-interface loopback 123 retry-down-count 1
Verifying a DME Configuration
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an ICMP Retrycount Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
probe icmp timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an ICMP Retrycount Frequency
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no probe icmp timeout 1 retry-up-count 1 retry-down-count 1 frequency 497177
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrProbe | sys/epbr/inst/service-epbr_serv/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring the Interface Through Which Service is Connected (IP)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ip 1.2.3.4 interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Interface Through Which Service is Connected (IP)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no service-end-point ip 1.2.3.4 interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1.2.3.4] |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Interface Through Which Service is Connected (IPv6)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-end-point ipv6 1:2::3:4 interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1:2::3:4] |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Interface Through Which Service is Connected (IPv6)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no service-end-point ipv6 1:2::3:4 interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrSvcEndPoint | sys/epbr/inst/service-epbr_serv/ep-[1:2::3:4] |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring an Interface Through Which All End Points of Service are Connected
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
service-interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an Interface Through Which All End Points of Service are Connected
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service epbr_serv
no service-interface ethernet 1/2
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-epbr_serv |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configure Probe for Reverse Endpoint
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service ser6_1
service-end-point ipv6 1000::1000
reverse ipv6 1001::1001
probe icmp
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-ser6_1 |
epbrSvcEndPoint | sys/epbr/inst/service-ser6_1/ep-[1000::1000] |
epbrSvcEndPointReverse | sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse |
epbrProbe | sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse/probe |
dnshost: |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ctrlStatusEnable | itd:ctrlType (scalar:Enum8) | SELECTION: 0 - disable 1 - enable DEFAULT: disable | |
delete | scalar:Bool | SELECTION: true or false | |
dnshost | itd:DnsHostType (string:Basic) | MAX SIZE: 99 | |
frequency | scalar:Uint32 | RANGE: [0 , 604800] DEFAULT: 0 | |
httpGetStr | itd:HttpStringType (string:Basic) | MAX SIZE: 99 | |
port | address:PortNumber (scalar:Uint16) | The service port number for the LDAP service. | RANGE: [0 , 65535] DEFAULT: 0 |
protocol | itd:protocolType (scalar:Enum8) | The transfer protocol to be used for data export. | SELECTION: 0 - noProtocol 1 - DNS 2 - HTTP 3 - ICMP 4 - TCP 5 - UDP 6 - IP DEFAULT: noProtocol |
retryDownCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
retryUpCount | scalar:Uint32 | RANGE: [0 , 5] DEFAULT: 0 | |
sourceIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 | |
timeout | scalar:Uint32 | The amount of time between authentication attempts. | RANGE: [0 , 604800] DEFAULT: 0 |
trackID | scalar:Uint32 | RANGE: [0 , 512] DEFAULT: 0 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting Probe for Reverse Endpoint
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
epbr service ser6_1
service-end-point ipv6 1000::1000
reverse ipv6 1001::1001
no probe icmp
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 |
---|---|
epbrInst | sys/epbr/inst |
epbrService | sys/epbr/inst/service-ser6_1 |
epbrSvcEndPoint | sys/epbr/inst/service-ser6_1/ep-[1000::1000] |
epbrSvcEndPointReverse | sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse |
epbrProbe | sys/epbr/inst/service-ser6_1/ep-[1000::1000]/epreverse/probe |
epbrService Properties
The following table contains information about the epbrService properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
name | itd:SvcNameType (string:Basic) | The name of the object. | MAX SIZE: 31 |
epbrSvcEndPoint Properties
The following table contains information about the epbrSvcEndPoint properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrSvcEndPointReverse Properties
The following table contains information about the epbrSvcEndPointReverse properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
delete | scalar:Bool | SELECTION: true or false | |
ip | address:Ip | The IP address. | Value must match ipv4 or ipv6 known format |
svcIntf | nw:IfId (base:IfIndex) | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
epbrProbe Properties
The following table contains information about the epbrProbe properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
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:
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:
Configuring an Ethernet Interface
Configuring an EPBR Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
epbr ip policy pol1
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 |
---|---|
topSystem | sys |
epbrEntity | sys/epbr |
epbrInst | sys/epbr/inst |
epbrEpbrIntf | sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-no-reverse |
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
epbrEpbrIntf Properties
The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ipType | epbr:IpType (scalar:Enum8) | SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4 | |
name | nw:IfId (base:IfIndex) | The name of the object. | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
policyName | itd:SvcNameType (string:Basic) | The name of the EPBR policy. | MAX SIZE: 31 |
reverse | epbr:ReverseType (scalar:Enum8) | SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting an EPBR Policy
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet1/2
no epbr ip policy pol1
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 |
---|---|
topSystem | sys |
epbrEntity | sys/epbr |
epbrInst | sys/epbr/inst |
epbrEpbrIntf | sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-no-reverse |
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
epbrEpbrIntf Properties
The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ipType | epbr:IpType (scalar:Enum8) | SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4 | |
name | nw:IfId (base:IfIndex) | The name of the object. | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
reverse | epbr:ReverseType (scalar:Enum8) | SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse | |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Policy in the Reverse Direction (IP)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
epbr ip policy pol2 reverse
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 |
---|---|
topSystem | sys |
epbrEntity | sys/epbr |
epbrInst | sys/epbr/inst |
epbrEpbrIntf | sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-reverse |
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
epbrEpbrIntf Properties
The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ipType | epbr:IpType (scalar:Enum8) | SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4 | |
name | nw:IfId (base:IfIndex) | The name of the object. | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
policyName | itd:SvcNameType (string:Basic) | The name of the EPBR policy. | MAX SIZE: 31 |
reverse | epbr:ReverseType (scalar:Enum8) | SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Deleting the Policy in the Reverse Direction (IP)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
no epbr ip policy pol2 reverse
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 |
---|---|
topSystem | sys |
epbrEntity | sys/epbr |
epbrInst | sys/epbr/inst |
epbrEpbrIntf | sys/epbr/inst/if-[eth1/2]-type-ipv4-reverse-reverse |
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
epbrEpbrIntf Properties
The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ipType | epbr:IpType (scalar:Enum8) | SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4 | |
name | nw:IfId (base:IfIndex) | The name of the object. | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
reverse | epbr:ReverseType (scalar:Enum8) | SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse | |
status | mo:ModificationStatus (scalar:Bitmask32) | The upgrade status. This property is for internal use only. | SELECTION: 2 - created 4 - modified 8 - deleted 16 - replaced |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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:
Configuring the Policy in the Reverse Direction (IPv6)
Note: This example was added in Release 9.3(5).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
interface ethernet 1/2
epbr ipv6 policy pol1 reverse
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 |
---|---|
topSystem | sys |
epbrEntity | sys/epbr |
epbrInst | sys/epbr/inst |
epbrEpbrIntf | sys/epbr/inst/if-[eth1/2]-type-ipv6-reverse-reverse |
interfaceEntity | sys/intf |
l1PhysIf | sys/intf/phys-[eth1/2] |
epbrEpbrIntf Properties
The following table contains information about the epbrEpbrIntf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
ipType | epbr:IpType (scalar:Enum8) | SELECTION: 0 - ipv4 1 - ipv6 DEFAULT: ipv4 | |
name | nw:IfId (base:IfIndex) | The name of the object. | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
policyName | itd:SvcNameType (string:Basic) | The name of the EPBR policy. | MAX SIZE: 31 |
reverse | epbr:ReverseType (scalar:Enum8) | SELECTION: 0 - no-reverse 1 - reverse DEFAULT: no-reverse |
l1PhysIf Properties
The following table contains information about the l1PhysIf properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
Property Name | Data Type | Description | Values |
---|---|---|---|
id | nw:IfId (base:IfIndex) | An identifier . | Must match first field in the output of `show intf brief`. Example: Eth1/1 or Vlan100 |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
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: