Siemens RUGGEDCOM MX5000RE Reference Manual Download Page 33

Page: 33 / 148

RUGGEDCOM NETCONF

Reference Guide

Chapter 2

NETCONF Capabilities and Namespaces

Viewing the Capabilities on a Device

<capability>http://ruggedcom.com/ns/rmf_iftunnel?module=rmf_iftunnel&revision=2012-03-07</

capability>

<capability>http://ruggedcom.com/ns/rmf_ip?module=rmf_ip&revision=2012-03-07</capability>

<capability>http://ruggedcom.com/ns/rmf_qos?module=rmf_qos&revision=2012-03-07</capability>

<capability>http://ruggedcom.com/ns/rmf_routing?module=rmf_routing&revision=2012-03-07</

capability>

<capability>http://ruggedcom.com/ns/rmf_security?module=rmf_security&revision=2012-03-07</

capability>

<capability>http://ruggedcom.com/ns/rmf_services?module=rmf_services&revision=2012-03-07</

capability>

<capability>http://tail-f.com/yang/common-monitoring?module=tailf-common-

monitoring&revision=2011-09-22</capability>

<capability>http://tail-f.com/yang/confd-monitoring?module=tailf-confd-

monitoring&revision=2011-09-22</capability>

<capability>http://tail-f.com/yang/netconf-monitoring?module=tailf-netconf-

monitoring&revision=2011-09-22</capability>

<capability>urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-

types&revision=2010-09-24</capability>

<capability>urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-

monitoring&revision=2010-10-04</capability>

<capability>urn:ietf:params:xml:ns:yang:ietf-yang-types?module=ietf-yang-

types&revision=2010-09-24</capability>

</capabilities>

<session-id>1020</session-id>

</hello>]]>]]>

Summary of Contents for RUGGEDCOM MX5000RE

Page 1: ...1501 RX1510 RX1511 RX1512 RX5000 MX5000 MX5000RE 06 2017 RC1065 EN 03 Preface Introduction 1 NETCONF Capabilities and Namespaces 2 NETCONF Sessions 3 Getting Data 4 Changing Configuration Data 5 RUGGEDCOM ROX II Actions 6 Examples 7 NETCONF XML Elements 8 ...

Page 2: ...orvalds owner of the mark on a world wide basis Other designations in this manual might be trademarks whose use by third parties for their own purposes would infringe the rights of the owner Open Source RUGGEDCOM ROX II is based on Linux Linux is made available under the terms of the GNU General Public License Version 2 0 http www gnu org licenses gpl 2 0 html RUGGEDCOM NETCONF contains additional...

Page 3: ...Sample Session Getting Data 4 1 5 2 Sample Session Performing an Action 6 1 5 3 Sample Session Editing Data 9 Chapter 2 NETCONF Capabilities and Namespaces 15 2 1 IETF Capabilities 15 2 2 Vendor Defined Capabilities 17 2 3 IETF Namespaces 17 2 4 Vendor Defined Namespaces 18 2 5 RUGGEDCOM Namespaces 18 2 6 Viewing the Capabilities on a Device 20 Chapter 3 NETCONF Sessions 23 3 1 Configuring Monitor...

Page 4: ...IN and YANG Files from the Device 37 4 6 3 Using pyang 38 4 6 3 1 Using the Text Based Tree 39 Chapter 5 Changing Configuration Data 41 5 1 Changing Data in the Running Configuration 41 5 2 Changing Data in the Candidate Configuration 42 5 2 1 Locking Data Stores 43 5 2 2 Copying Data 44 5 2 3 Replacing Data 46 5 2 4 Deleting Data 48 5 2 5 Validating Changes 50 5 2 6 Committing Changes 51 Chapter ...

Page 5: ...witch Port 66 6 2 11 clear cable stats port Switch Port 67 6 3 Services Namespace Actions 67 6 3 1 ntp status 67 6 3 2 log Link Failover 68 6 3 3 start test Link Failover 68 6 3 4 cancel test Link Failover 69 6 3 5 show active leases DHCP Server 69 6 4 Switch Namespace Actions 69 6 4 1 clear stp stats Switch 70 6 4 2 flush dynamic rules Switch 70 6 4 3 reset all switch ports Switch 70 6 4 4 clear ...

Page 6: ...tes on a Device 94 7 20 Configuring Static Multicast Routing on a Layer 3 Device 95 7 21 Enabling Static Multicast Routing on a Layer 3 Device 96 7 22 Retrieving Static Multicast Status on a Layer 3 Device 97 7 23 Replacing an IP Address 98 7 24 Configuring a Port to Dynamically Obtain an IP Address 99 7 25 Configuring OSPF Area and Network on a Layer 3 Device 100 7 26 Enabling the OSPF Passive De...

Page 7: ...20 7 45 Configuring a Signed CA Certificate 121 7 46 Installing a Private Key to a Signed CA Certificate 121 7 47 Installing a CRL File 122 7 48 Removing a Certificate 123 7 49 Removing a CA certificate 123 7 50 Removing a CRL File 124 Chapter 8 NETCONF XML Elements 125 8 1 125 8 2 close session 126 8 3 commit 126 8 4 copy config 127 8 5 data 127 8 6 discard changes 128 8 7 edit config 128 8 8 err...

Page 8: ...Table of Contents RUGGEDCOM NETCONF Reference Guide viii ...

Page 9: ...evice responding to the device s initial NETCONF message locking and unlocking datastores and signing off from the device Chapter 4 Getting Data describes how to retrieve configuration data from RUGGEDCOM NETCONF Read this section to learn how to retrieve individual configuration elements subsections of configuration data or the entire configuration from the device Chapter 5 Changing Configuration...

