juniper_junos_facts¶

Retrieve facts from a Junos device

New in version 2.0.0.

Synopsis
Requirements
Module-specific Options
Common Connection-related Options
Common Logging-related Options
Examples
Return Values
Notes
- Author
- Status

Synopsis ¶

Retrieve facts from a Junos device using the PyEZ fact gathering system.
Also returns the committed configuration of the Junos device if the config_format option has a value other than none.

Requirements ¶

The following software packages must be installed on hosts that execute this module:

junos-eznc >= 2.1.7
Python >= 2.7

Module-specific Options ¶

The following options may be specified for this module:

parameter	type	required	default	choices	comments
config_format		no	none	none xml set text json	The format of the configuration returned. The specified format must be supported by the target Junos device.
savedir	path	no	none		A path to a directory, on the Ansible control machine, where facts will be stored in a JSON file. The resulting JSON file is saved in savedir`/`hostname`-facts.json`. The savedir directory is the value of the savedir option. The hostname`-facts.json` filename begins with the value of the `hostname` fact returned from the Junos device, which might be different than the value of the host option passed to the module. If the value of the savedir option is `none`, the default, then facts are NOT saved to a file.

Common Connection-related Options ¶

In addition to the Module-specific Options, the following connection-related options are also supported by this module:

parameter type required default choices comments

attempts

int

The number of times to try connecting and logging in to the Junos device. This option is only applicable when using mode = 'telnet' or mode = 'serial'. Mutually exclusive with the console option.

baud

int

9600

The serial baud rate, in bits per second, used to connect to the Junos device. This option is only applicable when using mode = 'serial'. Mutually exclusive with the console option.

console

str

none

An alternate method of specifying a NETCONF over serial console connection to the Junos device using Telnet to a console server. The value of this option must be a string in the format --telnet <console_hostname>,<console_port_number>. This option is deprecated. It is present only for backwards compatibility. The string value of this option is exactly equivalent to specifying host with a value of <console_hostname>, mode with a value of telnet, and port with a value of <console_port_number>. Mutually exclusive with the mode, port, baud, and attempts options.

host

str

yes

{{ inventory_hostname }}

The hostname or IP address of the Junos device to which the connection should be established. This is normally the Junos device itself, but is the hostname or IP address of a console server when connecting to the console of the device by setting the mode option to the value telnet. This option is required, but does not have to be specified explicitly by the user because it defaults to {{ inventory_hostname }}.

aliases: hostname, ip

mode

str

none

none
telnet
serial

The PyEZ mode used to establish a NETCONF connection to the Junos device. A value of none uses the default NETCONF over SSH mode. Depending on the values of the host and port options, a value of telnet results in either a direct NETCONF over Telnet connection to the Junos device, or a NETCONF over serial console connection to the Junos device using Telnet to a console server. A value of serial results in a NETCONF over serial console connection to the Junos device. Mutually exclusive with the console option.

passwd

str

The first defined value from the following list 1) The ANSIBLE_NET_PASSWORD environment variable. (used by Ansible Tower) 2) The value specified using the -k or --ask-pass command line arguments to the ansible or ansible-playbook command. 3) none (An empty password/passphrase)

The password, or ssh key's passphrase, used to authenticate with the Junos device. If this option is not specified, authentication is attempted using an empty password, or ssh key passphrase.

aliases: password

port

int or str

830 if mode = none, 23 if mode = 'telnet', '/dev/ttyUSB0' if (mode = 'serial')

The TCP port number or serial device port used to establish the connection. Mutually exclusive with the console option.

provider

dict

An alternative syntax for specifying the connection options. Rather than specifying each connection-related top-level option, the connection-related options may be specified as a dictionary of suboptions to the provider option. All connection-related options must either be specified as top-level options or as suboptions of the provider option. You can not combine the two methods of specifying connection-related options.

