bf_upload_diagnostics.rst

bf_upload_diagnostics

Upload anonymized diagnostic information about a Batfish snapshot

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

Synopsis

• Fetches, anonymizes, and uploads diagnostic information about a Batfish snapshot. This runs a series of diagnostic questions on the specified snapshot, which are then anonymized with Netconan (https://github.com/intentionet/netconan), and optionally uploaded to the Batfish developers. By default, passwords are stripped and IP addresses are anonymized.

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
contact_info	str	no		Contact information associated with this upload.
dry_run	bool	no	True	Whether or not to skip upload. If true, upload is skipped and the anonymized files will be stored locally for review. If false, anonymized files will be uploaded to the Batfish developers.
netconan_config	bool	no	Anonymize passwords and IP addresses.	Path to Netconan (https://github.com/intentionet/netconan) configuration file, containing settings used for information anonymization.
network	str	no	Value in the bf_network fact.	Name of the network to collect diagnostic information from.
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 collect diagnostic information about.

Examples

# Generate diagnostic information about the specified snapshot and save locally (do not upload)
- bf_upload_diagnostics
    network: datacenter_sea
    snapshot: 2019-01-01
    dry_run: true
    contact_info: my.email@example.com
# Generate diagnostic information about the specified snapshot and upload to the Batfish developers
- bf_upload_diagnostics
    network: datacenter_sea
    snapshot: 2019-01-01
    dry_run: false
    contact_info: my.email@example.com

Return Values

name	description	returned	type
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.