Page 10: ...Related Documents Other documents that may be of interest include RUGGEDCOM NETCONF Web Interface User Guide for the RUGGEDCOM RX1400 RUGGEDCOM NETCONF Web Interface User Guide for the RUGGEDCOM RX1500 RX1501 RX1510 RX1511 RX1512 RUGGEDCOM NETCONF Web Interface User Guide for the RUGGEDCOM RX5000 RUGGEDCOM NETCONF CLI User Guide for the RUGGEDCOM RX1400 RUGGEDCOM NETCONF CLI User Guide for the RUG...

Page 11: ...lity visit www siemens com ruggedcom or contact a Siemens Sales representative Customer Support Customer support is available 24 hours 7 days a week for all Siemens customers For technical support or general information contact Siemens Customer Support through any of the following methods Online Visit http www siemens com automation support request to submit a Support Request SR or check on the st...

Page 12: ...Preface RUGGEDCOM NETCONF Reference Guide xii Customer Support ...

Page 13: ...ration Protocol NETCONF is a network configuration protocol developed by the Internet Engineering Task Force IETF NETCONF provides functions to download upload change and delete the configuration data on network devices Devices running the RUGGEDCOM ROX II operating system also support the ability to collect data and perform direct actions on the device such as rebooting the device clearing statis...

Page 14: ...DCOM namespaces The configuration data is structured in NETCONF in the same way as it is in the RUGGEDCOM ROX II web interface and command line interface CLI The NETCONF protocol is defined in several Internet Engineering Task Force Request For Comment RFC documents It is not necessary to read the RFCs to use NETCONF with devices but this guide provides links to the RFCs for those interested in th...

Page 15: ...uration management of network devices Readers should be familiar with the following general use and function of the RUGGEDCOM ROX II software network design and network management concepts and tasks using Secure Shell SSH to connect to RUGGEDCOM ROX II how to create well formed and valid XML documents Section 1 4 Supported IETF RFCs RUGGEDCOM ROX II supports the following IETF Request For Comments...

Page 16: ...ns Also review these sections to become familiar with examples of working NETCONF XML code The text in these examples can be copied and tested on an operating RUGGEDCOM NETCONF device The XML code in these examples has been formatted for legibility Line breaks and white space have been added to the XML text to make the lines easier to read and to show the element hierarchy When sending XML text to...

Page 17: ...t The s parameter indicates the subsystem All NETCONF communication must be identified with s netconf You can configure the IP addresses and ports on which RUGGEDCOM NETCONF listens for NETCONF For more information refer to Section 3 1 Configuring Monitoring NETCONF in RUGGEDCOM NETCONF The device responds with its hello statement xml version 1 0 encoding UTF 8 hello xmlns urn ietf params xml ns n...

Page 18: ...UGGEDCOM NETCONF data model The string indicates the end of the NETCONF message Each NETCONF message must end with The device responds with the requested data xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 1001 data admin xmlns http ruggedcom com ns rmf_admin system name Substation Ethernet Switch 2 system name admin data rpc reply The rpc reply e...

Page 19: ...Detailed Steps 1 Log in to the device via ssh ssh user ipAddress p 830 s netconf user is a user name on the device Typically the user should be assigned the administrative user role ipAddress is an address on the device listening for NETCONF activity The p parameter indicates the port listening for NETCONF activity Port 830 is the default NETCONF port The s parameter indicates the subsystem All NE...

Page 20: ...st is to perform an action on the device The action element must refer to the action namespace in the xmlns attribute The admin element is the root of the RUGGEDCOM admin namespace Within the admin element additional elements navigate down to the desired command In this example we are navigating to admin set system clock in the RUGGEDCOM NETCONF data model The string indicates the end of the NETCO...

Page 21: ...l xml dat a x ml xml dat a x ml xml dat a x ml xml dat a x ml xm l lock datastores Figure 4 Session Schematic Editing Data Basic Steps 1 Connect to the device and exchange hello messages 2 Issue an rpc command to discard changes Discarding changes removes changes that are incomplete and not yet committed to the datastores It is strongly recommended that you discard any such stray changes before ma...

Page 22: ...e on the device Typically the user should be assigned the administrative user role ipAddress is an address on the device listening for NETCONF activity The p parameter indicates the port listening for NETCONF activity Port 830 is the default NETCONF port The s parameter indicates the subsystem All NETCONF communication must be identified with s NETCONF You can configure the IP addresses and ports ...

Page 23: ...ded The message id attribute is returned in the device response allowing you to match responses with requests The lock element indicates that this request is to lock a configuration The target element specifies the configuration to lock In this rpc the lock target is the running configuration The string indicates the end of the NETCONF message Each NETCONF message must end with The device responds...

Page 24: ...0 message id 1014 ok rpc reply The edit is applied to the candidate configuration 7 Issue an rpc request to validate the candidate configuration rpc message id 1015 xmlns urn ietf params xml ns netconf base 1 0 validate source candidate source validate rpc The validate element indicates that this request is to validate a specified configuration The source element specifies the configuration to be ...

Page 25: ...ml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 1017 ok rpc reply 10 Issue an rpc request to unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 1018 unlock target running target unlock rpc The device responds with the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf ba...

Page 26: ...Chapter 1 Introduction RUGGEDCOM NETCONF Reference Guide 14 Sample Session Editing Data ...

Page 27: ...on of NETCONF configuration parameters are namespaces NETCONF supports both standard IETF NETCONF capabilities and vendor defined capabilities that are unique to the product platform NETCONF uses namespaces that define the NETCONF configuration data model and that support various capabilities CONTENTS Section 2 1 IETF Capabilities Section 2 2 Vendor Defined Capabilities Section 2 3 IETF Namespaces...

