Class: Ansible::Ruby::Modules::Iptables

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/system/iptables.rb

Overview

Iptables is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel. This module does not handle the saving and/or loading of rules, but rather only manipulates the current rules that are present in memory. This is the same as the behaviour of the C(iptables) and C(ip6tables) command which this module uses internally.

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

Returns Whether the rule should be appended at the bottom or inserted at the top.,If the rule already exists the chain won’t be modified.

Returns:

  • (:append, :insert, nil) —

    Whether the rule should be appended at the bottom or inserted at the top.,If the rule already exists the chain won’t be modified.



21
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 21

attribute :action

#chain ⇒ String?

Returns Chain to operate on.,This option can either be the name of a user defined chain or any of the builtin chains: ‘INPUT’, ‘FORWARD’, ‘OUTPUT’, ‘PREROUTING’, ‘POSTROUTING’, ‘SECMARK’, ‘CONNSECMARK’.

Returns:

  • (String, nil) —

    Chain to operate on.,This option can either be the name of a user defined chain or any of the builtin chains: ‘INPUT’, ‘FORWARD’, ‘OUTPUT’, ‘PREROUTING’, ‘POSTROUTING’, ‘SECMARK’, ‘CONNSECMARK’.



33
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 33

attribute :chain

#comment ⇒ String?

Returns This specifies a comment that will be added to the rule.

Returns:

  • (String, nil) —

    This specifies a comment that will be added to the rule.



106
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 106

attribute :comment

#ctstate ⇒ :DNAT, ...

Returns C(ctstate) is a list of the connection states to match in the conntrack module. Possible states are: ‘INVALID’, ‘NEW’, ‘ESTABLISHED’, ‘RELATED’, ‘UNTRACKED’, ‘SNAT’, ‘DNAT’.

Returns:

  • (:DNAT, :ESTABLISHED, :INVALID, :NEW, :RELATED, :SNAT, :UNTRACKED, nil) —

    C(ctstate) is a list of the connection states to match in the conntrack module. Possible states are: ‘INVALID’, ‘NEW’, ‘ESTABLISHED’, ‘RELATED’, ‘UNTRACKED’, ‘SNAT’, ‘DNAT’



110
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 110

attribute :ctstate

#destination ⇒ Object?

Returns Destination specification.,Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address.,Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea.,The mask can be either a network mask or a plain number, specifying the number of 1’s at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A “!” argument before the address specification inverts the sense of the address.

Returns:

  • (Object, nil) —

    Destination specification.,Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address.,Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea.,The mask can be either a network mask or a plain number, specifying the number of 1’s at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A “!” argument before the address specification inverts the sense of the address.



45
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 45

attribute :destination

#destination_port ⇒ Integer?

Returns Destination port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last. If the first port is omitted, ‘0’ is assumed; if the last is omitted, ‘65535’ is assumed. If the first port is greater than the second one they will be swapped. This is only valid if the rule also specifies one of the following protocols: tcp, udp, dccp or sctp.

Returns:

  • (Integer, nil) —

    Destination port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last. If the first port is omitted, ‘0’ is assumed; if the last is omitted, ‘65535’ is assumed. If the first port is greater than the second one they will be swapped. This is only valid if the rule also specifies one of the following protocols: tcp, udp, dccp or sctp.



80
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 80

attribute :destination_port

#flush ⇒ Object?

Returns Flushes the specified table and chain of all rules.,If no chain is specified then the entire table is purged.,Ignores all other parameters.

Returns:

  • (Object, nil) —

    Flushes the specified table and chain of all rules.,If no chain is specified then the entire table is purged.,Ignores all other parameters.



130
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 130

attribute :flush

#fragment ⇒ Object?

Returns This means that the rule only refers to second and further fragments of fragmented packets. Since there is no way to tell the source or destination ports of such a packet (or ICMP type), such a packet will not match any rules which specify them. When the “!” argument precedes fragment argument, the rule will only match head fragments, or unfragmented packets.

