cnos_facts - Collect facts from remote devices running Lenovo CNOS
New in version 2.3.
Synopsis
- Collects a base set of device facts from a remote Lenovo device running on CNOS. 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 | |
|---|---|---|---|
| auth_pass
(added in 2.6)
|
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
bool
(added in 2.6)
|
|
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
(added in 2.6)
|
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
(added in 2.6)
|
A dict object containing connection details.
|
||
| host
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.
|
||
| port | Default:
22
|
Specifies the port to use when building the connection to the remote device.
|
|
| username |
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.
|
||
| password |
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.
|
||
| timeout | Default:
10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
| ssh_keyfile |
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.
|
||
Notes
Note
- Tested against CNOS 10.8.0.42
Examples
Tasks: The following are examples of using the module cnos_facts.
---
- name: Test cnos Facts
cnos_facts:
provider={{ cli }}
vars:
cli:
host: "{{ inventory_hostname }}"
port: 22
username: admin
password: admin
transport: cli
timeout: 30
authorize: True
auth_pass:
---
# Collect all facts from the device
- cnos_facts:
gather_subset: all
provider: "{{ cli }}"
# Collect only the config and default facts
- cnos_facts:
gather_subset:
- config
provider: "{{ cli }}"
# Do not collect hardware facts
- cnos_facts:
gather_subset:
- "!hardware"
provider: "{{ cli }}"
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
str
|
when config is configured |
The current active config from the 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_image
string
|
always |
Indicates the active image for the device
|
| ansible_net_interfaces
dict
|
when interfaces is configured |
A hash of all interfaces running on the system. This gives information on description, mac address, mtu, speed, duplex and operstatus
|
| ansible_net_memfree_mb
int
|
when hardware is configured |
The available free memory on the remote device in MB
|
| ansible_net_model
str
|
always |
The model name returned from the Lenovo CNOS device
|
| ansible_net_neighbors
dict
|
when interfaces is configured |
The list of LLDP neighbors from the remote device
|
| ansible_net_serialnum
str
|
always |
The serial number of the Lenovo CNOS device
|
| ansible_net_version
str
|
always |
The CNOS operating system version running on the remote device
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Anil Kumar Muraleedharan (@amuraleedhar)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/cnos_facts_module.html