community.general.bigmon_policy (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - The name of the policy.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the policy should be present or absent.

action:
    choices:
    - forward
    - drop
    - flow-gen
    default: forward
    description:
    - 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.

duration:
    default: 0
    description:
    - Run policy for duration duration or until delivery_packet_count packets are delivered,
      whichever comes first.

priority:
    default: 100
    description:
    - A priority associated with this policy. The higher priority policy takes precedence
      over a lower priority.

controller:
    description:
    - The controller address.
    required: true

start_time:
    default: ansible_date_time.iso8601
    description:
    - Date the policy becomes active

access_token:
    description:
    - Bigmon access token. If this isn't set, the environment variable C(BIGSWITCH_ACCESS_TOKEN)
      is used.

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled devices using self-signed certificates.
    required: false
    type: bool

policy_description:
    description:
    - Description of policy.

delivery_packet_count:
    default: 0
    description:
    - Run policy until delivery_packet_count packets are delivered.