Returns:

  • (Object, nil) —

    This means that the rule only refers to second and further fragments of fragmented packets. Since there is no way to tell the source or destination ports of such a packet (or ICMP type), such a packet will not match any rules which specify them. When the “!” argument precedes fragment argument, the rule will only match head fragments, or unfragmented packets.



71
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 71

attribute :fragment

#goto ⇒ Object?

Returns This specifies that the processing should continue in a user specified chain. Unlike the jump argument return will not continue processing in this chain but instead in the chain that called us via jump.

Returns:

  • (Object, nil) —

    This specifies that the processing should continue in a user specified chain. Unlike the jump argument return will not continue processing in this chain but instead in the chain that called us via jump.



61
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 61

attribute :goto

#icmp_type ⇒ Object?

Returns This allows specification of the ICMP type, which can be a numeric ICMP type, type/code pair, or one of the ICMP type names shown by the command ‘iptables -p icmp -h’.

Returns:

  • (Object, nil) —

    This allows specification of the ICMP type, which can be a numeric ICMP type, type/code pair, or one of the ICMP type names shown by the command ‘iptables -p icmp -h’



127
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 127

attribute :icmp_type

#in_interface ⇒ String?

Returns Name of an interface via which a packet was received (only for packets entering the INPUT, FORWARD and PREROUTING chains). When the “!” argument is used before the interface name, the sense is inverted. If the interface name ends in a “+”, then any interface which begins with this name will match. If this option is omitted, any interface name will match.

Returns:

  • (String, nil) —

    Name of an interface via which a packet was received (only for packets entering the INPUT, FORWARD and PREROUTING chains). When the “!” argument is used before the interface name, the sense is inverted. If the interface name ends in a “+”, then any interface which begins with this name will match. If this option is omitted, any interface name will match.



64
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 64

attribute :in_interface

#ip_version ⇒ :ipv4, ...

Returns Which version of the IP protocol this rule should apply to.

Returns:

  • (:ipv4, :ipv6, nil) —

    Which version of the IP protocol this rule should apply to.



29
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 29

attribute :ip_version

#jump ⇒ String?

Returns This specifies the target of the rule; i.e., what to do if the packet matches it. The target can be a user-defined chain (other than the one this rule is in), one of the special builtin targets which decide the fate of the packet immediately, or an extension (see EXTENSIONS below). If this option is omitted in a rule (and the goto parameter is not used), then matching the rule will have no effect on the packet’s fate, but the counters on the rule will be incremented.

Returns:

  • (String, nil) —

    This specifies the target of the rule; i.e., what to do if the packet matches it. The target can be a user-defined chain (other than the one this rule is in), one of the special builtin targets which decide the fate of the packet immediately, or an extension (see EXTENSIONS below). If this option is omitted in a rule (and the goto parameter is not used), then matching the rule will have no effect on the packet’s fate, but the counters on the rule will be incremented.



54
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 54

attribute :jump

#limit ⇒ Object?

Returns Specifies the maximum average number of matches to allow per second.,The number can specify units explicitly, using ‘/second’, ‘/minute’, ‘/hour’ or ‘/day’, or parts of them (so ‘5/second’ is the same as ‘5/s’).

Returns:

  • (Object, nil) —

    Specifies the maximum average number of matches to allow per second.,The number can specify units explicitly, using ‘/second’, ‘/minute’, ‘/hour’ or ‘/day’, or parts of them (so ‘5/second’ is the same as ‘5/s’).



114
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 114

attribute :limit

#limit_burst ⇒ Object?

Returns Specifies the maximum burst before the above limit kicks in.

Returns:

  • (Object, nil) —

    Specifies the maximum burst before the above limit kicks in.



117
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 117

attribute :limit_burst

#log_prefix ⇒ Object?

Returns Specifies a log text for the rule. Only make sense with a LOG jump.

Returns:

  • (Object, nil) —

    Specifies a log text for the rule. Only make sense with a LOG jump.



58
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 58

attribute :log_prefix

#match ⇒ Object?

