├── env-setup.sh
├── lib
    └── netconify
    │   ├── constants.py
    │   ├── __init__.py
    │   ├── tty_telnet.py
    │   ├── tty_serial.py
    │   ├── facts.py
    │   ├── tty_ssh.py
    │   ├── tty_netconf.py
    │   ├── tty.py
    │   └── cmdo.py
├── tools
    └── netconify
├── .gitignore
├── COPYRIGHT
├── setup.py
├── README.md
└── LICENSE


/env-setup.sh:
--------------------------------------------------------------------------------
1 | export PYTHONPATH=`pwd`/lib:$PYTHONPATH
2 | export PATH=$PATH:`pwd`/tools
3 | 


--------------------------------------------------------------------------------
/lib/netconify/constants.py:
--------------------------------------------------------------------------------
1 | version = "1.0.3"
2 | date = "2016-March-17"
3 | author = "Jeremy Schulman, @nwkautomaniac"
4 | 


--------------------------------------------------------------------------------
/tools/netconify:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python
 2 | 
 3 | import sys
 4 | from netconify.cmdo import *
 5 | 
 6 | nc = netconifyCmdo()
 7 | results = nc.run()
 8 | 
 9 | if results['failed'] is True:
10 |     print results['errmsg']
11 |     sys.exit(1)
12 | 


--------------------------------------------------------------------------------
/lib/netconify/__init__.py:
--------------------------------------------------------------------------------
1 | from netconify.tty_serial import Serial
2 | from netconify.tty_telnet import Telnet
3 | from netconify.tty_ssh import SecureShell
4 | from netconify import constants as C
5 | 
6 | __version__ = C.version
7 | __date__ = C.date
8 | __author__ = C.author
9 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | *.py[cod]
 2 | 
 3 | # C extensions
 4 | *.so
 5 | 
 6 | # Packages
 7 | *.egg
 8 | *.egg-info
 9 | tests
10 | dist
11 | build
12 | eggs
13 | parts
14 | bin
15 | var
16 | sdist
17 | develop-eggs
18 | .installed.cfg
19 | lib64
20 | __pycache__
21 | 
22 | # Installer logs
23 | pip-log.txt
24 | 
25 | # Unit test / coverage reports
26 | .coverage
27 | .tox
28 | nosetests.xml
29 | 
30 | # Translations
31 | *.mo
32 | 
33 | # Mr Developer
34 | .mr.developer.cfg
35 | .project
36 | .pydevproject
37 | 


--------------------------------------------------------------------------------
/COPYRIGHT:
--------------------------------------------------------------------------------
 1 | # Copyright (c): 2014 
 2 | # Author: Jeremy Schulman, Juniper Networks, Inc.
 3 | # All Rights Reserved
 4 | # License: Apache 2.0 (see LICENSE file)
 5 | #
 6 | # YOU MUST ACCEPT THE TERMS OF THIS DISCLAIMER TO USE THIS SOFTWARE,
 7 | # IN ADDITION TO ANY OTHER LICENSES AND TERMS REQUIRED BY THE LICENSE.
 8 | #
 9 | # THE AUTHOR IS WILLING TO MAKE THE INCLUDED SOFTWARE AVAILABLE TO YOU ONLY 
10 | # UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN 
11 | # THIS DISCLAIMER. PLEASE READ THE TERMS AND CONDITIONS OF THIS DISCLAIMER
12 | # CAREFULLY.
13 | #
14 | # THE SOFTWARE CONTAINED IN THIS FILE IS PROVIDED "AS IS." THE AUTHOR MAKES NO
15 | # WARRANTIES OF ANY KIND WHATSOEVER WITH RESPECT TO SOFTWARE. ALL EXPRESS OR
16 | # IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY WARRANTY
17 | # OF NON-INFRINGEMENT OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR A
18 | # PARTICULAR PURPOSE, ARE HEREBY DISCLAIMED AND EXCLUDED TO THE EXTENT
19 | # ALLOWED BY APPLICABLE LAW.
20 | #
21 | # IN NO EVENT WILL THE AUTHOR BE LIABLE FOR ANY DIRECT OR INDIRECT DAMAGES,
22 | # INCLUDING BUT NOT LIMITED TO LOST REVENUE, PROFIT OR DATA, OR
23 | # FOR DIRECT, SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES
24 | # HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY ARISING OUT OF THE
25 | # USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF THE AUTHOR HAS BEEN ADVISED 
26 | # OF THE POSSIBILITY OF SUCH DAMAGES.


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | import os
 2 | import sys
 3 | from glob import glob
 4 | from setuptools import setup, find_packages
 5 | 
 6 | requirements = ['pyserial', 'lxml', 'paramiko']
 7 | 
 8 | setup(
 9 |     name="junos-netconify",
10 |     version="1.0.3",
11 |     author="Jeremy Schulman",
12 |     author_email="jnpr-community-netdev@juniper.net",
13 |     description=("Junos console/bootstrap automation"),
14 |     license="Apache 2.0",
15 |     keywords="Junos NETCONF basic CONSOLE automation",
16 |     url="http://www.github.com/Juniper/py-junos-netconify",
17 |     install_requires=requirements,
18 |     packages=find_packages('lib'),
19 |     package_dir={'': 'lib'},
20 |     scripts=['tools/netconify'],
21 |     classifiers=[
22 |         'Development Status :: 5 - Production/Stable',
23 |         'Environment :: Console',
24 |         'Intended Audience :: Developers',
25 |         'Intended Audience :: Information Technology',
26 |         'Intended Audience :: System Administrators',
27 |         'Intended Audience :: Telecommunications Industry',
28 |         'License :: OSI Approved :: Apache Software License',
29 |         'Operating System :: OS Independent',
30 |         'Programming Language :: Other Scripting Engines',
31 |         'Programming Language :: Python',
32 |         'Programming Language :: Python :: 2.6',
33 |         'Programming Language :: Python :: 2.7',
34 |         'Topic :: Software Development :: Libraries',
35 |         'Topic :: Software Development :: Libraries :: Application Frameworks',
36 |         'Topic :: Software Development :: Libraries :: Python Modules',
37 |         'Topic :: System :: Networking',
38 |         'Topic :: Text Processing :: Markup :: XML'
39 |     ],
40 | )
41 | 


--------------------------------------------------------------------------------
/lib/netconify/tty_telnet.py:
--------------------------------------------------------------------------------
 1 | from time import sleep
 2 | import telnetlib
 3 | 
 4 | from .tty import Terminal
 5 | 
 6 | # -------------------------------------------------------------------------
 7 | # Terminal connection over TELNET CONSOLE
 8 | # -------------------------------------------------------------------------
 9 | 
10 | 
11 | class Telnet(Terminal):
12 |     RETRY_OPEN = 3                # number of attempts to open TTY
13 |     RETRY_BACKOFF = 2             # seconds to wait between retries
14 | 
15 |     def __init__(self, host, port, **kvargs):
16 |         """
17 |         :host:
18 |           The hostname or ip-addr of the ternminal server
19 | 
20 |         :port:
21 |           The TCP port that maps to the TTY device on the
22 |           console server
23 | 
24 |         :kvargs['timeout']:
25 |           this is the tty read polling timeout.
26 |           generally you should not have to tweak this.
27 |         """
28 |         # initialize the underlying TTY device
29 | 
30 |         self._tn = telnetlib.Telnet()
31 |         self.host = host
32 |         self.port = port
33 |         self.timeout = kvargs.get('timeout', self.TIMEOUT)
34 |         self._tty_name = "{0}:{1}".format(host, port)
35 | 
36 |         Terminal.__init__(self, **kvargs)
37 | 
38 |     # -------------------------------------------------------------------------
39 |     # I/O open close called from Terminal class
40 |     # -------------------------------------------------------------------------
41 | 
42 |     def _tty_open(self):
43 |         retry = self.RETRY_OPEN
44 |         while retry > 0:
45 |             try:
46 |                 self._tn.open(self.host, self.port, self.timeout)
47 |                 break
48 |             except Exception as err:
49 |                 retry -= 1
50 |                 self.notify("TTY busy", "checking back in {0} ...".format(self.RETRY_BACKOFF))
51 |                 sleep(self.RETRY_BACKOFF)
52 |         else:
53 |             raise RuntimeError("open_fail: port not ready")
54 | 
55 |         self.write('\n')
56 | 
57 |     def _tty_close(self):
58 |         self._tn.close()
59 | 
60 |     # -------------------------------------------------------------------------
61 |     # I/O read and write called from Terminal class
62 |     # -------------------------------------------------------------------------
63 | 
64 |     def write(self, content):
65 |         """ write content + <ENTER> """
66 |         self._tn.write(content + '\n')
67 | 
68 |     def rawwrite(self, content):
69 |         """ write content as-is """
70 |         self._tn.write(content)
71 | 
72 |     def read(self):
73 |         """ read a single line """
74 |         return self._tn.read_until('\n', self.EXPECT_TIMEOUT)
75 | 
76 |     def read_prompt(self):
77 |         got = self._tn.expect(Terminal._RE_PAT, self.EXPECT_TIMEOUT)
78 |         sre = got[1]
79 | 
80 |         if 'in use' in got[2]:
81 |             raise RuntimeError("open_fail: port already in use")
82 | 
83 |         # (buffer, RE group)
84 |         return (None, None) if not got[1] else (got[2], got[1].lastgroup)
85 | 


