ironware_facts – Collect facts from devices running Extreme Ironware — Ansible Documentation

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

Documentation

# ironware_facts – Collect facts from devices running Extreme Ironware

New in version 2.5.

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

## Synopsis

- Collects a base set of device facts from a remote device that is running Ironware. 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
--- | --- | ---
authorize boolean | Choices: no ← yes | Deprecated Starting with Ansible 2.7 we recommend using `connection: network_cli` and `become: yes`. For more information please see the IronWare Platform Options guide. 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.
gather_subset - | Default: ["!config", "!mpls"] | When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, hardware, config, mpls 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 |  | Deprecated Starting with Ansible 2.7 we recommend using `connection: network_cli` and `become: yes`. For more information please see the IronWare Platform Options guide. 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 |  | Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. 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 |  | Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. 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, in seconds. Useful if the console freezes before continuing. For example when saving configurations.
| username string |  | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.

## Notes

Note

- Tested against Ironware 5.8e
- For more information on using Ansible to manage network devices see the Ansible Network Guide

## Examples

    # Collect all facts from the device
    - ironware_facts:
        gather_subset: all

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

    # Do not collect hardware facts
    - ironware_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_filesystems list | when hardware is configured | All file system names available on the device
ansible_net_gather_subset list | always | The list of fact subsets collected from 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_mpls_lsps dictionary | When LSP is configured | All MPLS LSPs configured on the device
ansible_net_mpls_vll dictionary | When MPLS VLL is configured | All VLL instances configured on the device
ansible_net_mpls_vll_local dictionary | When MPLS VLL-LOCAL is configured | All VLL-LOCAL instances configured on the device
ansible_net_mpls_vpls dictionary | When MPLS VPLS is configured | All VPLS instances configured on 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

- Paul Baker (@paulquack)

Hint

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