Class: Ansible::Ruby::Modules::Bigmon_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#access_token ⇒ Object?

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

Returns:

  • (Object, nil) —

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



52
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 52

attribute :access_token

#action ⇒ :forward, ...

Returns 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.

Returns:

  • (:forward, :drop, :"flow-gen", nil) —

    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.



20
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 20

attribute :action

#controller ⇒ String

Returns The controller address.

Returns:

  • (String) —

    The controller address.



44
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 44

attribute :controller

#delivery_packet_count ⇒ Integer?

Returns Run policy until delivery_packet_count packets are delivered.

Returns:

  • (Integer, nil) —

    Run policy until delivery_packet_count packets are delivered.



36
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 36

attribute :delivery_packet_count

#duration ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



28
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 28

attribute :duration

#name ⇒ String

Returns The name of the policy.

Returns:

  • (String) —

    The name of the policy.



12
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 12

attribute :name

#policy_description ⇒ String?

Returns Description of policy.

Returns:

  • (String, nil) —

    Description of policy.



16
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 16

attribute :policy_description

#priority ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



24
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 24

attribute :priority

#start_time ⇒ String?

Returns Date the policy becomes active.

Returns:

  • (String, nil) —

    Date the policy becomes active



32
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 32

attribute :start_time

#state ⇒ :present, ...

Returns Whether the policy should be present or absent.

Returns:

  • (:present, :absent, nil) —

    Whether the policy should be present or absent.



40
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 40

attribute :state

#validate_certs ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



48
 
# File 'lib/ansible/ruby/modules/generated/network/bigswitch/bigmon_policy.rb', line 48

attribute :validate_certs