paloaltonetworks.panos.panos_template_variable (2.19.1) — module

Manage template or template stack variable

| "added in version" 2.8.0 of paloaltonetworks.panos"

Authors: Garfield Lee Freeman (@shinmog)

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 a template or template stack variable on Panorama.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a template variable.
- name: create template variable
  paloaltonetworks.panos.panos_template_variable:
    provider: '{{ provider }}'
    template: 'tmpl name'
    name: '$ip1'
    value: '192.168.1.1'
    variable_type: 'ip-netmask'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a fqdn template stack variable
- name: create fqdn template stack variable
  paloaltonetworks.panos.panos_template_variable:
    name: '$fqdn1'
    value: 'example.com'
    variable_type: 'fqdn'

Inputs

    
name:
    description:
    - Name of the variable.
    - Variable names should start with the dollar sign.
    type: str

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

value:
    description:
    - The variable value.
    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

template:
    description:
    - (Panorama only) The template this operation should target. Mutually exclusive with
      I(template_stack).
    type: str

variable_type:
    choices:
    - ip-netmask
    - ip-range
    - fqdn
    - group-id
    - interface
    - device-priority
    - device-id
    default: ip-netmask
    description:
    - The variable type.
    type: str

template_stack:
    description:
    - (Panorama only) The template stack this operation should target. Mutually exclusive
      with I(template).
    type: str

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