--------------------------------------------------------------------------------
/lib/netconify/tty_serial.py:
--------------------------------------------------------------------------------
 1 | import serial
 2 | import re
 3 | from time import sleep
 4 | from datetime import datetime, timedelta
 5 | 
 6 | from .tty import Terminal
 7 | 
 8 | # -------------------------------------------------------------------------
 9 | # Terminal connection over SERIAL CONSOLE
10 | # -------------------------------------------------------------------------
11 | 
12 | _PROMPT = re.compile('|'.join(Terminal._RE_PAT))
13 | 
14 | 
15 | class Serial(Terminal):
16 | 
17 |     def __init__(self, port='/dev/ttyUSB0', **kvargs):
18 |         """
19 |         :port:
20 |           the serial port, defaults to USB0 since this
21 | 
22 |         :kvargs['timeout']:
23 |           this is the tty read polling timeout.
24 |           generally you should not have to tweak this.
25 |         """
26 |         # initialize the underlying TTY device
27 | 
28 |         self.port = port
29 |         self._ser = serial.Serial()
30 |         self._ser.port = port
31 |         self._ser.timeout = kvargs.get('timeout', self.TIMEOUT)
32 | 
33 |         self._tty_name = self.port
34 | 
35 |         Terminal.__init__(self, **kvargs)
36 | 
37 |     # -------------------------------------------------------------------------
38 |     # I/O open close called from Terminal class
39 |     # -------------------------------------------------------------------------
40 | 
41 |     def _tty_open(self):
42 |         try:
43 |             self._ser.open()
44 |         except OSError as err:
45 |             raise RuntimeError("open_failed:{0}".format(err.strerror))
46 |         self.write('\n\n\n')      # hit <ENTER> a few times, yo!
47 | 
48 |     def _tty_close(self):
49 |         self._ser.flush()
50 |         self._ser.close()
51 | 
52 |     # -------------------------------------------------------------------------
53 |     # I/O read and write called from Terminal class
54 |     # -------------------------------------------------------------------------
55 | 
56 |     def write(self, content):
57 |         """ write content + <RETURN> """
58 |         self._ser.write(content + '\n')
59 |         self._ser.flush()
60 | 
61 |     def rawwrite(self, content):
62 |         self._ser.write(content)
63 | 
64 |     def read(self):
65 |         """ read a single line """
66 |         return self._ser.readline()
67 | 
68 |     def read_prompt(self):
69 |         """
70 |         reads text from the serial console (using readline) until
71 |         a match is found against the :expect: regular-expression object.
72 |         When a match is found, return a tuple(<text>,<found>) where
73 |         <text> is the complete text and <found> is the name of the
74 |         regular-expression group. If a timeout occurs, then return
75 |         the tuple(None,None).
76 |         """
77 |         rxb = ''
78 |         mark_start = datetime.now()
79 |         mark_end = mark_start + timedelta(seconds=self.EXPECT_TIMEOUT)
80 | 
81 |         while datetime.now() < mark_end:
82 |             sleep(0.1)                          # do not remove
83 |             line = self._ser.readline()
84 |             if not line:
85 |                 continue
86 |             rxb += line
87 |             found = _PROMPT.search(rxb)
88 |             if found is not None:
89 |                 break         # done reading
90 |         else:
91 |             # exceeded the while loop timeout
92 |             return (None, None)
93 | 
94 |         return (rxb, found.lastgroup)
95 | 


--------------------------------------------------------------------------------
/lib/netconify/facts.py:
--------------------------------------------------------------------------------
 1 | import re
 2 | from lxml.builder import E
 3 | from lxml import etree
 4 | 
 5 | 
 6 | class Facts(object):
 7 | 
 8 |     def __init__(self, parent):
 9 |         self.rpc = parent.rpc
10 |         self.facts = {}
11 | 
12 |     @property
13 |     def items(self):
14 |         return self.facts
15 | 
16 |     def version(self):
17 |         rsp = self.rpc('get-software-information')
18 |         self.swinfo = rsp  # keep this since we may want it later
19 | 
20 |         # extract the version
21 |         # First try the <junos-version> tag present in >= 15.1
22 | 	swinfo = rsp.findtext('junos-version', default=None)
23 |         if not swinfo:
24 |             # For < 15.1, get version from the "junos" package.
25 |             pkginfo = rsp.xpath(
26 |                 './/package-information[normalize-space(name)="junos"]/comment'
27 |             )[0].text
28 |             try:
29 |                 swinfo = re.findall(r'\[(.*)\]', pkginfo)[0]
30 |             except:
31 |                 swinfo = "0.0I0.0"
32 |         self.facts['version'] = swinfo
33 | 
34 |         # extract the host-name
35 |         self.facts['hostname'] = rsp.xpath('.//host-name')[0].text
36 | 
37 |         # extract the product model/models
38 |         product_model = rsp.xpath('//product-model')
39 |         num_models = len(product_model)
40 |         if num_models == 0:
41 |             self.facts['model'] = None
42 |         elif num_models == 1:
43 |             self.facts['model'] = product_model[0].text.upper()
44 |         else:
45 |             fpc = lambda m: m.xpath('../../re-name')[0].text
46 |             self.facts['models'] = dict((fpc(m), m.text.upper()) for m in product_model)
47 | 
48 |     def chassis(self):
49 |         try:
50 |             # try to get the chassis inventory. this will fail if the device
51 |             # happens to be a QFX in 'node' mode, so use exception handling
52 |             rsp = self.rpc('get-chassis-inventory')
53 |             # keep this since we want to save the data to file
54 |             self.inventory = rsp
55 |             chas = rsp.find('chassis')
56 |             sn = chas.findtext('serial-number')
57 |             self.facts['model'] = chas.findtext('description').upper()
58 | 
59 |             # use the chassis level serial number, and if that doesn't exist
60 |             # look for the 'Backplane' serial number
61 |             self.facts['serialnumber'] = sn if sn is not None else \
62 |                 chas.xpath(
63 |                     'chassis-module[name="Backplane"]/serial-number')[0].text
64 |         except:
65 |             # basically this catches the case if the device is a QFX in node mode;
66 |             # the chassis-subsystem isn't running.  the hostname is the serial
67 |             # nubmer
68 |             self.facts['serialnumber'] = self.facts['hostname']
69 |             pass
70 | 
71 |     def eth(self, ifname):
72 |         cmd = E('get-interface-information',
73 |                 E.media(),
74 |                 E('interface-name', ifname))
75 | 
76 |         rsp = self.rpc(etree.tostring(cmd))[0]   # at physical-interface
77 |         facts = self.facts
78 | 
79 |         facts[ifname] = {}
80 |         facts[ifname]['macaddr'] = rsp.findtext('.//current-physical-address')
81 |         facts[ifname]['ifindex'] = rsp.findtext('snmp-index')
82 |         facts[ifname]['oper'] = rsp.findtext('oper-status')
83 |         facts[ifname]['admin'] = rsp.findtext('admin-status')
84 |         facts[ifname]['speed'] = rsp.findtext('speed')
85 |         facts[ifname]['duplex'] = rsp.findtext('duplex')
86 | 
87 |         return facts[ifname]
88 | 
89 |     def gather(self):
90 |         self.version()
91 |         self.chassis()
92 | 


