bf_validate_facts.rst

bf_validate_facts

Validates facts for the current Batfish snapshot against the facts in the supplied directory

• Synopsis
• Requirements
• Module-specific Options
• Examples
• Return Values
  • Status

Synopsis

• Validates facts for the current Batfish snapshot against the facts in the expected_facts directory

Requirements

The following software packages must be installed on hosts that execute this module:

• pybatfish

Module-specific Options

The following options may be specified for this module:

parameter	type	required	default	comments
expected_facts	str	yes		Directory to read expected facts from.
network	str	no	Value in the bf_network fact.	Name of the network to validate facts for.
session	dict	no	Value in the bf_session fact.	Batfish session object required to connect to the Batfish service.
snapshot	str	no	Value in the bf_snapshot fact.	Name of the snapshot to validate facts for.

Examples

# Validate current snapshot facts against local YAML facts
- bf_validate_facts:
    expected_facts: /path/to/local/YAML/files/

Return Values

name	description	returned	type
result	Contains a map of node-name to dictionary of failures for that node.	when validation does not pass	dict
summary	Summary of action(s) performed.	always	str

Status

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