Update for SBX and 8040

Author: hpreston

NC-edit-config/NC-edit-config-hostname.py

@@ -34,7 +34,7 @@
 
 data = '''
  <config>
- <native xmlns="http://cisco.com/ns/yang/ned/ios">
+ <native xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native">
  <hostname>NC-WAS-HERE</hostname>
  </native>
  </config>
@@ -59,4 +59,4 @@
  device_params={'name':"csr"})
  # Pretty print the XML reply
  xmlDom = xml.dom.minidom.parseString( str( m.edit_config(data, target='running') ) )
- print xmlDom.toprettyxml( indent = " " )
+ print xmlDom.toprettyxml( indent = " " )

NC-edit-config/README.md

@@ -9,7 +9,7 @@ For fun, you'll realize the script reconfigures the hostname of your network ele
 # requirements
 -- ncclient
 
--- IOS-XE running >/= 16.3.1 also enabled for NETCONF
+-- IOS-XE running >/= 16.5(1) also enabled for NETCONF
 
 # running
--- Can run on-box or off-box.
+-- Can run on-box or off-box.

NC-get-config/NC-get-config.py

@@ -24,7 +24,7 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 # SUCH DAMAGE.
 #
-# This script retrieves entire configuration from a network element via NETCONF 
+# This script retrieves entire configuration from a network element via NETCONF
 # prints it out in a "pretty" XML tree.
 
 import sys
@@ -44,14 +44,20 @@
  parser.add_argument('--port', type=int, default=830,
  help="Specify this if you want a non-default port")
  args = parser.parse_args()
- 
+
  m = manager.connect(host=args.host,
  port=args.port,
  username=args.username,
  password=args.password,
  device_params={'name':"csr"})
- # Pretty print the XML reply
- xmlDom = xml.dom.minidom.parseString( str( m.get_config(source='running')))
- print xmlDom.toprettyxml( indent = " " )
 
+ hostname_filter = '''
+ <filter>
+ <native xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native">
+ </native>
+ </filter>
+ '''
 
+ # Pretty print the XML reply
+ xmlDom = xml.dom.minidom.parseString( str( m.get_config('running', hostname_filter)))
+ print(xmlDom.toprettyxml( indent = " " ))

RC-get-config/RC-get-config.py

@@ -28,7 +28,6 @@
 # prints it out in a "pretty" XML tree.
 
 from argparse import ArgumentParser
-from ncclient import manager
 import requests
 
 if __name__ == '__main__':
@@ -42,7 +41,7 @@
  help="User credentials for the request")
  parser.add_argument('-passwd', '--password', type=str, default='cisco',
  help="It's the password")
- parser.add_argument('-port', '--port', type=int, default=830,
+ parser.add_argument('-port', '--port', type=int, default=443,
  help="Specify this if you want a non-default port")
 
  args = parser.parse_args()
@@ -52,12 +51,12 @@
  host = args.host
  port = str(args.port)
 
- url = "http://" + host + ":" + port + "/restconf/api/running/"
+ url = "https://" + host + ":" + port + "/restconf/api/running/"
 
  headers = {
  "Content-Type": "application/vnd.yang.datastore+json",
  "Accept": "application/vnd.yang.datastore+json",
  }
- response = requests.request("GET", url, headers=headers, auth=(username,password))
+ response = requests.request("GET", url, headers=headers, auth=(username,password), verify=False)
 
- print(response.text)
+ print(response.text)

eem_configdiff_to_spark/README.md

@@ -18,6 +18,33 @@ Then type the following in `EXEC` mode:
  guestshell enable
  ```
 
+Guestshell may not include the needed `requests` module. Enter guestshell with the following command:
+
+ ```
+ guestshell
+ ```
+
+From the guestshell prompt, run the following command:
+
+ ```
+ sudo pip install requests
+ ```
+
+If this returns an error about not being able to establish a connection to download the module, you
+may need to update your DNS settings within guestshell. If you know your DNS server, you can use
+that address. If you don't, just use 8.8.8.8. Run the command:
+
+ ```
+ sudo echo 'nameserver DNSSERVER' > /etc/resolv.conf
+ ```
+
+Where DNSSERVER is the IP address of your DNS server (or 8.8.8.8). After doing that, repeat
+the `pip` command, and it should install successfully. If `pip` tells you `requests` is already
+installed, then your guestshell environment is good. You can type `exit` to return to IOS-XE.
+
+**NOTE** The guestshell environment will persist across reboots. It will not revert to the default
+state unless you do a `guestshell destory` followed by another `guestshell enable`.
+
 Next, define the following EEM environment. Be sure **NOT** to put quotes around the variable
 values:
 

eem_configdiff_to_spark/sl_config_diff_to_spark.py

@@ -28,11 +28,13 @@
 #
 # spark_token : Bearer token for your Spark user/bot
 # spark_room : Spark room name to which messages will be sent
+# device_name : Device name from which the messages will be sent
 #
 # E.g.:
 #
 # event manager environment spark_token Bearer 1234abd...
 # event manager environment spark_room Network Operators
+# event manager environment device_name C3850
 #
 
 import eem
@@ -58,6 +60,10 @@
  eem.action_syslog(
  'Environment variable "spark_room" must be set', priority='3')
  sys.exit(1)
+if 'device_name' not in arr_envinfo:
+ eem.action_syslog(
+ 'Environment variable "device_name" must be set', priority='3')
+ sys.exit(1)
 
 # Get a CLI handle
 cli = eem.cli_open()
@@ -98,7 +104,9 @@
  # No differences found
  sys.exit(0)
 
-msg = 'Configuration differences between the running config and last backup:\n'
+device_name = arr_envinfo['device_name']
+msg = '### Alert: Config changed on ' + device_name + '\n'
+msg += 'Configuration differences between the running config and last backup:\n'
 msg += '```{}```'.format('\n'.join(diff_lines[:-1]))
 
 headers = {

restconf_update_ipaddress/updateip.py

@@ -24,6 +24,7 @@
 import json
 import requests
 import sys
+from argparse import ArgumentParser
 from collections import OrderedDict
 import urllib3
 
@@ -58,7 +59,7 @@ def get_configured_interfaces():
  auth=(USER, PASS),
  headers=headers,
  verify=False
- )
+  )
 
  # return the json as text
  return response.json()["ietf-interfaces:interfaces"]["interface"]
@@ -78,9 +79,9 @@ def configure_ip_address(interface, ip):
  ('ietf-ip:ipv4',
  OrderedDict([
  ('address', [OrderedDict([
-  ('ip',ip["address"]),
-  ('netmask',ip["mask"])
-  ])]
+ ('ip', ip["address"]),
+ ('netmask', ip["mask"])
+ ])]
  )
  ])
  ),
@@ -93,7 +94,7 @@ def configure_ip_address(interface, ip):
  headers=headers,
  verify=False,
  json=data
- )
+  )
  print(response.text)
 
 
@@ -106,7 +107,7 @@ def print_interface_details(interface):
  auth=(USER, PASS),
  headers=headers,
  verify=False
- )
+  )
 
  intf = response.json()["ietf-interfaces:interface"]
  # return the json as text
@@ -129,9 +130,9 @@ def interface_selection(interfaces):
 
  # Validate interface input
  # Must be an interface on the device AND NOT be the Management Interface
- while sel == MANAGEMENT_INTERFACE or not sel in [intf["name"] for intf in interfaces]:
+ while sel == args.interface or not sel in [intf["name"] for intf in interfaces]:
  print("INVALID: Select an available interface.")
- print(" " + MANAGEMENT_INTERFACE + " is used for management.")
+ print(" " + args.interface + " is used for management.")
  print(" Choose another Interface")
  sel = input("Which Interface do you want to configure? ")
 
@@ -142,12 +143,14 @@ def interface_selection(interfaces):
 def get_ip_info():
  # Ask User for IP and Mask
  ip = {}
- ip["address"] = input("What IP address do you want to set? ")
- ip["mask"] = input("What Subnet Mask do you want to set? ")
+ ip["address"] = do_input("What IP address do you want to set? ")
+ ip["mask"] = do_input("What Subnet Mask do you want to set? ")
  return(ip)
 
 
 def main():
+ global do_input
+
  """
  Simple main method calling our function.
  """
@@ -166,7 +169,7 @@ def main():
 
  # Print Starting Interface Details
  print("Starting Interface Configuration")
- print_interface_details(selected_interface)
+ print_interface_details(args, selected_interface)
 
  # As User for IP Address to set
  ip = get_ip_info()