.. _junos_get_facts:


junos_get_facts - Retrieve facts for a device running Junos OS.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

:Author: Jeremy Schulman, Juniper Networks

.. contents::
   :local:
   :depth: 1

Synopsis
--------

.. versionadded:: 1.0.0

Retrieve facts for a device running Junos OS, which includes information such as the serial number, product model, and Junos OS version. The module supports using both NETCONF and CONSOLE-based retrieval and returns the information as a JSON dictionary. The information is similar to facts gathered by other IT frameworks.

Options
-------

.. raw:: html

    <table border=1 cellpadding=4>
    <tr>
    <th class="head">parameter</th>
    <th class="head">required</th>
    <th class="head">default</th>
    <th class="head">choices</th>
    <th class="head">comments</th>
    </tr>
            <tr>
    <td>console</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>CONSOLE port, per the <b>netconify</b> utility</td>
    </tr>
            <tr>
    <td>host</td>
    <td>yes</td>
    <td></td>
        <td><ul></ul></td>
        <td>Set to {{ inventory_hostname }}</td>
    </tr>
            <tr>
    <td>logfile</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>Path on the local server where the progress status is logged for debugging purposes. This option is used only with the <em>console</em> option.</td>
    </tr>
            <tr>
    <td>mode</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>mode of console connection (telnet/serial). If mode is not provided SSH connection is used.</td>
    </tr>
            <tr>
    <td>passwd</td>
    <td>no</td>
    <td>assumes ssh-key active</td>
        <td><ul></ul></td>
        <td>Login password</td>
    </tr>
            <tr>
    <td>port</td>
    <td>no</td>
    <td>830</td>
        <td><ul></ul></td>
        <td>port number to use when connecting to the device</td>
    </tr>
            <tr>
    <td>savedir</td>
    <td>no</td>
    <td>$CWD</td>
        <td><ul></ul></td>
        <td>Path to the local server directory where device fact files will be stored. Resulting file will be <em>savedir/hostname-facts.json</em></td>
    </tr>
            <tr>
    <td>ssh_private_key_file</td>
    <td>no</td>
    <td>None</td>
        <td><ul></ul></td>
        <td>This can be used if you need to provide a private key rather than loading the key into the ssh-key-ring/environment.  if your ssh-key requires a password, then you must provide it via **passwd**</td>
    </tr>
            <tr>
    <td>user</td>
    <td>no</td>
    <td>$USER</td>
        <td><ul></ul></td>
        <td>Login username</td>
    </tr>
        </table>


.. note:: Requires junos-eznc >= 1.2.2


.. note:: Requires junos-netconify >= 1.0.1, when using the *console* option


Examples
--------

.. raw:: html

    <br/>


::

    
    # retrieve facts using NETCONF, assumes ssh-keys
    
    - junos_get_facts: host={{ inventory_hostname }}
      register: junos
    
    # retrieve facts using CONSOLE, assumes Amnesiac system
    # root login, no password
    
    - junos_get_facts:
        host={{ inventory_hostname }}
        user=root
        console="--telnet={{TERMSERV}},{{TERMSERVPORT}}"
        savedir=/usr/local/junos/inventory
      register: junos
    
    # access the facts
    
    - name: version
      debug: msg="{{ junos.facts.version }}"
    
    # retrieve facts using console server connection using PyEZ >= 2.0
    
    - junos_get_facts:
        host={{ inventory_hostname }}
        mode="telnet"
        port=7016
      register: junos
    
    # access the facts
    
    - name: version
      debug: msg="{{ junos.facts }}"