Class: Ansible::Ruby::Modules::Panos_nat_rule

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

Overview

  • Create a policy nat rule. Keep in mind that we can either end up configuring source NAT, destination NAT, or both. Instead of splitting it into two we will make a fair attempt to determine which one the user wants.

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

#api_key ⇒ Object?

Returns API key that can be used instead of I(username)/I(password) credentials.

Returns:

  • (Object, nil) —

    API key that can be used instead of I(username)/I(password) credentials.



25
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 25

attribute :api_key

#commit ⇒ :yes, ...

Returns Commit configuration if changed.

Returns:

  • (:yes, :no, nil) —

    Commit configuration if changed.



88
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 88

attribute :commit

#destination_ip ⇒ String?

Returns list of destination addresses.

Returns:

  • (String, nil) —

    list of destination addresses



47
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 47

attribute :destination_ip

#destination_zone ⇒ String

Returns destination zone.

Returns:

  • (String) —

    destination zone



39
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 39

attribute :destination_zone

#dnat_address ⇒ String?

Returns dnat translated address.

Returns:

  • (String, nil) —

    dnat translated address



80
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 80

attribute :dnat_address

#dnat_port ⇒ String?

Returns dnat translated port.

Returns:

  • (String, nil) —

    dnat translated port



84
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 84

attribute :dnat_port

#ip_address ⇒ String

Returns IP address (or hostname) of PAN-OS device being configured.

Returns:

  • (String) —

    IP address (or hostname) of PAN-OS device being configured.



13
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 13

attribute :ip_address

#operation ⇒ Object?

Returns The action to be taken. Supported values are I(add)/I(update)/I(find)/I(delete).

Returns:

  • (Object, nil) —

    The action to be taken. Supported values are I(add)/I(update)/I(find)/I(delete).



28
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 28

attribute :operation

#password ⇒ String

Returns Password credentials to use for auth unless I(api_key) is set.

Returns:

  • (String) —

    Password credentials to use for auth unless I(api_key) is set.



21
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 21

attribute :password

#rule_name ⇒ String

Returns name of the SNAT rule.

Returns:

  • (String) —

    name of the SNAT rule



31
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 31

attribute :rule_name

#service ⇒ String?

Returns service.

Returns:

  • (String, nil) —

    service



51
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 51

attribute :service

#snat_address_type ⇒ String?

Returns type of source translation. Supported values are I(translated-address)/I(translated-address).

Returns:

  • (String, nil) —

    type of source translation. Supported values are I(translated-address)/I(translated-address).



59
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 59

attribute :snat_address_type

#snat_bidirectional ⇒ :yes, ...

Returns bidirectional flag.

Returns:

  • (:yes, :no, nil) —

    bidirectional flag



76
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 76

attribute :snat_bidirectional

#snat_dynamic_address ⇒ Object?

Returns Source NAT translated address. Used with Dynamic-IP and Dynamic-IP-and-Port.

Returns:

  • (Object, nil) —

    Source NAT translated address. Used with Dynamic-IP and Dynamic-IP-and-Port.



66
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 66

attribute :snat_dynamic_address

#snat_interface ⇒ String?

Returns snat interface.

Returns:

  • (String, nil) —

    snat interface



69
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 69

attribute :snat_interface

#snat_interface_address ⇒ Object?

Returns snat interface address.

Returns:

  • (Object, nil) —

    snat interface address



73
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 73

attribute :snat_interface_address

#snat_static_address ⇒ Object?

Returns Source NAT translated address. Used with Static-IP translation.

Returns:

  • (Object, nil) —

    Source NAT translated address. Used with Static-IP translation.



63
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 63

attribute :snat_static_address

#snat_type ⇒ String?

Returns type of source translation.

Returns:

  • (String, nil) —

    type of source translation



55
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 55

attribute :snat_type

#source_ip ⇒ String?

Returns list of source addresses.

Returns:

  • (String, nil) —

    list of source addresses



43
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 43

attribute :source_ip

#source_zone ⇒ Array<String>, String

Returns list of source zones.

Returns:

  • (Array<String>, String) —

    list of source zones



35
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 35

attribute :source_zone

#username ⇒ String?

Returns Username credentials to use for auth unless I(api_key) is set.

Returns:

  • (String, nil) —

    Username credentials to use for auth unless I(api_key) is set.



17
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_nat_rule.rb', line 17

attribute :username