cisco.asa.asa_facts – Collect facts from remote devices running Cisco ASA
Note
This plugin is part of the cisco.asa collection (version 2.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.asa
.
To use it in a playbook, specify: cisco.asa.asa_facts
.
New in version 1.0.0: of cisco.asa
Synopsis
Collects a base set of device facts from a remote device that is running ASA. 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.Note, to collects facts from ASA device properly user should elevate the privilege to become.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network 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 Choices:
|
|
Specifies which context to target if you are running in the ASA in multiple context mode. Defaults to the current context you login to. |
|
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, vlans etc. Can specify a list of values to include a larger subset. Values can also be used with an initial |
|
When supplied, this argument restricts the facts collected to a given subset. Possible values for this argument include Specify a list of values to include a larger subset. Use a value with an initial Default: “!config” |
|
Saves running-config passwords in clear-text when set to True. Defaults to False Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
Specifies idle timeout in seconds for the connection, in seconds. Useful if the console freezes before continuing. For example when saving configurations. |
|
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 |
Notes
Note
Tested against asa 9.10(1)11
For more information on using Ansible to manage network devices see the Ansible Network Guide
Examples
- name: Gather all legacy facts
cisco.asa.asa_facts:
gather_subset: all
- name: Gather only the config and default facts
cisco.asa.asa_facts:
gather_subset:
- config
- name: Do not gather hardware facts
cisco.asa.asa_facts:
gather_subset:
- '!hardware'
- name: Gather legacy and resource facts
cisco.asa.asa_facts:
gather_subset: all
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The name of the transport Returned: always |
|
The operating system type (Cisco ASA) running on the remote device. Returned: always |
|
The current active config from the device Returned: when config is configured |
|
The Device manager version running on the remote device. Returned: always |
|
All file system names available on the device Returned: when hardware is configured |
|
A hash of all file systems containing info about each file system (e.g. free and total space) Returned: when hardware is configured |
|
The Firepower operating system version running on the remote device. Returned: always |
|
The list of fact subsets collected from the device Returned: always |
|
The configured hostname of the device Returned: always |
|
The image file the device is running Returned: always |
|
The available free memory on the remote device in Mb Returned: when hardware is configured |
|
The total memory on the remote device in Mb Returned: when hardware is configured |
|
The used memory on the remote device in Mb Returned: when hardware is configured |
|
The model name returned from the device Returned: always |
|
The Python version Ansible controller is using Returned: always |
|
The serial number of the remote device Returned: always |
|
The model names of each device in the stack Returned: when multiple devices are configured in a stack |
|
The serial numbers of each device in the stack Returned: when multiple devices are configured in a stack |
|
The operating system version running on the remote device Returned: always |
Authors
Sumit Jaiswal (@justjais)