dellos6_facts – Collect facts from remote devices running Dell EMC Networking OS6
dellos6_facts – Collect facts from remote devices running Dell EMC Networking OS6
New in version 2.2.
Synopsis
- Collects a base set of device facts from a remote device that is running OS6. 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 | |
provider - |
A dict object containing connection details. | ||
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. | ||
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 | ||
port - |
Default: 22 |
Specifies the port to use when building the connection to the remote device. | |
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 | ||
timeout - |
Default: 10 |
Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations. | |
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 |
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
- dellos6_facts:
gather_subset: all
# Collect only the config and default facts
- dellos6_facts:
gather_subset:
- config
# Do not collect hardware facts
- dellos6_facts:
gather_subset:
- "!interfaces"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ansible_net_config string |
When config is configured. |
The current active config from 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 that 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.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Abirami N(@abirami-n)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/dellos6_facts_module.html