Documentation

dellos9_facts - Collect facts from remote devices running Dell EMC Networking OS9

New in version 2.2.

Synopsis

  • Collects a base set of device facts from a remote device that is running OS9. 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
gather_subset 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
A dict object containing connection details.
username
User to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
host
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.
ssh_keyfile
Path to an ssh key used to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout Default:
10
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
password
Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port Default:
22
Specifies the port to use when building the connection to the remote device.

Notes

Note

  • This module requires OS9 version 9.10.0.1P13 or above.
  • This module requires an increase of the SSH connection rate limit. Use the following command ip ssh connection-rate-limit 60 to configure the same. This can be also be done with the dellos9_config module.
  • For more information on using Ansible to manage Dell EMC Network devices see https://www.ansible.com/ansible-dell-networking.

Examples

# Collect all facts from the device
- dellos9_facts:
    gather_subset: all

# Collect only the config and default facts
- dellos9_facts:
    gather_subset:
      - config

# Do not collect hardware facts
- dellos9_facts:
    gather_subset:
      - "!hardware"

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
when interfaces is configured
All IPv4 addresses configured on the device

ansible_net_all_ipv6_addresses
list
when interfaces is configured
All IPv6 addresses configured on the device

ansible_net_config
str
when config is configured
The current active config from the device

ansible_net_filesystems
list
when hardware is configured
All file system names available on the device

ansible_net_gather_subset
list
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
The image file the device is running

ansible_net_interfaces
dict
when interfaces is configured
A hash of all interfaces running on the system

ansible_net_memfree_mb
int
when hardware is configured
The available free memory on the remote device in Mb

ansible_net_memtotal_mb
int
when hardware is configured
The total memory on the remote device in Mb

ansible_net_model
str
always
The model name returned from the device

ansible_net_neighbors
dict
when interfaces is configured
The list of LLDP neighbors from the remote device

ansible_net_serialnum
str
always
The serial number of the remote device

ansible_net_version
str
always
The operating system version running on the remote device



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Dhivya P (@dhivyap)

Hint

If you notice any issues in this documentation you can edit this document to improve it.