--------------------------------------------------------------------------------
/lib/netconify/tty_ssh.py:
--------------------------------------------------------------------------------
  1 | from select import select
  2 | import paramiko
  3 | import re
  4 | import logging
  5 | from time import sleep, time
  6 | from .tty import Terminal
  7 | 
  8 | _PROMPT = re.compile('|'.join(Terminal._RE_PAT))
  9 | 
 10 | 
 11 | class SecureShell(Terminal):
 12 |     RETRY_BACKOFF = 2  # seconds to wait between retries
 13 |     SSH_LOGIN_RETRY = 1  # number off ssh login retry to console server
 14 |     SELECT_WAIT = 0.1
 15 |     RECVSZ = 1024
 16 | 
 17 |     def __init__(self, host, port, s_user, s_passwd, **kvargs):
 18 |         """
 19 |         Utility Constructor
 20 |         """
 21 |         self._ssh = paramiko.SSHClient()
 22 |         self._ssh.load_system_host_keys()
 23 |         self._ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 24 |         self._logger = logging.getLogger('paramiko.transport')
 25 |         self._logger.disabled = True
 26 |         self.host = host
 27 |         self.port = port
 28 |         self.s_user = s_user
 29 |         self.s_passwd = s_passwd
 30 |         self.timeout = kvargs.get('timeout', self.TIMEOUT)
 31 |         self.attempts = self.SSH_LOGIN_RETRY
 32 |         self._tty_name = "{0}:{1}:{2}:{3}".format(host, port, s_user, s_passwd)
 33 | 
 34 |         Terminal.__init__(self, **kvargs)
 35 | 
 36 |     def _tty_open(self):
 37 |         while True:
 38 |             try:
 39 |                 self._ssh.connect(hostname=self.host, port=int(self.port),
 40 |                                   username=self.s_user, password=self.s_passwd, timeout=self.timeout, allow_agent=False, look_for_keys=False)
 41 |                 break
 42 |             except paramiko.BadHostKeyException:
 43 |                 self.notify(
 44 |                     "SSH",
 45 |                     "Invalid host key for {0}".format(
 46 |                         self.host))
 47 |             except paramiko.AuthenticationException:
 48 |                 self.notify(
 49 |                     "SSH",
 50 |                     "Bad username or password when connecting to {0}".format(
 51 |                         self.host))
 52 |         else:
 53 |             raise RuntimeError("open_fail: ssh port not ready")
 54 | 
 55 |         self._chan = self._ssh.invoke_shell()
 56 |         self.write('\n')
 57 | 
 58 |     def write(self, data):
 59 |         """ write data + <ENTER> """
 60 |         self._chan.send(data)
 61 |         self._chan.send('\n')
 62 | 
 63 |     def rawwrite(self, data):
 64 |         """ write data only"""
 65 |         self._chan.send(data)
 66 | 
 67 |     def read(self):
 68 |         """
 69 |             read a single line
 70 |             this is and ugly hack to mimic serial and telnet which reads one byte at a time
 71 |         """
 72 |         gotr = []
 73 |         while True:
 74 |             data = self._chan.recv(1)
 75 |             if data is None or len(data) <= 0:
 76 |                 raise ValueError('Unable to detect device prompt')
 77 |             elif '\n' in data:
 78 |                 self._prompt = data.split('\n')[0].strip()
 79 |                 break
 80 |             else:
 81 |                 gotr.append(data)
 82 | 
 83 |         self._rt = ''.join(str(s) for s in gotr)
 84 |         return self._rt
 85 | 
 86 |     def _tty_close(self):
 87 |         """ Close the SSH client channel """
 88 |         self._chan.close()
 89 | 
 90 |     def read_prompt(self):
 91 |         got = []
 92 |         timeout = time() + 15.0
 93 | 
 94 |         while time() < timeout:
 95 |             sleep(0.1)
 96 |             rd, wr, err = select([self._chan], [], [], self.SELECT_WAIT)
 97 |             sleep(0.05)
 98 |             if rd:
 99 |                 data = self._chan.recv(self.RECVSZ)
100 |                 got.append(data)
101 |                 found = _PROMPT.search(data)
102 |                 if found is not None:
103 |                     break
104 |         else:
105 |             # exceeded the while loop timeout
106 |             raise RuntimeError(
107 |                 "Netconify Error: ssh could not find string Login:")
108 | 
109 |         return (got, found.lastgroup)


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | The repo is under active development.  If you take a clone, you are getting the latest, and perhaps not entirely stable code.
  2 | 
  3 | ## ABOUT
  4 | 
  5 | Junos console/bootstrap New-Out-Of-Box (NOOB) configuration automation. 
  6 | 
  7 | There are times when you MUST console into a Junos device to perform the NOOB configuration.  Generally this configuration is the bare minimum in takes to:
  8 | 
  9 |   * set the root password
 10 |   * set the host-name
 11 |   * set the management ipaddr
 12 |   * enable ssh and optionally NETCONF
 13 | 
 14 | The general use-case:
 15 | 
 16 | Primarily this library is used as a Console driver for the Junos Ansible Modules.
 17 | 
 18 | The `netconify` utility can be used perform configuration by logging into the serial console and pushing a configuration file to the device.
 19 | 
 20 | 
 21 | ## USAGE
 22 | 
 23 | ````
 24 | 
 25 | usage: netconify [-h] [--version] [-f JUNOS_CONF_FILE] [--merge] [--qfx-node]
 26 |                  [--qfx-switch] [--zeroize] [--shutdown {poweroff,reboot}]
 27 |                  [--facts] [--srx_cluster REQUEST_SRX_CLUSTER]
 28 |                  [--srx_cluster_disable] [-S [SAVEDIR]] [--no-save] [-p PORT]
 29 |                  [-b BAUD] [-t TELNET] [ -s SSH] [--timeout TIMEOUT] [-u USER]
 30 |                  [-P PASSWD] [-k] [-a ATTEMPTS]
 31 |                  [name]
 32 | 
 33 | positional arguments:
 34 |   name                  name of Junos device
 35 | 
 36 | optional arguments:
 37 |   -h, --help            show this help message and exit
 38 |   --version             show program's version number and exit
 39 |   --verbose VERBOSE     increase verbose levevel: 0 = default, 1 = login
 40 |                         debug, 2 = rpc reply debug
 41 | 
 42 | DEVICE options:
 43 |   -f JUNOS_CONF_FILE, --file JUNOS_CONF_FILE
 44 |                         Junos configuration file
 45 |   --merge               load-merge conf file, default is overwrite
 46 |   --qfx-node            Set QFX device into "node" mode
 47 |   --qfx-switch          Set QFX device into "switch" mode
 48 |   --zeroize             ZEROIZE the device
 49 |   --shutdown {poweroff,reboot}
 50 |                         SHUTDOWN or REBOOT the device
 51 |   --facts               Gather facts and save them into SAVEDIR
 52 |   --srx_cluster REQUEST_SRX_CLUSTER
 53 |                         cluster_id,node ... Invoke cluster on SRX device and
 54 |                         reboot
 55 |   --srx_cluster_disable
 56 |                         Disable cluster mode on SRX device and reboot
 57 | 
 58 | DIRECTORY options:
 59 |   -S [SAVEDIR], --savedir [SAVEDIR]
 60 |                         Files are saved into this directory, $CWD by default
 61 |   --no-save             Do not save facts and inventory files
 62 | 
 63 | CONSOLE options:
 64 |   -p PORT, --port PORT  serial port device
 65 |   -b BAUD, --baud BAUD  serial port baud rate
 66 |   -s SSH, --ssh SSH     ssh server, <host>,<port>,<user>,<password>
 67 |   -t TELNET, --telnet TELNET
 68 |                         terminal server, <host>,<port>
 69 |   --timeout TIMEOUT     TTY connection timeout (s)
 70 | 
 71 | LOGIN options:
 72 |   -u USER, --user USER  login user name, defaults to "root"
 73 |   -P PASSWD, --passwd PASSWD
 74 |                         login user password, *empty* for NOOB
 75 |   -k                    prompt for user password
 76 |   -a ATTEMPTS, --attempts ATTEMPTS
 77 |                         login attempts before giving up
 78 | ````
 79 | 
 80 | ## EXAMPLE
 81 | 
 82 | Junos NOOB devices can netconified:
 83 | 
 84 | ###Telnet:
 85 | ````
 86 | [rsherman@py-junos-netconify bin]$ ./netconify --telnet=host,23 -f host.conf
 87 | TTY:login:connecting to TTY:host:23 ...
 88 | TTY:login:logging in ...
 89 | TTY:login:starting NETCONF
 90 | conf:loading into device ...
 91 | conf:commit ... please be patient
 92 | conf:commit completed.
 93 | TTY:logout:logging out ...
 94 | ````
 95 | The above example is connecting to the host via telnet on port 23 and loading the configuration file specified.
 96 | ###SSH:
 97 | ````
 98 | r2600r@r2600r-mbp15 [~]netconify --facts --ssh=console-server,19876,c-user,pass123 -u user --passwd "pass123"
 99 | TTY:login:connecting to TTY:console-server:19876:c-user:pass123 ...
