paloaltonetworks.panos.panos_object_facts (2.19.1) — module

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1

Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Retrieves tag information objects on PAN-OS devices.

Requirements

• pan-python can be obtained from PyPI U(https://pypi.python.org/pypi/pan-python)
• pandevice can be obtained from PyPI U(https://pypi.python.org/pypi/pandevice)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve address group object 'Prod'
  paloaltonetworks.panos.panos_object_facts:
    provider: '{{ provider }}'
    name: 'Prod'
    object_type: 'address-group'
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve service group object 'Prod-Services'
  paloaltonetworks.panos.panos_object_facts:
    provider: '{{ provider }}'
    name: 'Prod-Services'
    object_type: 'service-group'
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Find all address objects with "Prod" in the name
  paloaltonetworks.panos.panos_object_facts:
    provider: '{{ provider }}'
    name_regex: '.*Prod.*'
    object_type: 'address'
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Find all static address objects that use addy1
  paloaltonetworks.panos.panos_object_facts:
    provider: '{{ provider }}'
    object_type: 'address-group'
    field: 'static_value'
    field_search_type: 'exact'
    field_search_value: 'addy1'
  register: result

Inputs

    
name:
    description:
    - Name of object to retrieve.
    - Mutually exclusive with I(name_regex) and I(field).
    type: str

port:
    default: 443
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The port number to connect to the PAN-OS device on.
    type: int

vsys:
    default: vsys1
    description:
    - The vsys this object belongs to.
    type: str

field:
    description:
    - The field to search instead of name.
    - Mutually exclusive with I(name) and I(name_regex)
    type: str

api_key:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The API key to use instead of generating it using I(username) / I(password).
    type: str

password:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The password to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      api_key:
        description:
        - The API key to use instead of generating it using I(username) / I(password).
        type: str
      ip_address:
        description:
        - The IP address or hostname of the PAN-OS device being configured.
        type: str
      password:
        description:
        - The password to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
      port:
        default: 443
        description:
        - The port number to connect to the PAN-OS device on.
        type: int
      serial_number:
        description:
        - The serial number of a firewall to use for targeted commands. If I(ip_address)
          is not a Panorama PAN-OS device, then this param is ignored.
        type: str
      username:
        default: admin
        description:
        - The username to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: paloaltonetworks.panos

username:
    default: admin
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The username to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

ip_address:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The IP address or hostname of the PAN-OS device being configured.
    type: str

name_regex:
    description:
    - A python regex for an object's name to retrieve.
    - Mutually exclusive with I(name) and I(field).
    type: str

object_type:
    choices:
    - address
    - address-group
    - application
    - application-group
    - custom-url-category
    - service
    - service-group
    - tag
    default: address
    description:
    - Type of object to retrieve.
    type: str

device_group:
    default: shared
    description:
    - (Panorama only) The device group the operation should target.
    type: str

field_search_type:
    choices:
    - exact
    - regex
    default: exact
    description:
    - The type of search to perform when doing a I(field) search.
    type: str

field_search_value:
    description:
    - The value for the I(field_search) and I(field) specified.
    type: str

Outputs

ansible_module_results:
  description: Dict containing object attributes.  Empty if object is not found.
  returned: when "name" is specified
  type: dict
objects:
  description: List of object dicts.
  returned: always
  type: list