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

From Get docs
Ansible/docs/2.11/collections/community/network/bigmon policy module


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

Note

This plugin is part of the community.network collection (version 2.0.1).

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 Choices/Defaults Comments

access_token

string

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

action

string

  • forward

  • drop
  • flow-gen

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.

controller

string / required

The controller address.

delivery_packet_count

string

Default:

0

Run policy until delivery_packet_count packets are delivered.

duration

string

Default:

0

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

name

string / required

The name of the policy.

policy_description

string

Description of policy.

priority

string

Default:

100

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

start_time

string

Default:

"ansible_date_time.iso8601"

Date the policy becomes active

state

string

  • present

  • absent

Whether the policy should be present or absent.

validate_certs

boolean

  • no
  • yes

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



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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/bigmon_policy_module.html