Builds a session for use with other Batfish Ansible modules
- Builds a session for use with other Batfish Ansible modules and populates
bf_session
fact.
The following software packages must be installed on hosts that execute this module:
- pybatfish
The following options may be specified for this module:
parameter | type | required | default | comments |
---|---|---|---|---|
host |
str | yes |
Host (resolvable name or IP address) running the Batfish service.
|
|
name |
str | no | "default" |
Name of the session.
|
parameters |
dict | no | None |
Dictionary with additional parameters used to configure the session. Use
{ssl: true} to use SSL. |
# Establish session with Batfish service running on localhost - bf_session: host: localhost name: my_session # Establish SSL session with Batfish service running at 10.10.10.10 - bf_session: host: 10.10.10.10 name: my_session parameters: ssl: true # Establish SSL session with Batfish Enterprise service running at 10.10.10.10 - bf_session: host: 10.10.10.10 name: enterprise_session parameters: ssl: true session_type: bfe
name | description | returned | type | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
session |
Details about the created session.
|
always | complex | |||||||||||||
contains: |
|
|||||||||||||||
summary |
Summary of action(s) performed.
|
always | str |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.