Page 28: ...neering Task Force RFC 6241 http tools ietf org html rfc6241 capability urn ietf params netconf capability validate 1 0 capability Supports the validate operation you can validate a specified configuration for syntax errors For more information on this capability see Internet Engineering Task Force RFC 6241 http tools ietf org html rfc6241 capability urn ietf params netconf capability rollback on ...

Page 29: ... vendor defined capabilities support NETCONF monitoring on the device Section 2 3 IETF Namespaces NETCONF uses several namespaces to data types and configuration data models Some namespaces are associated with and provide support for specific NETCONF capabilities The following are the standard IETF namespaces supported by NETCONF Capabilities Description capability urn ietf params xml ns yang ietf...

Page 30: ...he RUGGEDCOM ROX II command line interface capability http ruggedcom com ns rmf_chassis module rmf_chassis revision 2012 11 28 capability The chassis namespace contains chassis configuration data The chassis namespace is the equivalent of the chassis menu level in the RUGGEDCOM ROX II web user interface and the chassis command in the RUGGEDCOM ROX II command line interface capability http ruggedco...

Page 31: ...ty http ruggedcom com ns rmf_mpls module rmf_mpls revision 2012 11 28 capability The mpls namespace contains mpls configuration data The mpls namespace is the equivalent of the mpls menu level in the RUGGEDCOM ROX II web user interface and the mpls command in the RUGGEDCOM ROX II command line interface capability http ruggedcom com ns rmf_qos module rmf_qos revision 2012 11 28 capability The qos n...

Page 32: ... capability urn ietf params netconf capability confirmed commit 1 0 capability capability urn ietf params netconf capability confirmed commit 1 1 capability capability urn ietf params netconf capability XPath 1 0 capability capability urn ietf params netconf capability url 1 0 scheme ftp sftp file capability capability urn ietf params netconf capability validate 1 0 capability capability urn ietf ...

Page 33: ...gedcom com ns rmf_services module rmf_services revision 2012 03 07 capability capability http tail f com yang common monitoring module tailf common monitoring revision 2011 09 22 capability capability http tail f com yang confd monitoring module tailf confd monitoring revision 2011 09 22 capability capability http tail f com yang netconf monitoring module tailf netconf monitoring revision 2011 09 ...

Page 34: ...Chapter 2 NETCONF Capabilities and Namespaces RUGGEDCOM NETCONF Reference Guide 22 Viewing the Capabilities on a Device ...

Page 35: ... Configuring Monitoring NETCONF in RUGGEDCOM NETCONF Section 3 2 Connecting to the NETCONF Service Section 3 3 Saying Hello Section 3 4 Closing the Session Section 3 5 Killing a Session Section 3 1 Configuring Monitoring NETCONF in RUGGEDCOM NETCONF Before sending NETCONF XML messages to any RUGGEDCOM NETCONF device make sure NETCONF sessions are enabled and configured For more information refer t...

Page 36: ...ue NETCONF requests you must respond to the hello message The minimal response is to reply with a hello message listing just the netconf base capability from the client You can also reply with the client s actual capabilities or reply by returning the device s capabilities back to the device In all examples in this guide we respond to the hello message with the minimal response NOTE Your reply to ...

Page 37: ...y capability http ruggedcom com ns rmf module rmf revision 2012 03 07 capability capability http ruggedcom com ns rmf_admin module rmf_admin revision 2012 03 07 capability capability http ruggedcom com ns rmf_chassis module rmf_chassis revision 2012 03 07 capability capability http ruggedcom com ns rmf_events module rmf_events revision 2012 03 07 capability capability http ruggedcom com ns rmf_glo...

Page 38: ...ument containing the ok element If the NETCONF device cannot complete the request it sends an rpc reply document containing the rpc error element To close a NETCONF session send the following rpc message id 2010 xmlns urn ietf params xml ns netconf base 1 0 close session rpc Upon successfully closing the session the device responds with the following xml version 1 0 encoding UTF 8 rpc reply xmlns ...

Page 39: ...ill a session where you do not know the session id first attempt to lock a configuration In this example we attempt to lock the already locked running configuration rpc message id 2040 xmlns urn ietf params xml ns netconf base 1 0 lock target running target lock rpc The device responds with the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message...

Page 40: ...Chapter 3 NETCONF Sessions RUGGEDCOM NETCONF Reference Guide 28 Killing a Session ...

Page 41: ...TCONF data modelling The data model for RUGGEDCOM ROX II is defined in several YANG files Typically each RUGGEDCOM namespace is defined in a single YANG file YANG files contain structured content but they are not in XML YIN files are XML versions of YANG data model files YIN files are well formed XML files making them easily parseable and able to be programmatically traversed and manipulated You c...

Page 42: ... xmlns http ruggedcom com ns rmf_admin logging diagnostics developer log enabled developer log diagnostics logging admin filter get rpc The device returns the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 3010 data admin xmlns http ruggedcom com ns rmf_admin logging diagnostics developer log enabled true enabled developer log diagnostic...

Page 43: ...xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 3050 data admin xmlns http ruggedcom com ns rmf_admin users userid name admin name password 1 z6HPcW nIHgNp6EXWzN l9SlhAVE1 password role administrator role userid userid name guest name password 1 YEkflk EEEV0mzCClp9oFVWVAiba1 password role guest role userid userid name oper name password 1 1iSWr S64...

