Class: Ansible::Ruby::Modules::Win_firewall_rule

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb

Overview

Allows you to create/remove/update firewall rules.

Instance Method Summary collapse

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 ⇒ :allow, ...

Returns What to do with the items this rule is for.

Returns:

  • (:allow, :block, :bypass) —

    What to do with the items this rule is for.



28
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 28

attribute :action

#description ⇒ Object?

Returns Description for the firewall rule.

Returns:

  • (Object, nil) —

    Description for the firewall rule.



32
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 32

attribute :description

#direction ⇒ :in, :out

Returns Is this rule for inbound or outbound traffic.

Returns:

  • (:in, :out) —

    Is this rule for inbound or outbound traffic.



24
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 24

attribute :direction

#enabled ⇒ :yes, ...

Returns Is this firewall rule enabled or disabled.

Returns:

  • (:yes, :no, nil) —

    Is this firewall rule enabled or disabled.



12
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 12

attribute :enabled

#force ⇒ :yes, ...

Returns Replace any existing rule by removing it first.,This is no longer required in 2.4 as rules no longer need replacing when being modified.,DEPRECATED in 2.4 and will be removed in 2.9.

Returns:

  • (:yes, :no, nil) —

    Replace any existing rule by removing it first.,This is no longer required in 2.4 as rules no longer need replacing when being modified.,DEPRECATED in 2.4 and will be removed in 2.9.



64
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 64

attribute :force

#localip ⇒ String?

Returns The local ip address this rule applies to.

Returns:

  • (String, nil) —

    The local ip address this rule applies to.



35
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 35

attribute :localip

#localport ⇒ Integer?

Returns The local port this rule applies to.

Returns:

  • (Integer, nil) —

    The local port this rule applies to.



43
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 43

attribute :localport

#name ⇒ String

Returns The rules name.

Returns:

  • (String) —

    The rules name



20
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 20

attribute :name

#profiles ⇒ Array<String>, ...

Returns The profile this rule applies to.

Returns:

  • (Array<String>, String, nil) —

    The profile this rule applies to.



60
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 60

attribute :profiles

#program ⇒ Object?

Returns The program this rule applies to.

Returns:

  • (Object, nil) —

    The program this rule applies to.



50
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 50

attribute :program

#protocol ⇒ String?

Returns The protocol this rule applies to.

Returns:

  • (String, nil) —

    The protocol this rule applies to.



56
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 56

attribute :protocol

#remoteip ⇒ String?

Returns The remote ip address/range this rule applies to.

Returns:

  • (String, nil) —

    The remote ip address/range this rule applies to.



39
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 39

attribute :remoteip

#remoteport ⇒ Object?

Returns The remote port this rule applies to.

Returns:

  • (Object, nil) —

    The remote port this rule applies to.



47
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 47

attribute :remoteport

#service ⇒ Object?

Returns The service this rule applies to.

Returns:

  • (Object, nil) —

    The service this rule applies to.



53
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 53

attribute :service

#state ⇒ :absent, ...

Returns Should this rule be added or removed.

Returns:

  • (:absent, :present, nil) —

    Should this rule be added or removed.



16
 
# File 'lib/ansible/ruby/modules/generated/windows/win_firewall_rule.rb', line 16

attribute :state