community.ciscosmb.facts module – Collect facts from remote devices running Cisco SMB
Note
This module is part of the community.ciscosmb collection (version 1.0.5).
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 community.ciscosmb
.
To use it in a playbook, specify: community.ciscosmb.facts
.
Synopsis
Collects a base set of device facts from a remote device that is running Cisco SMB. 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 |
Comments |
---|---|
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include Choices:
Default: |
Notes
Note
Supports
check_mode
.
Examples
- name: Collect all facts from the device
community.ciscosmb.facts:
gather_subset: all
- name: Collect only the config and default facts
community.ciscosmb.facts:
gather_subset:
- config
- name: Do not collect hardware facts
community.ciscosmb.facts:
gather_subset:
- "!hardware"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
All IPv4 addresses configured on the device. Returned: when interfaces is configured |
|
All IPv6 addresses configured on the device. Returned: when interfaces is configured |
|
The current active config from the device. Returned: when config is configured |
|
Current CPU load. Returned: always |
|
The list of fact subsets collected from the device. Returned: always |
|
The configured hostname of the device. Returned: always |
|
A hash of all interfaces running on the system. Returned: when interfaces is configured |
|
The available free memory on the remote device in MiB. Returned: when hardware is configured |
|
The total memory on the remote device in MiB. Returned: when hardware is configured |
|
The model name returned from the device. Returned: always |
|
The list of neighbors from the remote device. Returned: when interfaces is configured |
|
The serial number of the remote device. Returned: always |
|
The available disk space on the remote device in MiB. Returned: when hardware is configured |
|
The total disk space on the remote device in MiB. Returned: when hardware is configured |
|
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 uptime of the device. Returned: always |
|
The operating system version running on the remote device. Returned: always |