Page 44: ...l ns netconf base 1 0 message id 3020 data admin xmlns http ruggedcom com ns rmf_admin logging diagnostics developer log enabled true enabled developer log diagnostics logging admin data rpc reply The following example shows how to use an XPath with the get config command rpc message id 3020 xmlns urn ietf params xml ns netconf base 1 0 get config source running source filter type xpath select adm...

Page 45: ...element For example element element data element element Where element is an element in the data model represents multiple elements in the data model to the target element data is the identifying data for the object whose information you want to retrieve For example to return the role for a specific user send an rpc message similar to the following rpc message id 3030 xmlns urn ietf params xml ns ...

Page 46: ...min users userid name oper role get rpc The device returns the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 3030 data admin xmlns http ruggedcom com ns rmf_admin users userid name oper name role operator role userid users admin data rpc reply Section 4 5 Getting Default Values The NETCONF standard does not require NETCONF servers to re...

Page 47: ...t admin logging diagnostics xpath trace log enabled get rpc The device returns the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 3030 data admin xmlns http ruggedcom com ns rmf_admin logging diagnostics xpath trace log enabled false enabled xpath trace log diagnostics logging admin data rpc reply Section 4 6 Getting Data Models from the...

Page 48: ...can be determined from the YANG files However YANG files can be difficult to decipher for some users For a list of commonly used NETCONF actions and their paths refer to Chapter 6 RUGGEDCOM ROX II Actions NOTE For more information on the YANG data modeling language refer to RFC 6020 http tools ietf org html rfc6020 CONTENTS Section 4 6 1 Getting Schemas from the Device Section 4 6 2 Getting YIN an...

Page 49: ...rom the Device Section 4 6 2 Getting YIN and YANG Files from the Device To retrieve a specific YIN or YANG file do the following 1 Log in to the device and start a NETCONF session For instructions on how to initiate a NETCONF session refer to Section 3 2 Connecting to the NETCONF Service 2 Download a list of schemas from RUGGEDCOM NETCONF and determine the identifier version and format of the sche...

Page 50: ...g download one or more YANG or YIN files from RUGGEDCOM ROX II For instructions on downloading schemas refer to Section 4 6 2 Getting YIN and YANG Files from the Device 2 At a command line prompt type this command pyang inputFile o outputFile f tree inputFile The path to and filename of the YANG or YIN file that you want to convert outputFile The path to and filename of the text based tree diagram...

Page 51: ...messages For example to enable the NTP service on a device locate the ntp enabled field in the tree rw services rw time rw ntp rw enabled boolean In the XML this tree structure looks like the following services ntp enabled enabled ntp services To set the Enabled field to true the XML in your NETCONF rpc looks like the following rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit ...

Page 52: ... empty rw peer empty In the XML this tree structure looks like the following services ntp server name name peer peer server ntp services To set a peer for the NTP server the XML in your NETCONF rpc looks like the following rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config services xmlns http ruggedcom com ns rmf_services ntp server name ntp...

Page 53: ...the changes with the discard changes command allowing you to cancel the editing process and clear any errors After reviewing and validating the changes you apply the changes to the running configuration with the commit command Editing the candidate configuration and then committing the changes is the recommended approach for editing configuration data CONTENTS Section 5 1 Changing Data in the Runn...

Page 54: ...ation For instructions on how to validate a configuration refer to Section 5 2 5 Validating Changes Section 5 2 Changing Data in the Candidate Configuration The recommended approach for changing data is to make your changes to the candidate configuration before committing the changes to the running configuration Making changes to the candidate configuration provides the opportunity to validate the...

Page 55: ...ck the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 1010 lock target running target lock rpc All commands must be enclosed within rpc tags The message id attribute is not required but is recommended The message id attribute is returned in the device response allowing you to match responses with requests The lock element indicates that this request is to lock a...

Page 56: ...device through the web interface or through the command line interface When using copy config to save the configuration to an XML file the file is saved in the var lib config directory on the device You can download the through the RUGGEDCOM ROX II Web interface or through the command line interface To save a configuration to an XML file do the following 1 Connect to and log in to the device 2 Iss...

Page 57: ... target lock rpc 4 Lock the target configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 5 Discard any configuration changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 6 Use copy config to copy the file to a specified configuration rpc message id 233 xmlns urn ietf params xml ns netconf base 1 ...

Page 58: ...unlock rpc 9 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 5 2 3 Replacing Data To replace an existing configuration value with a new value do the following 1 Connect to and log in to the device 2 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock ta...

Page 59: ... this point namespace The URL to the RUGGEDCOM namespace for the top level element configuration data with nc operation replace attribute The path to the data to be replaced with the nc operation replace attribute on the element containing the data to be replaced For example to replace an existing IP address with a new address issue the following request rpc message id 233 xmlns urn ietf params xm...

Page 60: ...ms xml ns netconf base 1 0 message id 230 lock target running target lock rpc 3 Lock the target configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 4 Discard any configuration changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 5 Issue an rpc request with the delete operation rpc message id 23...

Page 61: ...terface setting on an interface in OSPF issue the following request rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config routing xmlns http ruggedcom com ns rmf_routing xmlns nc urn ietf params xml ns netconf base 1 0 dynamic ospf interface ifname switch 0022 ifname passive nc operation delete interface ospf dynamic routing config edit config ...

Page 62: ... message id 103 xmlns urn ietf params xml ns netconf base 1 0 validate source candidate source validate rpc If the configuration syntax is correct the device responds with the following xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 103 ok rpc reply If the configuration syntax is not correct the device responds with an rpc error message For exampl...

