community.network.ordnance_facts – Collect facts from Ordnance Virtual Routers over SSH

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

Synopsis

  • Collects a base set of device facts from an Ordnance Virtual router over SSH. 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
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.

Examples

---
# Note: examples below use the following provider dict to handle
#       transport and authentication to the node.
vars:
  cli:
    host: "{{ inventory_hostname }}"
    username: RouterName
    password: ordnance
    transport: cli

---
- name: Collect all facts from the device
  community.network.ordnance_facts:
    gather_subset: all
    provider: "{{ cli }}"

- name: Collect only the config and default facts
  community.network.ordnance_facts:
    gather_subset:
      - config
    provider: "{{ cli }}"

- name: Do not collect hardware facts
  community.network.ordnance_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 / elements=string
when interfaces is configured
All IPv4 addresses configured on the virtual router

ansible_net_all_ipv6_addresses
list / elements=string
when interfaces is configured
All IPv6 addresses configured on the virtual router

ansible_net_config
string
when config is configured
The current active config from the virtual router

ansible_net_gather_subset
list / elements=string
always
The list of fact subsets collected from the virtual router

ansible_net_interfaces
dictionary
when interfaces is configured
A hash of all interfaces running on the virtual router



Authors