Documentation

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

New in version 2.3.

Synopsis

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

Options

parameter required default choices comments
access_token
 no
Bigmon access token. If this isn't set, the environment variable BIGSWITCH_ACCESS_TOKEN is used.
action
 no forward
  • 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
 yes
The controller address.
delivery_packet_count
 no
Run policy until delivery_packet_count packets are delivered.
duration
 no
Run policy for duration duration or until delivery_packet_count packets are delivered, whichever comes first.
name
 yes
The name of the policy.
policy_description
 no
Description of policy.
priority
 no 100
A priority associated with this policy. The higher priority policy takes precedence over a lower priority.
start_time
 no ansible_date_time.iso8601
Date the policy becomes active
state
 no present
  • present
  • absent
Whether the policy should be present or absent.
validate_certs
 no True
  • True
  • False
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
  bigmon_policy:
    name: policy1
    policy_description: DC 1 traffic policy
    action: drop
    controller: '{{ inventory_hostname }}'
    state: present
    validate_certs: false

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.