Page 63: ... Force RFC 6241 Appendix A NETCONF Error List http tools ietf org html rfc6241 appendix A Section 5 2 6 Committing Changes After making changes to the candidate configuration you can commit the changes to make the changes active in the running configuration It is recommended that you first validate the candidate configuration before issuing the commit command For instructions on how to validate a ...

Page 64: ...Chapter 5 Changing Configuration Data RUGGEDCOM NETCONF Reference Guide 52 Committing Changes ...

Page 65: ... rollback reboot admin software upgrade rollback reboot Section 6 1 5 roxflash admin rox imaging roxflash Section 6 1 6 clear all alarms admin clear all alarms Section 6 1 7 acknowledge all alarms admin acknowledge all alarms Section 6 1 8 shutdown admin shutdown Section 6 1 9 reboot admin reboot Section 6 1 10 set system clock admin set system clock Section 6 1 11 restore factory defaults admin r...

Page 66: ...mic rules Switch switch layer3 switching flush dynamic rules Section 6 4 3 reset all switch ports Switch switch reset all switch ports Section 6 4 4 clear all switch stats Switch switch clear all switch stats Section 6 4 5 clear cable stats all Switch switch clear cable stats all CONTENTS Section 6 1 Admin Namespace Actions Section 6 2 Interfaces Namespace Actions Section 6 3 Services Namespace Ac...

Page 67: ...s address port port port trap port trapPort trap port snmp discover snmp admin data action rpc ipAddress The SNMP IP address the device listens on port The SNMP data port the device listens on if any trapPort The SNMP trap port the device listens on if any Section 6 1 2 launch upgrade This action launches a RUGGEDCOM ROX II software upgrade to the alternate partition on the device The repository a...

Page 68: ...is not awaiting a reboot after applying an update this action has no effect This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf_admin software upgrade decline upgrade software upgrade admin data action rpc Section 6 1 4 rollback reboot This action boo...

Page 69: ...The URL format is protocol user password host port path to file If the server does not require authentication user password can be omitted When using the default port for the protocol port may also be omitted Section 6 1 6 clear all alarms This action clears all clearable alarms in the active list Note that not all alarms can be cleared This action does not take any parameters rpc message id 101 x...

Page 70: ...etconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf_admin shutdown admin data action rpc Section 6 1 9 reboot This action reboots the device This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf...

Page 71: ...dmin data action rpc Section 6 1 12 delete logs This action deletes all log files on the device This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf_admin delete logs admin data action rpc Section 6 1 13 install files This action copies files from a sp...

Page 72: ...dmin backup files file type fileType file type file file file timestamp timeStamp timestamp url url url backup files admin data action rpc fileType The type of file to copy from the device Must be one of the following config featurekey elancertificate ipseccertificate cacertificate or crlfiles file The name of the file to copy timeStamp A Boolean value true or false When true the system appends a ...

Page 73: ...his action loads a configuration from the specified file found in the var lib config directory on the device Parameters include format and file name rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf_admin full configuration load format format format file name fileName file name full config...

Page 74: ... modem interface name in the ifname element This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data interfaces xmlns http ruggedcom com ns rmf_ifs modem ifname interfaceName ifname reset modem interfaces data action rpc interfaceName The interface name for the modem Section 6 2 2 at Modem Thi...

Page 75: ...netconf actions 1 0 data interfaces xmlns http ruggedcom com ns rmf_ifs cellmodem module module module port port port reset cellmodem interfaces data action rpc module The module number for the cellular modem port The port number for the cellular modem Section 6 2 4 at Cellular Modem This action sends an AT command to the cellular modem The command must begin with the prefix AT Specify the modem m...

Page 76: ... netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data interfaces xmlns http ruggedcom com ns rmf_ifs serial module module module port port port reset serial interfaces data action rpc module The module number for the serial port port The port number for the serial port Section 6 2 6 clear serial port stats This action clears the port statistics for the specified serial port Sp...

Page 77: ...ata interfaces xmlns http ruggedcom com ns rmf_ifs serial restart serserver serial interfaces data action rpc Section 6 2 8 reset port Switch Port This action resets the specified switch port Specify the switch module and port in the module and port elements This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns net...

Page 78: ... clear port stats switch interfaces data action rpc module The module number for the switch port port The port number for the switch port Section 6 2 10 start cable test Switch Port This action starts cable test diagnostics on the specified switch port Specify the switch module and port in the module and port elements This action does not take any parameters rpc message id 101 xmlns urn ietf param...

Page 79: ...e stats port diagnostics switch interfaces data action rpc module The module number for the switch port port The port number for the switch port Section 6 3 Services Namespace Actions This section describes how to perform actions related to services namespaces using rpc messages through NETCONF CONTENTS Section 6 3 1 ntp status Section 6 3 2 log Link Failover Section 6 3 3 start test Link Failover...

Page 80: ...art test Link Failover This action starts a test of the link failover function Specify the name of the interface to test in the name element Parameters include test duration and start test delay rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data services xmlns http ruggedcom com ns rmf_services link failover main interfaceName ...

Page 81: ...rvices link failover main interfaceName main cancel test link failover services data action rpc interfaceName The name of the interface on which to stop the link failover test Section 6 3 5 show active leases DHCP Server This action returns a list of active leases from the DHCP server This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action x...

Page 82: ...e clear stp stats spanning tree switch data action rpc Section 6 4 2 flush dynamic rules Switch This action deletes all dynamic entries from the routing rules summary table This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data switch xmlns http ruggedcom com ns rmf_ifswitch layer3 switching...

Page 83: ...s all cable test diagnostic statistics This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data switch xmlns http ruggedcom com ns rmf_ifswitch clear cable stats all switch data action rpc Section 6 5 Tunnel Namespace Actions This section describes how to perform actions related to tunnel name...

