paloaltonetworks.panos.panos_import (2.19.1) — module

import file on PAN-OS devices

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

Authors: Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer), Michael Richardson (@mrichardson03)

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

Import file on PAN-OS device


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import software image into PAN-OS
  paloaltonetworks.panos.panos_import:
    provider: '{{ provider }}'
    category: software
    file: /tmp/paloaltonetworks.panos.panos_vm-10.0.1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import certificate
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'certificate'
    certificate_name: 'ISRG Root X1'
    format: 'pem'
    filename: '/tmp/isrgrootx1.pem'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import content
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'content'
    filename: '/tmp/panupv2-all-contents-8322-6317'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import named configuration snapshot
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'configuration'
    filename: '/tmp/config.xml'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import application block page
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'application-block-page'
    filename: '/tmp/application-block-page.html'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import custom logo
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'custom-logo'
    custom_logo_location: 'login-screen'
    filename: '/tmp/logo.jpg'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import SAML metadata profile
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'idp-metadata'
    filename: '/tmp/saml_metadata.xml'
    profile_name: 'saml-profile'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import SAML metadata profile to template
  paloaltonetworks.panos.panos_import:
    provider: '{{ device }}'
    category: 'idp-metadata'
    filename: '/tmp/saml_metadata.xml'
    profile_name: 'saml-profile'
    template: firewall-template

Inputs

    
url:
    description:
    - URL of the file that will be imported to device.
    required: false
    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

format:
    choices:
    - pem
    - pkcs12
    description:
    - Format of the imported certifcate.
    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

category:
    choices:
    - anti-virus
    - application-block-page
    - captive-portal-text
    - certificate
    - configuration
    - content
    - credential-block-page
    - credential-coach-text
    - custom-logo
    - data-filter-block-page
    - device-state
    - file-block-continue-page
    - file-block-page
    - global-protect-client
    - global-protect-clientless-vpn
    - global-protect-portal-custom-help-page
    - global-protect-portal-custom-home-page
    - global-protect-portal-custom-login-page
    - global-protect-portal-custom-welcome-page
    - high-availability-key
    - idp-metadata
    - keypair
    - license
    - logdb
    - mfa-login-page
    - pandb-url-database
    - plugin
    - safe-search-block-page
    - saml-auth-internal-error-page
    - signed-url-database
    - software
    - ssl-cert-status-page
    - ssl-optout-text
    - url-block-page
    - url-coach-text
    - url-database
    - virus-block-page
    - wildfire
    default: software
    description:
    - Category of file to import.
    type: str

filename:
    aliases:
    - file
    description:
    - Location of the file to import into device.
    required: false
    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

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

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

passphrase:
    description:
    - Passphrase used to decrypt the certificate and/or private key.
    type: str

profile_name:
    description:
    - When I(category=idp-metadata), the name of the SAML profile to create.
    type: str

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

certificate_name:
    description:
    - When I(category=certificate), this is the name of the certificate object.
    - When I(category=keypair), the key pair will be associated with this certificate
      object.
    type: str

custom_logo_location:
    choices:
    - login-screen
    - main-ui
    - pdf-report-footer
    - pdf-report-header
    description:
    - When I(category=custom-logo), import this logo file here.
    type: str

block_private_key_export:
    description:
    - When I(category=keypair), controls if the private key is allowed to be exported
      from PAN-OS in future.
    - If this parameter is left undefined, the effective value with be no.
    type: bool