Extreme SLX-OS NETCONF Operations Guide, 20.6.1
> Sample use cases for SLX-OS NETCONF
Published March 2024
Search this document
Print this page
Email this page
View PDF
Previous
Next
Preface
Text Conventions
Documentation and Training
Help and Support
Send Feedback
About This Document
What‘s New in this Document
Supported Hardware
NETCONF Overview
NETCONF and YANG
NETCONF in client/server architecture
RPC request
RPC reply
RPC and error handling
SSH subsystem
RFC references
Using NETCONF
Establishing a NETCONF session
Hello messages exchange
Server capabilities
Client capabilities
Connecting to the NETCONF server
Retrieving configuration data
Subtree filtering
xpath filtering
Retrieving operational data
Using custom RPCs
Retrieving operational data with pagination
Using the custom action mechanism
Editing the configuration
Managing the configuration
Disconnecting from a NETCONF session
Basic switch management with NETCONF overview
Connecting to the switch through an SSH session
Sample use cases for SLX-OS NETCONF
STP overview
Configuring STP
Configuring RSTP
VRF configuration
Configuring VRF
NETCONF Statements
aaa
aaa/accounting
aaa/authentication
aaa/authentication/login
aaa/authentication/login/first
aaa/authentication/login/second
aaa/username
aaa/username/desc
aaa/username/encryption-level
aaa/username/role
acl-policy
acl-policy/allow-conflicting-rules
acl-policy/allow-duplicate-rules
arp
bridge-domain
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/bpdu-drop-enable
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/logical-interface
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/local-switching
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/peer/(peer-ip)/cos
bridge-domain-id/(bridge-domain-type)/peer/(peer-ip)/load-balance
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/peer/(peer-ip)/lsp
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/pw-profile
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/statistics
bridge-domain/(bridge-domain-id)/(bridge-domain-type)/vc-id
chassis
chassis/virtual-ip
chassis/virtual-ipv6
clock
clock/time-zone
cluster/{cluster-name}/
config-drift-track/off
config-drift-track/values
config-drift-track/status
crypto-sa/crypto
dai
dai/arp/access-list
delay-link-event
dot1x
dot1x/test
dot3ah
event-handler
event-handler/{event-handler-name}/action
get-tpvm-detail
hardware
interface/{interface-type}/{interface-name}/ethernet-segment/advertise
interface/{interface-type}/{interface-name}/ip/access-group
interface/{interface-type}/{interface-name}/ip/arp-aging-timeout
interface/{interface-type}/{interface-name}/ip/dhcp/relay/gateway
interface/{interface-type}/{interface-name}/ip/igmp/immediate-leave
interface/{interface-type}/{interface-name}/ip/igmp/last-member-query-count
interface/{interface-type}/{interface-name}/ip/igmp/last-member-query-interval
interface/{interface-type}/{interface-name}/ip/igmp/query-interval
interface/{interface-type}/{interface-name}/ip/igmp/query-max-response-time
interface/{interface-type}/{interface-name}/ip/igmp/robustness-variable
interface/{interface-type}/{interface-name}/ip/igmp/startup-query-count
interface/{interface-type}/{interface-name}/ip/igmp/startup-query-interval
interface/{interface-type}/{interface-name}/ip/pim/dr-priority
interface/{interface-type}/{interface-name}/ip/pim/neighbor-filter
interface/{interface-type}/{interface-name}/ip/pim-sparse
interface/{interface-type}/{interface-name}/ip/policy
interface/{interface-type}/{interface-name}/ip/proxy-arp
interface/{interface-type}/{interface-name}/ip/router/isis
interface/{interface-type}/{interfacename}/ipv6/router/isis
interface/{interface-type}/{interface-name}/isis
interface/{interface-type}/{interface-name}/link-error-disable
interface/{interface-type}/{interface-name}/link-fault-signaling
interface/{interface-type}/{interface-name}/ipv6/access-group
interface/{interface-type}/{interface-name}/ipv6/dhcp/relay/address
interface/{interface-type}/{interface-name}/ipv6/nd/broadcast-mac-trap
interface/{interface-type}/{interface-name}/ipv6/nd/cache
interface/{interface-type}/{interface-name}/ipv6/nd/dad
interface/{interface-type}/{interface-name}/ipv6/nd/hoplimit
interface/{interface-type}/{interface-name}/ipv6/nd/managed-config-flag
interface/{interface-type}/{interface-name}/ipv6/nd/mtu
interface/{interface-type}/{interface-name}/ipv6/nd/ns-interval
interface/{interface-type}/{interface-name}/ipv6/nd/other-config-flag
interface/{interface-type}/{interface-name}/ipv6/nd/prefix
interface/{interface-type}/{interface-name}/ipv6/nd/ra-interval
interface/{interface-type}/{interface-name}/ipv6/nd/ra-lifetime
interface/{interface-type}/{interface-name}/ipv6/nd/reachable-time
interface/{interface-type}/{interface-name}/ipv6/nd/retrans-timer
interface/{interface-type}/{interface-name}/ipv6/nd/suppress-ra
interface/{interface-type}/{interface-name}/ipv6/ra-dns-server
interface/{interface-type}/{interface-name}/ra-dns-server/hoplimit
interface/{interface-type}/{interface-name}/ra-dns-server/mtu
interface/{interface-type}/{interface-name}/ra-dns-server/other-config-flag
interface/{interface-type}/{interface-name}/ipv6/ra-domain-name
interface/{interface-type}/{interface-name}/lldp/dcbx-version
interface/{interface-type}/{interface-name}/lldp/disable
interface/{interface-type}/{interface-name}/lldp/iscsi-priority
interface/{interface-type}/{interface-name}/lldp/profile
interface/{interface-type}/{interface-name}/isis/reverse-metric
interface/{interface-type}/{interface-name}/isis/priority
interface/{interface-type}/{interface-name}/isis/point-to-point
interface/{interface-type}/{interface-name}/isis/passive
interface/{interface-type}/{interface-name}/isis/metric
interface/{interface-type}/{interface-name}/isis/ldp-sync
interface/{interface-type}/{interface-name}/isis/ipv6-metric
interface/{interface-type}/{interface-name}/isis/hello-multiplier
interface/{interface-type}/{interface-name}/isis/hello-interval
interface/{interface-type}/{interface-name}/isis/hello-padding
interface/{interface-type}/{interface-name}/isis/circuit-type
interface/{interface-type}/{interface-name}/isis/auth-mode
interface/{interface-type}/{interface-name}/isis/auth-key
interface/{interface-type}/{interface-name}/isis/auth-check
interface/{interface-type}/{interface-name}/link-oam-interface
interface/{interface-type}/{interface-name}/link-oam/link-fault/action
interface/{interface-type}/{interface-name}/link-oam-interface/allow-loopback
interface/{interface-type}/{interface-name}/qos/cos-mutation
interface/{interface-type}/{interface-name}/qos/trust/trust-dscp
interface/{interface-type}/{interface-name}/qos/remark/remark-dscp
interface/{interface-type}/{interface-name}/rmon/collection/history
interface/{interface-type}/{interface-name}/rmon/collection/stats
interface/{interface-type}/{interface-name}/sflow/enable
interface/{interface-type}/{interface-name}/sflow/polling-interval
interface/{interface-type}/{interface-name}/sflow/sample-rate
interface/{interface-type}/{interface-name}/spanning-tree/autoedge
interface/{interface-type}/{interface-name}/spanning-tree/bpdu-mac
interface/{interface-type}/{interface-name}/spanning-tree/cost
interface/{interface-type}/{interface-name}/spanning-tree/edgeport
interface/{interface-type}/{interface-name}/spanning-tree/edgeport/bpdu-filter
interface/{interface-type}/{interface-name}/spanning-tree/edgeport/bpdu-guard
interface/{interface-type}/{interface-name}/spanning-tree/guard/root
interface/{interface-type}/{interface-name}/spanning-tree/hello-time
interface/{interface-type}/{interface-name}/spanning-tree/instance/priority
interface/{interface-type}/{interface-name}/spanning-tree/instance/cost
interface/{interface-type}/{interface-name}/spanning-tree/instance/restricted-role
interface/{interface-type}/{interface-name}/spanning-tree/instance/restricted-tcn
interface/{interface-type}/{interface-name}/spanning-tree/link-type
interface/{interface-type}/{interface-name}/spanning-tree/peer-switch
interface/{interface-type}/{interface-name}/spanning-tree/portfast
interface/{interface-type}/{interface-name}/spanning-tree/portfast/bpdu-filter
interface/{interface-type}/{interface-name}/spanning-tree/portfast/bpdu-guard
interface/{interface-type}/{interface-name}/spanning-tree/priority
interface/{interface-type}/{interface-name}/spanning-tree/restricted-role
interface/{interface-type}/{interface-name}/spanning-tree/restricted-tcn
interface/{interface-type}/{interface-name}/spanning-tree/shutdown
interface/{interface-type}/{interface-name}/spanning-tree/vlan
interface/{interface-type}/{interface-name}/storm-control/ingress
interface/{interface-type}/{interface-name}/switchport
interface/{interface-type}/{interface-name}/switchport/access
interface/{interface-type}/{interface-name}/switchport/mode
interface/{interface-type}/{interface-name}/switchport/mode/private-vlan
interface/{interface-type}/{interface-name}/switchport/mode/trunk-no-default-native
interface/{interface-type}/{interface-name}/switchport/port-security
interface/{interface-type}/{interface-name}/switchport/port-security/mac-address
interface/{interface-type}/{interface-name}/switchport/port-security/max
interface/{interface-type}/{interface-name}/switchport/port-security/oui
interface/{interface-type}/{interface-name}/switchport/port-security/shutdown-time
interface/{interface-type}/{interface-name}/switchport/port-security/sticky
interface/{interface-type}/{interface-name}/switchport/port-security/violation
ip/access-list/extended
ip/access-list/extended/{acl-name}/seq
ip/access-list/standard
ip/access-list/standard/{acl-name}/seq
ip/dhcp/relay/servers
ip/route
ipv6/access-list/extended
ipv6/access-list/extended/{acl-name}/seq
ipv6/access-list/standard
ipv6/access-list/standard/{acl-name}/seq
ipv6/route
lvtep/broadcast-local-bias
mac/access-list/extended/{acl-name}/seq
mac/access-list/standard
mac/access-list/standard/{acl-name}/seq
mac-address-table/aging-time
next-hop-recursion
ntp/authentication-key
ntp/disable
ntp/master
ntp/peer
ntp/server
ntp/source-ip
ntp/trusted-key
overlay-gateway
overlay-gateway/{gateway-name}/activate
overlay-gateway/{gateway-name}/attach/vlan
overlay-gateway/{gateway-name}/enable
overlay-gateway/{gateway-name}/ip/access-group
overlay-gateway/{gateway-name}/ip/interface/loopback
overlay-gateway/{gateway-name}/ip/interface/ve/{ve-id}/fabric-virtual-gateway
overlay-gateway/{gateway-name}/ip/interface/ve/{ve-id}/vrrp-extended-group
overlay-gateway/{gateway-name}/ipv6/access-group
overlay-gateway/{gateway-name}/mac
overlay-gateway/{gateway-name}/map
overlay-gateway/{gateway-name}/monitor
overlay-gateway/{gateway-name}/sflow
overlay-gateway/{gateway-name}/site
overlay-gateway/{gateway-name}/site/{site-name}/bfd
overlay-gateway/{gateway-name}/site/{site-name}/extend
overlay-gateway/{gateway-name}/site/{site-name}/ip
overlay-gateway/{gateway-name}/site/{site-name}/mac-learning/protocol/bgp
overlay-gateway/{gateway-name}/site/{site-name}/shutdown
overlay-gateway/{gateway-name}/type
password-attributes/expiry-alert-level
protocol/cfm
protocol/link-oam
protocol/lldp/advertise/dcbx-fcoe-app-tlv
protocol/lldp/advertise/dcbx-fcoe-logical-link-tlv
protocol/lldp/advertise/dcbx-iscsi-app-tlv
protocol/lldp/advertise/dcbx-tlv
protocol/lldp/advertise/dot1-tlv
protocol/lldp/advertise/dot3-tlv
protocol/lldp/advertise/optional-tlv
protocol/lldp/description
protocol/lldp/disable
protocol/lldp/hello
protocol/lldp/iscsi-priority
protocol/lldp/mode
protocol/lldp/multiplier
protocol/lldp/profile/{profile-name}/advertise
protocol/lldp/profile/{profile-name}/hello
protocol/lldp/profile/{profile-name}/mode
protocol/lldp/profile/{profile-name}/multiplier
protocol/lldp/system-description
protocol/lldp/system-name
protocol/spanning-tree/mstp/bridge-priority
protocol/spanning-tree/mstp/cisco-interoperability
protocol/spanning-tree/mstp/description
protocol/spanning-tree/mstp/error-disable-timeout/enable
protocol/spanning-tree/mstp/error-disable-timeout/interval
protocol/spanning-tree/mstp/forward-delay
protocol/spanning-tree/mstp/hello-time
protocol/spanning-tree/mstp/instance/priority
protocol/spanning-tree/mstp/instance/vlan
protocol/spanning-tree/mstp/max-age
protocol/spanning-tree/mstp/max-hops
protocol/spanning-tree/mstp/port-channel
protocol/spanning-tree/mstp/region
protocol/spanning-tree/mstp/revision
protocol/spanning-tree/mstp/shutdown
protocol/spanning-tree/mstp/transmit-holdcount
protocol/spanning-tree/pvst/bridge-priority
protocol/spanning-tree/pvst/description
protocol/spanning-tree/pvst/error-disable-timeout/enable
protocol/spanning-tree/pvst/error-disable-timeout/interval
protocol/spanning-tree/pvst/forward-delay
protocol/spanning-tree/pvst/hello-time
protocol/spanning-tree/pvst/max-age
protocol/spanning-tree/pvst/port-channel
protocol/spanning-tree/pvst/shutdown
protocol/spanning-tree/pvst/vlan/forward-delay
protocol/spanning-tree/pvst/vlan/hello-time
protocol/spanning-tree/pvst/vlan/max-age
protocol/spanning-tree/pvst/vlan/priority
protocol/spanning-tree/rpvst/bridge-priority
protocol/spanning-tree/rpvst/description
protocol/spanning-tree/rpvst/error-disable-timeout/enable
protocol/spanning-tree/rpvst/error-disable-timeout/interval
protocol/spanning-tree/rpvst/forward-delay
protocol/spanning-tree/rpvst/hello-time
protocol/spanning-tree/rpvst/max-age
protocol/spanning-tree/rpvst/port-channel
protocol/spanning-tree/rpvst/shutdown
protocol/spanning-tree/rpvst/transmit-holdcount
protocol/spanning-tree/rpvst/vlan/forward-delay
protocol/spanning-tree/rpvst/vlan/hello-time
protocol/spanning-tree/rpvst/vlan/max-age
protocol/spanning-tree/rpvst/vlan/priority
protocol/spanning-tree/rstp/bridge-priority
protocol/spanning-tree/rstp/description
protocol/spanning-tree/rstp/error-disable-timeout/enable
protocol/spanning-tree/rstp/error-disable-timeout/interval
protocol/spanning-tree/rstp/forward-delay
protocol/spanning-tree/rstp/hello-time
protocol/spanning-tree/rstp/max-age
protocol/spanning-tree/rstp/port-channel
protocol/spanning-tree/rstp/shutdown
protocol/spanning-tree/rstp/transmit-holdcount
protocol/spanning-tree/stp/bridge-priority
protocol/spanning-tree/stp/description
protocol/spanning-tree/stp/error-disable-timeout/enable
protocol/spanning-tree/stp/error-disable-timeout/interval
protocol/spanning-tree/stp/forward-delay
protocol/spanning-tree/stp/hello-time
protocol/spanning-tree/stp/max-age
protocol/spanning-tree/stp/port-channel
protocol/spanning-tree/stp/shutdown
qos-mpls
qos/map/cos-mutation
radius-server
ras
rmon/alarm
rmon/event
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/activate
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/additional-paths/disable
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/additional-paths/txrx
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/additional-paths/advertise
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/allowas-in
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/capability
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/default-originate
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/enable-peer-as-check
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/filter-list
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/maximum-prefix
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/prefix-list
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/route-map
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/route-reflector-client
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/send-community
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/unsuppress-map
/router/bgp/address-family/ipv6/unicast/{vrf-name}/neighbor/{ipv4-neighbor-address}/weight
/router/bgp/neighbor/neighbor-peer-grp/{peer-group}/update-source
/router/bgp/peer-group/ipv6prefix-over-ipv4peer
interface/{interface-type}/{interface-name}/isis
router/isis/is-type
route-map
router/mpls
router/mpls/ldp
router/mpls/lsp
router/mpls/rsvp
router/mpls/policy
router/mpls/policy/transit-session-accounting
router/mpls/policy/ingress-tunnel-accounting
router/mpls/policy/qos-ttl-mode
router/mpls/policy/traffic-engineering/isis
router/mpls/policy/soft-preemption/cleanup-timer
router/mpls/policy/cspf-computation-mode/rsvp-periodic-flooding-time
router/mpls/policy/qos-ttl-mode
router/mpls/policy/cspf-computation-mode/rapid-retry
router/mpls/policy/cspf-computation-mode/retry-time
router/mpls/policy/cspf-computation-mode/handle-ospf-neighbor-down
router/mpls/policy/cspf-computation-mode/handle-isis-neighbor-down
router/mpls/policy/cspf-computation-mode/cspf-interface-constraint
router/mpls/policy/cspf-computation-mode/add-penalty
router/mpls/policy/cspf-computation-mode/metric-type
router/mpls/policy/cspf-computation-mode/ignore-overload-bit
router/mpls/policy/backup-retry-time
router/mpls/cspf-group/(cspf-group-name)/penalty
router/mpls/lsp-xc-traps/enable
router/mpls/cspf-group/(cspf-groupname)/penalty
router/mpls/lsp-xc-traps/enable
router/mpls/rsvp
router/mpls/rsvp/reliable-messaging/rapid-retry-limit
router/mpls/rsvp/reliable-messaging/rapid-retrans-interval
router/mpls/rsvp/reliable-messaging/rapid-retrans-decay
router/mpls/rsvp/refresh-reduction/bundle-message/bundle-send-delay
router/mpls/rsvp/refresh-multiple
router/mpls/rsvp/refresh-interval
router/mpls/rsvp/g-rsvp-backup-bw-guarantee
router/mpls/rsvp/global-rsvp-hello-acknowledgements
router/mpls/rsvp/global-rsvp-hello/tolerance
router/mpls/rsvp/global-rsvp-hello
router/mpls/rsvp/refresh-reduction/summary-refresh
routing-system/ip/dhcp/relay/disable-flooding
show/selinux/status
sflow/agent-address
sflow/collector
sflow/enable
sflow/polling-interval
sflow/sample-rate
sflow/source-ip
sflow/update-destination-mac
sflow-profile
snmp-server/use-vrf/{vrf-name}
show-grub-version
show-onie-version
snmp-server/trap/bfd-std-mib
snmp-server/use-vrf/shutdown
system-monitor
system-monitor-mail/fru (email)
system-monitor-mail/fru/enable
system-monitor-mail/interface (email)
system-monitor-mail/interface/enable
system-monitor-mail/relay
system-monitor-mail/security (email)
system-monitor-mail/security/enable
system-monitor-mail/sfp (email)
system-monitor-mail/sfp/enable
system-watermark
topology-group
GUID-1B6C8E70-84CC-4617-99EE-132B9CBDBD97.ditamap
Remote Procedure Calls (RPCs)
bna-config-cmd
bna-config-cmd-status
brocade-sec-services
brocade-ip-policy
brocade-interface
clear-tm-voq-stat-ing-all-egr-all
clear-tm-voq-stat-ing-all-egr-ifname
clear-tm-voq-stat-slot-id-egr-all
clear-tm-voq-slot-id-egress-port-name
clear-mpls-ldp-statistics
clear-mpls-lsp
clear-mpls-rsvp-statistics
clear-mpls-rsvp-statistics-neighbor-address
clear-mpls-rsvp-statistics-neighbor-all
firmware-commit
firmware-restore
fwdl-status
get-arp
get-contained-in-ID
get-interface-detail
get-interface-switchport
get-ip-interface
get-last-config-update-time
get-last-config-update-time-for-xpaths
get-lldp-neighbor-detail
get-mac-acl-for-intf
get-mac-address-table
get-maint-mode-status
get-media-detail
get-nameserver-detail
get-netconf-client-capabilities
get-port-channel-detail
get-portchannel-info-by-intf
get-stp-brief-info
get-stp-mst-detail
get-system-uptime
get-tunnel-info
get-tunnel-statistics
get-vlan-brief
mpls-clear-all-ldp-sessions
mpls-clear-one-ldp-sessions
mpls-clear-statistics-type
mpls-reopt-lsp
prefix-independent-convergence-static
reload
set-http-application-url
show-clock
show-ntp
show-raslog
show snmp-server status
show-support-save-status
show-system-info
show-system-monitor
show threshold-monitor bfd-sessions
show threshold-monitor ecmp
show threshold-monitor host
show threshold-monitor lif
show threshold-monitor mac-table
show threshold-monitor nexthop
show threshold-monitor vxlan-tunnels
threshold-monitor bfd-session
threshold-monitor hardware-resources
threshold-monitor ecmp
threshold-monitor host
threshold-monitor lif
threshold-monitor mac-table
threshold-monitor nexthop
threshold-monitor route
threshold-monitor vxlan-tunnel
tpvm-cfg ldap ca-cert
tpvm-cfg dhcpv6
tpvm-cfg ipv6
tpvm-cfg dns
tpvm-cfg trusted-peer
tpvm-cfg ntp
tpvm-cfg ldap
tpvm upgrade
tpvm download
user-session-info
Sample use cases for SLX-OS NETCONF
Note
The information provided in this chapter may not cover the end-to-end configuration. Refer to the
Extreme SLX-OS User Guide
for the complete set of configuration tasks.