Page 84: ...rams xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data tunnel xmlns http ruggedcom com ns rmf_iftunnel ipsec status ipsec tunnel data action rpc Section 6 5 3 install certificate IPSEC This action uploads an IPSec certificate to the device The certificate must be located at a network location accessible to the device Parameters include remote host remote port remote ...

Page 85: ...ser name on the remote host Section 6 5 4 install ca certificate IPSEC This action uploads an IPSec ca certificate to the device The ca certificate must be located at a network location accessible to the device Parameters include remote host remote port remote_cacert_path user and password rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf acti...

Page 86: ...ote crl path user and password rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data tunnel xmlns http ruggedcom com ns rmf_iftunnel ipsec certificate install crl file remote host remoteHost remote host remote port remotePort remote port remote crl path crlFilePath remote crl path user remoteUserName user password remotePassword p...

Page 87: ...certificateName name remove ca certificate ca certs ca certificate certificate ipsec tunnel data action rpc certificateName The name of the certificate to remove Section 6 5 7 remove certificate IPSEC This action removes the specified certificate from the IPSec configuration Specify the certificate name in the name element This action does not take any parameters rpc message id 101 xmlns urn ietf ...

Page 88: ...e crl file name in the name element This action does not take any parameters rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data tunnel xmlns http ruggedcom com ns rmf_iftunnel ipsec certificate crl crls name crlFileName name remove crl crls crl certificate ipsec tunnel data action rpc crlFileName The name of the crl file to rem...

Page 89: ... command Section 7 7 Viewing Alarms Querying for state information Section 7 8 Restoring Factory Defaults Using an action command Section 7 9 Changing the System Name by Locking and Committing Recommended editing procedure Section 7 10 Changing the System Name Directly Editing configuration data in the running configuration Section 7 11 Creating a Static VLAN Recommended editing procedure Section ...

Page 90: ...7 35 Enabling the DHCP Server Service Recommended editing procedure Section 7 36 Disabling an Ethernet Port Recommended editing procedure Deleting data with the nc operation delete attribute Section 7 37 Enabling an Ethernet Port Recommended editing procedure Section 7 38 Checking an IP Address on a Specific Port using the Interfaces Namespace Querying for running configuration data Section 7 39 R...

Page 91: ...a Static Route Section 7 17 Disabling Spanning Tree Globally Section 7 18 Retrieving all IP Addresses from the Running Configuration Section 7 19 Retrieving the Active Routes on a Device Section 7 20 Configuring Static Multicast Routing on a Layer 3 Device Section 7 21 Enabling Static Multicast Routing on a Layer 3 Device Section 7 22 Retrieving Static Multicast Status on a Layer 3 Device Section ...

Page 92: ...g a Private Key to a Signed CA Certificate Section 7 47 Installing a CRL File Section 7 48 Removing a Certificate Section 7 49 Removing a CA certificate Section 7 50 Removing a CRL File Section 7 1 Getting the System Name In this example a single rpc queries the running configuration and returns the system name This example shows how to issue a query for configuration data directly from the runnin...

Page 93: ... base 1 0 get filter type subtree chassis xmlns http ruggedcom com ns rmf_chassis status status chassis filter get rpc Section 7 4 Setting the System Clock In this example a single rpc sets the system clock with the set system clock action This example shows how to use a RUGGEDCOM ROX II action on a running device rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 action xmlns http t...

Page 94: ...lns urn ietf params xml ns netconf base 1 0 action xmlns http tail f com ns netconf actions 1 0 data admin xmlns http ruggedcom com ns rmf_admin clear all alarms admin data action rpc Section 7 7 Viewing Alarms In this example a single rpc queries the device and returns a list of active alarms This example shows how to issue a query for state information directly from the device rpc message id 2 x...

Page 95: ... recommended procedure for making configuration changes on a device 1 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 2 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 3 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 ...

Page 96: ...ng the System Name Directly In this example a single rpc request changes the system name directly in the running configuration This example shows how to change configuration data on the running configuration directly without locking the datastores Changes made in this manner are applied to the running configuration immediately CAUTION Exercise caution when making changes directly to the running co...

Page 97: ...mlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Configure the static VLAN parameters rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config switch xmlns http ruggedcom com ns rmf_i...

Page 98: ... for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 me...

Page 99: ...rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 13 Disabling Spanning Tree on a Specific Port In this example multiple rpc requests disable spanning tree on a specified port in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the r...

Page 100: ...ation delete spanning tree switch interface config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message...

Page 101: ...id 232 discard changes rpc 4 Set the IP address on the port rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config ip xmlns http ruggedcom com ns rmf_ip ifname fe cm 1 ifname ipv4 address ipaddress 192 168 1 43 24 ipaddress address ipv4 ip config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 ...

Page 102: ...t holding the address and its container element 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 ...

Page 103: ...g target unlock rpc Section 7 16 Setting a Static Route In this example multiple rpc requests set a static route in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock...

Page 104: ...didate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 17 Disabling Spanning Tree Globally In this example multiple rpc requests globally disable spanning tree in the candidate ...

Page 105: ...params xml ns netconf base 1 0 edit config target candidate target config switch xmlns nc urn ietf params xml ns netconf base 1 0 xmlns http ruggedcom com ns rmf_ifswitch spanning tree enabled nc operation delete spanning tree switch config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the candidate configuration rpc xmlns...

Page 106: ...ing source filter type subtree ip xmlns http ruggedcom com ns rmf_ip ipv4 address address ipv4 ip filter get config rpc Section 7 19 Retrieving the Active Routes on a Device In this example a single rpc request retrieves the active routes from the running configuration on a device The following is the typical procedure for querying data from the running configuration Request the data from the runn...

