env_var_demo1.py

#! /usr/bin/env python
"""Script to retrieve interface list using NETCONF

This script will retrieve information from a device.

Copyright (c) 2018 Cisco and/or its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""

import os
from ncclient import manager
import xmltodict

# Pull device information from Environment Variables
device = {
    "address": os.getenv("SBX_ADDRESS"),
    "username": os.getenv("SBX_USER"),
    "password": os.getenv("SBX_PASS"),
    "netconf_port": os.getenv("SBX_NETCONF_PORT"),
}

# Make sure all information available
if None in device.values():
    raise Exception("Missing key piece of data to connect to device")

# Connect to device with NETCONF
with manager.connect(
    host=device["address"],
    port=device["netconf_port"],
    username=device["username"],
    password=device["password"],
    hostkey_verify=False,
) as m:

    # NETCONF Filter to retrieve interface list
    filter = """
    <filter>
      <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces" />
    </filter>
    """

    # Send <get-config>
    r = m.get_config("running", filter)

# Get interface list from XML body
interfaces = xmltodict.parse(r.xml)["rpc-reply"]["data"]["interfaces"]["interface"]

# Print out interface list
print("Here are the interfaces from device {}".format(device["address"]))
for interface in interfaces:
    print(interface["name"])