Class: Ansible::Ruby::Modules::Bigip_firewall_rule

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_firewall_rule

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb

Overview

Manages firewall rules in an AFM firewall policy. New rules will always be added to the end of the policy. Rules can be re-ordered using the C(bigip_security_policy) module. Rules can also be pre-ordered using the C(bigip_security_policy) module and then later updated using the C(bigip_firewall_rule) module.

Instance Method Summary

• #action ⇒ :accept, ...

  Specifies the action for the firewall rule.,When C(accept), allows packets with the specified source, destination, and protocol to pass through the firewall.

• #description ⇒ Object^?

  The rule description.

• #destination ⇒ Array<Hash>, ...

  Specifies packet destinations to which the rule applies.,Leaving this field blank applies the rule to all addresses and all ports.,You can specify the following destination items.

• #icmp_message ⇒ Hash^?

  Specifies the Internet Control Message Protocol (ICMP) or ICMPv6 message C(type) and C(code) that the rule uses.,This parameter is only relevant when C(protocol) is either C(icmp)(1) or C(icmpv6)(58).

• #irule ⇒ String^?

  Specifies an iRule that is applied to the rule.,An iRule can be started when the firewall rule matches traffic.

• #logging ⇒ Symbol^?

  Specifies whether logging is enabled or disabled for the firewall rule.,When creating a new rule, if this parameter is not specified, the default if C(no).

• #name ⇒ String

  Specifies the name of the rule.

• #parent_policy ⇒ String^?

  The policy which contains the rule to be managed.,One of either C(parent_policy) or C(parent_rule_list) is required.

• #parent_rule_list ⇒ Object^?

  The rule list which contains the rule to be managed.,One of either C(parent_policy) or C(parent_rule_list) is required.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #protocol ⇒ String^?

  Specifies the protocol to which the rule applies.,Protocols may be specified by either their name or numeric value.,A special protocol value C(any) can be specified to match any protocol.

• #rule_list ⇒ String^?

  Specifies an existing rule list to use in the rule.,This parameter is mutually exclusive with many of the other individual-rule specific settings.

• #schedule ⇒ Object^?

  Specifies a schedule for the firewall rule.,You configure schedules to define days and times when the firewall rule is made active.

• #source ⇒ Array<Hash>, ...

  Specifies packet sources to which the rule applies.,Leaving this field blank applies the rule to all addresses and all ports.,You can specify the following source items.

• #state ⇒ :present, ...

  When C(state) is C(present), ensures that the rule exists.,When C(state) is C(absent), ensures that the rule is removed.

• #status ⇒ :enabled, ...

  Indicates the activity state of the rule or rule list.,When C(disabled), specifies that the rule or rule list does not apply at all.,When C(enabled), specifies that the system applies the firewall rule or rule list to the given context and addresses.,When C(scheduled), specifies that the system applies the rule or rule list according to the specified schedule.,When creating a new rule, if this parameter is not provided, the default is C(enabled).

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#action ⇒ :accept, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 23

attribute :action

#description ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 34

attribute :description

#destination ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 49

attribute :destination

#icmp_message ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 61

attribute :icmp_message

#irule ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 37

attribute :irule

#logging ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 53

attribute :logging

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 12

attribute :name

#parent_policy ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 16

attribute :parent_policy

#parent_rule_list ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 20

attribute :parent_rule_list

#partition ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 65

attribute :partition

#protocol ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 41

attribute :protocol

#rule_list ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 57

attribute :rule_list

#schedule ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 31

attribute :schedule

#source ⇒ Array<Hash>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 45

attribute :source

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 69

attribute :state

#status ⇒ :enabled, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_firewall_rule.rb', line 27

attribute :status