100 | TTY:login:logging to device ...
101 | TTY:login: OK ... starting NETCONF
102 | facts:retrieving device facts...
103 | facts:saving: ./cfwj-lab1-0011a-facts.json
104 | inventory:saving: ./cfwj-lab1-0011a-inventory.xml
105 | TTY:logout:logging out ...
106 | ````
107 | The above example is connecting to the host via ssh on port 19876 and gather device facts. Additonal options such as serial connectivity and device specific functions are identified in Usage. If ssh username and password for console are omited, -u/--passwd will be used instead for both console server authetication and device authetication --ssh=console-server,19876,, -u user --passwd "pass123"
108 | 
109 | 
110 | ## INSTALLATION
111 | 
112 | Installation requires Python 2.6 or 2.7 and associate `pip` tool
113 | 
114 |     pip install junos-netconify
115 | 	
116 | Installing from Git is also supported (OS must have git installed).
117 | 
118 | 	To install the latest MASTER code
119 | 	pip install git+https://github.com/Juniper/py-junos-netconify.git
120 | 	-or-
121 | 	To install a specific version, branch, tag, etc.
122 | 	pip install git+https://github.com/Juniper/py-junos-netconify.git@<branch,tag,commit>
123 | 	
124 | ## UPGRADE
125 | 
126 | Upgrading has the same requirements as installation and has the same format with the addition of -UPGRADE
127 | 
128 | 	pip install -U junos-netconify
129 | 
130 | ## DEPENDENCIES
131 | 
132 | This has been tested with Python 2.6 and 2.7.  The required modules are defined in `setup.py`.
133 | 
134 | ## LICENSE
135 | 
136 | Apache 2.0
137 |   
138 | ## CONTRIBUTORS
139 | 
140 |   - Jeremy Schulman (@nwkautomaniac), Core developer
141 |   - Rick Sherman (@shermdog01)
142 |   - Patrik Bok (@r2660r)
143 |   - Ashley Burston
144 | 


--------------------------------------------------------------------------------
/lib/netconify/tty_netconf.py:
--------------------------------------------------------------------------------
  1 | import re
  2 | import time
  3 | from . import cmdo
  4 | from lxml import etree
  5 | from lxml.builder import E
  6 | from datetime import datetime, timedelta
  7 | 
  8 | 
  9 | from .facts import Facts
 10 | 
 11 | __all__ = ['xmlmode_netconf']
 12 | 
 13 | _NETCONF_EOM = ']]>]]>'
 14 | _xmlns = re.compile('xmlns=[^>]+')
 15 | _xmlns_strip = lambda text: _xmlns.sub('', text)
 16 | _junosns = re.compile('junos:')
 17 | _junosns_strip = lambda text: _junosns.sub('', text)
 18 | 
 19 | # =========================================================================
 20 | # xmlmode_netconf
 21 | # =========================================================================
 22 | 
 23 | 
 24 | class tty_netconf(object):
 25 | 
 26 |     """
 27 |     Basic Junos XML API for bootstraping through the TTY
 28 |     """
 29 | 
 30 |     def __init__(self, tty):
 31 |         self._tty = tty
 32 |         self.hello = None
 33 |         self.facts = Facts(self)
 34 | 
 35 |     # -------------------------------------------------------------------------
 36 |     # NETCONF session open and close
 37 |     # -------------------------------------------------------------------------
 38 | 
 39 |     def open(self, at_shell):
 40 |         """ start the XML API process and receive the 'hello' message """
 41 | 
 42 |         nc_cmd = ('junoscript', 'xml-mode')[at_shell]
 43 |         self._tty.write(nc_cmd + ' netconf need-trailer')
 44 | 
 45 |         while True:
 46 |             time.sleep(0.1)
 47 |             line = self._tty.read()
 48 |             if line.startswith("<!--"):
 49 |                 break
 50 | 
 51 |         self.hello = self._receive()
 52 | 
 53 |     def close(self, force=False):
 54 |         """ issue the XML API to close the session """
 55 | 
 56 |         # if we do not have an open connection, then return now.
 57 |         if force is False:
 58 |             if self.hello is None:
 59 |                 return
 60 | 
 61 |         self.rpc('close-session')
 62 |         # removed flush
 63 | 
 64 |     # -------------------------------------------------------------------------
 65 |     # Junos OS configuration methods
 66 |     # -------------------------------------------------------------------------
 67 | 
 68 |     def load(self, content, **kvargs):
 69 |         """
 70 |         load-override a Junos 'conf'-style file into the device.  if the
 71 |         load is successful, return :True:, otherwise return the XML reply
 72 |         structure for further processing
 73 |         """
 74 |         action = kvargs.get('action', 'override')
 75 |         cmd = E('load-configuration', dict(format='text', action=action),
 76 |                 E('configuration-text', content)
 77 |                 )
 78 |         rsp = self.rpc(etree.tostring(cmd))
 79 |         return rsp if rsp.findtext('.//ok') is None else True
 80 | 
 81 |     def commit_check(self):
 82 |         """
 83 |         performs the Junos 'commit check' operation.  if successful return
 84 |         :True: otherwise return the response as XML for further processing.
 85 |         """
 86 |         rsp = self.rpc('<commit-configuration><check/></commit-configuration>')
 87 |         return True if 'ok' == rsp.tag else rsp
 88 | 
 89 |     def commit(self):
 90 |         """
 91 |         performs the Junos 'commit' operation.  if successful return
 92 |         :True: otherwise return the response as XML for further processing.
 93 |         """
 94 |         rsp = self.rpc('<commit-configuration/>')
 95 |         if 'ok' == rsp.tag:
 96 |             return True     # some devices use 'ok'
 97 |         if len(rsp.xpath('.//commit-success')) > 0:
 98 |             return True
 99 |         return rsp
100 | 
101 |     def rollback(self):
102 |         """ rollback that recent changes """
103 |         cmd = E('load-configuration', dict(compare='rollback', rollback="0"))
104 |         return self.rpc(etree.tostring(cmd))
105 | 
106 |     # -------------------------------------------------------------------------
107 |     # MISC device commands
108 |     # -------------------------------------------------------------------------
109 | 
110 |     def reboot(self, in_min=0):
111 |         """ issue a reboot to the device """
112 |         cmd = E('request-reboot', E('in', str(in_min)))
113 |         rsp = self.rpc(etree.tostring(cmd))
114 |         return True
115 | 
116 |     def poweroff(self, in_min=0):
117 |         """ issue a reboot to the device """
118 |         cmd = E('request-power-off', E('in', str(in_min)))
119 |         rsp = self.rpc(etree.tostring(cmd))
120 |         return True
121 | 
122 |     def zeroize(self):
123 |         """ issue a reboot to the device """
124 |         cmd = E.command('request system zeroize')
125 |         try:
126 |             rsp = self.rpc(etree.tostring(cmd))
127 |         except:
128 |             pass
129 |         return True
130 | 
131 |     def enablecluster(self, cluster_id, node):
132 |         """ issue request chassis cluster command """
133 |         cmd = E('set-chassis-cluster-enable',
134 |                 E('cluster-id',
135 |                   str(cluster_id)),
136 |                 E('node',
137 |                   str(node)),
138 |                 E('reboot'))
139 |         rsp = self.rpc(etree.tostring(cmd))
140 |         # device will be set to new cluster ID:NODE value
141 |         return True
142 | 
143 |     def disablecluster(self):
144 |         """ issue set chassis cluster disable to the device nad reboot """
145 |         cmd = E.command('set chassis cluster disable reboot')
146 |         rsp = self.rpc(etree.tostring(cmd))
147 |         # No need to check error exception, device will be rebooted even if not
148 |         # in cluster
149 |         return True
150 | 
151 |     def enablecluster(self, cluster_id, node):
152 |         """ issue request chassis cluster command """
153 |         cmd = E('set-chassis-cluster-enable',
154 |                 E('cluster-id',
155 |                   str(cluster_id)),
156 |                 E('node',
157 |                   str(node)),
158 |                 E('reboot'))
159 |         rsp = self.rpc(etree.tostring(cmd))
160 |         # device will be set to new cluster ID:NODE value
161 |         return True
162 | 
163 |     # -------------------------------------------------------------------------
164 |     # XML RPC command execution
165 |     # -------------------------------------------------------------------------
166 | 
167 |     def rpc(self, cmd):
168 |         """
169 |         Write the XML cmd and return the response as XML object.
170 | 
171 |         :cmd:
172 |           <str> of the XML command.  if the :cmd: is not XML, then
173 |           this routine will perform the brackets; i.e. if given
174 |           'get-software-information', this routine will turn
175 |           it into '<get-software-information/>'
176 | 
177 |         NOTES:
178 |           The return XML object is the first child element after
179 |           the <rpc-reply>.  There is also no error-checking
180 |           performing by this routine.
181 |         """
182 |         if not cmd.startswith('<'):
183 |             cmd = '<{0}/>'.format(cmd)
184 |         self._tty.rawwrite('<rpc>{0}</rpc>'.format(cmd))
185 |         rsp = self._receive()
186 |         try:
187 |             return rsp[0]  # return first child after the <rpc-reply>
188 |         except:
189 |             return etree.XML('<error-in-receive/>')
190 | 
191 |     # -------------------------------------------------------------------------
192 |     # LOW-LEVEL I/O for reading back XML response
193 |     # -------------------------------------------------------------------------
194 | 
195 |     def _receive(self):
196 |         """ process the XML response into an XML object """
197 |         rxbuf = []
198 |         while True:
199 |             line = self._tty.read().strip()
200 |             if cmdo.verbose == 2:
201 |                 print(line)  # enable to see received xml messages
202 |             if not line:
203 |                 continue  # if we got nothin, go again
204 |             if _NETCONF_EOM == line:
205 |                 break  # check for end-of-message
206 |             rxbuf.append(line)
207 | 
208 |         rxbuf[0] = _xmlns_strip(rxbuf[0])  # nuke the xmlns
209 |         rxbuf[1] = _xmlns_strip(rxbuf[1])  # nuke the xmlns
210 |         rxbuf = map(_junosns_strip, rxbuf)  # nuke junos: namespace
211 | 
212 |         try:
213 |             as_xml = etree.XML(''.join(rxbuf))
214 |             return as_xml
215 |         except:
216 |             if '</xnm:error>' in rxbuf:
217 |                 for x in rxbuf:
218 |                     if '<message>' in x:
219 |                         return etree.XML(
220 |                             '<error-in-receive>' + x + '</error-in-receive>')
221 |             else:
222 |                 return etree.XML('<error-in-receive/>')
223 | 


