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 | Choices/Defaults | 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. | |
gather_subset string | Default: "!config" | 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. | |
provider dictionary | A dict object containing connection details. | ||
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. | |
host string / required | 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. | ||
password string | 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 ANSIBLE_NET_PASSWORD will be used instead. | ||
port integer | Default: 22 | Specifies the port to use when building the connection to the remote device. | |
ssh_keyfile path | 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 ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
timeout integer | Default: 10 | 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. | |
username string | 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 ANSIBLE_NET_USERNAME will be used instead. |
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: 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 | Returned | Description |
---|---|---|
ansible_net_all_ipv4_addresses list / elements=string | when interfaces is configured | All IPv4 addresses configured on the device |
ansible_net_all_ipv6_addresses list / elements=string | when interfaces is configured | All IPv6 addresses configured on the device |
ansible_net_config string | when config is configured | The current active config from the device |
ansible_net_gather_subset list / elements=string | always | The list of fact subsets collected from the device |
ansible_net_hostname string | always | The configured hostname of the device |
ansible_net_image string | always | Indicates the active image for the device |
ansible_net_interfaces dictionary | when interfaces is configured | A hash of all interfaces running on the system. This gives information on description, mac address, mtu, speed, duplex and operstatus |
ansible_net_memfree_mb integer | when hardware is configured | The available free memory on the remote device in MB |
ansible_net_model string | always | The model name returned from the Lenovo ENOS device |
ansible_net_neighbors dictionary | when interfaces is configured | The list of LLDP neighbors from the remote device |
ansible_net_serialnum string | always | The serial number of the Lenovo ENOS device |
ansible_net_version string | always | The ENOS operating system version running on the remote device |
Authors
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/enos_facts_module.html