paloaltonetworks.panos.panos_object_facts module – Retrieve facts about objects on PAN-OS devices.

Note

This module is part of the paloaltonetworks.panos collection (version 2.21.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_object_facts.

New in paloaltonetworks.panos 1.0.0

DEPRECATED

Removed in:

version 3.0.0

Why:

Updating module design to network resource modules.

Alternative:

Use various specific modules such as paloaltonetworks.panos.panos_address_object instead.

Synopsis

• Retrieves tag information objects on PAN-OS devices.

Requirements

The below requirements are needed on the host that executes this module.

• pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python

• pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice

Parameters

Parameter	Comments
api_key string	Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password.
device_group string	(Panorama only) The device group the operation should target. Default: :ansible-option-default:`"shared"`
field string	The field to search instead of name. Mutually exclusive with name and name_regex
field_search_type string	The type of search to perform when doing a field search. Choices: :ansible-option-choices-entry-default:`"exact"` ← (default) :ansible-option-choices-entry:`"regex"`
field_search_value string	The value for the field_search and field specified.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
name string	Name of object to retrieve. Mutually exclusive with name_regex and field.
name_regex string	A python regex for an object’s name to retrieve. Mutually exclusive with name and field.
object_type string	Type of object to retrieve. Choices: :ansible-option-choices-entry-default:`"address"` ← (default) :ansible-option-choices-entry:`"address-group"` :ansible-option-choices-entry:`"application"` :ansible-option-choices-entry:`"application-group"` :ansible-option-choices-entry:`"custom-url-category"` :ansible-option-choices-entry:`"service"` :ansible-option-choices-entry:`"service-group"` :ansible-option-choices-entry:`"tag"`
password string	Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified.
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
provider dictionary added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string	The IP address or hostname of the PAN-OS device being configured.
password string	The password to use for authentication. This is ignored if api_key is specified.
port integer	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
serial_number string	The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username string	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
username string	Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
vsys string	The vsys this object belongs to. Default: :ansible-option-default:`"vsys1"`

Notes

Note

• Panorama is supported.

• Check mode is not supported.

• PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

Examples

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

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

- 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

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ansible_module_results dictionary	Dict containing object attributes. Empty if object is not found. Returned: when “name” is specified
objects list / elements=string	List of object dicts. Returned: always

Status

• This module will be removed in version 3.0.0. [deprecated]

• For more information see DEPRECATED.

Authors

• Michael Richardson (@mrichardson03)

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)