paloaltonetworks.panos.panos_device_group (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

Manage Panorama device group.

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)
• pandevice >= 1.5.1

Usage examples

Scanned by Steampunk Spotter

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

# Create a device group under shared.
- name: Create device group
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'hello world'

Scanned by Steampunk Spotter

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

# Create a device group under "hello world"
- name: Create device group under hello world
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'child'
    parent: 'hello world'

Scanned by Steampunk Spotter

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

# Delete the child device group
- name: Delete a device group.
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'some device group'
    state: 'absent'

Inputs

    
tag:
    description:
    - List of tags
    elements: str
    type: list

name:
    description:
    - Name of the device group.
    type: str

state:
    choices:
    - present
    - absent
    - replaced
    - merged
    - deleted
    - gathered
    default: present
    description:
    - The state.
    type: str

parent:
    description:
    - Name of the device group parent.
    - An empty parent means the parent device group should be "shared".
    type: str

provider:
    description:
    - A dict object containing connection details.
    required: true
    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.
        required: true
        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

gathered_filter:
    description:
    - When I(state=gathered).
    - An advanced filtering option to filter results returned from PAN-OS.
    - Refer to the guide discussing I(gathered_filter) for more information.
    type: str