dellos10_facts – Collect facts from remote devices running Dell EMC Networking OS10 — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# dellos10_facts – Collect facts from remote devices running Dell EMC Networking OS10

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.

## 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 `!` to specify that a specific subset should not be collected.
provider dictionary |  | A dict object containing connection details.
| host string / 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 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 | Default: 22 | 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 | Default: 10 | 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
    - 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"

## 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 | when interfaces is configured | All IPv4 addresses configured on the device
ansible_net_all_ipv6_addresses list | 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_cpu_arch string | when hardware is configured | CPU Architecture of the remote 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_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_name string | Always. | The name of the OS that is running.
ansible_net_neighbors dictionary | when interfaces is configured | The list of LLDP neighbors from the remote device
ansible_net_servicetag string | always | The service tag 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

- Senthil Kumar Ganesan (@skg-net)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.