**Dictionary object provider**
parameter	type	required	default	choices	comments
baud	int	no	9600		The serial baud rate, in bits per second, used to connect to the Junos device. This option is only applicable when using `mode = 'serial'`. Mutually exclusive with the console option.
attempts	int	no	10		The number of times to try connecting and logging in to the Junos device. This option is only applicable when using `mode = 'telnet'` or `mode = 'serial'`. Mutually exclusive with the console option.
console	str	no	none		An alternate method of specifying a NETCONF over serial console connection to the Junos device using Telnet to a console server. The value of this option must be a string in the format `--telnet <console_hostname>,<console_port_number>`. This option is deprecated. It is present only for backwards compatibility. The string value of this option is exactly equivalent to specifying host with a value of `<console_hostname>`, mode with a value of `telnet`, and port with a value of `<console_port_number>`. Mutually exclusive with the mode, port, baud, and attempts options.
passwd	str	no	The first defined value from the following list 1) The `ANSIBLE_NET_PASSWORD` environment variable. (used by Ansible Tower) 2) The value specified using the `-k` or `--ask-pass` command line arguments to the `ansible` or `ansible-playbook` command. 3) none (An empty password/passphrase)		The password, or ssh key's passphrase, used to authenticate with the Junos device. If this option is not specified, authentication is attempted using an empty password, or ssh key passphrase.
ssh_config	path	no			The path to the SSH client configuration file. If this option is not specified, then the PyEZ Device instance by default queries file ~/.ssh/config.
host	str	yes	`{{ inventory_hostname }}`		The hostname or IP address of the Junos device to which the connection should be established. This is normally the Junos device itself, but is the hostname or IP address of a console server when connecting to the console of the device by setting the mode option to the value `telnet`. This option is required, but does not have to be specified explicitly by the user because it defaults to `{{ inventory_hostname }}`.
mode	str	no	none	none telnet serial	The PyEZ mode used to establish a NETCONF connection to the Junos device. A value of `none` uses the default NETCONF over SSH mode. Depending on the values of the host and port options, a value of `telnet` results in either a direct NETCONF over Telnet connection to the Junos device, or a NETCONF over serial console connection to the Junos device using Telnet to a console server. A value of `serial` results in a NETCONF over serial console connection to the Junos device. Mutually exclusive with the console option.
timeout	int	no	30		The maximum number of seconds to wait for RPC responses from the Junos device. This option does NOT control the initial connection timeout value.
ssh_private_key_file	path	no	The first defined value from the following list 1) The `ANSIBLE_NET_SSH_KEYFILE` environment variable. (used by Ansible Tower) 2) The value specified using the `--private-key` or `--key-file` command line arguments to the `ansible` or `ansible-playbook` command. 3) none (the file specified in the user's SSH configuration, or the operating-system-specific default)		The path to the SSH private key file used to authenticate with the Junos device. If this option is not specified, and no default value is found using the algorithm below, then the SSH private key file specified in the user's SSH configuration, or the operating-system-specific default is used.
port	int or str	no	`830` if `mode = none`, `23` if `mode = 'telnet'`, `'/dev/ttyUSB0'` if (mode = 'serial')		The TCP port number or serial device port used to establish the connection. Mutually exclusive with the console option.
user	str	yes	The first defined value from the following list 1) The `ANSIBLE_NET_USERNAME` environment variable. (used by Ansible Tower) 2) The `remote_user` as defined by Ansible. Ansible sets this value via several methods including a) `-u` or `--user` command line arguments to the `ansible` or `ansible-playbook` command. b) `ANSIBLE_REMOTE_USER` environment variable. c) `remote_user` configuration setting. See the Ansible documentation for the precedence used to set the `remote_user` value. 3) The `USER` environment variable.		The username used to authenticate with the Junos device. This option is required, but does not have to be specified explicitly by the user due to the algorithm for determining the default value.

ssh_config

path

The path to the SSH client configuration file. If this option is not specified, then the PyEZ Device instance by default queries file ~/.ssh/config.

ssh_private_key_file

path

The first defined value from the following list 1) The ANSIBLE_NET_SSH_KEYFILE environment variable. (used by Ansible Tower) 2) The value specified using the --private-key or --key-file command line arguments to the ansible or ansible-playbook command. 3) none (the file specified in the user's SSH configuration, or the operating-system-specific default)

The path to the SSH private key file used to authenticate with the Junos device. If this option is not specified, and no default value is found using the algorithm below, then the SSH private key file specified in the user's SSH configuration, or the operating-system-specific default is used.

aliases: ssh_keyfile

timeout

int

The maximum number of seconds to wait for RPC responses from the Junos device. This option does NOT control the initial connection timeout value.

user

str

yes

The first defined value from the following list 1) The ANSIBLE_NET_USERNAME environment variable. (used by Ansible Tower) 2) The remote_user as defined by Ansible. Ansible sets this value via several methods including a) -u or --user command line arguments to the ansible or ansible-playbook command. b) ANSIBLE_REMOTE_USER environment variable. c) remote_user configuration setting. See the Ansible documentation for the precedence used to set the remote_user value. 3) The USER environment variable.

The username used to authenticate with the Junos device. This option is required, but does not have to be specified explicitly by the user due to the algorithm for determining the default value.

aliases: username

