W3cubDocs

/Ansible 2.11

dellemc.os9.os9_facts – Collect facts from remote devices running Dell EMC Networking OS9

Note

This plugin is part of the dellemc.os9 collection (version 1.0.3).

To install it use: ansible-galaxy collection install dellemc.os9.

To use it in a playbook, specify: dellemc.os9.os9_facts.

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.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
gather_subset
list / elements=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
    Choices:
  • no ←
  • yes
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
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
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
integer
Specifies the port to use when building the connection to the remote device.
ssh_keyfile
path
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
integer
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.
username
string
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.

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 os9_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
- os9_facts:
    gather_subset: all
# Collect only the config and default facts
- os9_facts:
    gather_subset:
      - config
# Do not collect hardware facts
- os9_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 / 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_filesystems
list / elements=string
when hardware is configured
All file system names available on 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
The image file the device is running
ansible_net_interfaces
dictionary
when interfaces is configured
A hash of all interfaces running on the system
ansible_net_memfree_mb
integer
when hardware is configured
The available free memory on the remote device in Mb
ansible_net_memtotal_mb
integer
when hardware is configured
The total memory on the remote device in Mb
ansible_net_model
string
always
The model name returned from the 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 remote device
ansible_net_version
string
always
The operating system version running on the remote device


Authors

  • Dhivya P (@dhivyap)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/os9/os9_facts_module.html