community.network.bigmon_policy module – Create and remove a bigmon out-of-band policy.

Note

This module is part of the community.network collection (version 3.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.bigmon_policy.

Synopsis

  • Create and remove a bigmon out-of-band policy.

Parameters

Parameter

Comments

access_token

string

Bigmon access token. If this isn’t set, the environment variable BIGSWITCH_ACCESS_TOKEN is used.

action

string

Forward matching packets to delivery interfaces, Drop is for measure rate of matching packets, but do not forward to delivery interfaces, capture packets and write to a PCAP file, or enable NetFlow generation.

Choices:

  • forward ← (default)

  • drop

  • flow-gen

controller

string / required

The controller address.

delivery_packet_count

string

Run policy until delivery_packet_count packets are delivered.

Default: 0

duration

string

Run policy for duration duration or until delivery_packet_count packets are delivered, whichever comes first.

Default: 0

name

string / required

The name of the policy.

policy_description

string

Description of policy.

priority

string

A priority associated with this policy. The higher priority policy takes precedence over a lower priority.

Default: 100

start_time

string

Date the policy becomes active

Default: “ansible_date_time.iso8601”

state

string

Whether the policy should be present or absent.

Choices:

  • present ← (default)

  • absent

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled devices using self-signed certificates.

Choices:

  • no

  • yes ← (default)

Examples

- name: Policy to aggregate filter and deliver data center (DC) 1 traffic
  community.network.bigmon_policy:
    name: policy1
    policy_description: DC 1 traffic policy
    action: drop
    controller: '{{ inventory_hostname }}'
    state: present
    validate_certs: false

Authors

  • Ted (@tedelhourani)