examples: add ncclient examples of URL capability 06/14406/1
authorMarek Gradzki <[email protected]>
Wed, 22 Aug 2018 04:59:36 +0000 (06:59 +0200)
committerMarek Gradzki <[email protected]>
Wed, 22 Aug 2018 06:13:08 +0000 (08:13 +0200)
Change-Id: Icf3bfc331548d1e0f1862bf87615f7c03a24780a
Signed-off-by: Marek Gradzki <[email protected]>
examples/ncclient/Readme.adoc
examples/ncclient/acl/config_acl.xml
examples/ncclient/acl/config_acl_update.xml
examples/ncclient/bd/config_bd.xml
examples/ncclient/copy_config_url.py [new file with mode: 0755]
examples/ncclient/nat/config_nat.xml
examples/ncclient/nat/config_nat_update.xml

index f2a97eb..f3fafcb 100644 (file)
@@ -90,7 +90,7 @@ Start honeycomb
 NOTE: Remember that HC by default persists config and restores it after restart.
 You can disable this behaviour using config/honeycomb.json.
 
-== <copy-config> examples
+== <copy-config>
 
 === ACL
 
@@ -121,7 +121,7 @@ Example configuration of NAT on loopback interface.
 ./acl/test_nat_updates.sh
 ----
 
-== <validate> examples
+== <validate>
 
 == ACL <edit-config> + <validate>
 [source]
@@ -129,3 +129,19 @@ Example configuration of NAT on loopback interface.
 ./edit_config.py --validate acl/config_invalid_acl.xml
 ----
 
+== URL capability
+
+Provide URL as source or target.
+Source URL can use file, http, https or ftp protocol.
+Target URL can use file protocol.
+
+When using file protocol, provided patch should correspond to a file accessible by Honeycomb.
+
+Example:
+
+[source]
+----
+./copy_config_url.py "file:///home/m/hc2vpp/examples/ncclient/bd/config_bd.xml" candidate
+----
+
+
index 164fd5a..5c6c094 100644 (file)
@@ -5,7 +5,7 @@
   ~ terms of the Eclipse Public License v1.0 which accompanies this distribution,
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
-<config>
+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <nat xmlns="urn:ietf:params:xml:ns:yang:ietf-nat">
         <instances>
             <instance>
index 5b99994..db4fd8b 100644 (file)
@@ -5,7 +5,7 @@
   ~ terms of the Eclipse Public License v1.0 which accompanies this distribution,
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
-<config>
+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <nat xmlns="urn:ietf:params:xml:ns:yang:ietf-nat">
         <instances>
             <instance>
index d751223..255ad3e 100644 (file)
@@ -5,7 +5,7 @@
   ~ terms of the Eclipse Public License v1.0 which accompanies this distribution,
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
-<config>
+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <nat xmlns="urn:ietf:params:xml:ns:yang:ietf-nat">
         <instances>
             <instance>
diff --git a/examples/ncclient/copy_config_url.py b/examples/ncclient/copy_config_url.py
new file mode 100755 (executable)
index 0000000..09c8401
--- /dev/null
@@ -0,0 +1,44 @@
+#!/usr/bin/env python2
+#
+# Copyright (c) 2018 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import argparse
+import logging
+from ncclient import manager
+
+
+def _copy_config_url(source, target, host='localhost', port=2831, username='admin', password='admin'):
+    with manager.connect(host=host, port=port, username=username, password=password, hostkey_verify=False) as m:
+        logger.info("Connected to HC")
+        ret = m.copy_config(source=source, target=target)
+        logger.info("<copy-config> successful:\n%s" % ret)
+        ret = m.commit()
+        logger.info("<commit> successful:\n%s", ret)
+
+
+if __name__ == '__main__':
+    logger = logging.getLogger("hc2vpp.examples.copy_config_url")
+    argparser = argparse.ArgumentParser(description="Configures VPP using <copy-config> RPC")
+    argparser.add_argument('source', help="source datastore name or URI of XML file with <config> element")
+    argparser.add_argument('target', help="target datastore name or URI of XML file with <config> element")
+    argparser.add_argument('--verbose', help="increase output verbosity", action="store_true")
+    args = argparser.parse_args()
+
+    logger = logging.getLogger("hc2vpp.examples.copy_config")
+    if args.verbose:
+        logging.basicConfig(level=logging.DEBUG)
+    else:
+        logging.basicConfig(level=logging.INFO)
+
+    _copy_config_url(args.source, args.target)
index eb261f1..9c41cab 100644 (file)
@@ -5,7 +5,7 @@
   ~ terms of the Eclipse Public License v1.0 which accompanies this distribution,
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
-<config>
+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
         <interface>
             <name>local0</name>
index 7c8bd9b..a6235ad 100644 (file)
@@ -5,7 +5,7 @@
   ~ terms of the Eclipse Public License v1.0 which accompanies this distribution,
   ~ and is available at http://www.eclipse.org/legal/epl-v10.html
   -->
-<config>
+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
     <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
         <interface>
             <name>local0</name>