261 lines
8.4 KiB
Python
261 lines
8.4 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = """
|
|
module: nxos_facts
|
|
extends_documentation_fragment:
|
|
- cisco.nxos.nxos
|
|
short_description: Gets facts about NX-OS switches
|
|
description:
|
|
- Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact
|
|
collection is supported over both Cli and Nxapi transports. 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.
|
|
version_added: 1.0.0
|
|
author:
|
|
- Jason Edelman (@jedelman8)
|
|
- Gabriele Gerbino (@GGabriele)
|
|
notes:
|
|
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
|
- Unsupported for Cisco MDS
|
|
options:
|
|
gather_subset:
|
|
description:
|
|
- When supplied, this argument will restrict the facts collected to a given subset. Possible
|
|
values for this argument include C(all), C(hardware), C(config), C(legacy), and C(interfaces). Can
|
|
specify a list of values to include a larger subset. Values can also be used
|
|
with an initial C(!) to specify that a specific subset should not be collected.
|
|
required: false
|
|
default: '!config'
|
|
type: list
|
|
elements: str
|
|
gather_network_resources:
|
|
description:
|
|
- When supplied, this argument will restrict the facts collected to a given subset.
|
|
Possible values for this argument include all and the resources like interfaces,
|
|
vlans etc. Can specify a list of values to include a larger subset. Values can
|
|
also be used with an initial C(!) to specify that a specific subset should
|
|
not be collected. Valid subsets are C(all), C(bfd_interfaces), C(lag_interfaces),
|
|
C(telemetry), C(vlans), C(lacp), C(lacp_interfaces), C(interfaces), C(l3_interfaces),
|
|
C(l2_interfaces), C(lldp_global), C(acls), C(acl_interfaces), C(ospfv2), C(ospfv3), C(ospf_interfaces),
|
|
C(bgp_global), C(bgp_address_family), C(route_maps), C(prefix_lists), C(logging_global), C(ntp_global), C(snmp_server).
|
|
required: false
|
|
type: list
|
|
elements: str
|
|
available_network_resources:
|
|
description: When 'True' a list of network resources for which resource modules are available will be provided.
|
|
type: bool
|
|
default: false
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: Gather all legacy facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset: all
|
|
- name: Gather only the config and default facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset:
|
|
- config
|
|
- name: Do not gather hardware facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset:
|
|
- '!hardware'
|
|
- name: Gather legacy and resource facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset: all
|
|
gather_network_resources: all
|
|
- name: Gather only the interfaces resource facts and no legacy facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset:
|
|
- '!all'
|
|
- '!min'
|
|
gather_network_resources:
|
|
- interfaces
|
|
- name: Gather interfaces resource and minimal legacy facts
|
|
cisco.nxos.nxos_facts:
|
|
gather_subset: min
|
|
gather_network_resources: interfaces
|
|
"""
|
|
|
|
RETURN = """
|
|
ansible_net_gather_subset:
|
|
description: The list of fact subsets collected from the device
|
|
returned: always
|
|
type: list
|
|
ansible_net_gather_network_resources:
|
|
description: The list of fact for network resource subsets collected from the device
|
|
returned: when the resource is configured
|
|
type: list
|
|
# default
|
|
ansible_net_model:
|
|
description: The model name returned from the device
|
|
returned: always
|
|
type: str
|
|
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
|
|
ansible_net_hostname:
|
|
description: The configured hostname of the device
|
|
returned: always
|
|
type: str
|
|
ansible_net_image:
|
|
description: The image file the device is running
|
|
returned: always
|
|
type: str
|
|
ansible_net_api:
|
|
description: The name of the transport
|
|
returned: always
|
|
type: str
|
|
ansible_net_license_hostid:
|
|
description: The License host id of the device
|
|
returned: always
|
|
type: str
|
|
ansible_net_python_version:
|
|
description: The Python version Ansible controller is using
|
|
returned: always
|
|
type: str
|
|
# hardware
|
|
ansible_net_filesystems:
|
|
description: All file system names available on the device
|
|
returned: when hardware is configured
|
|
type: list
|
|
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
|
|
# config
|
|
ansible_net_config:
|
|
description: The current active config from the device
|
|
returned: when config is configured
|
|
type: str
|
|
# interfaces
|
|
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_interfaces:
|
|
description: A hash of all interfaces running on the system
|
|
returned: when interfaces is configured
|
|
type: dict
|
|
ansible_net_neighbors:
|
|
description:
|
|
- The list of LLDP and CDP neighbors from the device. If both,
|
|
CDP and LLDP neighbor data is present on one port, CDP is preferred.
|
|
returned: when interfaces is configured
|
|
type: dict
|
|
# legacy (pre Ansible 2.2)
|
|
fan_info:
|
|
description: A hash of facts about fans in the remote device
|
|
returned: when legacy is configured
|
|
type: dict
|
|
hostname:
|
|
description: The configured hostname of the remote device
|
|
returned: when legacy is configured
|
|
type: dict
|
|
interfaces_list:
|
|
description: The list of interface names on the remote device
|
|
returned: when legacy is configured
|
|
type: dict
|
|
kickstart:
|
|
description: The software version used to boot the system
|
|
returned: when legacy is configured
|
|
type: str
|
|
module:
|
|
description: A hash of facts about the modules in a remote device
|
|
returned: when legacy is configured
|
|
type: dict
|
|
platform:
|
|
description: The hardware platform reported by the remote device
|
|
returned: when legacy is configured
|
|
type: str
|
|
power_supply_info:
|
|
description: A hash of facts about the power supplies in the remote device
|
|
returned: when legacy is configured
|
|
type: str
|
|
vlan_list:
|
|
description: The list of VLAN IDs configured on the remote device
|
|
returned: when legacy is configured
|
|
type: list
|
|
"""
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.argspec.facts.facts import (
|
|
FactsArgs,
|
|
)
|
|
from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.facts.facts import (
|
|
Facts,
|
|
FACT_RESOURCE_SUBSETS,
|
|
)
|
|
from ansible_collections.cisco.nxos.plugins.module_utils.network.nxos.nxos import (
|
|
nxos_argument_spec,
|
|
)
|
|
|
|
|
|
def main():
|
|
"""
|
|
Main entry point for module execution
|
|
|
|
:returns: ansible_facts
|
|
"""
|
|
argument_spec = FactsArgs.argument_spec
|
|
argument_spec.update(nxos_argument_spec)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec, supports_check_mode=True
|
|
)
|
|
|
|
warnings = []
|
|
if module.params["gather_subset"] == "!config":
|
|
warnings.append(
|
|
"default value for `gather_subset` will be changed to `min` from `!config` v2.11 onwards"
|
|
)
|
|
|
|
ansible_facts = {}
|
|
if module.params.get("available_network_resources"):
|
|
ansible_facts["available_network_resources"] = sorted(
|
|
FACT_RESOURCE_SUBSETS.keys()
|
|
)
|
|
result = Facts(module).get_facts()
|
|
additional_facts, additional_warnings = result
|
|
ansible_facts.update(additional_facts)
|
|
warnings.extend(additional_warnings)
|
|
|
|
module.exit_json(ansible_facts=ansible_facts, warnings=warnings)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|