ansible.builtin.ironware_facts (v2.8.13) — module

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

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

# Collect all facts from the device
- ironware_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
- ironware_facts:
    gather_subset:
      - config

Scanned by Steampunk Spotter

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

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

Inputs

    
authorize:
    default: false
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.7 we recommend using C(connection: network_cli) and C(become:
      true).'
    - For more information please see the L(IronWare Platform Options guide, ../network/user_guide/platform_ironware.html).
    - HORIZONTALLINE
    - 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'
    - '!mpls'
    description:
    - 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 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_filesystems:
  description: All file system names available on the device
  returned: when hardware is configured
  type: list
ansible_net_gather_subset:
  description: The list of fact subsets collected from the device
  returned: always
  type: list
ansible_net_interfaces:
  description: A hash of all interfaces running on the system
  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_memtotal_mb:
  description: The total memory on the remote device in Mb
  returned: when hardware is configured
  type: int
ansible_net_model:
  description: The model name returned from the device
  returned: always
  type: str
ansible_net_mpls_lsps:
  description: All MPLS LSPs configured on the device
  returned: When LSP is configured
  type: dict
ansible_net_mpls_vll:
  description: All VLL instances configured on the device
  returned: When MPLS VLL is configured
  type: dict
ansible_net_mpls_vll_local:
  description: All VLL-LOCAL instances configured on the device
  returned: When MPLS VLL-LOCAL is configured
  type: dict
ansible_net_mpls_vpls:
  description: All VPLS instances configured on the device
  returned: When MPLS VPLS is configured
  type: dict
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 remote device
  returned: always
  type: str
ansible_net_version:
  description: The operating system version running on the remote device
  returned: always
  type: str