Common Logging-related Options ¶

In addition to the Module-specific Options, the following logging-related options are also supported by this module:

parameter	type	required	default	choices	comments
level	str	no	WARNING	INFO DEBUG	The level of information to be logged can be modified using this option 1) By default, messages at level `WARNING` or higher are logged. 2) If the `-v` or `--verbose` command-line options to the `ansible-playbook` command are specified, messages at level `INFO` or higher are logged. 3) If the `-vv` (or more verbose) command-line option to the `ansible-playbook` command is specified, or the `ANSIBLE_DEBUG` environment variable is set, then messages at level `DEBUG` or higher are logged. 4) If `level` is mentioned then messages at level `level` or more are logged.
logdir	path	no	none		The path to a directory, on the Ansible control machine, where debugging information for the particular task is logged. If this option is specified, debugging information is logged to a file named `{{ inventory_hostname }}.log` in the directory specified by the logdir option. The log file must be writeable. If the file already exists, it is appended. It is the users responsibility to delete/rotate log files. The level of information logged in this file is controlled by Ansible's verbosity, debug options and level option in task 1) By default, messages at level `WARNING` or higher are logged. 2) If the `-v` or `--verbose` command-line options to the `ansible-playbook` command are specified, messages at level `INFO` or higher are logged. 3) If the `-vv` (or more verbose) command-line option to the `ansible-playbook` command is specified, or the `ANSIBLE_DEBUG` environment variable is set, then messages at level `DEBUG` or higher are logged. 4) If `level` is mentioned then messages at level `level` or more are logged. The logfile and logdir options are mutually exclusive. The logdir option is recommended for all new playbooks. aliases: log_dir
logfile	path	no	none		The path to a file, on the Ansible control machine, where debugging information for the particular task is logged. The log file must be writeable. If the file already exists, it is appended. It is the users responsibility to delete/rotate log files. The level of information logged in this file is controlled by Ansible's verbosity, debug options and level option in task 1) By default, messages at level `WARNING` or higher are logged. 2) If the `-v` or `--verbose` command-line options to the `ansible-playbook` command are specified, messages at level `INFO` or higher are logged. 3) If the `-vv` (or more verbose) command-line option to the `ansible-playbook` command is specified, or the `ANSIBLE_DEBUG` environment variable is set, then messages at level `DEBUG` or higher are logged. 4) If `level` is mentioned then messages at level `level` or more are logged. When tasks are executed against more than one target host, one process is forked for each target host. (Up to the maximum specified by the forks configuration. See forks for details.) This means that the value of this option must be unique per target host. This is usually accomplished by including `{{ inventory_hostname }}` in the logfile value. It is the user's responsibility to ensure this value is unique per target host. For this reason, this option is deprecated. It is maintained for backwards compatibility. Use the logdir option in new playbooks. The logfile and logdir options are mutually exclusive. aliases: log_file

Examples ¶

---
- name: Gather facts from Junos devices
  hosts: junos-all
  connection: local
  gather_facts: no
  roles:
    - Juniper.junos
  tasks:
    - name: Gather Junos facts with no configuration
      juniper_junos_facts:

# Print a fact

# Using config_format option

# Print the config

# Using savedir option

# Print the saved JSON file

Return Values ¶

name description returned type sample

ansible_facts.junos

Facts collected from the Junos device. This dictionary contains the keys listed in the contains section of this documentation PLUS all of the keys returned from PyEZ's fact gathering system. See PyEZ facts for a complete list of these keys and their meaning.

success

complex

contains:

name	description	returned	type
master_state	The mastership state of the Routing Engine to which Ansible is connected. `true` if the RE is the master Routing Engine. `false` if the RE is not the master Routing Engine.	success	bool
config	The device's committed configuration, in the format specified by config_format, as a single multi-line string.	when config_format is not `none`.	str
re_name	The name of the current Routing Engine to which Ansible is connected.	success	str
has_2RE	Indicates if the device has more than one Routing Engine installed. Because Ansible does not allow keys to begin with a number, this fact is returned in place of PyEZ's `2RE` fact.	success	bool

changed

Indicates if the device's state has changed. Since this module does not change the operational or configuration state of the device, the value is always set to false.

success

bool

False

facts

Returned for backwards compatibility. Returns the same keys and values which are returned under ansible_facts.junos.

success

dict

failed

Indicates if the task failed.

always

bool

False

Notes ¶

Note

The NETCONF system service must be enabled on the target Junos device.

Author ¶

Juniper Networks - Stacy Smith (@stacywsmith)

Status ¶

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.