You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

dellemc.os10.os10_facts module – Collect facts from devices running Dell EMC SmartFabric OS10

Note

This module is part of the dellemc.os10 collection (version 1.1.1).

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 dellemc.os10.

To use it in a playbook, specify: dellemc.os10.os10_facts.

Synopsis

• Collects a base set of device facts from a remote device that is running OS10. 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	Comments
gather_subset list / elements=string	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 M(!) to specify that a specific subset should not be collected. Default: [“!config”]
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. Choices: no ← (default) yes
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

• 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
- os10_facts:
    gather_subset: all

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ansible_net_all_ipv4_addresses list / elements=string	All IPv4 addresses configured on the device Returned: when interfaces is configured
ansible_net_all_ipv6_addresses list / elements=string	All IPv6 addresses configured on the device Returned: when interfaces is configured
ansible_net_config string	The current active config from the device Returned: when config is configured
ansible_net_cpu_arch string	CPU Architecture of the remote device. Returned: when hardware is configured
ansible_net_gather_subset list / elements=string	The list of fact subsets collected from the device Returned: always
ansible_net_hostname string	The configured hostname of the device Returned: always
ansible_net_interfaces dictionary	A hash of all interfaces running on the system Returned: when interfaces is configured
ansible_net_memfree_mb integer	The available free memory on the remote device in Mb Returned: when hardware is configured
ansible_net_memtotal_mb integer	The total memory on the remote device in Mb Returned: when hardware is configured
ansible_net_model string	The model name returned from the device. Returned: always
ansible_net_name string	The name of the OS that is running. Returned: Always.
ansible_net_neighbors dictionary	The list of LLDP neighbors from the remote device Returned: when interfaces is configured
ansible_net_servicetag string	The service tag number of the remote device. Returned: always
ansible_net_version string	The operating system version running on the remote device Returned: always

Authors

• Senthil Kumar Ganesan (@skg-net)

Collection links

Issue Tracker Repository (Sources)