3.2.14. netconf-server¶
Configuration data for NETCONF server.
vsr running config# vrf <vrf> netconf-server
enabled (pushed)¶
Enable or disable NETCONF server. If no addresses are specified, NETCONF will listen on all IPv4 and IPv6 addresses on port 830.
vsr running config# vrf <vrf> netconf-server
vsr running netconf-server# enabled true|false
- Default value
true
idle-timeout¶
unit: seconds
Specifies the maximum number of seconds that a NETCONF session may remain idle. A NETCONF session will be dropped if it is idle for an interval longer than this number of seconds. If set to zero, then the server will never drop a session because it is idle. Sessions that have a notification subscription active are never dropped. If unset, the default value is 3600. If set in several vrfs, the biggest value is used.
vsr running config# vrf <vrf> netconf-server
vsr running netconf-server# idle-timeout <uint16>
address¶
List of addresses on which to listen to NETCONF clients.
vsr running config# vrf <vrf> netconf-server
vsr running netconf-server# address <address> port PORT description <string>
|
Description |
|---|---|
|
An IPv4 address. |
|
An IPv6 address. |
port¶
The port number to listen on (default: 830).
port PORT
|
A 16-bit port number used by a transport protocol such as TCP or UDP. |
- Default value
830
subscriptions (state only)¶
Contains the list of currently active subscriptions, i.e., subscriptions that are currently in effect, used for subscription management and monitoring purposes. This includes subscriptions that have been set up via RPC primitives as well as subscriptions that have been established via configuration.
subscription (state only)¶
The identity and specific parameters of a subscription. Subscriptions in this list can be created using a control channel or RPC or can be established through configuration. If the ‘kill-subscription’ RPC or configuration operations are used to delete a subscription, a ‘subscription-terminated’ message is sent to any active or suspended receivers.
configured-subscription-state (state only)¶
The presence of this leaf indicates that the subscription originated from configuration, not through a control channel or RPC. The value indicates the state of the subscription as established by the publisher.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> configured-subscription-state
datastore (state only)¶
Datastore from which to retrieve data.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> datastore
stream (state only)¶
Indicates the event stream to be considered for this subscription. If an event stream has been removed and can no longer be referenced by an active subscription, send a ‘subscription-terminated’ notification with ‘stream-unavailable’ as the reason. If a configured subscription refers to a nonexistent event stream, move that subscription to the ‘invalid’ state.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> stream
stream-filter-name (state only)¶
References an existing event stream filter that is to be applied to an event stream for the subscription.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> stream-filter-name
stream-xpath-filter (state only)¶
Event stream evaluation criteria encoded in the syntax of an XPath 1.0 expression. See ietf-subscribed-notifications for more details.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> stream-xpath-filter
transport (state only)¶
For a configured subscription, this leaf specifies the transport used to deliver messages destined for all receivers of that subscription.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> transport
stop-time (state only)¶
Identifies a time after which notification messages for a subscription should not be sent. If ‘stop-time’ is not present, the notification messages will continue until the subscription is terminated. If ‘replay-start-time’ exists, ‘stop-time’ must be for a subsequent time. If ‘replay-start-time’ doesn’t exist, ‘stop-time’, when established, must be for a future time.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> stop-time
encoding (state only)¶
The type of encoding for notification messages. For a dynamic subscription, if not included as part of an ‘establish-subscription’ RPC, the encoding will be populated with the encoding used by that RPC. For a configured subscription, if not explicitly configured, the encoding will be the default encoding for an underlying transport.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> encoding
purpose (state only)¶
Open text allowing a configuring entity to embed the originator or other specifics of this subscription.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> purpose
datastore-xpath-filter (state only)¶
This parameter contains an XPath expression identifying the portions of the target datastore to retrieve. See ietf-yang-push for more details.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> datastore-xpath-filter
source-interface (state only)¶
References the interface for notification messages.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> source-interface
source-vrf (state only)¶
VRF from which notification messages should egress a publisher.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> source-vrf
source-address (state only)¶
The source address for the notification messages. If a source VRF exists but this object doesn’t, a publisher’s default address for that VRF must be used.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> source-address
periodic (state only)¶
The publisher is requested to periodically notify the receiver regarding the current values of the datastore as defined by the selection filter.
period (state only)¶
unit: centiseconds
Duration of time that should occur between periodic push updates, in units of 0.01 seconds.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> periodic period
anchor-time (state only)¶
Designates a timestamp before or after which a series of periodic push updates are determined. The next update will take place at a point in time that is a multiple of a period from the ‘anchor-time’. For example, for an ‘anchor-time’ that is set for the top of a particular minute and a period interval of a minute, updates will be sent at the top of every minute that this subscription is active.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> periodic anchor-time
on-change (state only)¶
The publisher is requested to notify the receiver regarding changes in values in the datastore subset as defined by a selection filter.
dampening-period (state only)¶
unit: centiseconds
Specifies the minimum interval between the assembly of successive update records for a single receiver of a subscription. Whenever subscribed objects change and a dampening-period interval (which may be zero) has elapsed since the previous update record creation for a receiver, any subscribed objects and properties that have changed since the previous update record will have their current values marshalled and placed in a new update record.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> on-change dampening-period
sync-on-start (state only)¶
Sync on start is enabled. See ietf-yang-push for mor details.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> on-change sync-on-start
receivers (state only)¶
Set of receivers in a subscription.
receiver (state only)¶
A host intended as a recipient for the notification messages of a subscription. For configured subscriptions, transport-specific network parameters (or a leafref to those parameters) may be augmented to a specific receiver in this list.
state (state only)¶
Specifies the state of a subscription from the perspective of a particular receiver. With this information, it is possible to determine whether a publisher is currently generating notification messages intended for that receiver.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> receivers receiver <string> state
receiver-instance-ref (state only)¶
Reference to a receiver instance.
vsr> show state vrf <vrf> netconf-server subscriptions subscription <uint32> receivers receiver <string> receiver-instance-ref
receiver-instances (state only)¶
A container for all instances of receivers.
receiver-instance (state only)¶
A list of all receiver instances.
udp-notif-receiver (state only)¶
The UDP-notif receiver to send notifications to.
remote-address (state only)¶
The IP address or hostname of the remote UDP server. If a domain name is configured, then the DNS resolution should happen on each connection attempt. If the DNS resolution results in multiple IP addresses, the IP addresses are tried according to local preference order until a connection has been established or until all IP addresses have failed.
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver remote-address
remote-port (state only)¶
The port number of the remote UDP server. An invalid default value is used so that importing modules may ‘refine’ it with the appropriate default port number value.
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver remote-port
local-address (state only)¶
The local IP address/interface to bind to when sending UDP messages to the remote server. INADDR_ANY (‘0.0.0.0’) or INADDR6_ANY (‘0:0:0:0:0:0:0:0’ a.k.a. ‘::’) MAY be used to explicitly indicate the implicit default, that the server can bind to any IPv4 or IPv6 address.
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver local-address
local-port (state only)¶
The local IP port number to bind to when sending UDP messages to the remote server. The port number ‘0’, which is the default value, indicates that any available local port number may be used.
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver local-port
enable-segmentation (state only)¶
The switch for the segmentation feature. When disabled, the publisher will not allow fragment for a very large data.
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver enable-segmentation
max-segment-size (state only)¶
UDP-Notif provides a configurable max-segment-size to control the size of each segment (UDP-Notif header, with options, included).
vsr> show state vrf <vrf> netconf-server subscriptions receiver-instances receiver-instance <string> udp-notif-receiver max-segment-size