ironware_facts – Collect facts from devices running Extreme Ironware¶
New in version 2.5.
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
                                                                 | 
 | Deprecated Starting with Ansible 2.7 we recommend using  connection: network_cliandbecome: 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_AUTHORIZEwill 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_cliandbecome: 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_PASSwill 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_AUTHORIZEwill 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_PASSWORDwill 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_KEYFILEwill 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_USERNAMEwill 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:
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.
