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

Install specific release of PAN-OS.

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: Install PAN-OS 8.1.6 and restart
  paloaltonetworks.panos.panos_software:
    provider: '{{ provider }}'
    version: '8.1.6'
    restart: true

Scanned by Steampunk Spotter

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

- name: Download PAN-OS 9.0.0 base image only
  paloaltonetworks.panos.panos_software:
    provider: '{{ provider }}'
    version: '9.0.0'
    install: false
    restart: false

Scanned by Steampunk Spotter

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

- name: Download PAN-OS 9.0.1 and sync to HA peer
  paloaltonetworks.panos.panos_software:
    provider: '{{ provider }}'
    version: '9.0.1'
    sync_to_peer: true
    install: false
    restart: false

Scanned by Steampunk Spotter

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

- name: Downgrade to 9.1.10 with named config load
  paloaltonetworks.panos.panos_software:
    provider: '{{ device }}'
    version: 9.1.10
    named_config: '9.1.10_backup_named_config.xml'
    install: true
    restart: true

Inputs

    
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

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

install:
    default: true
    description:
    - Perform installation of the PAN-OS version on the device.
    type: bool

restart:
    default: false
    description:
    - Restart device after installing desired version.  Use in conjunction with M(paloaltonetworks.panos.panos_check)
      to determine when firewall is ready again.
    type: bool

timeout:
    default: 1200
    description:
    - Timeout value in seconds to wait for the device operation to complete
    type: int

version:
    description:
    - Desired PAN-OS release for target device.
    required: true
    type: str

download:
    default: true
    description:
    - Download PAN-OS version to the device.
    type: bool

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

named_config:
    description:
    - A name of a existing named config to be loaded after restart. If a non-existing
      file name is given the module will fail.
    required: false
    type: str

sync_to_peer:
    default: false
    description:
    - If device is a member of a HA pair, perform actions on the peer device as well.  Only
      used when downloading software - installation must be performed on both devices.
    type: bool

perform_software_check:
    default: true
    description:
    - Do a software check before doing the upgrade.
    type: bool

Outputs

version:
  description: After performing the software install, returns the version installed
    on the device.
  returned: on success
  type: str