Documentation

ordnance_facts - Collect facts from Ordnance Virtual Routers over SSH

New in version 2.3.

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.

Options

parameter required default choices comments
gather_subset
no !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

---
# Collect all facts from the device
- ordnance_facts:
    gather_subset: all
    provider: "{{ cli }}"

# Collect only the config and default facts
- ordnance_facts:
    gather_subset:
      - config
    provider: "{{ cli }}"

# Do not collect hardware facts
- ordnance_facts:
    gather_subset:
      - "!hardware"
    provider: "{{ cli }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
ansible_net_all_ipv4_addresses
All IPv4 addresses configured on the virtual router
when interfaces is configured list
ansible_net_config
The current active config from the virtual router
when config is configured str
ansible_net_all_ipv6_addresses
All IPv6 addresses configured on the virtual router
when interfaces is configured list
ansible_net_gather_subset
The list of fact subsets collected from the virtual router
always list
ansible_net_interfaces
A hash of all interfaces running on the virtual router
when interfaces is configured dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.