sample_ztp_script.py

#!/usr/bin/env python

import sys
sys.path.append("/pkg/bin/")
from ztp_helper import ZtpHelpers
import json, tempfile
from pprint import pprint

class ZtpFunctions(ZtpHelpers):

    def set_root_user(self):
        # The hash for the password in config below translates to "lab"
        # So root-user credentials will be netops/lab
        config = """ !
                     username netops
                     group root-lr
                     group cisco-support
                     secret 5 $1$7kTu$zjrgqbgW08vEXsYzUycXw1
                     !
                     end"""



        with tempfile.NamedTemporaryFile(delete=True) as f:
            f.write("%s" % config)
            f.flush()
            f.seek(0)
            result = self.xrapply(f.name)

        if result["status"] == "error":

            self.syslogger.info("Failed to apply root user to system %s"+json.dumps(result))

        return result





if __name__ == "__main__":

    # Create an Object of the child class, syslog parameters are optional. 
    # If nothing is specified, then logging will happen to local log rotated file.

    ztp_script = ZtpFunctions(syslog_file="/root/ztp_python.log", syslog_server="11.11.11.2", syslog_port=514)

    print "\n###### Debugs enabled ######\n"

    # Enable verbose debugging to stdout/console. By default it is off
    ztp_script.toggle_debug(1)

    # Change context to XR VRF in the linux shell when needed. Depends on when user changes config to create network namespace.

    print "\n###### Change context to user specified VRF ######\n"
    ztp_script.set_vrf("global-vrf")



    # Use the child class methods
    print "\n###### Using Child class method, setting the root user ######\n"
    ztp_script.set_root_user()



    # Disable debugs
    print "\n###### Debugs Disabled ######\n"
    ztp_script.toggle_debug(0)

    # Show commands using Parent class helper method: xrcmd

    print "\n###### Executing a show command ######\n"
    pprint(ztp_script.xrcmd({"exec_cmd" :  "show running-config"}))


    # Config apply with file using Parent class helper method: xrapply

    print "\n###### Apply valid configuration using a file ######\n"
    config = """ !
                 hostname customer
                 !
                 cdp
                 !
                 end"""



    with tempfile.NamedTemporaryFile(delete=True) as f:
        f.write("%s" % config)
        f.flush()
        f.seek(0)
        print ztp_script.xrapply(f.name)

    # Config apply with string using Parent class helper method: xrapply_string

    print "\n###### Apply valid configuration using a string ######\n"
    out = ztp_script.xrapply_string("hostname customer2")
    pprint(out)

    # xrapply with atomic option enabled on a successful case
    with tempfile.NamedTemporaryFile(delete=True) as f:
        f.write("%s" % config)
        f.flush()
        f.seek(0)
        print ztp_script.xrapply(f.name, atomic=True)

    # Send syslogs to the preset syslog destinations (see above)

    print "\n###### Sending Syslogs to Server/file ######\n"
    ztp_script.syslogger.info("Hostname updated")
    ztp_script.syslogger.info(ztp_script.xrcmd({"exec_cmd" : "show running-config hostname"}))

    # Error handling
    print "\n###### Apply invalid configuration using a string ######\n"
    pprint(ztp_script.xrapply_string("hostnaime customer2"))

    # xrapply with atomic option enabled on a failure case
    config_negative = """key chain Bundle-Ether29-pri
             no macsec
             macsec
             key f9d3f4f01a50517afb0000000000000000000000000000000000000000000000
             key-string password 95157010155425f56085d070c751c1f5a4e077777777777777777777777774054435155545b5d515108074d41080e54515650045c5f07545e05004753010f5c53 cryptographic-algorithm aes-128-cmac
             """

    with tempfile.NamedTemporaryFile(delete=True) as f:
        f.write("%s" % config_negative)
        f.flush()
        f.seek(0)
        print ztp_script.xrapply(f.name, atomic=True)

    # HTTP file download
    print "\n###### Downloading file from HTTP server ######\n"
    print ztp_script.download_file(file_url='http://1.2.29.64/sj21-ddd-01-07/ztp.script',
                                   destination_folder='/disk0:/ztp/tmp')

    # HTTPS file download with certificate validation
    print "\n###### Downloading file from HTTPS server ######\n"
    print ztp_script.download_file(file_url='https://1.2.29.64:5000/get-report',
                                   destination_folder='/disk0:/ztp/tmp',
                                   ca_cert='/disk0:/ztp/tmp/cacert.pem')

    # HTTPS file download without certificate validation
    print "\n###### Downloading file from HTTPS server ######\n"
    print ztp_script.download_file(file_url='https://1.2.29.64:5000/get-report',
                                   destination_folder='/disk0:/ztp/tmp',
                                   validate_server=False)