Returns Specifies a match to use, that is, an extension module that tests for a specific property. The set of matches make up the condition under which a target is invoked. Matches are evaluated first to last if specified as an array and work in short-circuit fashion, i.e. if one extension yields false, evaluation will stop.

Returns:

  • (Object, nil) —

    Specifies a match to use, that is, an extension module that tests for a specific property. The set of matches make up the condition under which a target is invoked. Matches are evaluated first to last if specified as an array and work in short-circuit fashion, i.e. if one extension yields false, evaluation will stop.



51
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 51

attribute :match

#out_interface ⇒ Object?

Returns Name of an interface via which a packet is going to be sent (for packets entering the FORWARD, OUTPUT and POSTROUTING chains). When the “!” argument is used before the interface name, the sense is inverted. If the interface name ends in a “+”, then any interface which begins with this name will match. If this option is omitted, any interface name will match.

Returns:

  • (Object, nil) —

    Name of an interface via which a packet is going to be sent (for packets entering the FORWARD, OUTPUT and POSTROUTING chains). When the “!” argument is used before the interface name, the sense is inverted. If the interface name ends in a “+”, then any interface which begins with this name will match. If this option is omitted, any interface name will match.



68
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 68

attribute :out_interface

#policy ⇒ :ACCEPT, ...

Returns Set the policy for the chain to the given target.,Only built-in chains can have policies.,This parameter requires the C(chain) parameter.,Ignores all other parameters.

Returns:

  • (:ACCEPT, :DROP, :QUEUE, :RETURN, nil) —

    Set the policy for the chain to the given target.,Only built-in chains can have policies.,This parameter requires the C(chain) parameter.,Ignores all other parameters.



133
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 133

attribute :policy

#protocol ⇒ String?

Returns The protocol of the rule or of the packet to check.,The specified protocol can be one of tcp, udp, udplite, icmp, esp, ah, sctp or the special keyword “all”, or it can be a numeric value, representing one of these protocols or a different one. A protocol name from /etc/protocols is also allowed. A “!” argument before the protocol inverts the test. The number zero is equivalent to all. “all” will match with all protocols and is taken as default when this option is omitted.

Returns:

  • (String, nil) —

    The protocol of the rule or of the packet to check.,The specified protocol can be one of tcp, udp, udplite, icmp, esp, ah, sctp or the special keyword “all”, or it can be a numeric value, representing one of these protocols or a different one. A protocol name from /etc/protocols is also allowed. A “!” argument before the protocol inverts the test. The number zero is equivalent to all. “all” will match with all protocols and is taken as default when this option is omitted.



37
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 37

attribute :protocol

#reject_with ⇒ String?

Returns Specifies the error packet type to return while rejecting. It implies “jump: REJECT”.

Returns:

  • (String, nil) —

    Specifies the error packet type to return while rejecting. It implies “jump: REJECT”



123
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 123

attribute :reject_with

#rule_num ⇒ Integer?

Returns Insert the rule as the given rule number. This works only with action = ‘insert’.

Returns:

  • (Integer, nil) —

    Insert the rule as the given rule number. This works only with action = ‘insert’.



25
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 25

attribute :rule_num

#set_counters ⇒ Object?

Returns This enables the administrator to initialize the packet and byte counters of a rule (during INSERT, APPEND, REPLACE operations).

Returns:

  • (Object, nil) —

    This enables the administrator to initialize the packet and byte counters of a rule (during INSERT, APPEND, REPLACE operations).



74
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 74

attribute :set_counters

#set_dscp_mark ⇒ Integer?

Returns This allows specifying a DSCP mark to be added to packets. It takes either an integer or hex value.,Mutually exclusive with C(set_dscp_mark_class).

Returns:

  • (Integer, nil) —

    This allows specifying a DSCP mark to be added to packets. It takes either an integer or hex value.,Mutually exclusive with C(set_dscp_mark_class).



98
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 98

attribute :set_dscp_mark

#set_dscp_mark_class ⇒ String?

Returns This allows specifying a predefined DiffServ class which will be translated to the corresponding DSCP mark.,Mutually exclusive with C(set_dscp_mark).