Page 107: ...he candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Configure static multicast routing rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config routing xm...

Page 108: ...unlock rpc Section 7 21 Enabling Static Multicast Routing on a Layer 3 Device In this example multiple rpc requests enable static multicast routing in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock ta...

Page 109: ...ation rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 22 Retrieving Static Multicast Status on a Layer 3 Device In this example a single rpc request retrieves the static multicast status info...

Page 110: ...ing configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Replace the IP address rpc...

Page 111: ...rget unlock rpc Section 7 24 Configuring a Port to Dynamically Obtain an IP Address In this example multiple rpc requests configure a report as a DHCP client in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 ...

Page 112: ... ns netconf base 1 0 commit rpc 6 Unlock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 25 Configuring OSPF Area and Network on a Layer 3 Device In this example m...

Page 113: ...twork rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config routing xmlns http ruggedcom com ns rmf_routing dynamic ospf area area 0 0 0 0 area network 192 168 114 0 24 network area ospf dynamic routing config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the candidate ...

Page 114: ...nf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Enable the OSPF passive default option rpc message id 233 xmlns urn ietf params xm...

Page 115: ...on and then commit the changes The following is the recommended procedure for making configuration changes on a device This example also shows how to use the nc operation delete attribute to disable a configuration option 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns...

Page 116: ...te configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 28 Configuring OSPF Parameters In this example multiple rpc requests configure OSPF parameters in the candidate configuration ...

Page 117: ...target config routing xmlns http ruggedcom com ns rmf_routing dynamic ospf router id 192 168 1 43 router id interface ifname switch 0022 ifname hello interval 10 hello interval dead interval dead interval 40 dead interval dead interval interface ospf dynamic routing config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the ...

Page 118: ...id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Enable the redistribute connected option rpc message id 233 xmlns urn ietf params xml ns netconf base ...

Page 119: ...ble OSPF in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock targe...

Page 120: ...k the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 31 Retrieving OSPF Status In this example a single rpc request retrieves the OSPF status information from the running configuration on a device The following is the typical procedure for querying data from the running configuration Request the data from the...

Page 121: ...Section 7 33 Configuring DHCP Server In this example multiple rpc requests configure the DHCP server service in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the...

Page 122: ...ock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 34 Configure the DHCP Server Port Listening for DHCP Client Requests In this example multiple rpc requests conf...

Page 123: ...e rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config services xmlns http ruggedcom com ns rmf_services dhcpserver interface name switch 0021 name interface dhcpserver services config edit config rpc 5 Commit the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the candidate configuration rpc xmlns ...

Page 124: ...figuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 discard changes rpc 4 Enable the DHCP Server service rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config services xmlns http ruggedcom ...

Page 125: ...e nc operation delete attribute 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 2 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lock rpc 3 Discard uncommitted changes rpc xmlns urn ietf params xml ns netconf base 1 0 message id 232 d...

Page 126: ...l ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 37 Enabling an Ethernet Port In this example multiple rpc requests enable an Ethernet port in the candidate configuration and then commit the changes The following is the recommended procedure for making configuration changes on a device 1 Lock the running configuration rpc xmlns urn ietf params xml ns netconf b...

Page 127: ...t the changes rpc message id 234 xmlns urn ietf params xml ns netconf base 1 0 commit rpc 6 Unlock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 235 unlock target candidate target unlock rpc 7 Unlock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 236 unlock target running target unlock rpc Section 7 38 Checking an I...

Page 128: ...ning database Request data from the running databse rpc message id 1 xmlns urn ietf params xml ns netconf base 1 0 with defaults true get config xmlns urn ietf params xml ns netconf base 1 0 source running source get config rpc Section 7 40 Retreiving All Data From Running Database Including Default Tags and Values In this example a single rpc request retrieves information including default tags a...

Page 129: ...asswd available on most Linux distributions to generate a hashed password For a Windows based utility contact Siemens Customer Service 2 Lock the running configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 230 lock target running target lock rpc 3 Lock the candidate configuration rpc xmlns urn ietf params xml ns netconf base 1 0 message id 231 lock target candidate target lo...

Page 130: ...nlock rpc Section 7 42 Displaying the Status of the IPsec Service Displays the status of the running IPsec service This action does not take any parameters rpc message id 2 xmlns urn ietf params xml ns netconf base 1 0 get filter type subtree tunnel xmlns http ruggedcom com ns rmf_iftunnel ipsec status status ipsec tunnel filter get rpc Section 7 43 Selecting a Certificate for an IPSec Tunnel This...

Page 131: ...e value ip value value public ip subnet network network network subnet key type key type type certificate certificate certificate key nexthop type nexthop type type value nexthop value value nexthop right connection ipsec tunnel config edit config rpc name The name of the IPSec tunnel startup The action to take when IPSec is initialized Must be one of the following add default ignore route or star...

Page 132: ...default route nexthop value The IP address of the next hop that can be used to reach the destination network The value is defined based on the selected nexthop type value For example if address is chosen as the nexthop type an ip address is defined here Section 7 44 Installing a CA Certificate This action uploads the contents of a Certificate Authority CA certificate to the device Parameters inclu...

Page 133: ...config target candidate target config security xmlns http ruggedcom com ns rmf_security crypto certificate name name name ca name ca name ca name private key name private key name private key name contents BEGIN CERTIFICATE MIIC8jCCAlugAwIBAgIBATANBgkqhkiG9w0BAQUFADCBiTELMAkGA1UEBhMCQ0Ex IsAFEeX2iShlXT7OSYqS771RFFSp1dzirAcndiFeUUzXm5Gj8P4 END CERTIFICATE contents certificate crypto security config...

