community.network.icx_facts – Collect facts from remote Ruckus ICX 7000 series switches

From Get docs
Ansible/docs/2.11/collections/community/network/icx facts module


community.network.icx_facts – Collect facts from remote Ruckus ICX 7000 series switches

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.icx_facts.


Synopsis

  • Collects a base set of device facts from a remote device that is running ICX. 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

gather_subset

list / elements=string

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.



Notes

Note


Examples

- name: Collect all facts from the device
  community.network.icx_facts:
    gather_subset: all

- name: Collect only the config and default facts
  community.network.icx_facts:
    gather_subset:
      - config

- name: Do not collect hardware facts
  community.network.icx_facts:
    gather_subset:
      - "!hardware"

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 / elements=string

when interfaces is configured

All IPv4 addresses configured on the device


ansible_net_all_ipv6_addresses

list / elements=string

when interfaces is configured

All IPv6 addresses configured on the device


ansible_net_config

string

when config is configured

The current active config from the device


ansible_net_filesystems

list / elements=string

when hardware is configured

All file system names available on the device


ansible_net_filesystems_info

dictionary

when hardware is configured

A hash of all file systems containing info about each file system (e.g. free and total space)


ansible_net_gather_subset

list / elements=string

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

The image file the device is running


ansible_net_interfaces

dictionary

when interfaces is configured

A hash of all interfaces running on the system


ansible_net_memfree_mb

integer

when hardware is configured

The available free memory on the remote device in Mb


ansible_net_memtotal_mb

integer

when hardware is configured

The total memory on the remote device in Mb


ansible_net_model

string

always

The model name returned from the device


ansible_net_neighbors

dictionary

when interfaces is configured

The list of LLDP neighbors from the remote device


ansible_net_serialnum

string

always

The serial number of the remote device


ansible_net_stacked_models

list / elements=string

when multiple devices are configured in a stack

The model names of each device in the stack


ansible_net_stacked_serialnums

list / elements=string

when multiple devices are configured in a stack

The serial numbers of each device in the stack


ansible_net_version

string

always

The operating system version running on the remote device





Authors

  • Ruckus Wireless (@Commscope)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/icx_facts_module.html