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 always collects a base set of facts from the device and can enable or disable collection of additional facts.

Options

parameter required default choices comments
gather_subset
 no !config
When supplied, this argument restricts the facts collected to a given subset. Possible values for this argument include all, hardware, config, and interfaces. You can specify a list of values to include a larger subset. You can also use values with an initial ! to specify that a specific subset should not be collected.
provider
 no
A dict object containing connection details.
Dictionary object provider
parameter required default choices comments
username
 no
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
 yes
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
 no
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
 no 10
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
password
 no
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
 no 22
Specifies the port to use when building the connection to the remote device.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
ansible_net_all_ipv4_addresses
All IPv4 addresses configured on the device.
 When interfaces is configured. list
ansible_net_all_ipv6_addresses
All IPv6 addresses configured on the device.
 When interfaces is configured. list
ansible_net_config
The current active config from the device.
 When config is configured. str
ansible_net_filesystems
All file system names available on the device.
 When hardware is configured. list
ansible_net_gather_subset
The list of fact subsets collected from the device.
 Always. list
ansible_net_hostname
The configured hostname of the device.
 Always. string
ansible_net_image
The image file the device is running.
 Always. string
ansible_net_interfaces
A hash of all interfaces running on the system.
 When interfaces is configured. dict
ansible_net_memfree_mb
The available free memory on the remote device in MB.
 When hardware is configured. int
ansible_net_memtotal_mb
The total memory on the remote device in MB.
 When hardware is configured. int
ansible_net_model
The model name returned from the device.
 Always. str
ansible_net_neighbors
The list of LLDP neighbors from the remote device
 When interfaces is configured. dict
ansible_net_serialnum
The serial number of the remote device.
 Always. str
ansible_net_version
The operating system version running on the remote device.
 Always. str


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.

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.