community.network.enos_facts – Collect facts from remote devices running Lenovo ENOS
Note
This plugin is part of the community.network collection (version 3.0.0).
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.
Parameters
Parameter |
Comments |
---|---|
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 |
|
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 Choices:
|
|
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 Default: “!config” |
|
A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
|
Specifies the port to use when building the connection to the remote device. Default: 22 |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. Default: 10 |
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
Examples
Tasks: The following are examples of using the module enos_facts.
---
- name: Test Enos Facts
community.network.enos_facts:
provider={{ cli }}
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
provider: "{{ cli }}"
# Collect only the config and default facts
- community.network.enos_facts:
gather_subset:
- config
provider: "{{ cli }}"
# Do not collect hardware facts
- community.network.enos_facts:
gather_subset:
- "!hardware"
provider: "{{ cli }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
All IPv4 addresses configured on the device Returned: when interfaces is configured |
|
All IPv6 addresses configured on the device Returned: when interfaces is configured |
|
The current active config from the device Returned: when config is configured |
|
The list of fact subsets collected from the device Returned: always |
|
The configured hostname of the device Returned: always |
|
Indicates the active image for the device Returned: always |
|
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 |
|
The available free memory on the remote device in MB Returned: when hardware is configured |
|
The model name returned from the Lenovo ENOS device Returned: always |
|
The list of LLDP neighbors from the remote device Returned: when interfaces is configured |
|
The serial number of the Lenovo ENOS device Returned: always |
|
The ENOS operating system version running on the remote device Returned: always |
Authors
Anil Kumar Muraleedharan (@amuraleedhar)