Returns:

  • (String, nil) —

    This allows specifying a predefined DiffServ class which will be translated to the corresponding DSCP mark.,Mutually exclusive with C(set_dscp_mark).



102
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 102

attribute :set_dscp_mark_class

#source ⇒ String?

Returns Source specification.,Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address.,Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea.,The mask can be either a network mask or a plain number, specifying the number of 1’s at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A “!” argument before the address specification inverts the sense of the address.

Returns:

  • (String, nil) —

    Source specification.,Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address.,Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea.,The mask can be either a network mask or a plain number, specifying the number of 1’s at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A “!” argument before the address specification inverts the sense of the address.



41
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 41

attribute :source

#source_port ⇒ Object?

Returns Source port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last. If the first port is omitted, ‘0’ is assumed; if the last is omitted, ‘65535’ is assumed. If the first port is greater than the second one they will be swapped.

Returns:

  • (Object, nil) —

    Source port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last. If the first port is omitted, ‘0’ is assumed; if the last is omitted, ‘65535’ is assumed. If the first port is greater than the second one they will be swapped.



77
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 77

attribute :source_port

#state ⇒ :absent, ...

Returns Whether the rule should be absent or present.

Returns:

  • (:absent, :present, nil) —

    Whether the rule should be absent or present.



17
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 17

attribute :state

#syn ⇒ :ignore, ...

Returns This allows matching packets that have the SYN bit set and the ACK and RST bits unset.,When negated, this matches all packets with the RST or the ACK bits set.

Returns:

  • (:ignore, :match, :negate, nil) —

    This allows matching packets that have the SYN bit set and the ACK and RST bits unset.,When negated, this matches all packets with the RST or the ACK bits set.



94
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 94

attribute :syn

#table ⇒ :filter, ...

Returns This option specifies the packet matching table which the command should operate on. If the kernel is configured with automatic module loading, an attempt will be made to load the appropriate module for that table if it is not already there.

Returns:

  • (:filter, :nat, :mangle, :raw, :security, nil) —

    This option specifies the packet matching table which the command should operate on. If the kernel is configured with automatic module loading, an attempt will be made to load the appropriate module for that table if it is not already there.



13
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 13

attribute :table

#tcp_flags ⇒ Object?

Returns TCP flags specification.,C(tcp_flags) expects a dict with the two keys C(flags) and C(flags_set).

Returns:

  • (Object, nil) —

    TCP flags specification.,C(tcp_flags) expects a dict with the two keys C(flags) and C(flags_set).



48
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 48

attribute :tcp_flags

#to_destination ⇒ Object?

Returns This specifies a destination address to use with DNAT.,Without this, the destination address is never altered.

Returns:

  • (Object, nil) —

    This specifies a destination address to use with DNAT.,Without this, the destination address is never altered.



88
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 88

attribute :to_destination

#to_ports ⇒ Integer?

Returns This specifies a destination port or range of ports to use: without this, the destination port is never altered. This is only valid if the rule also specifies one of the following protocols: tcp, udp, dccp or sctp.

Returns:

  • (Integer, nil) —

    This specifies a destination port or range of ports to use: without this, the destination port is never altered. This is only valid if the rule also specifies one of the following protocols: tcp, udp, dccp or sctp.



84
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 84

attribute :to_ports

#to_source ⇒ Object?

Returns This specifies a source address to use with SNAT.,Without this, the source address is never altered.

Returns:

  • (Object, nil) —

    This specifies a source address to use with SNAT.,Without this, the source address is never altered.



91
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 91

attribute :to_source

#uid_owner ⇒ Object?

Returns Specifies the UID or username to use in match by owner rule. From Ansible 2.6 when the C(!) argument is prepended then the it inverts the rule to apply instead to all users except that one specified.

Returns:

  • (Object, nil) —

    Specifies the UID or username to use in match by owner rule. From Ansible 2.6 when the C(!) argument is prepended then the it inverts the rule to apply instead to all users except that one specified.



120
 
# File 'lib/ansible/ruby/modules/generated/system/iptables.rb', line 120

attribute :uid_owner