{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"fa624450-613a-4e56-b93a-03ebd3390b90"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":1},"content":[{"text":"NETCONF","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NETCONF overview","type":"text"}]},{"type":"paragraph","content":[{"text":"NETCONF is a protocol that provides mechanisms for installing, manipulating, and deleting the configuration of network devices. It uses Extensible Markup Language (XML)-based data encoding for configuration data and protocol messages. The NETCONF operations are realized as remote procedure calls (RPCs).","type":"text"}]},{"type":"paragraph","content":[{"text":"Refer to RFC 6241, Network Configuration Protocol (NETCONF), at ","type":"text"},{"text":"https://tools.ietf.org/html/rfc6241","type":"text","marks":[{"type":"link","attrs":{"href":"https://tools.ietf.org/html/rfc6241"}}]},{"text":" for more information.","type":"text"}]},{"type":"paragraph","content":[{"text":"On the DANOS vRouter, NETCONF is used within an SSH session through the SSH connection protocol. This mapping allows NETCONF to be run from a secure shell session by a user or an application. This mapping also makes sure that NETCONF complies with SSH IPv6.","type":"text"}]},{"type":"paragraph","content":[{"text":"On the DANOS vRouter, NETCONF is intended as a machine interface for management software and not intended as a user interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"Refer to RFC 6242, Using the NETCONF Protocol over Secure Shell (SSH), at ","type":"text"},{"text":"https://tools.ietf.org/html/rfc6242","type":"text","marks":[{"type":"link","attrs":{"href":"https://tools.ietf.org/html/rfc6242"}}]},{"text":" for more information on using the NETCONF configuration protocol over SSH.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NETCONF capabilities supported on the DANOS vRouter","type":"text"}]},{"type":"paragraph","content":[{"text":"A NETCONF capability is a set of functions that supplements the base NETCONF specification. The capability is identified by a uniform resource identifier (URI). Capabilities augment the base operations of the device, describing both additional operations and the content that is allowed inside the operations. The client discovers the capabilities of the server and uses any additional operations, parameters, and content that are defined by those capabilities.","type":"text"}]},{"type":"paragraph","content":[{"text":"Following are the NETCONF capabilities that are supported on the DANOS vRouter:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"capability:candidate 1.0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"capability:startup 1.0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"capability:rollback-on-error 1.0","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"capability:validate 1.1","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Refer to RFC 6241, Network Configuration Protocol (NETCONF), at ","type":"text"},{"text":"https://tools.ietf.org/html/rfc6241","type":"text","marks":[{"type":"link","attrs":{"href":"https://tools.ietf.org/html/rfc6241"}}]},{"text":" for more information on these capabilities.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Initiating a NETCONF session","type":"text"}]},{"type":"paragraph","content":[{"text":"To allow an inbound NETCONF session request from a remote system to be accepted, use the commands that are shown in the following table.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"vyatta@R1# set service netconf\nvyatta@R1# set service ssh port 830\nvyatta@R1# commit","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"YANG model for NETCONF monitoring","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" operation is supported on the DANOS vRouter to query and retrieve schema information and NETCONF state information from a NETCONF server.","type":"text"}]},{"type":"paragraph","content":[{"text":"Refer to RFC 6022, YANG Module for NETCONF Monitoring, at ","type":"text"},{"text":"https://tools.ietf.org/html/rfc6022","type":"text","marks":[{"type":"link","attrs":{"href":"https://tools.ietf.org/html/rfc6022"}}]},{"text":" for more information on using ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Verifying Connections and Retrieving Operational Data Using NETCONF","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ping","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"ping","type":"text","marks":[{"type":"code"}]},{"text":" command displays whether a destination responded and how long the destination took to receive a reply. If an error occurs in the delivery to the destination, the command displays an error message.","type":"text"}]},{"type":"paragraph","content":[{"text":"Sample XML request:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"\n 127.0.0.1\n 5\n 3\n","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"strong"}]},{"text":": IP address you want to ping.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"count","type":"text","marks":[{"type":"strong"}]},{"text":": Number of packets with which you are pinging.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ttl","type":"text","marks":[{"type":"strong"}]},{"text":": Time to live (ttl) in an IP packet in seconds that tells a network router whether the packet has been in the network too long and should be discarded. By default, the TTL value is 255.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Sample rpc-reply:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"5\n5\n54\n62\n74","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"interface","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"interface","type":"text","marks":[{"type":"code"}]},{"text":" command displays information about an interface name. The command output displays all the IP addresses that are associated with the interface, administrator status, operational status, and description of the interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"Sample XML request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n br0\n","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":": Name of interface.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Sample rpc-reply:","type":"text"}]},{"type":"codeBlock","content":[{"text":"

\n 15.15.15.15/24\n

\n 2020::/64\n

\n 2001::15/64\n

\n 3001::211:22ff:fe33:4455/64\n

\nup\nup\nsample bridge","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"route","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"route","type":"text","marks":[{"type":"code"}]},{"text":" command displays information about the path taken to a particular destination address.","type":"text"}]},{"type":"paragraph","content":[{"text":"Sample XML request:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n192.168.14.0/24\n","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"destination (optional)","type":"text","marks":[{"type":"strong"}]},{"text":": IP address or IP prefix","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"family","type":"text","marks":[{"type":"strong"}]},{"text":": ipv4 (default) or ipv6","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"NOTE: When the destination is not present, the entire route table for the specified family","type":"text"},{"type":"hardBreak"},{"text":"is returned as the output.","type":"text"}]},{"type":"paragraph","content":[{"text":"Sample rpc-reply:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n 192.168.14.0\n \n 1\n 31.31.31.32\n dp0p256p1\n \n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Retrieving statistics using NETCONF","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"You can retrieve DANOS vRouter statistics of all types by using NETCONF. Some of the statistics are also available from the CLI. The configuration model is a subtree of the overall YANG tree, which is included in the ISO distribution for the DANOS vRouter.","type":"text"}]},{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"ssh","type":"text","marks":[{"type":"strong"}]},{"text":" to obtain NETCONF information in XML format from the vRouter as follows.","type":"text"}]},{"type":"paragraph","content":[{"text":"Configure ","type":"text"},{"text":"set service ssh","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"set service netconf","type":"text","marks":[{"type":"code"}]},{"text":" on the DANOS vRouter.","type":"text"}]},{"type":"paragraph","content":[{"text":"From a remote system, use SSH as follows to access and sign in the DANOS vRouter, when prompted.","type":"text"},{"type":"hardBreak"},{"text":"ssh vyatta@ -s netconf","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Send a capabilities list enclosed within a ","type":"text"},{"text":"...","type":"text","marks":[{"type":"strong"}]},{"text":" element.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"\n\nurn:ietf:params:netconf:base:1.0\nurn:ietf:params:netconf:capability:writable-running:1.0\nurn:ietf:params:netconf:capability:candidate:1.0\nurn:ietf:params:netconf:capability:startup:1.0\nurn:ietf:params:netconf:capability:rollback-on-error:1.0\n\n\n]]>]]>","type":"text"}]},{"type":"paragraph","content":[{"text":"Respond to the DANOS vRouter hello element with a hello message and capabilities list. End the list with ","type":"text"},{"text":"]]>]]>","type":"text","marks":[{"type":"strong"}]},{"text":" to inform SSH that the XML element is completed and should be sent.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following sections provide XML examples for different categories of statistics and other information.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CPU information","type":"text"}]},{"type":"paragraph","content":[{"text":"The XML examples in this section provide CPU information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows an RPC request for CPU information.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n]]>]]>","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows the RPC reply.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n 0\n 0.00\n 98.41\n 0.11\n 0.00\n 0.00\n 0.00\n 0.00\n 0.07\n 1.39\n 0.01\n \n \n 1\n 0.00\n 97.27\n 0.06\n 0.00\n 0.00\n 0.00\n 0.00\n 0.35\n 1.87\n 0.44\n \n \n all\n 0.00\n 97.85\n 0.09\n 0.00\n 0.00\n 0.00\n 0.00\n 0.21\n 1.63\n 0.23\n \n \n \n \n \n\n]]>]]>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Memory information","type":"text"}]},{"type":"paragraph","content":[{"text":"The XML examples in this section provide memory information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows an RPC request for memory information.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n]]>]]>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Uptime information","type":"text"}]},{"type":"paragraph","content":[{"text":"The XML examples in this section provide memory information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows an RPC request for uptime information.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n]]>]]>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Version information","type":"text"}]},{"type":"paragraph","content":[{"text":"The XML examples in this section provide memory information.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example shows an RPC request for version information.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n \n]]>]]>","type":"text"}]}],"version":1}

Browser not supported