New in version 2.2.
Collects a base set of device facts from a remote device that is running Dell 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.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| gather_subset | no | !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. |
|
| 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. |
||
| 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. |
|
| provider | no | Convenience method that allows all dellos10 arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
| 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. |
|
| 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. |
# Collect all facts from the device
- dellos10_facts:
gather_subset: all
# Collect only the config and default facts
- dellos10_facts:
gather_subset:
- config
# Do not collect hardware facts
- dellos10_facts:
gather_subset:
- "!hardware"
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| ansible_net_model | The model name returned from the device | always | str | |
| ansible_net_all_ipv4_addresses | All IPv4 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_hostname | The configured hostname of the device | always | str | |
| ansible_net_cpu_arch | Cpu Architecture of the remote device | when hardware is configured | str | |
| ansible_net_interfaces | A hash of all interfaces running on the system | when interfaces is configured | dict | |
| ansible_net_version | The operating system version running on the remote device | always | str | |
| ansible_net_servicetag | The service tag number of the remote device | always | str | |
| ansible_net_name | The name of the OS which is running | always | str | |
| ansible_net_gather_subset | The list of fact subsets collected from the device | always | list | |
| ansible_net_neighbors | The list of LLDP neighbors from the remote device | 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_all_ipv6_addresses | All IPv6 addresses configured on the device | when interfaces is configured | list | |
| ansible_net_memtotal_mb | The total memory on the remote device in Mb | when hardware is configured | int |
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/dellos10_facts_module.html