community.general.cnos_facts (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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 C(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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

Tasks: The following are examples of using the module cnos_facts.
---
- name: Test cnos Facts
  cnos_facts:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

Tasks: The following are examples of using the module cnos_facts.
---
- name: Test cnos Facts
  cnos_facts:

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Do not collect hardware facts
- cnos_facts:
    gather_subset:
      - "!hardware"

Inputs

    
auth_pass:
    description:
    - Specifies the password to use if required to enter privileged mode on the remote
      device.  If I(authorize) is false, then this argument does nothing. If the value
      is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
      will be used instead.

authorize:
    default: 'no'
    description:
    - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
    type: bool

gather_subset:
    default: '!config'
    description:
    - 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
      C(M(!)) to specify that a specific subset should not be collected.
    required: false

Outputs

ansible_net_all_ipv4_addresses:
  description: All IPv4 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_all_ipv6_addresses:
  description: All IPv6 addresses configured on the device
  returned: when interfaces is configured
  type: list
ansible_net_config:
  description: The current active config from the device
  returned: when config is configured
  type: str
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_hostname:
  description: The configured hostname of the device
  returned: always
  type: str
ansible_net_image:
  description: Indicates the active image for the device
  returned: always
  type: str
ansible_net_interfaces:
  description: A hash of all interfaces running on the system. This gives information
    on description, mac address, mtu, speed, duplex and operstatus
  returned: when interfaces is configured
  type: dict
ansible_net_memfree_mb:
  description: The available free memory on the remote device in MB
  returned: when hardware is configured
  type: int
ansible_net_model:
  description: The model name returned from the Lenovo CNOS device
  returned: always
  type: str
ansible_net_neighbors:
  description: The list of LLDP neighbors from the remote device
  returned: when interfaces is configured
  type: dict
ansible_net_serialnum:
  description: The serial number of the Lenovo CNOS device
  returned: always
  type: str
ansible_net_version:
  description: The CNOS operating system version running on the remote device
  returned: always
  type: str