--------------------------------------------------------------------------------
/lib/netconify/tty.py:
--------------------------------------------------------------------------------
  1 | from time import sleep
  2 | from datetime import datetime, timedelta
  3 | from . import cmdo
  4 | 
  5 | from .tty_netconf import tty_netconf
  6 | 
  7 | __all__ = ['Terminal']
  8 | 
  9 | # =========================================================================
 10 | # Terminal class
 11 | # =========================================================================
 12 | 
 13 | 
 14 | class Terminal(object):
 15 | 
 16 |     """
 17 |     Terminal is used to bootstrap Junos New Out of the Box (NOOB) device
 18 |     over the CONSOLE port.  The general use-case is to setup the minimal
 19 |     configuration so that the device is IP reachable using SSH
 20 |     and NETCONF for remote management.
 21 | 
 22 |     Serial is needed for Junos devices that do not support
 23 |     the DHCP 'auto-installation' or 'ZTP' feature; i.e. you *MUST*
 24 |     to the NOOB configuration via the CONSOLE.
 25 | 
 26 |     Serial is also useful for situations even when the Junos
 27 |     device supports auto-DHCP, but is not an option due to the
 28 |     specific situation
 29 |     """
 30 |     TIMEOUT = 0.2           # serial readline timeout, seconds
 31 |     EXPECT_TIMEOUT = 10     # total read timeout, seconds
 32 |     LOGIN_RETRY = 20         # total number of passes thru login state-machine
 33 | 
 34 |     _ST_INIT = 0
 35 |     _ST_LOADER = 1
 36 |     _ST_LOGIN = 2
 37 |     _ST_PASSWD = 3
 38 |     _ST_DONE = 4
 39 |     _ST_BAD_PASSWD = 5
 40 |     _ST_TTY_NOLOGIN = 6
 41 | 
 42 |     _re_pat_login = '(?P<login>ogin:\s*$)'
 43 | 
 44 |     _RE_PAT = [
 45 |         '(?P<loader>oader>\s*$)',
 46 |         _re_pat_login,
 47 |         '(?P<passwd>assword:\s*$)',
 48 |         '(?P<badpasswd>ogin incorrect)',
 49 |         '(?P<shell>%|#\s*$)',
 50 |         '(?P<cli>[^\\-"]>\s*$)'
 51 |     ]
 52 | 
 53 |     # -----------------------------------------------------------------------
 54 |     # CONSTRUCTOR
 55 |     # -----------------------------------------------------------------------
 56 | 
 57 |     def __init__(self, **kvargs):
 58 |         """
 59 |         :kvargs['user']:
 60 |           defaults to 'root'
 61 | 
 62 |         :kvargs['passwd']:
 63 |           defaults to empty; NOOB Junos devics there is
 64 |           no root password initially
 65 | 
 66 |         :kvargs['attempts']:
 67 |           the total number of login attempts thru the login
 68 |           state-machine
 69 |         """
 70 |         # logic args
 71 |         self.user = kvargs.get('user', 'root')
 72 |         self.passwd = kvargs.get('passwd', '')
 73 |         self.c_user = kvargs.get('s_user', self.user)
 74 |         self.c_passwd = kvargs.get('s_passwd', self.passwd)
 75 |         self.login_attempts = kvargs.get('attempts') or self.LOGIN_RETRY
 76 | 
 77 |         # misc setup
 78 |         self.nc = tty_netconf(self)
 79 |         self.state = self._ST_INIT
 80 |         self.notifier = None
 81 |         self._badpasswd = 0
 82 |         self._loader = 0
 83 | 
 84 |     @property
 85 |     def tty_name(self):
 86 |         return self._tty_name
 87 | 
 88 |     def notify(self, event, message):
 89 |         if not self.notifier:
 90 |             return
 91 |         self.notifier(self, event, message)
 92 | 
 93 |     # -----------------------------------------------------------------------
 94 |     # Login/logout
 95 |     # -----------------------------------------------------------------------
 96 | 
 97 |     def login(self, notify=None):
 98 |         """
 99 |         open the TTY connection and login.  once the login is successful,
100 |         start the NETCONF XML API process
101 |         """
102 |         self.notifier = notify
103 |         self.notify('TTY', 'connecting to TTY:{0} ...'.format(self.tty_name))
104 |         self._tty_open()
105 | 
106 |         self.notify('TTY', 'logging in ...')
107 | 
108 |         self.state = self._ST_INIT
109 |         self._login_state_machine()
110 | 
111 |         # now start NETCONF XML
112 |         self.notify('TTY', ' OK ... starting NETCONF')
113 |         self.nc.open(at_shell=self.at_shell)
114 |         return True
115 | 
116 |     def logout(self):
117 |         """
118 |         cleanly logout of the TTY
119 |         """
120 |         self.notify('logout', 'logging out ...')
121 |         self.nc.close()
122 |         self._logout_state_machine()
123 |         return True
124 | 
125 |         # ---------------------------------------------------------------------
126 |         # TTY logout state-machine
127 |         # ---------------------------------------------------------------------
128 | 
129 |     def _logout_state_machine(self, attempt=0):
130 |         if 10 == attempt:
131 |             raise RuntimeError('logout_sm_failure')
132 | 
133 |         prompt, found = self.read_prompt()
134 | 
135 |         def _ev_login():
136 |             # back at login prompt, so we are cleanly done!
137 |             self._tty_close()
138 | 
139 |         def _ev_shell():
140 |             self.write('exit')
141 | 
142 |         def _ev_cli():
143 |             self.write('exit')
144 | 
145 |         _ev_tbl = {
146 |             'login': _ev_login,
147 |             'shell': _ev_shell,
148 |             'cli': _ev_cli
149 |         }
150 | 
151 |         _ev_tbl[found]()
152 | 
153 |         if found == 'login':
154 |             return True
155 |         else:
156 |             sleep(1)
157 |             self._logout_state_machine(attempt=attempt + 1)
158 | 
159 |     # -----------------------------------------------------------------------
160 |     # TTY login state-machine
161 |     # -----------------------------------------------------------------------
162 |     def _login_state_machine(self, attempt=0):
163 |         if self.login_attempts == attempt:
164 |             raise RuntimeError('login_sm_failure')
165 | 
166 |         prompt, found = self.read_prompt()
167 | 
168 |         if cmdo.verbose == 1:
169 |             self.notify('\nDEBUG:current state', "{0}".format(self.state))
170 |             self.notify('DEBUG:login', "IN:{0}:`{1}`".format(found, prompt))
171 |             self.notify('DEBUG:password', "{0}".format(self.passwd))
172 |             self.notify('DEBUG:attempt', "{0}".format(attempt))
173 | 
174 |         def _ev_loader():
175 |             self.state = self._ST_LOADER
176 |             self.write('boot')
177 |             self.write('\n')
178 |             sleep(300)
179 |             self._login_state_machine(attempt=0)
180 |             self._loader += 1
181 |             if self._loader == 2:
182 |                 raise RuntimeError("propably corrupted image, stuck in loader")
183 | 
184 |         def _ev_login():
185 |             self.state = self._ST_LOGIN
186 |             self.write(self.user)
187 | 
188 |         def _ev_passwd():
189 |             self.state = self._ST_PASSWD
190 |             self.write(self.passwd)
191 | 
192 |         def _ev_bad_passwd():
193 |             self.state = self._ST_BAD_PASSWD
194 |             self.write('\n')
195 |             self._badpasswd += 1
196 |             # if self._badpasswd == 3:
197 |             #     self.passwd = 'pass123'
198 |             if self._badpasswd == 5:
199 |                 raise RuntimeError("bad_passwd")
200 |             # return through and try again ... could have been
201 |             # prior failed attempt
202 | 
203 |         def _ev_tty_nologin():
204 |             if self._ST_INIT == self.state:
205 |                 # assume we're in a hung state, i.e. we don't see
206 |                 # a login prompt for whatever reason
207 |                 self.state = self._ST_TTY_NOLOGIN
208 |                 self.write('<close-session/>')  # @@@ this is a hack
209 |                 # if console connection have a banner or warning
210 |                 # comment-out line above and uncoment lines bellow ... better hack
211 |                 # sleep(5)
212 |                 # self.write('\n')
213 | 
214 |         def _ev_shell():
215 |             if self.state == self._ST_INIT:
216 |                 # this means that the shell was left
217 |                 # open.  probably not a good thing,
218 |                 # so issue a notify, but move on.
219 |                 self.notify('login_warn', 'shell login was open!')
220 | 
221 |             self.at_shell = True
222 |             self.state = self._ST_DONE
223 |             # if we are here, then we are done
224 | 
225 |         def _ev_cli():
226 |             if self.state == self._ST_INIT:
227 |                 # this means that the shell was left open.  probably not a good thing,
228 |                 # so issue a notify, hit <ENTER> and try again just to be
229 |                 # sure...
230 |                 self.notify('login_warn', 'waiting on TTY.')
231 |                 sleep(5)
232 |                 #  return
233 | 
234 |             self.at_shell = False
235 |             self.state = self._ST_DONE
236 | 
237 |         _ev_tbl = {
238 |             'loader': _ev_loader,
239 |             'login': _ev_login,
240 |             'passwd': _ev_passwd,
241 |             'badpasswd': _ev_bad_passwd,
242 |             'shell': _ev_shell,
243 |             'cli': _ev_cli
244 |         }
245 | 
246 |         _ev_tbl.get(found, _ev_tty_nologin)()
247 | 
248 |         if self.state == self._ST_DONE:
249 |             return True
250 |         else:
251 |             # if we are here, then loop the event again
252 |             self._login_state_machine(attempt + 1)
253 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    Copyright 2013 Juniper Networks, Inc.
180 | 
181 |    Licensed under the Apache License, Version 2.0 (the "License");
182 |    you may not use this file except in compliance with the License.
183 |    You may obtain a copy of the License at
184 | 
185 |        http://www.apache.org/licenses/LICENSE-2.0
186 | 
187 |    Unless required by applicable law or agreed to in writing, software
188 |    distributed under the License is distributed on an "AS IS" BASIS,
189 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190 |    See the License for the specific language governing permissions and
191 |    limitations under the License.
192 | 


