community.network.enos_facts module – Collect facts from remote devices running Lenovo ENOS

Note

This module is part of the community.network collection (version 5.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.enos_facts.

Synopsis

  • Collects a base set of device facts from a remote Lenovo device running on ENOS. This module prepends all of the base network fact keys with ansible_net_<fact>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Aliases: network.enos.enos_facts

Parameters

Parameter

Comments

auth_pass

string

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

authorize

boolean

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

Choices:

  • false ← (default)

  • true

gather_subset

string

When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.

Default: "!config"

Notes

Note

  • Tested against ENOS 8.4.1

Examples

Tasks: The following are examples of using the module enos_facts.
---
- name: Test Enos Facts
  community.network.enos_facts:

  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: 22
      username: admin
      password: admin
      transport: cli
      timeout: 30
      authorize: true
      auth_pass:

---
# Collect all facts from the device
- community.network.enos_facts:
    gather_subset: all

# Collect only the config and default facts
- community.network.enos_facts:
    gather_subset:
      - config

# Do not collect hardware facts
- community.network.enos_facts:
    gather_subset:
      - "!hardware"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ansible_net_all_ipv4_addresses

list / elements=string

All IPv4 addresses configured on the device

Returned: when interfaces is configured

ansible_net_all_ipv6_addresses

list / elements=string

All IPv6 addresses configured on the device

Returned: when interfaces is configured

ansible_net_config

string

The current active config from the device

Returned: when config is configured

ansible_net_gather_subset

list / elements=string

The list of fact subsets collected from the device

Returned: always

ansible_net_hostname

string

The configured hostname of the device

Returned: always

ansible_net_image

string

Indicates the active image for the device

Returned: always

ansible_net_interfaces

dictionary

A hash of all interfaces running on the system. This gives information on description, mac address, mtu, speed, duplex and operstatus

Returned: when interfaces is configured

ansible_net_memfree_mb

integer

The available free memory on the remote device in MB

Returned: when hardware is configured

ansible_net_model

string

The model name returned from the Lenovo ENOS device

Returned: always

ansible_net_neighbors

dictionary

The list of LLDP neighbors from the remote device

Returned: when interfaces is configured

ansible_net_serialnum

string

The serial number of the Lenovo ENOS device

Returned: always

ansible_net_version

string

The ENOS operating system version running on the remote device

Returned: always

Authors

  • Anil Kumar Muraleedharan (@amuraleedhar)