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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/windows/win_firewall_rule.rb

Overview

allows you to create/remove/update firewall rules

Instance Method Summary

• #action ⇒ :allow, :block

  What to do with the items this rule is for.

• #description ⇒ Object^?

  Description for the firewall rule.

• #direction ⇒ :In, :Out

  Is this rule for inbound or outbound trafic.

• #enable ⇒ :yes, ...

  Is this firewall rule enabled or disabled.

• #force ⇒ Boolean^?

  Enforces the change if a rule with different values exists.

• #localip ⇒ Object^?

  The local ip address this rule applies to.

• #localport ⇒ Integer^?

  The local port this rule applies to.

• #name ⇒ String

  The rules name.

• #profile ⇒ Object^?

  The profile this rule applies to.

• #program ⇒ Object^?

  The program this rule applies to.

• #protocol ⇒ String^?

  The protocol this rule applies to.

• #remoteip ⇒ Object^?

  The remote ip address/range this rule applies to.

• #remoteport ⇒ Object^?

  The remote port this rule applies to.

• #service ⇒ Object^?

  The service this rule applies to.

• #state ⇒ :present, :absent

  Should this rule be added or removed.

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

#action ⇒ :allow, :block

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

Returns:

• (:allow, :block) —

  what to do with the items this rule is for

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

attribute :action

#description ⇒ Object^?

Returns description for the firewall rule.

Returns:

• (Object, nil) —

  description for the firewall rule

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

attribute :description

#direction ⇒ :In, :Out

Returns is this rule for inbound or outbound trafic.

Returns:

• (:In, :Out) —

  is this rule for inbound or outbound trafic

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

attribute :direction

#enable ⇒ :yes, ...

Returns is this firewall rule enabled or disabled.

Returns:

• (:yes, :no, nil) —

  is this firewall rule enabled or disabled

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

attribute :enable

#force ⇒ Boolean^?

Returns Enforces the change if a rule with different values exists.

Returns:

• (Boolean, nil) —

  Enforces the change if a rule with different values exists

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

attribute :force

#localip ⇒ Object^?

Returns the local ip address this rule applies to.

Returns:

• (Object, nil) —

  the local ip address this rule applies to

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

attribute :localip

#localport ⇒ Integer^?

Returns the local port this rule applies to.

Returns:

• (Integer, nil) —

  the local port this rule applies to

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

attribute :localport

#name ⇒ String

Returns the rules name.

Returns:

• (String) —

  the rules name

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

attribute :name

#profile ⇒ Object^?

Returns the profile this rule applies to.

Returns:

• (Object, nil) —

  the profile this rule applies to

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

attribute :profile

#program ⇒ Object^?

Returns the program this rule applies to.

Returns:

• (Object, nil) —

  the program this rule applies to

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

attribute :program

#protocol ⇒ String^?

Returns the protocol this rule applies to.

Returns:

• (String, nil) —

  the protocol this rule applies to

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

attribute :protocol

#remoteip ⇒ Object^?

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

Returns:

• (Object, nil) —

  the remote ip address/range this rule applies to

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

attribute :remoteip

#remoteport ⇒ Object^?

Returns the remote port this rule applies to.

Returns:

• (Object, nil) —

  the remote port this rule applies to

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

attribute :remoteport

#service ⇒ Object^?

Returns the service this rule applies to.

Returns:

• (Object, nil) —

  the service this rule applies to

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

attribute :service

#state ⇒ :present, :absent

Returns should this rule be added or removed.

Returns:

• (:present, :absent) —

  should this rule be added or removed

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

attribute :state