Merge remote-tracking branch 'upstream/master'

Author: rsmekala

.dockerignore

@@ -0,0 +1,8 @@
+.travis.yml
+ISSUE_TEMPLATE.md
+docs/
+test/
+tools/
+COPYRIGHT
+env-setup
+.vscode

.gitignore

@@ -53,3 +53,6 @@ desktop.ini
 
 # PyCharm
 .idea
+
+# VC Code
+.vscode

Dockerfile

@@ -1,38 +1,26 @@
 FROM juniper/pyez:latest
-MAINTAINER Stephen Steiner <ssteiner@juniper.net>
 
-ARG ver_ansible=2.4.0.0
-ARG ver_jsnapy=1.2.1
+LABEL net.juniper.image.maintainer="Stephen Steiner <ssteiner@juniper.net>"
 
 WORKDIR /tmp
-RUN mkdir /tmp/ansible-junos-stdlib &&\
-    mkdir /tmp/ansible-junos-stdlib/library &&\
-    mkdir /tmp/ansible-junos-stdlib/meta &&\
-    mkdir /project
-
-ADD action_plugins /tmp/ansible-junos-stdlib/action_plugins
-ADD callback_plugins /tmp/ansible-junos-stdlib/callback_plugins
-ADD library /tmp/ansible-junos-stdlib/library
-ADD LICENSE /tmp/ansible-junos-stdlib/LICENSE
-ADD meta /tmp/ansible-junos-stdlib/meta
-ADD module_utils /tmp/ansible-junos-stdlib/module_utils
-ADD version.py /tmp/ansible-junos-stdlib/version.py
-
-
-
-RUN tar -czf Juniper.junos ansible-junos-stdlib &&\
-    apk update && apk add ca-certificates &&\
-    apk add openssh-client &&\
-    apk add build-base gcc g++ make python-dev &&\
-    apk update && apk add py-pip &&\
-    pip install --upgrade pip setuptools &&\
-    pip install jxmlease &&\
-    pip install ansible==$ver_ansible &&\
-    pip install jsnapy==$ver_jsnapy &&\
-    ansible-galaxy install --roles-path=/etc/ansible/roles Juniper.junos &&\
-    apk del -r --purge gcc make g++ &&\
+
+RUN apk add --no-cache ca-certificates openssh-client build-base gcc g++ make python-dev py-pip
+
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+
+RUN apk del -r --purge gcc make g++ &&\
     rm -rf /source/* &&\
     rm -rf /var/cache/apk/* &&\
     rm -rf /tmp/*
 
-WORKDIR /project
+WORKDIR /etc/ansible/roles/Juniper.junos
+COPY action_plugins action_plugins
+COPY callback_plugins callback_plugins
+COPY library library
+COPY meta meta
+COPY module_utils module_utils
+
+WORKDIR /playbooks
+
+VOLUME /playbooks

README.md

@@ -1,3 +1,5 @@
+# Juniper Ansible roles for Junos
+
 ## About
 
 Juniper Networks supports Ansible for managing devices running
@@ -9,6 +11,7 @@ retrieving information, and resetting, rebooting, or shutting down managed devic
 [INSTALLATION](#installation) section for instructions on installing this role.
 
 ## Two Sets of Ansible Modules for Junos devices
+
 Since Ansible version >= 2.1, Ansible also natively includes
 [core modules for Junos](http://docs.ansible.com/ansible/list_of_network_modules.html#junos). The Junos modules included
 in Ansible core have names which begin with the prefix `junos_`. The Junos modules included in this Juniper.junos role
@@ -17,7 +20,9 @@ Ansible control machine, and an Ansible play may invoke a module from either (or
 using the modules in this role when writing new playbooks that manage Junos devices.
 
 ## Overview of Modules
+
 This Juniper.junos role includes the following modules:
+
 - **juniper_junos_command** — Execute one or more CLI commands on a Junos device.
 - **juniper_junos_config** — Manipulate the configuration of a Junos device.
 - **juniper_junos_facts** — Retrieve facts from a Junos device.
@@ -31,6 +36,7 @@ This Juniper.junos role includes the following modules:
 - **juniper_junos_table** — Retrieve data from a Junos device using a PyEZ table/view.
 
 ### Important Changes
+
 Significant changes to the modules in the Juniper.junos role were made between versions 1.4.3 and 2.0.0.
 In versions <= 1.4.3 of the Juniper.junos role, the modules used different module and argument names. Versions >= 2.0.0
 of the Juniper.junos role provide backwards compatibility with playbooks written to prior versions of the Juniper.junos
@@ -47,68 +53,75 @@ In addition to the modules listed above, a callback_plugin `jsnapy` is available
 The callback_plugin `jsnapy` helps to print on the screen additional information regarding jsnapy failed tests.
 For each failed test, a log will be printed after the RECAP of the playbook as shown in this example:
 
-```
-PLAY RECAP *********************************************************************
-qfx10002-01                : ok=3    changed=0    unreachable=0    failed=1
-qfx10002-02                : ok=3    changed=0    unreachable=0    failed=1
-qfx5100-01                 : ok=1    changed=0    unreachable=0    failed=1
-
-JSNAPy Results for: qfx10002-01 ************************************************
-Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
-Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "60021", "peer-state": "Idle", "peer-address": "192.168.0.1"}
-Value of 'oper-status' not 'is-equal' at '//interface-information/physical-interface[normalize-space(admin-status)='up' and logical-interface/address-family/address-family-name ]' with {"oper-status": "down", "name": "et-0/0/18"}
-
-JSNAPy Results for: qfx10002-02 ************************************************
-Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
-```
+    PLAY RECAP *********************************************************************
+    qfx10002-01                : ok=3    changed=0    unreachable=0    failed=1
+    qfx10002-02                : ok=3    changed=0    unreachable=0    failed=1
+    qfx5100-01                 : ok=1    changed=0    unreachable=0    failed=1
+
+    JSNAPy Results for: qfx10002-01 ************************************************
+    Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
+    Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "60021", "peer-state": "Idle", "peer-address": "192.168.0.1"}
+    Value of 'oper-status' not 'is-equal' at '//interface-information/physical-interface[normalize-space(admin-status)='up' and logical-interface/address-family/address-family-name ]' with {"oper-status": "down", "name": "et-0/0/18"}
+
+    JSNAPy Results for: qfx10002-02 ************************************************
+    Value of 'peer-state' not 'is-equal' at '//bgp-information/bgp-peer' with {"peer-as": "65200", "peer-state": "Active", "peer-address": "100.0.0.21"}
 
 The `jsnapy` plugin is currently in **Experimental** stage, please provide feedback.
 
 Callback plugins are not activated by default. They must be manually added to the Ansible
 configuration file under the `[defaults]` section using the variable `callback_whitelist`. Specifically, these lines
 should be added to the Ansible configuration file in order to allow the jsnapy callback plugin:
-```
-[defaults]
-callback_whitelist = jsnapy
-```
+
+    [defaults]
+    callback_whitelist = jsnapy
 
 ## DOCUMENTATION
 
 [Official Juniper documentation](http://www.juniper.net/techpubs/en_US/release-independent/junos-ansible/information-products/pathway-pages/index.html) (detailed information, including examples)
 
 [Ansible style documentation](http://junos-ansible-modules.readthedocs.org)
 
-
 ## INSTALLATION
+
 You must have the [DEPENDENCIES](#dependencies) installed on your system.  
 
+### NOTICES
+
+#### Ubuntu 14.04
+
 If you're dealing with Ubuntu 14.04 and faced following error during the installation, it's because the system python which used by Ubuntu 14.04 is locked to 2.7.6 till EOL, as a result, please consider to skip galaxy certification process by appending `-c` option of ansible-galaxy. i.e. `ansible-galaxy install Juniper.junos -c`
 
-```
-[WARNING]: - Juniper.junos was NOT installed successfully: Failed to get data
-from the API server (https://galaxy.ansible.com/api/): Failed to validate the
-SSL certificate for galaxy.ansible.com:443. Make sure your managed systems have
-a valid CA certificate installed. If the website serving the url uses SNI you
-need python >= 2.7.9 on your managed machine  (the python executable used
-(/usr/bin/python) is version: 2.7.6 (default, Nov 23 2017, 15:49:48) [GCC
-4.8.4]) or you can install the `urllib3`, `pyOpenSSL`, `ndg-httpsclient`, and
-`pyasn1` python modules to perform SNI verification in python >= 2.6. You can
-use validate_certs=False if you do not need to confirm the servers identity but
-this is unsafe and not recommended. Paths checked for this platform:
-/etc/ssl/certs, /etc/pki/ca-trust/extracted/pem, /etc/pki/tls/certs, /usr/share
-/ca-certificates/cacert.org, /etc/ansible. The exception msg was: hostname
-u'galaxy.ansible.com' doesn't match either of
-'*.c1e4.galaxy.openshiftapps.com', 'c1e4.galaxy.openshiftapps.com'.
-
-ERROR! - you can use --ignore-errors to skip failed roles and finish processing the list.
-```
+    [WARNING]: - Juniper.junos was NOT installed successfully: Failed to get data
+    from the API server (https://galaxy.ansible.com/api/): Failed to validate the
+    SSL certificate for galaxy.ansible.com:443. Make sure your managed systems have
+    a valid CA certificate installed. If the website serving the url uses SNI you
+    need python >= 2.7.9 on your managed machine  (the python executable used
+    (/usr/bin/python) is version: 2.7.6 (default, Nov 23 2017, 15:49:48) [GCC
+    4.8.4]) or you can install the `urllib3`, `pyOpenSSL`, `ndg-httpsclient`, and
+    `pyasn1` python modules to perform SNI verification in python >= 2.6. You can
+    use validate_certs=False if you do not need to confirm the servers identity but
+    this is unsafe and not recommended. Paths checked for this platform:
+    /etc/ssl/certs, /etc/pki/ca-trust/extracted/pem, /etc/pki/tls/certs, /usr/share
+    /ca-certificates/cacert.org, /etc/ansible. The exception msg was: hostname
+    u'galaxy.ansible.com' doesn't match either of
+    '*.c1e4.galaxy.openshiftapps.com', 'c1e4.galaxy.openshiftapps.com'.
+
+    ERROR! - you can use --ignore-errors to skip failed roles and finish processing the list.
 
+### MacOS Mojave and newer
+
+In MacOS Mojave and newer (>=10.14), ssh keys created with the system `ssh-keygen` are created using the newer 'OPENSSH' key format, even when specifying `-t rsa` during creation. This directly affects the usage of ssh keys, particularly when using the `ssh_private_key_file`. To create/convert/check keys, follow these steps:
+
+- Create a new RSA key: `ssh-keygen -m PEM -t rsa -b 4096`
+- Check existing keys: `head -n1 ~/.ssh/some_private_key` RSA keys will be `-----BEGIN RSA PRIVATE KEY-----` and OPENSSH keys will be `-----BEGIN OPENSSH PRIVATE KEY-----`
+- Convert an OPENSSH key to an RSA key: `ssh-keygen -p -m PEM -f ~/.ssh/some_key`
 
 ### Ansible Galaxy Role
+
 To download the latest released version of the junos role to the Ansible
 server, execute the ansible-galaxy install command, and specify **Juniper.junos**.
 
-```
+```bash
 [root@ansible-cm]# ansible-galaxy install Juniper.junos
 - downloading role 'junos', owned by Juniper
 - downloading role from https://github.com/Juniper/ansible-junos-stdlib/archive/1.3.1.tar.gz
@@ -118,52 +131,65 @@ server, execute the ansible-galaxy install command, and specify **Juniper.junos*
 
 You can also use the ansible-galaxy install command to install the latest
 development version of the junos role directly from GitHub.
-```
+
+```bash
 sudo ansible-galaxy install git+https://github.com/Juniper/ansible-junos-stdlib.git,,Juniper.junos
 ```
 
 ### Git clone
+
 For testing you can `git clone` this repo and run the `env-setup` script in the repo directory:
-```
+
+```bash
 user@ansible-junos-stdlib> source env-setup
 ```
-This will set your `$ANSIBLE_LIBRARY` variable to the repo location and the installed Ansible library path. For example:
-```
-[jeremy@ansible-junos-stdlib]$ echo $ANSIBLE_LIBRARY
+
+This will set your `$ANSIBLE_LIBRARY` variable to the repo location and the installed Ansible library path.  For example:
+
+```bash
+$ echo $ANSIBLE_LIBRARY
 /home/jeremy/Ansible/ansible-junos-stdlib/library:/usr/share/ansible
 ```
 
 ### Docker
-To run this as a Docker container, which includes JSNAPy and PyEZ, simply pull it from the Docker hub and run it.
-The following will pull the latest image and run it in an interactive ash shell.
-```
-$ docker run -it --rm juniper/pyez-ansible ash
-```
-Although, you'll probably want to bind mount a host directory (perhaps the directory containing your playbooks and
-associated files). The following will bind mount the current working directory and start the ash shell.
+
+To run this as a Docker container, which includes JSNAPy and PyEZ, simply pull it from the Docker hub and run it. The following will pull the latest image and run it in an interactive ash shell.
+
+```bash
+docker run -it --rm juniper/pyez-ansible ash
 ```
-$ docker run -it --rm -v $PWD:/project juniper/pyez-ansible ash
+
+Although, you'll probably want to bind mount a host directory (perhaps the directory containing your playbooks and associated files). The following will bind mount the current working directory and start the ash shell.
+
+```bash
+docker run -it --rm -v $PWD:/project juniper/pyez-ansible ash
 ```
+
 You can also use the container as an executable to run your playbooks. Let's assume we have a typical playbook structure as below:
-```
-example
-|playbook.yml
-|hosts
-|-vars
-|-templates
-|-scripts
-```
+
+    example
+    |playbook.yml
+    |hosts
+    |-vars
+    |-templates
+    |-scripts
+
 We can move to the example directory and run the playbook with the following command:
+
+```bash
+cd example/
+docker run -it --rm -v $PWD:/playbooks juniper/pyez-ansible ansible-playbook -i hosts playbook.yml
 ```
-$ docker run -it --rm -v $PWD:/project juniper/pyez-ansible ansible-playbook -i hosts playbook.yml
-```
+
 You may have noticed that the base command is almost always the same. We can also use an alias to save some keystrokes.
-```
-$ alias pb-ansible="docker run -it --rm -v $PWD:/project juniper/pyez-ansible ansible-playbook"
-$ pb-ansible -i hosts playbook.yml
+
+```bash
+alias pb-ansible="docker run -it --rm -v $PWD:/project juniper/pyez-ansible ansible-playbook"
+pb-ansible -i hosts playbook.yml
 ```
 
 ## Example Playbook
+
 This example outlines how to use Ansible to install or upgrade the software image on a device running Junos OS.
 
 ```yaml
@@ -198,21 +224,26 @@ This example outlines how to use Ansible to install or upgrade the software imag
     - name: wait_reboot
       wait_for: host={{ inventory_hostname }} port=830 timeout={{ wait_time }}
       when: not sw.check_mode
-```      
+```
 
 ## DEPENDENCIES
+
 This modules requires the following to be installed on the Ansible control machine:
-* Python >= 2.7 
-* [Ansible](http://www.ansible.com) 2.3 or later
-* Junos [py-junos-eznc](https://github.com/Juniper/py-junos-eznc) 2.1.7 or later
-* [jxmlease](https://github.com/Juniper/jxmlease) 1.0.1 or later
+
+- Python >= 2.7
+- [Ansible](http://www.ansible.com) 2.3 or later
+- Junos [py-junos-eznc](https://github.com/Juniper/py-junos-eznc) 2.1.7 or later
+- [jxmlease](https://github.com/Juniper/jxmlease) 1.0.1 or later
 
 ## LICENSE
+
 Apache 2.0
 
 ## SUPPORT
+
 Support for this Juniper.junos role is provided by the community and Juniper Networks. If you have an
 issue with a module in the Juniper.junos role, you may:
+
 - Open a [GitHub issue](https://github.com/Juniper/ansible-junos-stdlib/issues).
 - Post a question on our [Google Group](https://groups.google.com/forum/#!forum/junos-python-ez)
 - Email [jnpr-community-netdev@juniper.net](jnpr-community-netdev@juniper.net)
@@ -222,15 +253,13 @@ Support for the Junos modules included in Ansible core is provided by Ansible. I
 core module you should open a [Github issue against the Ansible project](https://github.com/ansible/ansible/issues).
 
 ## CONTRIBUTORS
+
 Juniper Networks is actively contributing to and maintaining this repo. Please contact
 [jnpr-community-netdev@juniper.net](jnpr-community-netdev@juniper.net) for any queries.
 
 *Contributors:*
-[Nitin Kumar](https://github.com/vnitinv), [Stacy W Smith](https://github.com/stacywsmith),
-[David Gethings](https://github.com/dgjnpr)
-
-* v2.1.0: [Raja Shekar](https://github.com/rsmekala), [Stacy W Smith](https://github.com/stacywsmith)
+[Nitin Kumar](https://github.com/vnitinv), [Stacy W Smith](https://github.com/stacywsmith), [Stephen Steiner](https://github.com/ntwrkguru)
 
 *Former Contributors:*
-[Jeremy Schulman](https://github.com/jeremyschulman), [Rick Sherman](https://github.com/shermdog),
-[Damien Garros](https://github.com/dgarros)
+
+[Jeremy Schulman](https://github.com/jeremyschulman), [Rick Sherman](https://github.com/shermdog), [Damien Garros](https://github.com/dgarros), [David Gethings](https://github.com/dgjnpr)