--------------------------------------------------------------------------------
/lib/netconify/cmdo.py:
--------------------------------------------------------------------------------
  1 | """
  2 | This file defines the 'netconifyCmdo' class.
  3 | Used by the 'netconify' shell utility.
  4 | """
  5 | import os
  6 | import sys
  7 | import json
  8 | import re
  9 | import argparse
 10 | import logging
 11 | import traceback
 12 | from ConfigParser import SafeConfigParser
 13 | from getpass import getpass
 14 | from lxml import etree
 15 | import traceback
 16 | 
 17 | import netconify
 18 | import netconify.constants as C
 19 | 
 20 | # only export the netconifyCmdo class definition
 21 | __all__ = ['netconifyCmdo']
 22 | 
 23 | QFX_MODEL_LIST = ['QFX3500', 'QFX3600', 'VIRTUAL CHASSIS']
 24 | QFX_MODE_NODE = 'NODE'
 25 | QFX_MODE_SWITCH = 'SWITCH'
 26 | verbose = 0
 27 | 
 28 | 
 29 | class netconifyCmdo(object):
 30 | 
 31 |     # -------------------------------------------------------------------------
 32 |     # CONSTRUCTOR
 33 |     # -------------------------------------------------------------------------
 34 | 
 35 |     def __init__(self, **kvargs):
 36 |         """
 37 |         kvargs['notify']
 38 |           event notify callback
 39 |         """
 40 | 
 41 |         #
 42 |         # private attributes
 43 |         #
 44 |         self._name = None
 45 |         self._tty = None
 46 |         self._skip_logout = False
 47 |         self.on_notify = kvargs.get('notify', None)
 48 | 
 49 |         #
 50 |         # do stuff in the constructor
 51 |         #
 52 |         self._init_argsparser()
 53 | 
 54 |         #
 55 |         # public attributes
 56 |         #
 57 |         self.facts = None
 58 |         self.results = dict(changed=False, failed=False, errmsg=None)
 59 | 
 60 |     # -------------------------------------------------------------------------
 61 |     # Command Line Arguments Parser
 62 |     # -------------------------------------------------------------------------
 63 | 
 64 |     def _init_argsparser(self):
 65 |         p = argparse.ArgumentParser(add_help=True)
 66 |         self._argsparser = p
 67 | 
 68 |         # ---------------------------------------------------------------------
 69 |         # input identifiers
 70 |         # ---------------------------------------------------------------------
 71 | 
 72 |         p.add_argument('name',
 73 |                        nargs='?',
 74 |                        help='name of Junos device')
 75 | 
 76 |         p.add_argument('--version', action='version', version=C.version)
 77 | 
 78 |         p.add_argument('--verbose',
 79 |                        type=int, default=0,
 80 |                        help="increase verbose levevel: 0 = default, 1 = login debug, 2 = rpc reply debug")
 81 | 
 82 |         # ---------------------------------------------------------------------
 83 |         # Device level options
 84 |         # ---------------------------------------------------------------------
 85 | 
 86 |         g = p.add_argument_group('DEVICE options')
 87 | 
 88 |         g.add_argument('-f', '--file',
 89 |                        dest='junos_conf_file',
 90 |                        help="Junos configuration file")
 91 | 
 92 |         g.add_argument("--merge",
 93 |                        dest='junos_merge_conf',
 94 |                        help='load-merge conf file, default is overwrite',
 95 |                        action='store_true')
 96 | 
 97 |         g.add_argument('--qfx-node',
 98 |                        dest='qfx_mode',
 99 |                        action='store_const', const=QFX_MODE_NODE,
100 |                        help='Set QFX device into "node" mode')
101 | 
102 |         g.add_argument('--qfx-switch',
103 |                        dest='qfx_mode',
104 |                        action='store_const', const=QFX_MODE_SWITCH,
105 |                        help='Set QFX device into "switch" mode')
106 | 
107 |         g.add_argument('--zeroize',
108 |                        dest='request_zeroize',
109 |                        action='store_true',
110 |                        help='ZEROIZE the device')
111 | 
112 |         g.add_argument('--shutdown',
113 |                        dest='request_shutdown',
114 |                        choices=['poweroff', 'reboot'],
115 |                        help='SHUTDOWN or REBOOT the device')
116 | 
117 |         g.add_argument('--facts',
118 |                        action='store_true',
119 |                        dest='gather_facts',
120 |                        help='Gather facts and save them into SAVEDIR')
121 | 
122 |         g.add_argument('--srx_cluster',
123 |                        dest='request_srx_cluster',
124 |                        help='cluster_id,node ... Invoke cluster on SRX device and reboot')
125 | 
126 |         g.add_argument('--srx_cluster_disable',
127 |                        dest='request_srx_cluster_dis',
128 |                        action='store_true',
129 |                        help='Disable cluster mode on SRX device and reboot')
130 | 
131 |         # ---------------------------------------------------------------------
132 |         # directories
133 |         # ---------------------------------------------------------------------
134 | 
135 |         g = p.add_argument_group('DIRECTORY options')
136 | 
137 |         g.add_argument('-S', '--savedir',
138 |                        nargs='?', default='.',
139 |                        help="Files are saved into this directory, $CWD by default")
140 | 
141 |         g.add_argument('--no-save',
142 |                        action='store_true',
143 |                        help="Do not save facts and inventory files")
144 | 
145 |         # ---------------------------------------------------------------------
146 |         # console port
147 |         # ---------------------------------------------------------------------
148 | 
149 |         g = p.add_argument_group('CONSOLE options')
150 | 
151 |         g.add_argument('-p', '--port',
152 |                        default='/dev/ttyUSB0',
153 |                        help="serial port device")
154 | 
155 |         g.add_argument('-b', '--baud',
156 |                        default='9600',
157 |                        help="serial port baud rate")
158 | 
159 |         g.add_argument('-t', '--telnet',
160 |                        help='terminal server, <host>,<port>')
161 | 
162 |         g.add_argument('--timeout',
163 |                        default='0.5',
164 |                        help='TTY connection timeout (s)')
165 | 
166 |         # ---------------------------------------------------------------------
167 |         # login configuration
168 |         # ---------------------------------------------------------------------
169 | 
170 |         g = p.add_argument_group("LOGIN options")
171 | 
172 |         g.add_argument('-u', '--user',
173 |                        default='root',
174 |                        help='login user name, defaults to "root"')
175 | 
176 |         g.add_argument('-P', '--passwd',
177 |                        default='',
178 |                        help='login user password, *empty* for NOOB')
179 | 
180 |         g.add_argument('-k',
181 |                        action='store_true', default=False,
182 |                        dest='passwd_prompt',
183 |                        help='prompt for user password')
184 | 
185 |         g.add_argument('-a', '--attempts',
186 |                        default=10,
187 |                        help='login attempts before giving up')
188 | 
189 |         g.add_argument('-s', '--ssh',
190 |                        help='ssh server, <host>,<port>,<user>,<password>')
191 | 
192 |     # -------------------------------------------------------------------------
193 |     # run command, can be involved from SHELL or programmatically
194 |     # -------------------------------------------------------------------------
195 | 
196 |     def run(self, args=None):
197 | 
198 |         # ------------------------
199 |         # parse command arguments
200 |         # ------------------------
201 | 
202 |         try:
203 |             # parse command arguments
204 |             self._args = self._argsparser.parse_args(args)
205 |             self._name = self._args.name
206 |         except Exception as err:
207 |             self._hook_exception('parse_args', err)
208 | 
209 |         args = self._args  # alias
210 | 
211 |         # ---------------------------------------------------------------
212 |         # validate device hostname or IP address
213 |         # ---------------------------------------------------------------
214 | 
215 |         # if self._name is None:
216 |         #     self.results['failed'] = True
217 |         #     self.results['errmsg'] = 'ERROR: Device hostname/IP not specified !!!'
218 |         #     return self.results
219 | 
220 |         global verbose
221 |         debug = args.verbose
222 |         if debug == 1:  # DEBUG LOGIN LEVEL
223 |             verbose = 1
224 |         elif debug == 2:  # DEBUG RPC REPLY
225 |             verbose = 2
226 | 
227 |         # ----------------------------------
228 |         # handle password input if necessary
229 |         # ----------------------------------
230 | 
231 |         if args.passwd_prompt is True:
232 |             args.passwd = getpass()
233 | 
234 |         # ---------------------------------------------------------------
235 |         # validate command options before going through the LOGIN process
236 |         # ---------------------------------------------------------------
237 | 
238 |         fname = args.junos_conf_file
239 |         if fname is not None:
240 |             if os.path.isfile(fname) is False:
241 |                 self.results['failed'] = True
242 |                 self.results[
243 |                     'errmsg'] = 'ERROR: unknown file: {0}'.format(fname)
244 |                 return self.results
245 | 
246 |         # --------------------
247 |         # login to the CONSOLE
248 |         # --------------------
249 | 
250 |         try:
251 |             self._tty_login()
252 |         except Exception as err:
253 |             self._hook_exception('login', err)
254 | 
255 |         # ----------------------------------------------------
256 |         # now deal with the various actions/options provided
257 |         # by the command args
258 |         # -----------------------------------------------------
259 | 
260 |         try:
261 |             self._do_actions()
262 |         except Exception as err:
263 |             try:
264 |                 self._tty_logout()
265 |             except Exception as logout_err:
266 |                 self._hook_exception('ERROR', "{0}\n".format(str(logout_err)))
267 |             traceback.print_exc()
268 |             self._hook_exception('action', err)
269 | 
270 |         # ----------------------------------------------------
271 |         # logout, unless we don't need to (due to reboot,etc.)
272 |         # -----------------------------------------------------
273 | 
274 |         if self._skip_logout is False:
275 |             try:
276 |                 self._tty_logout()
277 |             except Exception as err:
278 |                 self._hook_exception('logout', err)
279 |         else:
280 |             try:
281 |                 self._tty._tty_close()
282 |             except Exception as err:
283 |                 self._hook_exception('close', err)
284 | 
285 |         return self.results
286 | 
287 |     # -------------------------------------------------------------------------
288 |     # Handlers
289 |     # -------------------------------------------------------------------------
290 | 
291 |     def _hook_exception(self, event, err):
292 |         self._notify("ERROR", "{0}:{1}\n".format(event, str(err)))
293 |         raise
294 | 
295 |     def _tty_notifier(self, tty, event, message):
296 |         self._notify("{0}".format(event), message)
297 | 
298 |     def _notify(self, event, message):
299 |         if self.on_notify is not None:
300 |             self.on_notify(self, event, message)
301 |         elif self.on_notify is not False:
302 |             print "{0}:{1}".format(event, message)
303 | 
304 |     # -------------------------------------------------------------------------
305 |     # LOGIN/LOGOUT
306 |     # -------------------------------------------------------------------------
307 | 
308 |     def _tty_login(self):
309 | 
310 |         tty_args = {}
311 |         tty_args['user'] = self._args.user
312 |         tty_args['passwd'] = self._args.passwd
313 |         tty_args['timeout'] = float(self._args.timeout)
314 |         tty_args['attempts'] = int(self._args.attempts)
315 | 
316 |         if self._args.telnet is not None:
317 |             host, port = re.split('[,:]', self._args.telnet)
318 |             tty_args['host'] = host
319 |             tty_args['port'] = port
320 |             self.console = ('telnet', host, port)
321 |             self._tty = netconify.Telnet(**tty_args)
322 |         elif self._args.ssh is not None:
323 |             host, port, s_user, s_passwd = re.split('[,:]', self._args.ssh)
324 |             tty_args['host'] = host
325 |             tty_args['port'] = port
326 |             tty_args['s_user'] = s_user or self._args.user
327 |             tty_args['s_passwd'] = s_passwd or self._args.passwd
328 |             self.console = ('ssh', host, port, s_user, s_passwd)
329 |             self._tty = netconify.SecureShell(**tty_args)
330 |         else:
331 |             tty_args['port'] = self._args.port
332 |             tty_args['baud'] = self._args.baud
333 |             self.console = ('serial', self._args.port)
334 |             self._tty = netconify.Serial(**tty_args)
335 | 
336 |         notify = self.on_notify or self._tty_notifier
337 |         self._tty.login(notify=notify)
338 | 
339 |     def _tty_logout(self):
340 |         self._tty.logout()
341 | 
342 |     # -------------------------------------------------------------------------
343 |     # ACTIONS
344 |     # -------------------------------------------------------------------------
345 |     def _do_actions(self):
346 |         args = self._args  # alias
347 | 
348 |         if args.request_srx_cluster is not None:
349 |             self._srx_cluster()
350 |             return
351 | 
352 |         if args.request_srx_cluster_dis:
353 |             self._srx_cluster_disable()
354 |             return
355 | 
356 |         if args.request_shutdown:
357 |             self._shutdown()
358 |             return
359 | 
360 |         if args.request_zeroize:
361 |             self._zeroize()
362 |             return
363 | 
364 |         if args.gather_facts is True:
365 |             self._gather_facts()
366 |             self._save_facts_json()
367 |             self._save_inventory_xml()
368 | 
369 |         if args.junos_conf_file is not None:
370 |             self._push_config()
371 |         if args.qfx_mode is not None:
372 |             self._qfx_mode()
373 | 
374 |     def _srx_cluster(self):
375 |         """ Enable cluster mode on SRX device"""
376 |         srx_args = {}
377 |         cluster_id, node = re.split('[:,]', self._args.request_srx_cluster)
378 |         srx_args['cluster_id'] = cluster_id
379 |         srx_args['node'] = node
380 |         self._notify('srx_cluster', 'set device to cluster mode, rebooting')
381 |         self._notify('srx_cluster', 'Cluster ID: {0}'.format(cluster_id))
382 |         self._notify('srx_cluster', 'Node: {0}'.format(node))
383 |         self._tty.nc.enablecluster(cluster_id, node)
384 |         self._skip_logout = True
385 |         self.results['changed'] = True
386 | 
387 |     def _srx_cluster_disable(self):
388 |         """ Disable cluster mode on SRX device"""
389 |         self._notify(
390 |             'srx_cluster',
391 |             'disable cluster mode on srx device, rebooting')
392 |         self._tty.nc.disablecluster()
393 |         self._skip_logout = True
394 |         self.results['changed'] = True
395 | 
396 |     def _zeroize(self):
397 |         """ perform device ZEROIZE actions """
398 |         self._notify('zeroize', 'ZEROIZE device, rebooting')
399 |         self._tty.nc.zeroize()
400 |         self._skip_logout = True
401 |         self.results['changed'] = True
402 | 
403 |     def _shutdown(self):
404 |         """ shutdown or reboot """
405 |         self._skip_logout = True
406 |         mode = self._args.request_shutdown
407 |         self._notify('shutdown', 'shutdown {0}'.format(mode))
408 |         nc = self._tty.nc
409 |         shutdown = nc.poweroff if 'poweroff' == mode else nc.reboot
410 |         shutdown()
411 |         self._skip_logout = True
412 |         self.results['changed'] = True
413 | 
414 |     def _save_facts_json(self):
415 |         if self._args.no_save is True:
416 |             self._notify('facts', '{0}'.format(self.facts))
417 |             return
418 |         fname = self._save_name + '-facts.json'
419 |         path = os.path.join(self._args.savedir, fname)
420 |         self._notify('facts', 'saving: {0}'.format(path))
421 |         try:
422 |             with open(path, 'w+') as f:
423 |                 f.write(json.dumps(self.facts))
424 |         except:
425 |             raise RuntimeError(
426 |                 "Netconify Error: can not write file, check directory persmissions")
427 | 
428 |     def _save_inventory_xml(self):
429 |         if self._args.no_save is True:
430 |             return
431 |         if not hasattr(self._tty.nc.facts, 'inventory'):
432 |             return
433 | 
434 |         fname = self._save_name + '-inventory.xml'
435 |         path = os.path.join(self._args.savedir, fname)
436 |         self._notify('inventory', 'saving: {0}'.format(path))
437 |         as_xml = etree.tostring(
438 |             self._tty.nc.facts.inventory, pretty_print=True)
439 |         with open(path, 'w+') as f:
440 |             f.write(as_xml)
441 | 
442 |     def _gather_facts(self):
443 |         self._notify('facts', 'retrieving device facts...')
444 |         self._tty.nc.facts.gather()
445 |         self.facts = self._tty.nc.facts.items
446 |         self.results['facts'] = self.facts
447 |         self._save_name = self._name or self.facts[
448 |             'hostname'] or '_'.join(self.console)
449 | 
450 |     def _push_config(self):
451 |         """ push the configuration or rollback changes on error """
452 | 
453 |         self._notify('conf', 'loading into device ...')
454 |         content = open(self._args.junos_conf_file, 'r').read()
455 |         load_args = dict(content=content)
456 |         if self._args.junos_merge_conf is True:
457 |             load_args['action'] = 'replace'  # merge/replace; yeah, I know ...
458 |         rc = self._tty.nc.load(**load_args)
459 | 
460 |         if rc is not True:
461 |             self.results['failed'] = True
462 |             self.results['errmsg'] = 'failure to load configuration, aborting.'
463 |             self._notify('conf_ld_err', self.results['errmsg'])
464 |             self._tty.nc.rollback()
465 |             return
466 | 
467 |         self._notify('conf', 'commit ... please be patient')
468 |         rc = self._tty.nc.commit()
469 |         if rc is not True:
470 |             self.results['failed'] = True
471 |             self.results[
472 |                 'errmsg'] = 'faiure to commit configuration, aborting.'
473 |             self._notify('conf_save_err', self.results['errmsg'])
474 |             self._tty.nc.rollback()
475 |             return
476 | 
477 |         self._notify('conf', 'commit completed.')
478 |         self.results['changed'] = True
479 |         return
480 | 
481 |     # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
482 |     # -------------------------------------------------------------------------
483 |     # QFX MODE processing
484 |     # -------------------------------------------------------------------------
485 |     # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
486 |     def _qfx_mode(self):
487 | 
488 |         # ----------------------------------------------------
489 |         # we need the facts, so if the caller didn't explicity
490 |         # request them, grab them now
491 |         # ----------------------------------------------------
492 | 
493 |         if self.facts is None:
494 |             self._gather_facts()
495 |         facts = self.facts  # alias
496 | 
497 |         # --------------------------------------------------------
498 |         # make sure we're logged into a QFX node device.
499 |         # set this up as a list check in case we have other models
500 |         # in the future to deal with.
501 |         # --------------------------------------------------------
502 | 
503 |         if not any([facts['model'].startswith(m) for m in QFX_MODEL_LIST]):
504 |             self.results['errmsg'] = "Not on a QFX device [{0}]".format(
505 |                 facts['model'])
506 |             self.results['failed'] = True
507 |             self._save_facts_json()
508 |             self._save_inventory_xml()
509 |             self.results['facts'] = self.facts
510 |             self._notify('qfx', self.results['errmsg'])
511 |             return
512 | 
513 |         now, later = self._qfx_device_mode_get()
514 |         # compare to after-reoobt
515 |         change = bool(later != self._args.qfx_mode)
516 |         reboot = bool(now != self._args.qfx_mode)       # compare to now
517 | 
518 |         if now == QFX_MODE_SWITCH and change is True:   # flipping to NODE
519 |             # --------------------------------------------------------
520 |             # we want to revert the facts information from the 'FPC 0'
521 |             # inventory, rather than the chassis, and re-save the facts
522 |             # --------------------------------------------------------
523 |             inv = self._tty.nc.facts.inventory
524 |             fpc0 = inv.xpath('chassis/chassis-module[name="FPC 0"]')[0]
525 |             facts['serialnumber'] = fpc0.findtext('serial-number')
526 |             facts['model'] = fpc0.findtext('model-number')
527 | 
528 |         self._save_facts_json()
529 |         self._save_inventory_xml()
530 |         self.results['facts'] = self.facts
531 | 
532 |         self._notify('info', "QFX mode now/later: {0}/{1}".format(now, later))
533 |         if now == later and later == self._args.qfx_mode:
534 |             # nothing to do
535 |             self._notify('info', 'No change required')
536 |         else:
537 |             self._notify('info', 'Action required')
538 | 
539 |         if change is True:
540 |             self._notify('change',
541 |                          'Changing the mode to: {0}'.format(self._args.qfx_mode))
542 |             self.results['changed'] = True
543 |             self._qfx_device_mode_set()
544 | 
545 |         if reboot is True:
546 |             self._notify('change', 'REBOOTING device now!')
547 |             self.results['changed'] = True
548 |             self._tty.nc.reboot()
549 |             # no need to close the tty, since the device is rebooting ...
550 |             self._skip_logout = True
551 | 
552 |     # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
553 |     # -------------------------------------------------------------------------
554 |     # MISC device RPC commands & controls
555 |     # -------------------------------------------------------------------------
556 |     # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
557 | 
558 |     # the following are the mode status string retrieved from NETCONF command
559 |     # to determine the current mode
560 | 
561 |     _QFX_MODES = {
562 |         'Standalone': QFX_MODE_SWITCH,
563 |         'Node-device': QFX_MODE_NODE
564 |     }
565 | 
566 |     # the following are the mode options inserted into the NETCONF command
567 |     # to change the mode
568 | 
569 |     _QFX_XML_MODES = {
570 |         QFX_MODE_SWITCH: 'standalone',
571 |         QFX_MODE_NODE: 'node-device'
572 |     }
573 | 
574 |     def _qfx_device_mode_get(self):
575 |         """ get the current device mode """
576 |         rpc = self._tty.nc.rpc
577 |         got = rpc('show-chassis-device-mode')
578 |         now = got.findtext('device-mode-current')
579 |         later = got.findtext('device-mode-after-reboot')
580 |         return (self._QFX_MODES[now], self._QFX_MODES[later])
581 | 
582 |     def _qfx_device_mode_set(self):
583 |         """ sets the device mode """
584 |         rpc = self._tty.nc.rpc
585 |         mode = self._QFX_XML_MODES[self._args.qfx_mode]
586 |         cmd = '<request-chassis-device-mode><{0}/></request-chassis-device-mode>'.format(
587 |             mode)
588 |         got = rpc(cmd)
589 |         return True
590 | 


--------------------------------------------------------------------------------