Page 134: ...he type of private key Must be one of the following dsa rsa or ssh rsa Section 7 47 Installing a CRL File This action uploads the contents of a Certificate Revocation List CRL file to the device rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config security xmlns http ruggedcom com ns rmf_security crypto ca name name name key cert sign certific...

Page 135: ...com ns rmf_security crypto certificate nc operation delete name name name contents BEGIN CERTIFICATE MIIDCDCCAnGgAwIBAgIJAPl3LLRHpm cMA0GCSqGSIb3DQEBBQUAMIGcMQswCQYD ZptpoW N2920tXQvsjD4SG EoCPilKD63vbb54UFh 10SRIlIUplCDu1uXNvI3Pe u Kh vRZz8IqXtI0 END CERTIFICATE contents certificate crypto security config edit config rpc name The name of the certificate to remove Section 7 49 Removing a CA certif...

Page 136: ...g a CRL File This action removes the specified crl file from the device Specify the crl file name in the name element This action does not take any parameters rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target candidate target config security xmlns nc urn ietf params xml ns netconf base 1 0 xmlns http ruggedcom com ns rmf_security crypto ca name crlFileName name cr...

Page 137: ... discard changes Section 8 7 edit config Section 8 8 error info Section 8 9 get config Section 8 10 hello Section 8 11 kill session Section 8 12 lock Section 8 13 ok Section 8 14 rpc Section 8 15 rpc error Section 8 16 rpc reply Section 8 17 target Section 8 18 unlock Section 8 19 validate Section 8 1 Description Indicates the end of an XML document The sequence must appear at the end of each XML ...

Page 138: ...changes immediately apply to the currently running configuration To require confirmation of the changes issue the confirmed tag within the commit tag the changes appear in the currently running configuration but are rolled back if they are not confirmed within a timeout period The default timeout period is 10 minutes To specify a different timeout period use the confirm timeout tag within the comm...

Page 139: ... configuration source file to copy Response If the NETCONF device can complete the request it sends an rpc reply document containing the ok element If the NETCONF device cannot complete the request it sends an rpc reply document containing the rpc error element Example To copy a configuration and make it the candidate configuration rpc copy config target candidate target source url https user exam...

Page 140: ...element and results of the query If the NETCONF device cannot complete the request it sends an rpc reply document containing the rpc error element Example To change the system name parameter in the running configuration rpc message id 233 xmlns urn ietf params xml ns netconf base 1 0 edit config target running target config admin xmlns http ruggedcom com ns rmf_admin system name Lorem Ipsum system...

Page 141: ... 10 hello Description Lists the capabilities of the NETCONF server and client When connecting to the device the device sends a hello message containing its NETCONF capabilities and a session id The client connecting to the device must also send a hello message listing at least the base NETCONF capability The client s hello message must not contain a session id Parameters capabilities contains one ...

Page 142: ...edcom com ns rmf_events module rmf_events revision 2012 03 07 capability capability http ruggedcom com ns rmf_global module rmf_global revision 2012 03 07 capability capability http ruggedcom com ns rmf_if module rmf_if revision 2012 03 07 capability capability http ruggedcom com ns rmf_ifs module rmf_ifs revision 2012 03 07 capability capability http ruggedcom com ns rmf_iftunnel module rmf_iftun...

Page 143: ...the rpc error element Example To kill a session rpc message id 101 xmlns urn ietf params xml ns netconf base 1 0 kill session session id 4 session id kill session rpc Section 8 12 lock Description Locks the specified configuration preventing other NETCONF sessions and other services such as the web interface and command line interface from editing the session Other sessions may read a locked sessi...

Page 144: ...essage id 103 xmlns urn ietf params xml ns netconf base 1 0 validate source running source validate rpc xml version 1 0 encoding UTF 8 rpc reply xmlns urn ietf params xml ns netconf base 1 0 message id 103 ok rpc reply Section 8 15 rpc error Description Indicates that the NETCONF server encountered an error processing an rpc request The rpc error element appears within rpc request messages For mor...

Page 145: ...e must be set error message error info bad element authentication bad element error info rpc error rpc reply Section 8 16 rpc reply Description Contains the results of an rpc request The rpc reply may contain returned data the ok element indicating the successful completion of an operation request or error information The user id attribute contains the user id string sent with the rpc request The ...

Page 146: ...k element If the NETCONF device cannot complete the request it sends an rpc reply document containing the rpc error element Example To lock the candidate configuration rpc lock target candidate target lock rpc Section 8 18 unlock Description Releases the configuration lock placed by an earlier lock operation in the same NETCONF session The specified configuration must already be locked and only th...

Page 147: ...to validate candidate or running Response If the NETCONF device can complete the request it sends an rpc reply document containing the ok element If the NETCONF device cannot complete the request it sends an rpc reply document containing the rpc error element The rpc error element will contain information on the syntax errors found in the configuration Example To verify the candidate configuration...

Page 148: ...Chapter 8 NETCONF XML Elements RUGGEDCOM NETCONF Reference Guide 136 validate ...

Search results

Summary of Contents for RUGGEDCOM MX5000RE

Reviews:

Related manuals for RUGGEDCOM MX5000RE

Brands by name

Popular brands

Siemens RUGGEDCOM MX5000RE, Reference Manual

Search results

Summary of Contents for RUGGEDCOM MX5000RE

Reviews:

Related manuals for RUGGEDCOM MX5000RE

Brands by name

Popular brands