Class: Ansible::Ruby::Modules::Panos_object

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

Overview

Policy objects form the match criteria for policy rules and many other functions in PAN-OS. These may include address object, address groups, service objects, service groups, and tag.

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

#address ⇒ String?

Returns The IP address of the host or network in CIDR notation.

Returns:

  • (String, nil) —

    The IP address of the host or network in CIDR notation.



36
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 36

attribute :address

#address_type ⇒ Object?

Returns The type of address object definition. Valid types are I(ip-netmask) and I(ip-range).

Returns:

  • (Object, nil) —

    The type of address object definition. Valid types are I(ip-netmask) and I(ip-range).



40
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 40

attribute :address_type

#addressgroup ⇒ String?

Returns A static group of address objects or dynamic address group.

Returns:

  • (String, nil) —

    A static group of address objects or dynamic address group.



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

attribute :addressgroup

#addressobject ⇒ String?

Returns The name of the address object.

Returns:

  • (String, nil) —

    The name of the address object.



32
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 32

attribute :addressobject

#api_key ⇒ String?

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

Returns:

  • (String, nil) —

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



24
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 24

attribute :api_key

#color ⇒ String?

Returns - The color of the tag object. Valid values are I(red, green, blue, yellow, copper, orange, purple, gray, light green, cyan, light gray, blue gray, lime, black, gold, and brown).rn.

Returns:

  • (String, nil) —

    • The color of the tag object. Valid values are I(red, green, blue, yellow, copper, orange, purple, gray, light green, cyan, light gray, blue gray, lime, black, gold, and brown).rn



83
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 83

attribute :color

#description ⇒ String?

Returns The description of the object.

Returns:

  • (String, nil) —

    The description of the object.



75
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 75

attribute :description

#destination_port ⇒ String?

Returns The destination port to be used in a service object definition.

Returns:

  • (String, nil) —

    The destination port to be used in a service object definition.



61
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 61

attribute :destination_port

#devicegroup ⇒ String?

Returns - The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it is assumed that we are contacting a firewall.rn.

Returns:

  • (String, nil) —

    • The name of the Panorama device group. The group must exist on Panorama. If device group is not defined it is assumed that we are contacting a firewall.rn



87
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 87

attribute :devicegroup

#dynamic_value ⇒ Object?

Returns The filter match criteria to be used in a dynamic addressgroup definition.

Returns:

  • (Object, nil) —

    The filter match criteria to be used in a dynamic addressgroup definition.



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

attribute :dynamic_value

#ip_address ⇒ String

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

Returns:

  • (String) —

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



12
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 12

attribute :ip_address

#operation ⇒ String

Returns The operation to be performed. Supported values are I(add)/I(delete)/I(find).

Returns:

  • (String) —

    The operation to be performed. Supported values are I(add)/I(delete)/I(find).



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

attribute :operation

#password ⇒ String

Returns Password credentials to use for authentication.

Returns:

  • (String) —

    Password credentials to use for authentication.



20
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 20

attribute :password

#protocol ⇒ String?

Returns The IP protocol to be used in a service object definition. Valid values are I(tcp) or I(udp).

Returns:

  • (String, nil) —

    The IP protocol to be used in a service object definition. Valid values are I(tcp) or I(udp).



65
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 65

attribute :protocol

#servicegroup ⇒ Object?

Returns A group of service objects.

Returns:

  • (Object, nil) —

    A group of service objects.



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

attribute :servicegroup

#serviceobject ⇒ String?

Returns The name of the service object.

Returns:

  • (String, nil) —

    The name of the service object.



54
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 54

attribute :serviceobject

#services ⇒ Object?

Returns The group of service objects used in a servicegroup definition.

Returns:

  • (Object, nil) —

    The group of service objects used in a servicegroup definition.



72
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 72

attribute :services

#source_port ⇒ Object?

Returns The source port to be used in a service object definition.

Returns:

  • (Object, nil) —

    The source port to be used in a service object definition.



58
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 58

attribute :source_port

#static_value ⇒ Array<String>, ...

Returns A group of address objects to be used in an addressgroup definition.

Returns:

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

    A group of address objects to be used in an addressgroup definition.



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

attribute :static_value

#tag_name ⇒ String?

Returns The name of an object or rule tag.

Returns:

  • (String, nil) —

    The name of an object or rule tag.



79
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 79

attribute :tag_name

#username ⇒ String?

Returns Username credentials to use for authentication.

Returns:

  • (String, nil) —

    Username credentials to use for authentication.



16
 
# File 'lib/ansible/ruby/modules/generated/network/panos/panos_object.rb', line 16

attribute :username