bf_set_snapshot.rst

bf_set_snapshot

Set the current Batfish snapshot

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

Synopsis

• Set the current Batfish network and snapshot.

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
network	str	yes		Name of the network to set as the active network.
session	dict	no	Value in the bf_session fact.	Batfish session object required to connect to the Batfish service.
snapshot	str	yes		Name of the snapshot to set as the active snapshot. This snapshot must already exist.

Examples

# Set the current snapshot and network names
- bf_set_snapshot
    network: datacenter_sea
    snapshot: 2019-01-01

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.