category: Network Security
provider: Palo Alto Networks
sectionorder:
- Connect
- Collect
commonfields:
  id: Panorama
  version: -1
configuration:
- display: Server URL (e.g., https://192.168.0.1)
  name: server
  required: true
  type: 0
  section: Connect
- displaypassword: API Key
  name: credentials
  type: 9
  hiddenusername: true
  section: Connect
  required: false
- defaultvalue: '443'
  display: Port (e.g 443)
  name: port
  type: 0
  section: Connect
  advanced: true
  required: false
- additionalinfo: Located in the Panorama UI. Go to Panorama, Device Groups and select the desired Device Group
  display: Device group - Panorama instances only (write shared for Shared location)
  name: device_group
  type: 0
  section: Connect
  advanced: true
  required: false
- additionalinfo: Located in the Firewall URL; by default of PAN-OS it is vsys1
  display: Vsys - Firewall instances only
  name: vsys
  type: 0
  section: Connect
  required: false
- display: Template - Panorama instances only
  name: template
  type: 0
  section: Connect
  advanced: true
  required: false
- additionalinfo: If selected, when running the !url command, the command will execute using pan-os with PAN_DB (with applied filters). The URL filtering categories determine DBot score (malicious, suspicious, benign).
  display: Use URL Filtering for auto enrichment
  name: use_url_filtering
  type: 8
  section: Collect
  advanced: true
  required: false
- display: URL Filtering Additional suspicious categories. CSV list of categories that will be considered suspicious.
  name: additional_suspicious
  type: 12
  section: Collect
  advanced: true
  required: false
- display: URL Filtering Additional malicious categories. CSV list of categories that will be considered malicious.
  name: additional_malicious
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  section: Connect
  advanced: true
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  section: Connect
  advanced: true
  required: false
- display: API Key (Deprecated)
  name: key
  type: 4
  hidden: true
  additionalinfo: Use the "API Key (Recommended)" parameter instead.
  section: Connect
  advanced: true
  required: false
- additionalinfo: Reliability of the source providing the intelligence data.
  defaultvalue: B - Usually reliable
  display: Source Reliability
  name: integrationReliability
  options:
  - A+ - 3rd party enrichment
  - A - Completely reliable
  - B - Usually reliable
  - C - Fairly reliable
  - D - Not usually reliable
  - E - Unreliable
  - F - Reliability cannot be judged
  type: 15
  section: Collect
  advanced: true
  required: false
- defaultvalue: indicatorType
  name: feedExpirationPolicy
  display: ''
  options:
  - never
  - interval
  - indicatorType
  - suddenDeath
  type: 17
  section: Collect
  advanced: true
  required: false
- defaultvalue: '20160'
  name: feedExpirationInterval
  display: ''
  type: 1
  section: Collect
  advanced: true
  required: false
- display: Fetch incidents
  name: isFetch
  type: 8
  section: Collect
  required: false
  supportedModules:
  - agentix
  - xsiam
- defaultvalue: 24 hours
  display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  name: first_fetch
  type: 0
  section: Collect
  required: false
  supportedModules:
  - agentix
  - xsiam
- defaultvalue: "100"
  display: Max incidents per fetch (for each selected Log Type Query)
  additionalinfo: The maximum number of incidents to fetch per Log Type Query. To ensure optimal efficiency, it is strongly advised to keep the limit as low as possible. The maximum is 5,000.
  name: max_fetch
  type: 0
  section: Collect
  required: false
  supportedModules:
  - agentix
  - xsiam
- display: Log Type
  name: log_types
  type: 16
  additionalinfo: "Select which log types to fetch.\nSelecting 'All' will use all the log type queries in the fetch.\nTo choose a specific set of queries, select their log types from the dropdown (make sure the 'All' option is unselected)."
  options:
  - Traffic
  - Threat
  - Url
  - Data
  - Correlation
  - System
  - Wildfire
  - Decryption
  - All
  section: Connect
  advanced: true
  required: false
- display: Log type max number of job pulling attempts
  name: fetch_job_polling_max_num_attempts
  additionalinfo: "The maximum number of attempts to try and pull results for each log type from a job that was created by its query. Each attempt takes around 1 second. Increasing this value is useful in case there are many logs to pull from a given log type.\nNote: When increasing this number, in case fetching more than 4 logs types together, it is recommended to split different log types for different integration instances"
  type: 0
  defaultvalue: '10'
  advanced: true
  section: Collect
  required: false
- display: Traffic Log Type Query
  name: traffic_query
  additionalinfo: "Traffic Log Type query example: (addr.src in {source}) and (addr.dst in {destination}) and (action eq {action}).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Threat Log Type Query
  name: threat_query
  additionalinfo: "Threat Log Type query example: (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: URL Log Type Query
  name: url_query
  additionalinfo: "URL Log Type query example: ((action eq block-override) or (action eq block-url)) and (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Data Log Type Query
  name: data_query
  additionalinfo: "Data Log Type query example: ((action eq alert) or (action eq wildfire-upload-success) or (action eq forward)) and (severity geq high).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Correlation Log Type Query
  name: correlation_query
  additionalinfo: "Correlation Log Type query example: (hostid eq {host_id}) and (match_time in {last_x_time}) and (objectname eq {object_name}) and (severity geq '{severity}'') and (src in {source_address}).\nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: System Log Type Query
  name: system_query
  additionalinfo: "System Log Type query example: (subtype eq {sub_type}) and (severity geq {severity}). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Wildfire Submission Log Type Query
  name: wildfire_query
  additionalinfo: "Wildfire Submission Log Type query example: ((action eq wildfire-upload-fail) or (action eq wildfire-upload-skip) or (action eq sinkhole)). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Decryption Log Type Query
  name: decryption_query
  additionalinfo: "Decryption Log Type query example: (app eq {application}) and (policy_name geq {policy_name}) and ((src in {source}) or (dst in {destination})). \nIn case of multiple devices, for the sake of speed it is recommended to narrow the query to a specific device. \nFor example:(device_name eq dummy_device)"
  type: 12
  section: Collect
  advanced: true
  required: false
- display: Incident type
  name: incidentType
  type: 13
  section: Connect
  required: false
  supportedModules:
  - agentix
  - xsiam
- defaultvalue: '1'
  display: Incidents Fetch Interval
  name: incidentFetchInterval
  required: false
  section: Collect
  type: 19
  supportedModules:
  - agentix
  - xsiam
description: Manage Palo Alto Networks Firewall and Panorama. Use this pack to manage Prisma Access through Panorama. For more information, see the Panorama documentation.
display: Palo Alto Networks PAN-OS
name: Panorama
script:
  commands:
  - arguments:
    - auto: PREDEFINED
      description: Action to be taken, such as show, get, set, edit, delete, rename, clone, move, override, multi-move, multi-clone, or complete.
      name: action
      predefined:
      - set
      - edit
      - delete
      - rename
      - clone
      - move
      - override
      - muti-move
      - multi-clone
      - complete
      - show
      - get
    - description: The category parameter. For example, when exporting a configuration file, use "category=configuration".
      name: category
    - description: The XML structure that defines the command. Used for operation commands.
      name: cmd
    - description: The command to run. For example, command =<show><arp><entry name='all'/></arp></show>.
      name: command
    - description: The specified destination.
      name: dst
    - description: The new value defined for an object.
      name: element
    - description: The end time (used when cloning an object).
      name: to
    - description: The start time (used when cloning an object).
      name: from
    - description: The key value to set.
      name: key
    - description: The log type to retrieve. For example, log-type=threat for threat logs.
      name: log-type
    - description: The type of move operation (for example, where=after, where=before, where=top, where=bottom).
      name: where
    - description: The time period. For example, period=last-24-hrs.
      name: period
    - description: The xpath location. For example, xpath=/config/predefined/application/entry[@name='hotmail'].
      name: xpath
    - description: The PCAP ID included in the threat log.
      name: pcap-id
    - description: The device serial number.
      name: serialno
    - description: The report type, for example dynamic, predefined, or custom.
      name: reporttype
    - description: The report name.
      name: reportname
    - defaultValue: keygen,config,commit,op,report,log,import,export,user-id,version
      description: The request type, for example export, import, log, config.
      name: type
    - description: The time the PCAP was received on the firewall. Used for threat PCAPs.
      name: search-time
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    - description: The job ID.
      name: job-id
    - description: The query string.
      name: query
    - description: The name of the virtual system to be configured. If no vsys is mentioned, this command will not use the vsys parameter.
      name: vsys
    description: Runs any command supported in the API.
    deprecated: true
    name: panorama
  - arguments:
    - description: The firewall managed by Panorama from which to retrieve the predefined threats.
      name: target
    description: Gets the predefined threats list from a firewall or Panorama and stores it as a JSON file in the context.
    deprecated: true
    name: panorama-get-predefined-threats-list
    outputs:
    - contextPath: File.Size
      description: The file size.
      type: number
    - contextPath: File.Name
      description: The file name.
      type: string
    - contextPath: File.Type
      description: The file type.
      type: string
    - contextPath: File.Info
      description: The file information.
      type: string
    - contextPath: File.Extension
      description: The file extension.
      type: string
    - contextPath: File.EntryID
      description: The file entry ID.
      type: string
    - contextPath: File.MD5
      description: The MD5 hash of the file.
      type: string
    - contextPath: File.SHA1
      description: The SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: The SHA256 hash of the file.
      type: string
    - contextPath: File.SHA512
      description: The SHA512 hash of the file.
      type: string
    - contextPath: File.SSDeep
      description: The SSDeep hash of the file.
      type: string
  - arguments:
    - description: The commit description.
      name: description
    - description: The administrator name. To commit admin-level changes on a firewall, include the administrator name in the request.
      name: admin_name
    - auto: PREDEFINED
      description: Forces a commit.
      name: force_commit
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Performs a partial commit while excluding device and network configuration.
      name: exclude_device_network_configuration
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Performs a partial commit while excluding shared objects.
      name: exclude_shared_objects
      predefined:
      - 'true'
      - 'false'
    description: Commits a configuration to the Palo Alto firewall or Panorama, but does not validate if the commit was successful. Committing to Panorama does not push the configuration to the firewalls. To push the configuration, run the panorama-push-to-device-group command.
    deprecated: true
    name: panorama-commit
    outputs:
    - contextPath: Panorama.Commit.JobID
      description: The job ID to commit.
      type: number
    - contextPath: Panorama.Commit.Status
      description: The commit status.
      type: string
  - arguments:
    - default: true
      description: The device group to which to push (Panorama instances).
      name: device-group
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Pre policy validation.
      name: validate-only
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether to include template changes.
      name: include-template
      predefined:
      - 'true'
      - 'false'
    - description: The push description.
      name: description
    - description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
      name: serial_number
    description: Pushes rules from PAN-OS to the configured device group. In order to push the configuration to Prisma Access managed tenants (single or multi- tenancy), use the device group argument with the device group associated with the tenant ID.
    deprecated: true
    name: panorama-push-to-device-group
    outputs:
    - contextPath: Panorama.Push.DeviceGroup
      description: The device group in which the policies were pushed.
      type: String
    - contextPath: Panorama.Push.JobID
      description: The job ID of the policies that were pushed.
      type: Number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: String
    - contextPath: Panorama.Push.Warnings
      description: The push warnings.
      type: String
    - contextPath: Panorama.Push.Errors
      description: The push errors.
      type: String
  - arguments:
    - default: true
      description: The template to push.
      name: template
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Whether to validate the policy.
      name: validate-only
      predefined:
      - 'true'
      - 'false'
    - description: The push description.
      name: description
    - description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
      name: serial_number
    description: Pushes the given PAN-OS template to the given devices or all devices that belong to the template.
    name: pan-os-push-to-template
    outputs:
    - contextPath: Panorama.Push.Template
      description: The device group in which the policies were pushed.
      type: String
    - contextPath: Panorama.Push.JobID
      description: The job ID of the policies that were pushed.
      type: Number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: String
    - contextPath: Panorama.Push.Warnings
      description: The push warnings.
      type: String
    - contextPath: Panorama.Push.Errors
      description: The push errors.
      type: String
  - arguments:
    - description: The template-stack to push.
      name: template-stack
      required: true
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Whether to validate the policy.
      name: validate-only
      predefined:
      - 'true'
      - 'false'
    - description: The push description.
      name: description
    - description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
      name: serial_number
    description: Pushes the given PAN-OS template-stack to the given devices or all devices that belong to the template stack.
    name: pan-os-push-to-template-stack
    outputs:
    - contextPath: Panorama.Push.TemplateStack
      description: The device group in which the policies were pushed.
      type: String
    - contextPath: Panorama.Push.JobID
      description: The job ID of the policies that were pushed.
      type: Number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: String
    - contextPath: Panorama.Push.Warnings
      description: The push warnings.
      type: String
    - contextPath: Panorama.Push.Errors
      description: The push errors.
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for which to filter the list of addresses.
      name: tag
    description: Returns a list of addresses.
    deprecated: true
    name: panorama-list-addresses
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP Netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The address device group.
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The address name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns address details for the supplied address name.
    deprecated: true
    name: panorama-get-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The new address name.
      name: name
      required: true
    - description: The new address description.
      name: description
    - description: The FQDN of the new address.
      name: fqdn
    - description: The IP Netmask of the new address. For example, 10.10.10.10/24.
      name: ip_netmask
    - description: The IP range of the new address IP. For example, 10.10.10.0-10.10.10.255.
      name: ip_range
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for the new address.
      isArray: true
      name: tag
    - auto: PREDEFINED
      description: Whether to create the tag if it does not exist.
      defaultValue: 'false'
      name: create_tag
      predefined:
      - 'true'
      - 'false'
    description: Creates an address object.
    deprecated: true
    name: panorama-create-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The name of the address to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes an address object.
    deprecated: true
    name: panorama-delete-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name that was deleted.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for which to filter the address groups.
      name: tag
    description: Returns a list of address groups.
    deprecated: true
    name: panorama-list-address-groups
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: String
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The address group name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Gets details for the specified address group.
    deprecated: true
    name: panorama-get-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The address group name.
      name: name
      required: true
    - auto: PREDEFINED
      description: The address group type.
      name: type
      predefined:
      - dynamic
      - static
      required: true
    - description: The dynamic address group match. For example "1.1.1.1 or 2.2.2.2".
      name: match
    - description: The static address group list of addresses.
      isArray: true
      name: addresses
    - description: The address group description.
      name: description
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for the address group.
      isArray: true
      name: tags
    description: Creates a static or dynamic address group.
    deprecated: true
    name: panorama-create-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group list of addresses.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: 'The session rejection type. Possible values are: "drop", "alert", "block-ip", "reset-both", "reset-client", and "reset-server". Default is "drop".'
      name: drop_mode
      predefined:
      - drop
      - alert
      - block-ip
      - reset-both
      - reset-client
      - reset-server
    - description: The name of the vulnerability profile.
      name: vulnerability_profile
      required: true
    - description: The numerical threat ID.
      name: threat_id
      required: true
    description: Sets a vulnerability signature to block mode.
    deprecated: true
    name: panorama-block-vulnerability
    outputs:
    - contextPath: Panorama.Vulnerability.ID
      description: The ID of the vulnerability that was blocked/overridden.
      type: string
    - contextPath: Panorama.Vulnerability.NewAction
      description: The new action for the vulnerability.
      type: string
  - arguments:
    - description: The name of the address group to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes an address group.
    deprecated: true
    name: panorama-delete-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The name of the address group that was deleted.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
  - arguments:
    - description: The name of the address group to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The address group type.
      name: type
      predefined:
      - static
      - dynamic
      required: true
    - description: The address group new match. For example, '1.1.1.1 and 2.2.2.2'.
      name: match
    - description: The element to add to the list of the static address group. Only existing address objects can be added.
      name: element_to_add
    - description: The element to remove from the list of the static address group. Only existing address objects can be removed.
      name: element_to_remove
    - description: The address group new description.
      name: description
    - description: The tag of the address group to edit.
      isArray: true
      name: tags
    description: Edits a static or dynamic address group.
    deprecated: true
    name: panorama-edit-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Filter
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for which to filter the services.
      name: tag
    description: Returns a list of addresses.
    deprecated: true
    name: panorama-list-services
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group in which the service was configured (Panorama instances).
      type: string
    - contextPath: Panorama.Services.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The service name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns service details for the supplied service name.
    deprecated: true
    name: panorama-get-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
    - contextPath: Panorama.Service.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The name for the new service.
      name: name
      required: true
    - auto: PREDEFINED
      description: The protocol for the new service.
      name: protocol
      predefined:
      - tcp
      - udp
      - sctp
      required: true
    - description: The destination port for the new service.
      name: destination_port
      required: true
    - description: The source port for the new service.
      name: source_port
    - description: The description for the new service.
      name: description
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for the new service.
      isArray: true
      name: tags
    description: >
      Creates a service.
      Note: overrides the service if it already exists.
    deprecated: true
    name: panorama-create-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
    - contextPath: Panorama.Services.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The name of the service to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a service.
    deprecated: true
    name: panorama-delete-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The name of the deleted service.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for which to filter the service groups.
      isArray: true
      name: tag
    description: Returns a list of service groups.
    deprecated: true
    name: panorama-list-service-groups
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The service group name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns details for the specified service group.
    deprecated: true
    name: panorama-get-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The service group name.
      name: name
      required: true
    - description: The service group related services.
      isArray: true
      name: services
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for which to filter service groups.
      isArray: true
      name: tags
    description: Creates a service group.
    deprecated: true
    name: panorama-create-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The name of the service group to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a service group.
    deprecated: true
    name: panorama-delete-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The name of the deleted service group.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
  - arguments:
    - description: The name of the service group to edit.
      name: name
      required: true
    - description: The services to add to the service group. Only existing service objects can be added.
      isArray: true
      name: services_to_add
    - description: The services to remove from the service group. Only existing service objects can be removed.
      name: services_to_remove
    - description: The tag of the service group to edit.
      isArray: true
      name: tags
    description: Edits a service group.
    name: panorama-edit-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: Custom URL category name.
      name: name
      required: true
    - description: The device group for which to return addresses for the custom URL category (Panorama instances).
      name: device-group
    description: Returns information for a custom URL category.
    deprecated: true
    name: panorama-get-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The category name of the custom URL.
      type: String
    - contextPath: Panorama.CustomURLCategory.Description
      description: The category description of the custom URL.
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The list of sites of the custom URL category.
      type: String
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL category (Panorama instances).
      type: String
    - contextPath: Panorama.CustomURLCategory.Categories
      description: The list of categories of the custom URL category.
      type: String
    - contextPath: Panorama.CustomURLCategory.Type
      description: The category type of the custom URL.
      type: String
  - arguments:
    - description: The name of the custom URL category to create.
      name: name
      required: true
    - description: The description of the custom URL category to create.
      name: description
    - description: The list of sites for the custom URL category.
      isArray: true
      name: sites
    - description: The device group for which to return addresses for the custom URL category (Panorama instances).
      name: device-group
    - auto: PREDEFINED
      description: The category type of the URL. Relevant from PAN-OS v9.x.
      name: type
      predefined:
      - URL List
      - Category Match
    - description: The list of categories. Relevant from PAN-OS v9.x.
      isArray: true
      name: categories
    description: Creates a custom URL category.
    deprecated: true
    name: panorama-create-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The custom URL category name.
      type: String
    - contextPath: Panorama.CustomURLCategory.Description
      description: The custom URL category description.
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of sites.
      type: String
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL category (Panorama instances).
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of categories.
      type: String
    - contextPath: Panorama.CustomURLCategory.Type
      description: The custom URL category type.
      type: String
  - arguments:
    - description: The name of the custom URL category to delete.
      name: name
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a custom URL category.
    deprecated: true
    name: panorama-delete-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The name of the custom URL category to delete.
      type: string
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL category (Panorama instances).
      type: string
  - arguments:
    - description: The name of the custom URL category to add or remove sites.
      name: name
      required: true
    - description: A comma-separated list of sites to add to the custom URL category.
      isArray: true
      name: sites
    - auto: PREDEFINED
      description: Adds or removes sites or categories.
      isArray: true
      name: action
      predefined:
      - add
      - remove
      required: true
    - description: A comma-separated list of categories to add to the custom URL category.
      isArray: true
      name: categories
    description: Adds or removes sites to and from a custom URL category.
    deprecated: true
    name: panorama-edit-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The custom URL category name.
      type: string
    - contextPath: Panorama.CustomURLCategory.Description
      description: The custom URL category description.
      type: string
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of sites.
      type: string
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL category (Panorama instances).
      type: string
  - arguments:
    - default: true
      description: The URL to check.
      isArray: true
      name: url
    description: Gets a URL category from URL filtering. This command is only available on firewall devices.
    name: panorama-get-url-category
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
      type: String
    - contextPath: DBotScore.Score
      description: The actual score.
      type: Number
    - contextPath: DBotScore.Type
      description: The indicator type.
      type: String
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
      type: String
    - contextPath: URL.Data
      description: The URL address.
      type: String
    - contextPath: URL.Category
      description: The URL category.
      type: String
  - arguments:
    - description: The URL to check.
      isArray: true
      name: url
      required: true
    description: Returns a URL category from URL filtering. This command is only available on firewall devices.
    deprecated: true
    name: panorama-get-url-category-from-cloud
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
  - arguments:
    - description: The URL to check.
      isArray: true
      name: url
      required: true
    description: Returns a URL category from URL filtering. This command is only available on firewall devices.
    deprecated: true
    name: panorama-get-url-category-from-host
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
  - arguments:
    - description: URL filter name.
      name: name
      required: true
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Returns information for a URL filtering rule.
    deprecated: true
    name: panorama-get-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL Filter name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override block list.
      type: string
    - contextPath: Panorama.URLFilter.OverrideAllowList
      description: The URL filter override allow list.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter to create.
      name: name
      required: true
    - description: The URL categories.
      isArray: true
      name: url_category
      required: true
    - auto: PREDEFINED
      description: The action for the URL categories.
      name: action
      predefined:
      - allow
      - block
      - alert
      - continue
      - override
      required: true
    - description: The CSV list of URLs to exclude from the allow list.
      isArray: true
      name: override_allow_list
    - description: The CSV list of URLs to exclude from the blocked list.
      isArray: true
      name: override_block_list
    - description: The URL filter description.
      name: description
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Creates a URL filtering rule.
    deprecated: true
    name: panorama-create-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override allow list.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override blocked list.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The element to change.
      name: element_to_change
      predefined:
      - override_allow_list
      - override_block_list
      - allow_categories
      - block_categories
      - description
      required: true
    - description: The element value. Limited to one value.
      name: element_value
      required: true
    - auto: PREDEFINED
      defaultValue: add
      description: Adds or removes an element from the Allow List or Block List fields.
      name: add_remove_element
      predefined:
      - add
      - remove
    description: Edits a URL filtering rule.
    deprecated: true
    name: panorama-edit-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter name.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category.
      type: string
    - contextPath: Panorama.URLFilter.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideAllowList
      description: The list of allow overrides for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The list of block overrides for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter rule to delete.
      name: name
      required: true
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Deletes a URL filtering rule.
    name: panorama-delete-url-filter
    deprecated: true
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter rule name.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Returns a list of external dynamic lists.
    deprecated: true
    name: panorama-list-edls
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The EDL type.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The EDL description.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Returns information for an external dynamic list.
    deprecated: true
    name: panorama-get-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The EDL type.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The EDL description.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: the time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The URL from which to pull the EDL.
      name: url
      required: true
    - auto: PREDEFINED
      description: The EDL type.
      name: type
      predefined:
      - ip
      - url
      - domain
      required: true
    - auto: PREDEFINED
      description: The time interval for pulling and updating the EDL.
      name: recurring
      predefined:
      - five-minute
      - hourly
      required: true
    - description: The certificate profile name for the URL that was previously uploaded. to PAN OS.
      name: certificate_profile
    - description: The EDL description.
      name: description
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Creates an external dynamic list.
    deprecated: true
    name: panorama-create-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The EDL type.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The EDL description.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval that the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the external dynamic list to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The element to change (“url”, “recurring”, “certificate_profile”, “description”).
      name: element_to_change
      predefined:
      - url
      - recurring
      - certificate_profile
      - description
      required: true
    - description: The element value.
      name: element_value
      required: true
    description: Modifies an element of an external dynamic list.
    deprecated: true
    name: panorama-edit-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL where the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The EDL description.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval that the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL to delete.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Deletes an external dynamic list.
    deprecated: true
    name: panorama-delete-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL that was deleted.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    - auto: PREDEFINED
      description: The EDL type. Required when refreshing an EDL object which is configured on Panorama.
      name: edl_type
      predefined:
      - ip
      - url
      - domain
    - description: The location of the EDL. Required when refreshing an EDL object which is configured on Panorama.
      name: location
    - description: The Vsys of the EDL. Required when refreshing an EDL object which is configured on Panorama.
      name: vsys
    description: Refreshes the specified external dynamic list.
    deprecated: true
    name: panorama-refresh-edl
  - arguments:
    - description: The name of the rule to create.
      name: rulename
    - description: The description of the rule to create.
      name: description
    - auto: PREDEFINED
      description: The action for the rule.
      name: action
      predefined:
      - allow
      - deny
      - drop
      required: true
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      isArray: true
      name: source
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      isArray: true
      name: destination
    - description: A comma-separated list of source zones.
      isArray: true
      name: source_zone
    - description: A comma-separated list of destination zones.
      isArray: true
      name: destination_zone
    - auto: PREDEFINED
      description: Whether to negate the source (address, address group).
      name: negate_source
      predefined:
      - Yes
      - No
    - auto: PREDEFINED
      description: Whether to negate the destination (address, address group).
      name: negate_destination
      predefined:
      - Yes
      - No
    - description: A comma-separated list of service object names for the rule.
      isArray: true
      name: service
    - auto: PREDEFINED
      defaultValue: No
      description: Whether to disable the rule.
      name: disable
      predefined:
      - Yes
      - No
    - defaultValue: any
      description: A comma-separated list of application object names for the rule to create.
      isArray: true
      name: application
    - description: A comma-separated list of source users for the rule to create.
      name: source_user
      isArray: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: Specifies a target firewall for the rule (Panorama instances).
      name: target
    - description: The log forwarding profile.
      name: log_forwarding
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    - description: The rule tags to create.
      isArray: true
      name: tags
    - description: A comma-separated list of URL categories.
      name: category
    - description: A profile setting group.
      name: profile_setting
    - auto: PREDEFINED
      defaultValue: bottom
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    description: Creates a policy rule.
    execution: true
    name: panorama-create-rule
    deprecated: true
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Description
      description: The rule description.
      type: string
    - contextPath: Panorama.SecurityRule.Action
      description: The action for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Source
      description: The source address.
      type: string
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address.
      type: string
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Whether the source is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Whether the destination negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.Service
      description: The service for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Disabled
      description: Whether the rule is disabled.
      type: string
    - contextPath: Panorama.SecurityRule.Application
      description: The application for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.LogForwarding
      description: The log forwarding profile (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRules.Tags
      description: The rule tags.
      type: String
    - contextPath: Panorama.SecurityRules.ProfileSetting
      description: The profile setting group.
      type: String
  - arguments:
    - description: The name of the custom block policy rule to create.
      name: rulename
    - auto: PREDEFINED
      description: The object type to block in the policy rule.
      name: object_type
      predefined:
      - ip
      - address-group
      - application
      - url-category
      - edl
      required: true
    - description: A comma-separated list of object values for the object_type argument.
      isArray: true
      name: object_value
      required: true
    - auto: PREDEFINED
      defaultValue: both
      description: The direction to block. This argument is not applicable to the "custom-url-category" object_type.
      name: direction
      predefined:
      - to
      - from
      - both
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: Specifies a target firewall for the rule (Panorama instances).
      name: target
    - description: The log forwarding profile.
      name: log_forwarding
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    - description: Tags to use for the custom block policy rule.
      isArray: true
      name: tags
    - auto: PREDEFINED
      defaultValue: bottom
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    description: Creates a custom block policy rule.
    execution: true
    deprecated: true
    name: panorama-custom-block-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Object
      description: The blocked object.
      type: string
    - contextPath: Panorama.SecurityRule.Direction
      description: The blocked direction.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.LogForwarding
      description: The log forwarding profile (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.Tags
      description: The rule tags.
      type: String
    - contextPath: Panorama.SecurityRules.ProfileSetting
      description: The profile setting group.
      type: String
  - arguments:
    - description: The name of the rule to move.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
      required: true
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    - auto: PREDEFINED
      description: The rule location. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    description: Changes the location of a policy rule.
    execution: true
    deprecated: true
    name: panorama-move-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
  - arguments:
    - description: The name of the rule to edit.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: The parameter in the security rule to change.
      name: element_to_change
      predefined:
      - source
      - destination
      - application
      - action
      - category
      - description
      - disabled
      - target
      - log-forwarding
      - tag
      - profile-setting
      - source-user
      - service
      required: true
    - description: The new value for the parameter.
      name: element_value
      required: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - auto: PREDEFINED
      defaultValue: replace
      description: Whether to replace, add, or remove the element_value from the current rule object value.
      name: behaviour
      predefined:
      - replace
      - add
      - remove
    description: Edits a policy rule.
    execution: true
    deprecated: true
    name: panorama-edit-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Description
      description: The rule description.
      type: string
    - contextPath: Panorama.SecurityRule.Action
      description: The action for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Source
      description: The source address.
      type: string
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address.
      type: string
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Whether the source is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Whether the destination is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.Service
      description: The service for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Disabled
      description: Whether the rule is disabled.
      type: string
    - contextPath: Panorama.SecurityRule.Application
      description: The application for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.Tags
      description: The tags for the rule.
      type: String
  - arguments:
    - description: The name of the rule to delete.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    description: Deletes a policy rule.
    execution: true
    deprecated: true
    name: panorama-delete-rule
    outputs:
    - contextPath: Panorama.CleanedUpRules.Category
      description: The rule category.
      type: string
    - contextPath: Panorama.CleanedUpRules.RuleName
      description: The rule name.
      type: string
    - contextPath: Panorama.CleanedUpRules.Rulebase
      description: The rule rulebase.
      type: string
    - contextPath: Panorama.CleanedUpRules.PrePost
      description: The rule prepost.
      type: string
    - contextPath: Panorama.CleanedUpRules.DeviceGroup
      description: The rule device group.
      type: string
    - contextPath: Panorama.CleanedUpRules.Target
      description: The rule target.
      type: string
    - contextPath: Panorama.CleanedUpRules.Vsys
      description: The rule vsys.
      type: string
    - contextPath: Panorama.CleanedUpRules.AppliedAction
      description: The rule applied action.
      type: string
  - arguments:
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Whether to list predefined applications or not.
      name: predefined
      predefined:
      - 'true'
      - 'false'
    description: Returns a list of applications.
    deprecated: true
    name: panorama-list-applications
    outputs:
    - contextPath: Panorama.Applications.Name
      description: The application name.
      type: string
    - contextPath: Panorama.Applications.Id
      description: The application ID.
      type: number
    - contextPath: Panorama.Applications.Category
      description: The application category.
      type: string
    - contextPath: Panorama.Applications.SubCategory
      description: The application sub-category.
      type: string
    - contextPath: Panorama.Applications.Technology
      description: The application technology.
      type: string
    - contextPath: Panorama.Applications.Risk
      description: The application risk (1 to 5).
      type: number
    - contextPath: Panorama.Applications.Description
      description: The application description.
      type: string
  - arguments:
    - description: The job ID to check.
      name: job_id
      required: true
    description: Returns commit status for a configuration.
    deprecated: true
    name: panorama-commit-status
    outputs:
    - contextPath: Panorama.Commit.JobID
      description: The job ID of the configuration to be committed.
      type: number
    - contextPath: Panorama.Commit.Status
      description: The commit status.
      type: string
    - contextPath: Panorama.Commit.Details
      description: The job ID details.
      type: string
    - contextPath: Panorama.Commit.Warnings
      description: The job ID warnings.
      type: String
  - arguments:
    - description: The job ID to check.
      name: job_id
      required: true
    description: Returns the push status for a configuration.
    deprecated: true
    name: panorama-push-status
    outputs:
    - contextPath: Panorama.Push.DeviceGroup
      description: The device group to which the policies were pushed.
      type: string
    - contextPath: Panorama.Push.JobID
      description: The job ID of the configuration to be pushed.
      type: number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: string
    - contextPath: Panorama.Push.Details
      description: The job ID details.
      type: string
    - contextPath: Panorama.Push.Warnings
      description: The job ID warnings.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The type of Packet Capture.
      name: pcapType
      predefined:
      - application-pcap
      - filter-pcap
      - threat-pcap
      - dlp-pcap
      required: true
    - description: The serial number of the firewall to download the PCAP from.
      name: serialNumber
    - description: The.
      name: from
    - description: The new name for the PCAP file after downloading. If this argument is not specified, the file name is the PCAP file name set in the firewall.
      name: localName
    - description: The serial number for the request. See the Panorama XML API documentation.
      name: serialNo
    - description: 'The search time for the request. For example: "2019/12/26 00:00:00", "2020/01/10". See the Panorama XML API documentation.'
      name: searchTime
    - description: The ID of the PCAP for the request. See the Panorama XML API documentation.
      name: pcapID
    - description: The password for Panorama, needed for the 'dlp-pcap' PCAP type only.
      name: password
    - description: The device name on which the PCAP is stored. See the Panorama XML API documentation.
      name: deviceName
    - description: The session ID of the PCAP. See the Panorama XML API documentation.
      name: sessionID
    description: Returns information for a Panorama PCAP file. The recommended maximum file size is 5 MB. If the limit is exceeded, you may need to SSH the firewall and run the scp export command to export the PCAP file. See the Palo Alto Networks documentation.
    deprecated: true
    name: panorama-get-pcap
    outputs:
    - contextPath: File.Size
      description: The file size.
      type: number
    - contextPath: File.Name
      description: The file name.
      type: string
    - contextPath: File.Type
      description: The file type.
      type: string
    - contextPath: File.Info
      description: The file info.
      type: string
    - contextPath: File.Extension
      description: The file extension.
      type: string
    - contextPath: File.EntryID
      description: The file entryID.
      type: string
    - contextPath: File.MD5
      description: The MD5 hash of the file.
      type: string
    - contextPath: File.SHA1
      description: The SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: The SHA256 hash of the file.
      type: string
    - contextPath: File.SHA512
      description: The SHA512 hash of the file.
      type: string
    - contextPath: File.SSDeep
      description: The SSDeep hash of the file.
      type: string
  - arguments:
    - auto: PREDEFINED
      description: The type of Packet Capture.
      name: pcapType
      predefined:
      - application-pcap
      - filter-pcap
      - dlp-pcap
      required: true
    - description: The serial number of the firewall to download the PCAP from.
      name: serialNumber
    - description: The password for Panorama. Relevant for the 'dlp-pcap' PCAP type.
      name: password
    description: Returns a list of all PCAP files by PCAP type. Not available for threat PCAPs.
    deprecated: true
    name: panorama-list-pcaps
  - arguments:
    - description: The tag for which to register IP addresses.
      name: tag
      required: true
    - description: The IP addresses to register.
      isArray: true
      name: IPs
      required: true
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether the IP addresses remain registered to the tag after the device reboots ('true':persistent, 'false':non-persistent).
      name: persistent
      predefined:
      - 'true'
      - 'false'
    - description: The timeout value to automatically unregister the IPs. Only applicable for PAN-OS 9.x and higher. Cannot be used with persistent set to true.
      name: timeout
    description: Registers IP addresses to a tag.
    deprecated: true
    name: panorama-register-ip-tag
    outputs:
    - contextPath: Panorama.DynamicTags.Tag
      description: The name of the tag.
      type: string
    - contextPath: Panorama.DynamicTags.IPs
      description: The registered IP addresses.
      type: string
  - arguments:
    - description: The tag for which to unregister IP addresses.
      name: tag
      required: true
    - description: The IP addresses to unregister.
      isArray: true
      name: IPs
      required: true
    description: Unregisters IP addresses from a tag.
    deprecated: true
    name: panorama-unregister-ip-tag
  - arguments:
    - description: The tag for which to register users.
      name: tag
      required: true
    - description: A comma-separated list of users to register.
      isArray: true
      name: Users
      required: true
    description: Registers users to a tag. This command is only available for PAN-OS version 9.x and higher.
    deprecated: true
    name: panorama-register-user-tag
    outputs:
    - contextPath: Panorama.DynamicTags.Tag
      description: The name of the tag.
      type: string
    - contextPath: Panorama.DynamicTags.Users
      description: The list of registered users.
      type: string
  - arguments:
    - description: The tag from which to unregister users.
      name: tag
      required: true
    - description: A comma-separated list of users to unregister.
      isArray: true
      name: Users
      required: true
    description: Unregisters users from a tag. This command is only available for PAN-OS version 9.x and higher.
    deprecated: true
    name: panorama-unregister-user-tag
  - arguments:
    - description: Specifies the match criteria for the logs. This is similar to the query provided in the web interface under the Monitor tab, when viewing the logs.
      name: query
    - defaultValue: '100'
      description: The number of logs to retrieve. The maximum is 5000.
      name: number_of_logs
    - auto: PREDEFINED
      defaultValue: backward
      description: |-
        Whether logs are shown oldest first (forward) or newest
        first (backward).
      name: direction
      predefined:
      - backward
      - forward
    - description: The source address for the query.
      name: source
    - description: The destination address for the query.
      name: destination
    - description: The date and time after which logs were received in the format YYYY/MM/DD HH:MM:SS.
      name: receive_time
    - description: The application for the query.
      name: application
    - description: The destination port for the query.
      name: to_port
    - description: The action for the query.
      name: action
    description: Deprecated. Use the pan-os-query-logs command instead.
    deprecated: true
    name: panorama-query-traffic-logs
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
  - arguments:
    - description: The job ID of the query.
      name: job_id
      required: true
    description: Deprecated. Use the pan-os-check-logs-status command instead.
    deprecated: true
    name: panorama-check-traffic-logs-status
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
  - arguments:
    - description: The job ID of the query.
      name: job_id
      required: true
    description: Deprecated. Use the pan-os-get-logs command instead.
    deprecated: true
    name: panorama-get-traffic-logs
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Action
      description: The action of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ActionSource
      description: The action source of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Application
      description: The application of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Category
      description: The category of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.DeviceName
      description: The device name of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Destination
      description: The destination of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.DestinationPort
      description: The destination port of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.FromZone
      description: The from zone of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Protocol
      description: The protocol of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ReceiveTime
      description: The receive time of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Rule
      description: The rule of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.SessionEndReason
      description: The session end reason of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Source
      description: The source of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.SourcePort
      description: The source port of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.StartTime
      description: The start time of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ToZone
      description: The to zone of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Bytes
      description: The total log bytes.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.BytesReceived
      description: The log bytes received.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.BytesSent
      description: The log bytes sent.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The rules location. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag to filter the rules.
      name: tag
    description: Returns a list of predefined security rules.
    deprecated: true
    name: panorama-list-rules
    outputs:
    - contextPath: Panorama.SecurityRule.Location
      description: The location of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Indicates whether the destination is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Disabled
      description: Indicates whether the security rule is disabled.
      type: String
    - contextPath: Panorama.SecurityRule.ICMPUnreachable
      description: Specifies the behavior for ICMP unreachable messages.
      type: String
    - contextPath: Panorama.SecurityRule.Description
      description: The description of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.GroupTag
      description: The group tag of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.LogForwardingProfile
      description: The log forwarding profile applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Indicates whether the source is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfileGroup
      description: The security profile group assigned to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.url-filtering
      description: The security profile setting for url-filtering in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.data-filtering
      description: The security profile setting for data-filtering in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.file-blocking
      description: The security profile setting for file-blocking in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.virus
      description: The security profile setting for viruses in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.spyware
      description: The security profile setting for spyware in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.vulnerability
      description: The security profile setting for vulnerability in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.wildfire-analysis
      description: The security profile setting for wildfire-analysis in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Target.devices
      description: The devices targeted by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Target.negate
      description: Indicates whether the target is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Name
      description: The name of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.From
      description: The source zone of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.DestinationDevice
      description: The destination device of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Action
      description: The action taken by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SourceDevice
      description: The source device of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Tags
      description: The tags associated with the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SourceUser
      description: The source user of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Application
      description: The application used in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Service
      description: The service used in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.To
      description: The destination zone of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Source
      description: The source address of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.CustomUrlCategory
      description: The custom URL category targeted by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.LogAtSessionStart
      description: Indicates whether the session start is logged.
      type: String
    - contextPath: Panorama.SecurityRule.Options.LogForwarding
      description: Indicates whether log forwarding is enabled for the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.Schedule
      description: The schedule applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.QoSMarking
      description: The QoS marking applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.DisableServerResponseInspection
      description: Specifies whether to disable server response inspection for the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group of the security rule (Panorama instances only).
      type: String
    - contextPath: Panorama.SecurityRule.Type
      description: Represents the type of the security rule (e.g., pre-rule, post-rule, intra-zone, inter-zone).
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The log type.
      name: log-type
      predefined:
      - threat
      - traffic
      - wildfire
      - url
      - data
      required: true
    - description: The query string by which to match criteria for the logs. This is similar to the query provided in the web interface under the Monitor tab when viewing the logs.
      name: query
    - description: |-
        The time the log was generated from the timestamp and prior to it.
        For example "2019/08/11 01:10:44", will get logs before the specified date.
      name: time-generated
    - description: The source address.
      isArray: true
      name: addr-src
    - description: The destination address.
      isArray: true
      name: addr-dst
    - description: The source or destination IP address.
      isArray: true
      name: ip
    - description: The source zone.
      isArray: true
      name: zone-src
    - description: The destination source.
      isArray: true
      name: zone-dst
    - description: The rule action.
      isArray: true
      name: action
    - description: The destination port.
      isArray: true
      name: port-dst
    - description: The rule name, for example "Allow all outbound".
      isArray: true
      name: rule
    - description: The URL, for example "safebrowsing.googleapis.com".
      isArray: true
      name: url
    - description: The file hash (for WildFire logs only).
      isArray: true
      name: filedigest
    - defaultValue: '100'
      description: The maximum number of logs to retrieve. The maximum is 5000.
      name: number_of_logs
    description: Queries logs in Panorama.
    deprecated: true
    name: panorama-query-logs
    outputs:
    - contextPath: Panorama.Monitor.JobID
      description: The job ID of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Status
      description: The status of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Message
      description: The message of the logs query.
      type: String
  - arguments:
    - description: The job ID of the query.
      isArray: true
      name: job_id
      required: true
    description: Checks the status of a log query.
    deprecated: true
    name: panorama-check-logs-status
    outputs:
    - contextPath: Panorama.Monitor.JobID
      description: The job ID of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Status
      description: The status of the log query.
      type: String
  - arguments:
    - description: The job ID of the query.
      isArray: true
      name: job_id
      required: true
    - defaultValue: 'true'
      description: Whether to auto-enrich the War Room entry. If "true", entry is not auto-enriched. If "false", entry is auto-extracted.
      name: ignore_auto_extract
    description: Retrieves the data of a logs query.
    name: panorama-get-logs
    outputs:
    - contextPath: Panorama.Monitor.Logs.Action
      description: The action taken for the session. Can be "alert", "allow", "deny", "drop", "drop-all-packets", "reset-client", "reset-server", "reset-both", or "block-url".
      type: String
    - contextPath: Panorama.Monitor.Logs.Application
      description: The application associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Category
      description: The URL category of the URL subtype. For WildFire subtype, it is the verdict on the file, and can be either "malicious", "phishing", "grayware", or "benign". For other subtypes, the value is "any".
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceName
      description: The hostname of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationAddress
      description: The original session destination IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationUser
      description: The username of the user to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationCountry
      description: The destination country or internal region for private addresses. Maximum length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationPort
      description: The destination port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileDigest
      description: Only for the WildFire subtype, all other types do not use this field. The filedigest string shows the binary hash of the file sent to be analyzed by the WildFire service.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileName
      description: |-
        File name or file type when the subtype is file.
        File name when the subtype is virus.
        File name when the subtype is wildfire-virus.
        File name when the subtype is wildfire.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileType
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the type of file that the firewall forwarded for WildFire analysis.
      type: String
    - contextPath: Panorama.Monitor.Logs.FromZone
      description: The zone from which the session was sourced.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLOrFilename
      description: |-
        The actual URL when the subtype is url.
        File name or file type when the subtype is file.
        File name when the subtype is virus.
        File name when the subtype is wildfire-virus.
        File name when the subtype is wildfire.
        URL or file name when the subtype is vulnerability (if applicable).
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationIP
      description: The post-NAT destination IP address if destination NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationPort
      description: The post-NAT destination port.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourceIP
      description: The post-NAT source IP address if source NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourcePort
      description: The post-NAT source port.
      type: String
    - contextPath: Panorama.Monitor.Logs.PCAPid
      description: |-
        The packet capture (pcap) ID is a 64 bit unsigned integral denoting
        an ID to correlate threat pcap files with extended pcaps taken as a part of
        that flow. All threat logs will contain either a pcap_id of 0 (no associated
        pcap), or an ID referencing the extended pcap file.
      type: String
    - contextPath: Panorama.Monitor.Logs.IPProtocol
      description: The IP protocol associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Recipient
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the name of the receiver of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.Rule
      description: The name of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.RuleID
      description: The ID of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.ReceiveTime
      description: The time the log was received at the management plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.Sender
      description: |-
        Only for the WildFire subtype; all other types do not use this field.
        Specifies the name of the sender of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.SessionID
      description: An internal numerical identifier applied to each session.
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceSN
      description: The serial number of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.Severity
      description: |-
        The severity associated with the threat. Can be "informational", "low",
        "medium", "high", or "critical".
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceAddress
      description: The original session source IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceCountry
      description: |-
        The source country or internal region for private addresses. Maximum
        length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceUser
      description: The username of the user who initiated the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourcePort
      description: The source port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.ThreatCategory
      description: |-
        The threat categories used to classify different types of
        threat signatures.
      type: String
    - contextPath: Panorama.Monitor.Logs.Name
      description: |-
        The Palo Alto Networks identifier for the threat. A description
        string followed by a 64-bit numerical identifier.
      type: String
    - contextPath: Panorama.Monitor.Logs.ID
      description: The Palo Alto Networks ID for the threat.
      type: String
    - contextPath: Panorama.Monitor.Logs.ToZone
      description: The zone to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.TimeGenerated
      description: The time the log was generated on the data plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLCategoryList
      description: |-
        A list of the URL filtering categories that the firewall used to
        enforce the policy.
      type: String
    - contextPath: Panorama.Monitor.Logs.Bytes
      description: The total log bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesReceived
      description: The log bytes received.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesSent
      description: The log bytes sent.
      type: String
    - contextPath: Panorama.Monitor.Logs.Vsys
      description: The vsys on the firewall that generated the log.
      type: String
  - arguments:
    - description: The application name.
      name: application
    - description: The category name.
      name: category
    - description: The destination IP address.
      name: destination
      required: true
    - description: The destination port.
      name: destination-port
    - description: The from zone.
      name: from
    - description: The to zone.
      name: to
    - description: The IP protocol value.
      name: protocol
      required: true
    - description: The source IP address.
      name: source
      required: true
    - description: The source user.
      name: source-user
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
      isArray: true
    - description: The target vsys of the firewall. Used only on a Panorama instance.
      name: vsys
      isArray: true
    description: Checks whether a session matches a specified security policy. This command is only available on firewall instances.
    deprecated: true
    name: panorama-security-policy-match
    outputs:
    - contextPath: Panorama.SecurityPolicyMatch.Query
      description: The query for the session to test.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Name
      description: The matching rule name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Action
      description: The matching rule action.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Category
      description: The matching rule category.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Destination
      description: The matching rule destination.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.From
      description: The matching rule from zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Source
      description: The matching rule source.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.To
      description: The matching rule to zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Application
      description: The application name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Category
      description: The category name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Destination
      description: The destination IP address.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.DestinationPort
      description: The destination port.
      type: Number
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.From
      description: The query fields from zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.To
      description: The query fields to zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Protocol
      description: The IP protocol value.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Source
      description: The destination IP address.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.SourceUser
      description: The source user.
      type: String
  - arguments:
    - description: The name of the virtual router for which to list the static routes.
      name: virtual_router
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Whether to show an uncommitted configuration.
      name: show_uncommitted
      predefined:
      - 'true'
      - 'false'
    description: Lists the static routes of a virtual router.
    deprecated: true
    name: panorama-list-static-routes
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of a static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
    - contextPath: Panorama.StaticRoutes.Uncommitted
      description: Whether the static route is committed.
      type: Boolean
  - arguments:
    - description: The name of the virtual router for which to display the static route.
      name: virtual_router
      required: true
    - description: The name of the static route to display.
      name: static_route
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Returns the specified static route of a virtual router.
    deprecated: true
    name: panorama-get-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
  - arguments:
    - description: The virtual router to which the routes will be added.
      name: virtual_router
      required: true
    - description: The name of the static route to add. The argument is limited to a maximum of 31 characters, is case-sensitive, and supports letters, numbers, spaces, hyphens, and underscores.
      name: static_route
      required: true
    - description: 'The IP address and network mask in Classless Inter-domain Routing (CIDR) notation: ip_address/mask. For example, 192.168.0.1/24 for IPv4 or 2001:db8::/32 for IPv6).'
      name: destination
      required: true
    - auto: PREDEFINED
      description: The type for the next hop.
      name: nexthop_type
      predefined:
      - ip-address
      - next-vr
      - fqdn
      - discard
      required: true
    - description: The next hop value.
      name: nexthop_value
      required: true
    - description: The metric port for the static route (1-65535).
      name: metric
    - description: The interface name in which to add the static route.
      name: interface
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Adds a static route.
    deprecated: true
    name: panorama-add-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
  - arguments:
    - description: The name of the static route to delete.
      name: route_name
      required: true
    - description: The virtual router from which the routes will be deleted.
      name: virtual_router
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Deletes a static route.
    deprecated: true
    name: panorama-delete-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route to delete.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
    - contextPath: Panorama.StaticRoutes.Deleted
      description: Whether the static route was deleted.
      type: Boolean
  - arguments:
    - description: The serial number of the target device.
      name: target
    description: Shows the firewall device software version.
    deprecated: true
    name: panorama-show-device-version
    outputs:
    - contextPath: Panorama.Device.Info.Devicename
      description: The device name of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Model
      description: The model of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Serial
      description: The serial number of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Version
      description: The version of the PAN-OS.
      type: String
  - arguments:
    - description: The device to which to download the content update.
      name: target
    description: Downloads the latest content update.
    deprecated: true
    name: panorama-download-latest-content-update
    outputs:
    - contextPath: Panorama.Content.Download.JobID
      description: The job ID of the content download.
      type: String
    - contextPath: Panorama.Content.Download.Status
      description: The content download status.
      type: String
  - arguments:
    - description: The device to which the content update is downloading.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Checks the download status of a content update.
    deprecated: true
    name: panorama-content-update-download-status
    outputs:
    - contextPath: Panorama.Content.Download.JobID
      description: The job ID to monitor.
      type: String
    - contextPath: Panorama.Content.Download.Status
      description: The download status.
      type: String
    - contextPath: Panorama.Content.Download.Details
      description: The job ID details.
      type: String
  - arguments:
    - description: The device on which to install the content update.
      name: target
    description: Installs the latest content update.
    deprecated: true
    name: panorama-install-latest-content-update
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      description: The job ID of the installation.
      type: String
    - contextPath: Content.Install.Status
      description: The installation status.
      type: String
  - arguments:
    - description: The device on which to check the installation status of the content update.
      name: target
    - description: The job ID of the content installation.
      name: job_id
      required: true
    description: Gets the installation status of the content update.
    deprecated: true
    name: panorama-content-update-install-status
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      description: The job ID of the content installation.
      type: String
    - contextPath: Panorama.Content.Install.Status
      description: The content installation status.
      type: String
    - contextPath: Panorama.Content.Install.Details
      description: The content installation status details.
      type: String
  - arguments:
    - description: The target device from which to get the PAN-OS software version.
      name: target
    description: Checks the PAN-OS software version from the repository.
    deprecated: true
    name: panorama-check-latest-panos-software
  - arguments:
    - description: The target device from which to download the PAN-OS software version.
      name: target
    - description: The target version number to install.
      name: target_version
      required: true
    description: Downloads the target PAN-OS software version to install on the target device.
    deprecated: true
    name: panorama-download-panos-version
    outputs:
    - contextPath: Panorama.PANOS.Download.JobID
      description: The job ID of the PAN-OS download.
      type: number
    - contextPath: Panorama.PANOS.Download.Status
      description: The status of the PAN-OS download.
      type: String
  - arguments:
    - description: The target device from which to get the download status.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Gets the download status of the target PAN-OS software.
    name: panorama-download-panos-status
    deprecated: true
    outputs:
    - contextPath: Panorama.PANOS.Download.JobID
      description: The job ID of the PAN-OS download.
      type: string
    - contextPath: Panorama.PANOS.Download.Status
      description: The PAN-OS download status.
      type: String
    - contextPath: Panorama.PANOS.Download.Details
      description: The PAN-OS download details.
      type: String
  - arguments:
    - description: The target device on which to install the target PAN-OS software version.
      name: target
    - description: The target PAN-OS version to install.
      name: target_version
      required: true
    description: Installs the target PAN-OS version on the specified target device.
    deprecated: true
    name: panorama-install-panos-version
    outputs:
    - contextPath: Panorama.PANOS.Install.JobID
      description: The job ID of the PAN-OS installation.
      type: string
    - contextPath: Panorama.PANOS.Install.Status
      description: The status of the PAN-OS installation.
      type: String
  - arguments:
    - description: The target device from which to get the installation status.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Gets the installation status of the PAN-OS software.
    deprecated: true
    name: panorama-install-panos-status
    outputs:
    - contextPath: Panorama.PANOS.Install.JobID
      description: The job ID of the PAN-OS installation.
      type: number
    - contextPath: Panorama.PANOS.Install.Status
      description: The status of the PAN-OS installation.
      type: String
    - contextPath: Panorama.PANOS.Install.Details
      description: The PAN-OS installation details.
      type: String
  - arguments:
    - description: The target device on which to reboot the firewall.
      name: target
    description: Reboots the firewall device.
    deprecated: true
    name: panorama-device-reboot
  - arguments:
    - description: The IP address from which to return information.
      name: ip_address
      required: true
    description: Gets location information for an IP address.
    deprecated: true
    name: panorama-show-location-ip
    outputs:
    - contextPath: Panorama.Location.IP.country_code
      description: The IP address location country code.
      type: String
    - contextPath: Panorama.Location.IP.country_name
      description: The IP address location country name.
      type: String
    - contextPath: Panorama.Location.IP.ip_address
      description: The IP address.
      type: String
    - contextPath: Panorama.Location.IP.Status
      description: Whether the IP address was found.
      type: String
  - arguments: []
    description: Gets information about available PAN-OS licenses and their statuses.
    deprecated: true
    name: panorama-get-licenses
    outputs:
    - contextPath: Panorama.License.Authcode
      description: The authentication code of the license.
      type: String
    - contextPath: Panorama.License.Base-license-name
      description: The base license name.
      type: String
    - contextPath: Panorama.License.Description
      description: The description of the license.
      type: String
    - contextPath: Panorama.License.Expired
      description: Whether the license has expired.
      type: String
    - contextPath: Panorama.License.Expires
      description: When the license will expire.
      type: String
    - contextPath: Panorama.License.Feature
      description: The feature of the license.
      type: String
    - contextPath: Panorama.License.Issued
      description: When the license was issued.
      type: String
    - contextPath: Panorama.License.Serial
      description: The serial number of the license.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: The security profile for which to get information.
      name: security_profile
      predefined:
      - data-filtering
      - file-blocking
      - spyware
      - url-filtering
      - virus
      - vulnerability
      - wildfire-analysis
    description: Gets information for the specified security profile.
    deprecated: true
    name: panorama-get-security-profiles
    outputs:
    - contextPath: Panorama.Spyware.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.Spyware.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Spyware.Rules.Category
      description: The category for which to apply the rule.
      type: String
    - contextPath: Panorama.Spyware.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Spyware.Rules.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Spyware.Rules.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Spyware.Rules.Threat-name
      description: The threat name to apply for the rule.
      type: String
    - contextPath: Panorama.URLFilter.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.URLFilter.Rules.Category.Action
      description: The rule action to apply to the category.
      type: String
    - contextPath: Panorama.URLFilter.Rules.Category.Name
      description: The category name.
      type: String
    - contextPath: Panorama.WildFire.Name
      description: The WildFire profile name.
      type: String
    - contextPath: Panorama.WildFire.Rules.Analysis
      description: The rule analysis.
      type: String
    - contextPath: Panorama.WildFire.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.WildFire.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.WildFire.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Name
      description: The vulnerability profile name.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Vendor-id
      description: The vendor ID to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Host
      description: The rule host.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Category
      description: The category to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.CVE
      description: The CVE to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Threat-name
      description: The threat to apply for the rule.
      type: String
    - contextPath: Panorama.Antivirus.Name
      description: The antivirus profile name.
      type: String
    - contextPath: Panorama.Antivirus.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Antivirus.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Antivirus.Rules.WildFire-action
      description: The WildFire action.
      type: String
    - contextPath: Panorama.FileBlocking.Name
      description: The file blocking profile name.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.DataFiltering.Name
      description: The data filtering profile name.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Alert-threshold
      description: The alert threshold.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Block-threshold
      description: The block threshold.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Data-object
      description: The data object.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Direction
      description: The rule direction.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Log-severity
      description: The log severity.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Name
      description: The rule name.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: Security profile type.
      name: profile_type
      predefined:
      - data-filtering
      - file-blocking
      - spyware
      - url-filtering
      - virus
      - vulnerability
      - wildfire-analysis
      required: true
    - description: The rule name to apply.
      name: rule_name
      required: true
    - description: The profile name to apply to the rule.
      name: profile_name
      required: true
    - auto: PREDEFINED
      description: The location of the rules. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Applies a security profile to specific rules or rules with a specific tag.
    deprecated: true
    name: panorama-apply-security-profile
  - arguments:
    - auto: PREDEFINED
      description: The location of the rules. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Get SSL decryption rules.
    deprecated: true
    name: panorama-get-ssl-decryption-rules
    outputs:
    - contextPath: Panorama.SSLRule.From
      description: The SSL rule from the source.
      type: String
    - contextPath: Panorama.SSLRule.Name
      description: The name of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Destination
      description: The destination of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Target
      description: The target of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Service
      description: The SSL rule service.
      type: String
    - contextPath: Panorama.SSLRule.Action
      description: The SSL rule action.
      type: String
    - contextPath: Panorama.SSLRule.Type
      description: The SSL rule type.
      type: String
    - contextPath: Panorama.SSLRule.Source
      description: The source of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.To
      description: The SSL rule to destination.
      type: String
    - contextPath: Panorama.SSLRule.UUID
      description: The SSL rule UUID.
      type: String
    - contextPath: Panorama.SSLRule.Description
      description: The SSL rule description.
      type: String
    - contextPath: Panorama.SSLRule.Source-user
      description: The SSL rule source user.
      type: String
    - contextPath: Panorama.SSLRule.Category
      description: The SSL rule category.
      type: String
  - arguments:
    - description: The template name.
      name: template
      required: true
    description: Retrieves the Wildfire configuration.
    deprecated: true
    name: panorama-get-wildfire-configuration
    outputs:
    - contextPath: Panorama.WildFire.Name
      description: The file name.
      type: String
    - contextPath: Panorama.WildFire.Size-limit
      description: The file size limit.
      type: String
    - contextPath: Panorama.WildFire.recurring
      description: The schedule that is recurring.
      type: String
  - arguments:
    - description: The URL filtering profile name. Get the name by running the get-security-profiles command.
      name: profile_name
      required: true
    description: Sets default categories to block in the URL filtering profile.
    deprecated: true
    name: panorama-url-filtering-block-default-categories
  - arguments: []
    description: Gets anti-spyware best practices.
    deprecated: true
    name: panorama-get-anti-spyware-best-practice
    outputs:
    - contextPath: Panorama.Spyware.BotentDomain.Name
      description: The botnet domain name.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Action
      description: The botnet domain action.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Sinkhole.ipv4-address
      description: The botnet domain IPv4 address.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Sinkhole.ipv6-address
      description: The Botnet domain IPv6 address.
      type: String
    - contextPath: Panorama.Spyware.Rule.Category
      description: The rule category.
      type: String
    - contextPath: Panorama.Spyware.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Spyware.Rule.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Spyware.Rule.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Spyware.Rule.Threat-name
      description: The rule threat name.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Max_version
      description: The botnet domain max version.
      type: String
  - arguments: []
    description: Gets file-blocking best practices.
    deprecated: true
    name: panorama-get-file-blocking-best-practice
    outputs:
    - contextPath: Panorama.FileBlocking.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.Application
      description: The rule application.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.File-type
      description: The rule file type.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.Name
      description: The rule name.
      type: String
  - arguments: []
    description: Get anti-virus best practices.
    deprecated: true
    name: panorama-get-antivirus-best-practice
    outputs:
    - contextPath: Panorama.Antivirus.Decoder.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Antivirus.Decoder.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Antivirus.Decoder.WildFire-action
      description: The WildFire action.
      type: String
  - arguments: []
    description: Gets vulnerability-protection best practices.
    deprecated: true
    name: panorama-get-vulnerability-protection-best-practice
    outputs:
    - contextPath: Panorama.Vulnerability.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.CVE
      description: The rule CVE.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Category
      description: The rule category.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Host
      description: The rule host.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Threat-name
      description: The threat name.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Vendor-id
      description: The vendor ID.
      type: String
  - arguments: []
    description: Views WildFire best practices.
    deprecated: true
    name: panorama-get-wildfire-best-practice
    outputs:
    - contextPath: Panorama.WildFire.Analysis
      description: The WildFire analysis.
      type: String
    - contextPath: Panorama.WildFire.Application
      description: The WildFire application.
      type: String
    - contextPath: Panorama.WildFire.File.File-size
      description: The recommended file size.
      type: String
    - contextPath: Panorama.WildFire.File.Name
      description: The file name.
      type: String
    - contextPath: Panorama.WildFire.File-type
      description: The WildFire profile file type.
      type: String
    - contextPath: Panorama.WildFire.Name
      description: The WildFire profile name.
      type: String
    - contextPath: Panorama.WildFire.SSLDecrypt
      description: The SSL decrypt content.
      type: String
    - contextPath: Panorama.WildFire.Schedule.Action
      description: The WildFire schedule action.
      type: String
    - contextPath: Panorama.WildFire.Schedule.Recurring
      description: The WildFire schedule recurring.
      type: String
  - arguments: []
    description: Views URL filtering best practices.
    deprecated: true
    name: panorama-get-url-filtering-best-practice
    outputs:
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action to perform on the category.
      type: String
    - contextPath: Panorama.URLFilter.Category.Name
      description: The category name.
      type: String
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group name.
      type: String
    - contextPath: Panorama.URLFilter.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-container-page-only
      description: The log container page only.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-referer
      description: The log HTTP header referrer.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-user
      description: The log HTTP header user.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-xff
      description: The log HTTP header xff.
      type: String
  - arguments:
    - description: The template name.
      name: template
      required: true
    description: Enforces wildfire best practices to upload files to the maximum size, forwards all file types, and updates the schedule.
    deprecated: true
    name: panorama-enforce-wildfire-best-practice
  - arguments:
    - description: The name of the profile to create.
      name: profile_name
      required: true
    description: Creates an antivirus best practice profile.
    deprecated: true
    name: panorama-create-antivirus-best-practice-profile
  - arguments:
    - description: The profile name to create.
      name: profile_name
      required: true
    description: Creates an anti-spyware best practice profile.
    deprecated: true
    name: panorama-create-anti-spyware-best-practice-profile
  - arguments:
    - description: The profile name.
      name: profile_name
      required: true
    description: Creates a vulnerability protection best practice profile.
    deprecated: true
    name: panorama-create-vulnerability-best-practice-profile
  - arguments:
    - description: The profile name.
      name: profile_name
      required: true
    description: Creates a URL filtering best practice profile.
    deprecated: true
    name: panorama-create-url-filtering-best-practice-profile
  - arguments:
    - description: The name of the profile.
      name: profile_name
      required: true
    description: Creates a file blocking best practice profile.
    deprecated: true
    name: panorama-create-file-blocking-best-practice-profile
  - arguments:
    - description: The name of the profile.
      name: profile_name
      required: true
    description: Creates a WildFire analysis best practice profile.
    deprecated: true
    name: panorama-create-wildfire-best-practice-profile
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Shows the user ID interface configuration.
    deprecated: true
    name: panorama-show-user-id-interfaces-config
    outputs:
    - contextPath: Panorama.UserInterfaces.Name
      description: The name of the user interface.
      type: String
    - contextPath: Panorama.UserInterfaces.Zone
      description: The zone to which the interface is connected.
      type: String
    - contextPath: Panorama.UserInterfaces.EnableUserIdentification
      description: Whether user identification is enabled.
      type: String
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Shows the zones configuration.
    deprecated: true
    name: panorama-show-zones-config
    outputs:
    - contextPath: Panorama.Zone.Name
      description: The name of the zone.
      type: String
    - contextPath: Panorama.Zone.Network
      description: The network to which the zone is connected.
      type: String
    - contextPath: Panorama.Zone.EnableUserIdentification
      description: Whether user identification is enabled.
      type: String
    - contextPath: Panorama.Zone.ZoneProtectionProfile
      description: The zone protection profile.
      type: String
    - contextPath: Panorama.Zone.LogSetting
      description: The log setting for the zone.
      type: String
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Retrieves list of user ID agents configured in the system.
    deprecated: true
    name: panorama-list-configured-user-id-agents
    outputs:
    - contextPath: Panorama.UserIDAgents.Name
      description: The user ID agent name.
      type: String
    - contextPath: Panorama.UserIDAgents.Host
      description: The user ID agent host.
      type: String
    - contextPath: Panorama.UserIDAgents.Port
      description: The user ID agent port.
      type: Number
    - contextPath: Panorama.UserIDAgents.LdapProxy
      description: Whether LDAP proxy is used in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.NtlmAuth
      description: Whether NLTM authentication is used in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.EnableHipCollection
      description: Whether HIP collection is enabled in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.IpUserMapping
      description: Whether IP user mapping is enabled in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.SerialNumber
      description: The serial number associated with the user ID agent.
      type: Unknown
    - contextPath: Panorama.UserIDAgents.CollectorName
      description: The user ID agent collector name.
      type: String
    - contextPath: Panorama.UserIDAgents.Secret
      description: The user ID agent secret.
      type: String
    - contextPath: Panorama.UserIDAgents.Disabled
      description: Whether the user ID agent is disabled.
      type: String
  - arguments:
    - description: The entry ID of the file to upload.
      name: entryID
      required: true
    - auto: PREDEFINED
      description: The category of the content.
      name: category
      predefined:
      - wildfire
      - anti-virus
      - content
      required: true
    description: Uploads a content file to Panorama.
    deprecated: true
    name: panorama-upload-content-update-file
    outputs:
    - contextPath: Panorama.Content.Upload.Status
      description: The content upload status.
      type: string
    - contextPath: Panorama.Content.Upload.Message
      description: The content upload message.
      type: string
  - arguments:
    - description: The update file name to be installed on PAN-OS.
      name: version_name
      required: true
    - auto: PREDEFINED
      description: The category of the content.
      name: category
      predefined:
      - wildfire
      - anti-virus
      - content
      required: true
    - auto: PREDEFINED
      defaultValue: no
      description: Skips the file validity check with the PAN-OS update server. Use this option for air-gapped networks and only if you trust the content file.
      name: skip_validity_check
      predefined:
      - yes
      - no
      required: true
    description: Installs a specific content update file.
    deprecated: true
    name: panorama-install-file-content-update
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      description: The job ID of the installation.
      type: string
    - contextPath: Panorama.Content.Install.Status
      description: The installation status.
      type: string
  - arguments:
    - auto: PREDEFINED
      description: Action to be taken, such as show, get, set, edit, delete, rename, clone, move, override, multi-move, multi-clone, or complete. Documentation - https://docs.paloaltonetworks.com/pan-os/9-1/pan-os-panorama-api/pan-os-xml-api-request-types/configuration-api.
      name: action
      predefined:
      - set
      - edit
      - delete
      - rename
      - clone
      - move
      - override
      - muti-move
      - multi-clone
      - complete
      - show
      - get
    - description: The object's new name, used when action=rename. If no value is provided, the name defaults to 'newname'.
      name: newname
    - description: The category parameter. For example, when exporting a configuration file, use "category=configuration".
      name: category
    - description: Specifies the XML structure that defines the command. Used for operation commands (op type command). Can be retrieved from the PAN-OS web UI debugger or enabling debugging via the CLI using `debug cli on`.
      name: cmd
    - description: The command to run. For example, command =<show><arp><entry name='all'/></arp></show>.
      name: command
    - description: The specified destination.
      name: dst
    - description: Used to define a new value for an object. Should be an XML object, for example, <static><member>test</member></static>.
      name: element
    - description: The end time (used only when cloning an object).
      name: to
    - description: The start time (used only when cloning an object).
      name: from
    - description: The key value to set.
      name: key
    - description: The log type to retrieve. For example, log-type=threat for threat logs.
      name: log-type
    - description: The type of move operation (for example, where=after, where=before, where=top, where=bottom).
      name: where
    - description: The time period, for example period=last-24-hrs.
      name: period
    - description: xpath location. xpath defines the location of the object. For example, xpath=/config/predefined/application/entry[@name='hotmail']. Documentation - https://docs.paloaltonetworks.com/pan-os/9-1/pan-os-panorama-api/about-the-pan-os-xml-api/structure-of-a-pan-os-xml-api-request/xml-and-xpath.
      name: xpath
    - description: The PCAP ID included in the threat log.
      name: pcap-id
    - description: The device serial number.
      name: serialno
    - description: The report type, for example dynamic, predefined, or custom.
      name: reporttype
    - description: The report name.
      name: reportname
    - defaultValue: 'config'
      description: The request type, for example export, import, log, config.
      name: type
      predefined:
      - 'keygen'
      - 'config'
      - 'commit'
      - 'op'
      - 'report'
      - 'log'
      - 'import'
      - 'export'
      - 'user-id'
      - 'version'
      auto: PREDEFINED
    - description: The time the PCAP was received on the firewall. Used for threat PCAPs.
      name: search-time
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance. This argument will work only with op type commands.
      name: target
    - description: The job ID.
      name: job-id
    - description: The query string.
      name: query
    - description: The name of the virtual system to be configured. If no vsys is mentioned, this command will not use the vsys parameter.
      name: vsys
    - description: The device group in which to run the command.
      name: device-group
    - description: Return raw XML.
      name: is_xml
      auto: PREDEFINED
      predefined:
      - "false"
      - "true"
      defaultValue: "false"
    description: Runs any command supported in the API.
    name: pan-os
  - arguments:
    - description: The firewall managed by Panorama from which to retrieve the predefined threats.
      name: target
    description: Gets the predefined threats list from a Firewall or Panorama and stores it as a JSON file in the context.
    name: pan-os-get-predefined-threats-list
    outputs:
    - contextPath: File.Size
      description: The file size.
      type: number
    - contextPath: File.Name
      description: The file name.
      type: string
    - contextPath: File.Type
      description: The file type.
      type: string
    - contextPath: File.Info
      description: The file information.
      type: string
    - contextPath: File.Extension
      description: The file extension.
      type: string
    - contextPath: File.EntryID
      description: The file entry ID.
      type: string
    - contextPath: File.MD5
      description: The MD5 hash of the file.
      type: string
    - contextPath: File.SHA1
      description: The SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: The SHA256 hash of the file.
      type: string
    - contextPath: File.SHA512
      description: The SHA512 hash of the file.
      type: string
    - contextPath: File.SSDeep
      description: The SSDeep hash of the file.
      type: string
  - arguments:
    - description: Panorama only. Limits the commit scope to the specified device group(s), so only pending changes for those device groups are committed. If omitted, all pending changes are committed.
      name: device-group
    - description: Panorama only. Limits the commit scope to the specified template(s), so only pending changes for those templates are committed. If omitted, all pending changes are committed.
      name: template
      isArray: True
    - description: The commit description.
      name: description
    - description: The administrator name. To commit admin-level changes on a firewall, include the administrator name in the request.
      name: admin_name
    - auto: PREDEFINED
      description: Forces a commit.
      name: force_commit
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Performs a partial commit while excluding device and network configuration.
      name: exclude_device_network_configuration
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Performs a partial commit while excluding shared objects.
      name: exclude_shared_objects
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to use polling.
      defaultValue: 'false'
      name: polling
      predefined:
      - 'true'
      - 'false'
    - description: commit job ID to use in polling commands. (automatically filled by polling).
      name: commit_job_id
      deprecated: true
    - description: The timeout (in seconds) when polling.
      name: timeout
      defaultValue: '120'
    - description: The interval (in seconds) when polling.
      name: interval_in_seconds
      defaultValue: '10'
    - description: whether to hide the polling result (automatically filled by polling).
      name: hide_polling_output
      deprecated: true
    description: Commits a configuration to the Palo Alto firewall or Panorama, validates if a commit was successful if using polling="true" otherwise does not validate if the commit was successful. Committing to Panorama does not push the configuration to the firewalls. To push the configuration, run the panorama-push-to-device-group command.
    name: pan-os-commit
    polling: true
    outputs:
    - contextPath: Panorama.Commit.JobID
      description: The job ID to commit.
      type: Number
    - contextPath: Panorama.Commit.Status
      description: The commit status.
      type: String
    - contextPath: Panorama.Commit.Description
      description: The commit description from the the command input.
      type: String
    - contextPath: Panorama.Commit.Scope
      description: Whether the commit is partial.
      type: String
    - contextPath: Panorama.Commit.Details
      description: The summary of the targeted device group and templates.
      type: String
  - arguments:
    - default: true
      description: The device group to which to push (Panorama instances).
      name: device-group
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Pre policy validation.
      name: validate-only
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether to include template changes.
      name: include-template
      predefined:
      - 'true'
      - 'false'
    - description: The push description.
      name: description
    - description: The serial number for a virtual system commit. If provided, the commit will be a virtual system commit.
      name: serial_number
    - auto: PREDEFINED
      description: Whether to use polling.
      defaultValue: 'false'
      name: polling
      predefined:
      - 'true'
      - 'false'
    - description: push job ID to use in polling commands. (automatically filled by polling).
      name: push_job_id
      deprecated: true
    - description: The timeout (in seconds) when polling.
      name: timeout
      defaultValue: '120'
    - description: The interval (in seconds) when polling.
      name: interval_in_seconds
      defaultValue: '10'
    - description: whether to hide the polling result (automatically filled by polling).
      name: hide_polling_output
      deprecated: true
    description: Pushes rules from PAN-OS to the configured device group. In order to push the configuration to Prisma Access managed tenants (single or multi tenancy), use the device group argument with the device group which is associated with the tenant ID. Validates if a push has been successful if polling="true".
    name: pan-os-push-to-device-group
    polling: true
    outputs:
    - contextPath: Panorama.Push.DeviceGroup
      description: The device group in which the policies were pushed.
      type: String
    - contextPath: Panorama.Push.JobID
      description: The job ID of the policies that were pushed.
      type: Number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: String
    - contextPath: Panorama.Push.Warnings
      description: The push warnings.
      type: String
    - contextPath: Panorama.Push.Errors
      description: The push errors.
      type: String
    - contextPath: Panorama.Push.Details
      description: The job ID details.
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag to filter the list of addresses.
      name: tag
    description: Returns a list of addresses.
    name: pan-os-list-addresses
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The address device group.
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The address name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns address details for the supplied address name.
    name: pan-os-get-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The new address name.
      name: name
      required: true
    - description: The new address description.
      name: description
    - description: The FQDN of the new address.
      name: fqdn
    - description: The IP netmask of the new address. For example, 10.10.10.10/24.
      name: ip_netmask
    - description: The IP range of the new address IP. For example, 10.10.10.0-10.10.10.255.
      name: ip_range
    - description: The IP wildcard of the new address. For example, 10.20.1.0/0.0.248.255.
      name: ip_wildcard
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for the new address.
      isArray: true
      name: tag
    - auto: PREDEFINED
      description: Whether to create the tag if it does not exist.
      defaultValue: 'false'
      name: create_tag
      predefined:
      - 'true'
      - 'false'
    description: Creates an address object.
    name: pan-os-create-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name.
      type: string
    - contextPath: Panorama.Addresses.Description
      description: The address description.
      type: string
    - contextPath: Panorama.Addresses.FQDN
      description: The address FQDN.
      type: string
    - contextPath: Panorama.Addresses.IP_Netmask
      description: The address IP Netmask.
      type: string
    - contextPath: Panorama.Addresses.IP_Range
      description: The address IP range.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
    - contextPath: Panorama.Addresses.Tags
      description: The address tags.
      type: String
  - arguments:
    - description: The name of the address to edit.
      name: name
      required: true
    - description: The device-group in which the address is in.
      name: device-group
    - auto: PREDEFINED
      description: The element to change.
      name: element_to_change
      required: true
      predefined:
      - fqdn
      - ip_netmask
      - ip_range
      - ip_wildcard
      - description
      - tag
    - description: The value of the element that needs to be changed. Can be a list when element_to_change == 'tag' only.
      isArray: true
      name: element_value
      required: true
    description: Edits an address object.
    name: pan-os-edit-address
  - arguments:
    - description: The name of the address to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes an address object.
    name: pan-os-delete-address
    outputs:
    - contextPath: Panorama.Addresses.Name
      description: The address name that was deleted.
      type: string
    - contextPath: Panorama.Addresses.DeviceGroup
      description: The device group for the address (Panorama instances).
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag for which to filter the address groups.
      name: tag
    description: Returns a list of address groups.
    name: pan-os-list-address-groups
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic Address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: String
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The address group name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Gets details for the specified address group.
    name: pan-os-get-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The address group name.
      name: name
      required: true
    - auto: PREDEFINED
      description: The address group type.
      name: type
      predefined:
      - dynamic
      - static
      required: true
    - description: The dynamic address group match. For example "1.1.1.1 or 2.2.2.2".
      name: match
    - description: The static address group list of addresses.
      isArray: true
      name: addresses
    - description: The address group description.
      name: description
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for the address group.
      isArray: true
      name: tags
    description: Creates a static or dynamic address group.
    name: pan-os-create-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Match
      description: The dynamic address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group list of addresses.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: 'The type of session rejection. Possible values are: "drop", "alert", "block-ip", "reset-both", "reset-client", and "reset-server". Default is "drop".'
      name: drop_mode
      predefined:
      - drop
      - alert
      - block-ip
      - reset-both
      - reset-client
      - reset-server
    - description: The name of the vulnerability profile.
      name: vulnerability_profile
      required: true
    - description: The numerical threat ID.
      name: threat_id
      required: true
    description: Sets a vulnerability signature to block mode.
    name: pan-os-block-vulnerability
    outputs:
    - contextPath: Panorama.Vulnerability.ID
      description: The ID of the vulnerability that was blocked/overridden.
      type: string
    - contextPath: Panorama.Vulnerability.NewAction
      description: The new action for the vulnerability.
      type: string
  - arguments:
    - description: The name of the address group to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes an address group.
    name: pan-os-delete-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The name of the address group that was deleted.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
  - arguments:
    - description: The name of the address group to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The address group type.
      name: type
      predefined:
      - static
      - dynamic
      required: true
    - description: The address group new match. For example, '1.1.1.1 and 2.2.2.2'.
      name: match
    - description: The element to add to the list of the static address group. Only existing address objects can be added.
      name: element_to_add
    - description: The element to remove from the list of the static address group. Only existing address objects can be removed.
      name: element_to_remove
    - description: The address group new description.
      name: description
    - description: The tag of the address group to edit.
      isArray: true
      name: tags
    - description: The device group in which the address group belongs to.
      name: device-group
    description: Edits a static or dynamic address group.
    name: pan-os-edit-address-group
    outputs:
    - contextPath: Panorama.AddressGroups.Name
      description: The address group name.
      type: string
    - contextPath: Panorama.AddressGroups.Type
      description: The address group type.
      type: string
    - contextPath: Panorama.AddressGroups.Filter
      description: The dynamic Address group match.
      type: string
    - contextPath: Panorama.AddressGroups.Description
      description: The address group description.
      type: string
    - contextPath: Panorama.AddressGroups.Addresses
      description: The static address group addresses.
      type: string
    - contextPath: Panorama.AddressGroups.DeviceGroup
      description: The device group for the address group (Panorama instances).
      type: String
    - contextPath: Panorama.AddressGroups.Tags
      description: The address group tags.
      type: String
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag to filter the services.
      name: tag
    description: Returns a list of addresses.
    name: pan-os-list-services
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group in which the service was configured (Panorama instances).
      type: string
    - contextPath: Panorama.Services.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The service name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns service details for the supplied service name.
    name: pan-os-get-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
    - contextPath: Panorama.Service.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The name for the new service.
      name: name
      required: true
    - auto: PREDEFINED
      description: The protocol for the new service.
      name: protocol
      predefined:
      - tcp
      - udp
      - sctp
      required: true
    - description: The destination port  for the new service.
      name: destination_port
      required: true
    - description: The source port for the new service.
      name: source_port
    - description: The description for the new service.
      name: description
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for the new service.
      isArray: true
      name: tags
    description: Creates a service.
    name: pan-os-create-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The service name.
      type: string
    - contextPath: Panorama.Services.Protocol
      description: The service protocol.
      type: string
    - contextPath: Panorama.Services.Description
      description: The service description.
      type: string
    - contextPath: Panorama.Services.DestinationPort
      description: The service destination port.
      type: string
    - contextPath: Panorama.Services.SourcePort
      description: The service source port.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
    - contextPath: Panorama.Services.Tags
      description: The service tags.
      type: String
  - arguments:
    - description: The name of the service to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a service.
    name: pan-os-delete-service
    outputs:
    - contextPath: Panorama.Services.Name
      description: The name of the deleted service.
      type: string
    - contextPath: Panorama.Services.DeviceGroup
      description: The device group for the service (Panorama instances).
      type: string
  - arguments:
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags for which to filter the Service groups.
      isArray: true
      name: tag
    description: Returns a list of service groups.
    name: pan-os-list-service-groups
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The service group name.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Returns details for the specified service group.
    name: pan-os-get-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The service group name.
      name: name
      required: true
    - description: The service group related services.
      isArray: true
      name: services
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tags to filter service groups.
      isArray: true
      name: tags
    description: Creates a service group.
    name: pan-os-create-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The name of the service group to delete.
      name: name
      required: true
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a service group.
    name: pan-os-delete-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The name of the deleted service group.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
  - arguments:
    - description: The name of the service group to edit.
      name: name
      required: true
    - description: The services to add to the service group. Only existing service objects can be added.
      isArray: true
      name: services_to_add
    - description: The services to remove from the service group. Only existing Service objects can be removed.
      name: services_to_remove
    - description: The tag of the service group to edit.
      isArray: true
      name: tags
    - description: The device group in which the service group belongs to.
      name: device-group
    description: Edits a service group.
    name: pan-os-edit-service-group
    outputs:
    - contextPath: Panorama.ServiceGroups.Name
      description: The service group name.
      type: string
    - contextPath: Panorama.ServiceGroups.Services
      description: The service group related services.
      type: string
    - contextPath: Panorama.ServiceGroups.DeviceGroup
      description: The device group for the service group (Panorama instances).
      type: string
    - contextPath: Panorama.ServiceGroups.Tags
      description: The service group tags.
      type: String
  - arguments:
    - description: The custom URL category name.
      name: name
      required: true
    - description: The device group for which to return addresses for the custom URL category (Panorama instances).
      name: device-group
    description: Returns information for a custom URL category.
    name: pan-os-get-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The category name of the custom URL.
      type: String
    - contextPath: Panorama.CustomURLCategory.Description
      description: The category description of the custom URL.
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The list of sites of the custom URL category.
      type: String
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL Category (Panorama instances).
      type: String
    - contextPath: Panorama.CustomURLCategory.Categories
      description: The list of categories of the custom URL category.
      type: String
    - contextPath: Panorama.CustomURLCategory.Type
      description: The category type of the custom URL.
      type: String
  - arguments:
    - description: The name of the custom URL category to create.
      name: name
      required: true
    - description: The description of the custom URL category to create.
      name: description
    - description: The list of sites for the custom URL category.
      isArray: true
      name: sites
    - description: The device group for which to return addresses for the custom URL category (Panorama instances).
      name: device-group
    - auto: PREDEFINED
      description: The category type of the URL. Relevant from PAN-OS v9.x.
      name: type
      predefined:
      - URL List
      - Category Match
    - description: The list of categories. Relevant from PAN-OS v9.x.
      isArray: true
      name: categories
    description: Creates a custom URL category.
    name: pan-os-create-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The custom URL category name.
      type: String
    - contextPath: Panorama.CustomURLCategory.Description
      description: The custom URL category description.
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of sites.
      type: String
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the custom URL category (Panorama instances).
      type: String
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of categories.
      type: String
    - contextPath: Panorama.CustomURLCategory.Type
      description: The custom URL category type.
      type: String
  - arguments:
    - description: The name of the custom URL category to delete.
      name: name
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    description: Deletes a custom URL category.
    name: pan-os-delete-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The name of the custom URL category to delete.
      type: string
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the Custom URL Category (Panorama instances).
      type: string
  - arguments:
    - description: The name of the custom URL category to add or remove sites.
      name: name
      required: true
    - description: A comma-separated list of sites to add to the custom URL category.
      isArray: true
      name: sites
    - auto: PREDEFINED
      description: Adds or removes sites or categories.
      isArray: true
      name: action
      predefined:
      - add
      - remove
      required: true
    - description: A comma-separated list of categories to add to the custom URL category.
      isArray: true
      name: categories
    - description: The device group in which the URL category belongs to.
      name: device-group
    description: Adds or removes sites to and from a custom URL category.
    name: pan-os-edit-custom-url-category
    outputs:
    - contextPath: Panorama.CustomURLCategory.Name
      description: The custom URL category name.
      type: string
    - contextPath: Panorama.CustomURLCategory.Description
      description: The custom URL category description.
      type: string
    - contextPath: Panorama.CustomURLCategory.Sites
      description: The custom URL category list of sites.
      type: string
    - contextPath: Panorama.CustomURLCategory.DeviceGroup
      description: The device group for the Custom URL Category (Panorama instances).
      type: string
  - arguments:
    - default: true
      description: The URL to check.
      isArray: true
      name: url
      required: true
    description: Gets a URL category from URL filtering.
    name: url
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
      type: String
    - contextPath: DBotScore.Score
      description: The actual score.
      type: Number
    - contextPath: DBotScore.Type
      description: The indicator type.
      type: String
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
      type: String
    - contextPath: URL.Data
      description: The URL address.
      type: String
    - contextPath: URL.Category
      description: The URL category.
      type: String
  - arguments:
    - default: true
      description: The URL to check.
      isArray: true
      name: url
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    description: Gets a URL category from URL filtering. This command is only available on firewall devices.
    name: pan-os-get-url-category
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
      type: String
    - contextPath: DBotScore.Score
      description: The actual score.
      type: Number
    - contextPath: DBotScore.Type
      description: The indicator type.
      type: String
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
      type: String
    - contextPath: URL.Data
      description: The URL address.
      type: String
    - contextPath: URL.Category
      description: The URL category.
      type: String
  - arguments:
    - description: The URL to check.
      isArray: true
      name: url
      required: true
    description: Returns a URL category from URL filtering. This command is only available on firewall devices.
    name: pan-os-get-url-category-from-cloud
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
  - arguments:
    - description: The URL to check.
      isArray: true
      name: url
      required: true
    description: Returns a URL category from URL filtering. This command is only available on firewall devices.
    name: pan-os-get-url-category-from-host
    outputs:
    - contextPath: Panorama.URLFilter.URL
      description: The URL.
      type: string
    - contextPath: Panorama.URLFilter.Category
      description: The URL category.
      type: string
  - arguments:
    - description: URL filter name.
      name: name
      required: true
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Returns information for a URL filtering rule.
    name: pan-os-get-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override block list.
      type: string
    - contextPath: Panorama.URLFilter.OverrideAllowList
      description: The URL filter override allow list.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter to create.
      name: name
      required: true
    - description: The URL category.
      isArray: true
      name: url_category
      required: true
    - auto: PREDEFINED
      description: The action for the URL category.
      name: action
      predefined:
      - allow
      - block
      - alert
      - continue
      - override
      required: true
    - description: The CSV list of URLs to exclude from the allow list.
      isArray: true
      name: override_allow_list
    - description: The CSV list of URLs to exclude from the blocked list.
      isArray: true
      name: override_block_list
    - description: The URL filter description.
      name: description
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Creates a URL filtering rule.
    name: pan-os-create-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category name.
      type: string
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override allow list.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The URL filter override blocked list.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The element to change.
      name: element_to_change
      predefined:
      - override_allow_list
      - override_block_list
      - allow_categories
      - block_categories
      - description
      required: true
    - description: The element value. Limited to one value.
      name: element_value
      required: true
    - auto: PREDEFINED
      defaultValue: add
      description: Adds or remove an element from the Allow List or Block List fields.
      name: add_remove_element
      predefined:
      - add
      - remove
    - description: The device group in which the URL-filter belongs to.
      name: device-group
    description: Edits a URL filtering rule.
    name: pan-os-edit-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter name.
      type: string
    - contextPath: Panorama.URLFilter.Description
      description: The URL filter description.
      type: string
    - contextPath: Panorama.URLFilter.Category.Name
      description: The URL filter category.
      type: string
    - contextPath: Panorama.URLFilter.Action
      description: The action for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideAllowList
      description: The allow list overrides for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.OverrideBlockList
      description: The block list overrides for the URL category.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The name of the URL filter rule to delete.
      name: name
      required: true
    - description: The device group for which to return addresses for the URL filter (Panorama instances).
      name: device-group
    description: Deletes a URL filtering rule.
    name: pan-os-delete-url-filter
    outputs:
    - contextPath: Panorama.URLFilter.Name
      description: The URL filter rule name.
      type: string
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group for the URL filter (Panorama instances).
      type: string
  - arguments:
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Returns a list of external dynamic lists.
    name: pan-os-list-edls
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The type of EDL.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The description of the EDL.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Returns information for an external dynamic list.
    name: pan-os-get-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The type of EDL.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The description of the EDL.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The URL from which to pull the EDL.
      name: url
      required: true
    - auto: PREDEFINED
      description: The type of EDL.
      name: type
      predefined:
      - ip
      - url
      - domain
      required: true
    - auto: PREDEFINED
      description: The time interval for pulling and updating the EDL.
      name: recurring
      predefined:
      - five-minute
      - hourly
      required: true
    - description: The certificate profile name for the URL that was previously uploaded. to PAN OS.
      name: certificate_profile
    - description: The description of the EDL.
      name: description
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Creates an external dynamic list.
    name: pan-os-create-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.Type
      description: The type of the EDL.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL in which the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The description of the EDL.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the external dynamic list to edit.
      name: name
      required: true
    - auto: PREDEFINED
      description: The element to change (“url”, “recurring”, “certificate_profile”, “description”).
      name: element_to_change
      predefined:
      - url
      - recurring
      - certificate_profile
      - description
      required: true
    - description: The element value.
      name: element_value
      required: true
    - description: The device group in which the EDL belongs to.
      name: device-group
    description: Modifies an element of an external dynamic list.
    name: pan-os-edit-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL.
      type: string
    - contextPath: Panorama.EDL.URL
      description: The URL where the EDL is stored.
      type: string
    - contextPath: Panorama.EDL.Description
      description: The description of the EDL.
      type: string
    - contextPath: Panorama.EDL.CertificateProfile
      description: The EDL certificate profile.
      type: string
    - contextPath: Panorama.EDL.Recurring
      description: The time interval the EDL was pulled and updated.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The name of the EDL to delete.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    description: Deletes an external dynamic list.
    name: pan-os-delete-edl
    outputs:
    - contextPath: Panorama.EDL.Name
      description: The name of the EDL that was deleted.
      type: string
    - contextPath: Panorama.EDL.DeviceGroup
      description: The device group for the EDL (Panorama instances).
      type: string
  - arguments:
    - description: The serial number of the device.
      name: target
    - defaultValue: 'running_config'
      description: Name of the file to save the configuration to.
      name: filename
    description: Pull the running config file.
    name: pan-os-get-running-config
  - arguments:
    - description: The serial number of the device.
      name: target
    description: Pull the merged config file.
    name: pan-os-get-merged-config
  - arguments:
    - description: The name of the EDL.
      name: name
      required: true
    - description: The device group for which to return addresses for the EDL (Panorama instances).
      name: device-group
    - description: The type of the EDL. Required when refreshing an EDL object which is configured on Panorama.
      name: edl_type
      auto: PREDEFINED
      predefined:
      - ip
      - url
      - domain
    - description: The location of the EDL. Required when refreshing an EDL object which is configured on Panorama.
      name: location
    - description: The VSYS of the EDL. Required when refreshing an EDL object which is configured on Panorama.
      name: vsys
    description: Refreshes the specified external dynamic list.
    name: pan-os-refresh-edl
  - arguments:
    - description: The name of the rule to create.
      name: rulename
    - description: The description of the rule to create.
      name: description
    - description: The action for the rule.
      name: action
      auto: PREDEFINED
      predefined:
      - allow
      - deny
      - drop
      required: true
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      name: source
      isArray: true
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      name: destination
      isArray: true
    - description: A comma-separated list of source zones.
      isArray: true
      name: source_zone
    - description: A comma-separated list of destination zones.
      isArray: true
      name: destination_zone
    - auto: PREDEFINED
      description: Whether to negate the source (address, address group).
      name: negate_source
      predefined:
      - Yes
      - No
    - auto: PREDEFINED
      description: Whether to negate the destination (address, address group).
      name: negate_destination
      predefined:
      - Yes
      - No
    - description: A comma-separated list of service object names for the rule.
      isArray: true
      name: service
    - auto: PREDEFINED
      defaultValue: No
      description: Whether to disable the rule.
      name: disable
      predefined:
      - Yes
      - No
    - defaultValue: any
      description: A comma-separated list of application object names for the rule to create.
      isArray: true
      name: application
    - description: A comma-separated list of source users for the rule to create.
      name: source_user
      isArray: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The target firewall for the rule (Panorama instances).
      name: target
    - description: The log forwarding profile.
      name: log_forwarding
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    - description: The rule tags to create.
      isArray: true
      name: tags
    - description: A comma-separated list of URL categories.
      name: category
    - description: A profile setting group.
      name: profile_setting
    - auto: PREDEFINED
      defaultValue: bottom
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    - description: An audit comment for the rule.
      name: audit_comment
    description: Creates a policy rule.
    execution: true
    name: pan-os-create-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Description
      description: The rule description.
      type: string
    - contextPath: Panorama.SecurityRule.Action
      description: The action for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Source
      description: The source address.
      type: string
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address.
      type: string
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Whether the source is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Whether the destination negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.Service
      description: The service for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Disabled
      description: Whether the rule is disabled.
      type: string
    - contextPath: Panorama.SecurityRule.Application
      description: The application for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.LogForwarding
      description: The log forwarding profile (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRules.Tags
      description: The rule tags.
      type: String
    - contextPath: Panorama.SecurityRules.ProfileSetting
      description: The profile setting group.
      type: String
  - arguments:
    - description: The name of the custom block policy rule to create.
      name: rulename
    - auto: PREDEFINED
      description: The object type to block in the policy rule.
      name: object_type
      predefined:
      - ip
      - address-group
      - application
      - url-category
      - edl
      required: true
    - description: A comma-separated list of object values for the object_type argument.
      name: object_value
      required: true
      isArray: true
    - auto: PREDEFINED
      description: The direction to block. This argument is not applicable for the "custom-url-category" object_type.
      name: direction
      predefined:
      - to
      - from
      - both
      defaultValue: both
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: Specifies a target firewall for the rule (Panorama instances).
      name: target
    - description: The log forwarding profile.
      name: log_forwarding
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    - description: The tags to use for the custom block policy rule.
      isArray: true
      name: tags
    - auto: PREDEFINED
      defaultValue: bottom
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    description: Creates a custom block policy rule.
    execution: true
    name: pan-os-custom-block-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Object
      description: The blocked object.
      type: string
    - contextPath: Panorama.SecurityRule.Direction
      description: The direction blocked.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.LogForwarding
      description: The log forwarding profile (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.Tags
      description: The rule tags.
      type: String
    - contextPath: Panorama.SecurityRules.ProfileSetting
      description: The profile setting group.
      type: String
  - arguments:
    - description: The name of the rule to move.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: Where to move the rule. If you specify "before" or "after", you need to supply the "dst" argument.
      name: where
      predefined:
      - before
      - after
      - top
      - bottom
      required: true
    - description: The destination rule relative to the rule that you are moving. This field is only relevant if you specify "before" or "after" in the "where" argument.
      name: dst
    - auto: PREDEFINED
      description: The rule location. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to return addresses for the rule (Panorama instances).
      name: device-group
    description: Changes the location of a policy rule.
    execution: true
    name: pan-os-move-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
  - arguments:
    - description: The name of the rule to edit.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: The parameter in the security rule to change.
      name: element_to_change
      predefined:
      - source
      - destination
      - application
      - action
      - category
      - description
      - disabled
      - target
      - log-forwarding
      - tag
      - profile-setting
      - source-user
      - service
      - audit-comment
      required: true
    - description: The new value for the parameter.
      name: element_value
      required: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - auto: PREDEFINED
      defaultValue: replace
      description: Whether to replace, add, or remove the element_value from the current rule object value.
      name: behaviour
      predefined:
      - replace
      - add
      - remove
    - description: The device group in which the rule belongs to.
      name: device-group
    description: Edits a policy rule.
    name: pan-os-edit-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.Description
      description: The rule description.
      type: string
    - contextPath: Panorama.SecurityRule.Action
      description: The action for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Source
      description: The source address.
      type: string
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address.
      type: string
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Whether the source is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Whether the destination is negated (address, address group).
      type: boolean
    - contextPath: Panorama.SecurityRule.Service
      description: The service for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Disabled
      description: Whether the rule is disabled.
      type: string
    - contextPath: Panorama.SecurityRule.Application
      description: The application for the rule.
      type: string
    - contextPath: Panorama.SecurityRule.Target
      description: The target firewall (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.Category
      description: The category of the rule.
      type: string
    - contextPath: Panorama.SecurityRule.LogForwarding
      description: The log forwarding of the rule.
      type: string
    - contextPath: Panorama.SecurityRule.ProfileSetting
      description: The profile setting of the rule.
      type: string
    - contextPath: Panorama.SecurityRule.SourceUser
      description: The source user of the rule.
      type: string
    - contextPath: Panorama.SecurityRule.AuditComment
      description: The audit comment of the rule.
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SecurityRule.Tags
      description: The tags for the rule.
      type: String
    - contextPath: Panorama.SecurityRules.ProfileSetting
      description: The profile setting group.
      type: String
    execution: true
  - arguments:
    - description: The name of the rule to delete.
      name: rulename
      required: true
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group where the rule is configured (Panorama instances).
      name: device-group
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - auto: PREDEFINED
      defaultValue: security
      description: The rulebase from which to delete the rule.
      name: rulebase
      required: false
      predefined:
      - security
      - application-override
      - authentication
      - decryption
      - nat
      - pbf
    - defaultValue: vsys1
      description: The Firewall VSYS to delete the rule from. Use for deleting local rules from a firewall via Panorama or to specify a different VSYS than set in Integration parameters.
      name: vsys
    description: Deletes a policy rule.
    name: pan-os-delete-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.NAT.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.NAT.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SSLRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SSLRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.PBF.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.PBF.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.AuthRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.AuthRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.AppOverride.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.AppOverride.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.Category
      description: The category of rule that was cleaned up (Local or Panorama).
      type: string
    - contextPath: Panorama.CleanedUpRules.AppliedAction
      description: The applied cleanup action (Disabled or Deleted).
      type: string
    - contextPath: Panorama.CleanedUpRules.DeviceGroup
      description: The device group that the rule was cleaned up from (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.PrePost
      description: The location where the rule was cleaned up from (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.RuleName
      description: The name of the rule.
      type: string
    - contextPath: Panorama.CleanedUpRules.Rulebase
      description: The rulebase where the rule was cleaned up from (for example, 'security', 'nat').
      type: string
    - contextPath: Panorama.CleanedUpRules.Target
      description: The target firewall serial number, if provided.
      type: string
    - contextPath: Panorama.CleanedUpRules.Vsys
      description: The VSYS where the rule was cleaned up from.
      type: string
    execution: true
  - arguments:
    - description: The name of the rule to disable.
      name: rulename
      required: true
    - description: The pre-rule or post-rule (Panorama instances).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group where the rule is configured (Panorama instances).
      name: device-group
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The rulebase from which to disable the rule.
      auto: PREDEFINED
      name: rulebase
      predefined:
      - security
      - application-override
      - authentication
      - decryption
      - nat
      - pbf
      defaultValue: security
      required: true
    - description: The Firewall VSYS to disable the rule on. Use for disabling local rules on a firewall via Panorama or to specify a different VSYS than set in Integration parameters.
      name: vsys
      defaultValue: vsys1
    description: Disables a policy rule.
    name: pan-os-disable-rule
    outputs:
    - contextPath: Panorama.SecurityRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.NAT.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.NAT.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.SSLRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.SSLRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.PBF.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.PBF.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.AuthRule.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.AuthRule.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.AppOverride.Name
      description: The rule name.
      type: string
    - contextPath: Panorama.AppOverride.DeviceGroup
      description: The device group for the rule (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.Category
      description: The category of rule cleaned up (Local or Panorama).
      type: string
    - contextPath: Panorama.CleanedUpRules.AppliedAction
      description: The applied cleanup action (Disabled or Deleted).
      type: string
    - contextPath: Panorama.CleanedUpRules.DeviceGroup
      description: The device group where the rule was cleaned up from (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.PrePost
      description: The location where the rule was cleaned up from (Panorama instances).
      type: string
    - contextPath: Panorama.CleanedUpRules.RuleName
      description: The name of the rule.
      type: string
    - contextPath: Panorama.CleanedUpRules.Rulebase
      description: The rulebase where the rule was cleaned up from (e.g. 'security', 'nat').
      type: string
    - contextPath: Panorama.CleanedUpRules.Target
      description: The target firewall serial number, if provided.
      type: string
    - contextPath: Panorama.CleanedUpRules.Vsys
      description: The VSYS where the rule was cleaned up from.
      type: string
    execution: true
  - arguments:
    - description: Whether to list predefined applications.
      name: predefined
      auto: PREDEFINED
      defaultValue: 'false'
      predefined:
      - 'true'
      - 'false'
    - description: The device group for which to return applications.
      name: device-group
    - description: When specified, the results returned in the list are limited to applications whose names match the specified string.
      name: name_match
    - description: When specified, the results returned in the list are limited to applications whose names contain the specified string.
      name: name_contain
    - description: The application risk (1 to 5).
      auto: PREDEFINED
      name: risk
      predefined:
      - '1'
      - '2'
      - '3'
      - '4'
      - '5'
    - description: The application category.
      auto: PREDEFINED
      name: category
      predefined:
      - 'collaboration'
      - 'business-systems'
      - 'networking'
      - 'media'
    - description: The application sub-category.
      name: sub_category
    - description: The application technology.
      auto: PREDEFINED
      name: technology
      predefined:
      - 'browser-based'
      - 'client-server'
      - 'network-protocol'
      - 'peer-to-peer'
    - description: "A comma-separated list of characteristics. Possible values are: 'virus-ident', 'evasive-behavior', 'file-type-ident', 'consume-big-bandwidth', 'used-by-malware', 'able-to-transfer-file', 'has-known-vulnerability', 'tunnel-other-application', 'prone-to-misuse', 'pervasive-use', 'file-forward', 'is-saas'."
      name: characteristics
    - defaultValue: '50'
      description: The maximum number of rules to retrieve. Will be used by default if page argument was not provided.
      name: limit
    - defaultValue: '50'
      description: The page size of the applications to return.
      name: page_size
    - description: The page at which to start listing applications. Must be a positive number.
      name: page
    description: Returns a list of applications.
    name: pan-os-list-applications
    outputs:
    - contextPath: Panorama.Applications.Characteristics
      description: The application characteristics.
      type: string
    - contextPath: Panorama.Applications.Name
      description: The application name.
      type: string
    - contextPath: Panorama.Applications.Id
      description: The application ID.
      type: number
    - contextPath: Panorama.Applications.Category
      description: The application category.
      type: string
    - contextPath: Panorama.Applications.SubCategory
      description: The application sub-category.
      type: string
    - contextPath: Panorama.Applications.Technology
      description: The application technology.
      type: string
    - contextPath: Panorama.Applications.Risk
      description: The application risk (1 to 5).
      type: number
    - contextPath: Panorama.Applications.Description
      description: The application description.
      type: string
  - arguments:
    - description: The job ID to check.
      name: job_id
      required: true
    description: Returns commit status for a configuration.
    name: pan-os-commit-status
    outputs:
    - contextPath: Panorama.Commit.JobID
      description: The job ID of the configuration to be committed.
      type: number
    - contextPath: Panorama.Commit.Status
      description: The commit status.
      type: string
    - contextPath: Panorama.Commit.Details
      description: The job ID details.
      type: string
    - contextPath: Panorama.Commit.Warnings
      description: The job ID warnings.
      type: String
  - arguments:
    - description: The job ID to check.
      name: job_id
      required: true
    description: Returns the push status for a configuration.
    name: pan-os-push-status
    outputs:
    - contextPath: Panorama.Push.DeviceGroup
      description: The device group to which the policies were pushed.
      type: string
    - contextPath: Panorama.Push.JobID
      description: The job ID of the configuration to be pushed.
      type: number
    - contextPath: Panorama.Push.Status
      description: The push status.
      type: string
    - contextPath: Panorama.Push.Details
      description: The job ID details.
      type: string
    - contextPath: Panorama.Push.Warnings
      description: The job ID warnings.
      type: String
  - arguments:
    - description: The type of packet capture.
      name: pcapType
      required: true
      auto: PREDEFINED
      predefined:
      - application-pcap
      - filter-pcap
      - threat-pcap
      - dlp-pcap
    - description: The serial number of the firewall to download the PCAP from, relevant only for Panorama instances.
      name: serialNumber
    - description: The file name for the PCAP type ('dlp-pcap', 'filter-pcap', or 'application-pcap'). Required for 'filter-pcap'.
      name: from
    - description: The new name for the PCAP file after downloading. If this argument is not specified, the file name is the PCAP file name set in the firewall.
      name: localName
    - description: The serial number for the request. See the Panorama XML API documentation.
      name: serialNo
    - description: 'The Search time for the request. For example: "2019/12/26 00:00:00", "2020/01/10". See the Panorama XML API documentation. Required for "threat-pcap".'
      name: searchTime
    - description: The ID of the PCAP for the request. See the Panorama XML API documentation. Required for 'threat-pcap'.
      name: pcapID
    - description: The password for Panorama, needed for the 'dlp-pcap' PCAP type only.
      name: password
    - description: The device name on which the PCAP is stored. See the Panorama XML API documentation. Required for 'threat-pcap' when using a Panorama instance.
      name: deviceName
    - description: The Session ID of the PCAP. See the Panorama XML API documentation. Required for 'threat-pcap' when using Panorama instance.
      name: sessionID
    description: Returns a PCAP file. The recommended maximum file size is 5 MB. If the limit is exceeded, you may need to connect to the firewall and run the scp export command in order to export the PCAP file. See the Palo Alto Networks documentation.
    name: pan-os-get-pcap
    outputs:
    - contextPath: File.Size
      description: The file size.
      type: number
    - contextPath: File.Name
      description: The file name.
      type: string
    - contextPath: File.Type
      description: The file type.
      type: string
    - contextPath: File.Info
      description: The file info.
      type: string
    - contextPath: File.Extension
      description: The file extension.
      type: string
    - contextPath: File.EntryID
      description: The file entryID.
      type: string
    - contextPath: File.MD5
      description: The MD5 hash of the file.
      type: string
    - contextPath: File.SHA1
      description: The SHA1 hash of the file.
      type: string
    - contextPath: File.SHA256
      description: The SHA256 hash of the file.
      type: string
    - contextPath: File.SHA512
      description: The SHA512 hash of the file.
      type: string
    - contextPath: File.SSDeep
      description: The SSDeep hash of the file.
      type: string
  - arguments:
    - description: The type of packet capture.
      name: pcapType
      required: true
      auto: PREDEFINED
      predefined:
      - application-pcap
      - filter-pcap
      - dlp-pcap
    - description: The serial number of the firewall to download the PCAP from.
      name: serialNumber
    - description: The password for Panorama. Relevant for the 'dlp-pcap' PCAP type.
      name: password
    description: Returns a list of all PCAP files by PCAP type. Not available for threat PCAPs.
    name: pan-os-list-pcaps
  - arguments:
    - description: The tag for which to register IP addresses.
      name: tag
      required: true
    - description: The IP addresses to register.
      isArray: true
      name: IPs
      required: true
    - description: Whether the IP addresses remain registered to the tag after the device reboots ('true':persistent, 'false':non-persistent).
      name: persistent
      auto: PREDEFINED
      defaultValue: 'true'
      predefined:
      - 'true'
      - 'false'
    - description: The timeout value to automatically unregister the IPs. Only applicable for PAN-OS 9.x and higher. Can not be used with persistent set to true.
      name: timeout
    description: Registers IP addresses to a tag.
    name: pan-os-register-ip-tag
    outputs:
    - contextPath: Panorama.DynamicTags.Tag
      description: Name of the tag.
      type: string
    - contextPath: Panorama.DynamicTags.IPs
      description: Registered IP addresses.
      type: string
  - arguments:
    - description: Tag for which to unregister IP addresses.
      name: tag
      required: true
    - description: IP addresses to unregister.
      isArray: true
      name: IPs
      required: true
    description: Unregisters IP addresses from a tag.
    name: pan-os-unregister-ip-tag
  - arguments:
    - description: Tag for which to register users.
      name: tag
      required: true
    - description: A comma-separated list of users to register.
      name: Users
      isArray: true
      required: true
    - description: |-
        Timeout value to automatically unregister the users (in seconds). Only applicable to PAN-OS 9.x and higher.
      name: timeout
    description: Registers users to a tag. This command is only available for PAN-OS version 9.x and above.
    name: pan-os-register-user-tag
    outputs:
    - contextPath: Panorama.DynamicTags.Tag
      description: The name of the tag.
      type: string
    - contextPath: Panorama.DynamicTags.Users
      description: The list of registered users.
      type: string
  - arguments:
    - description: The tag from which to unregister users.
      name: tag
      required: true
    - description: A comma-separated list of users to unregister.
      isArray: true
      name: Users
      required: true
    description: Unregisters users from a tag. This command is only available for PAN-OS version 9.x and higher.
    name: pan-os-unregister-user-tag
  - arguments:
    - description: Specifies the match criteria for the logs. This is similar to the query provided in the web interface under the Monitor tab, when viewing the logs.
      name: query
    - defaultValue: '100'
      description: The number of logs to retrieve. Maximum is 5000.
      name: number_of_logs
    - auto: PREDEFINED
      defaultValue: backward
      description: |-
        Whether logs are shown oldest first (forward) or newest
        first (backward).
      name: direction
      predefined:
      - backward
      - forward
    - description: The source address for the query.
      name: source
    - description: The destination address for the query.
      name: destination
    - description: The date and time after which logs were received (in the format YYYY/MM/DD HH:MM:SS).
      name: receive_time
    - description: The application for the query.
      name: application
    - description: The destination port for the query.
      name: to_port
    - description: The action for the query.
      name: action
    deprecated: true
    description: Deprecated. Use the pan-os-query-logs command instead.
    name: pan-os-query-traffic-logs
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
  - arguments:
    - description: The job ID of the query.
      name: job_id
      required: true
    description: Deprecated. Use the pan-os-check-logs-status command instead.
    name: pan-os-check-traffic-logs-status
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
    deprecated: true
  - arguments:
    - description: The job ID of the query.
      name: job_id
      required: true
    description: Deprecated. Use the pan-os-get-logs command instead.
    name: pan-os-get-traffic-logs
    outputs:
    - contextPath: Panorama.TrafficLogs.JobID
      description: The job ID of the traffic logs query.
      type: Number
    - contextPath: Panorama.TrafficLogs.Status
      description: The status of the traffic logs query.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Action
      description: The action of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ActionSource
      description: The action source of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Application
      description: The application of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Category
      description: The category of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.DeviceName
      description: The device name of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Destination
      description: The destination of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.DestinationPort
      description: The destination port of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.FromZone
      description: The from zone of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Protocol
      description: The protocol of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ReceiveTime
      description: The receive time of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Rule
      description: The rule of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.SessionEndReason
      description: The session end reason of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Source
      description: The source of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.SourcePort
      description: The source port of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.StartTime
      description: The start time of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.ToZone
      description: The to zone of the traffic log.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.Bytes
      description: The total log bytes.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.BytesReceived
      description: The log bytes received.
      type: String
    - contextPath: Panorama.TrafficLogs.Logs.BytesSent
      description: The log bytes sent.
      type: String
    deprecated: true
  - arguments:
    - description: The rules location. Mandatory for Panorama instances.
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to return addresses (Panorama instances).
      name: device-group
    - description: The tag to filter the rules.
      name: tag
      deprecated: true
    - description: A comma-separated list of tags by which to filter the rules.
      name: tags
      isArray: true
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The name of the rule to retrieve. If not mentioned, will retrieve all the rules.
      name: rulename
    - auto: PREDEFINED
      description: Whether to retrieve the disabled rules or not. If not mentioned, will retrieve all the rules.
      name: disabled
      predefined:
      - yes
      - no
    - auto: PREDEFINED
      description: The action of the rules to retrieve. If not mentioned, will retrieve all the rules.
      name: action
      predefined:
      - allow
      - deny
      - drop
    - description: Free query to retrieve rules. If not mentioned, will retrieve all the rules. When passing a query, all other arguments are overridden.
      name: query
    description: Returns a list of predefined Security Rules. (When passing a query, all other arguments are overridden. Make sure the query includes all the filters you want).
    name: pan-os-list-rules
    outputs:
    - contextPath: Panorama.SecurityRule.Location
      description: The location of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.NegateDestination
      description: Indicates whether the destination is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Disabled
      description: Indicates whether the security rule is disabled.
      type: String
    - contextPath: Panorama.SecurityRule.ICMPUnreachable
      description: Specifies the behavior for ICMP unreachable messages.
      type: String
    - contextPath: Panorama.SecurityRule.Description
      description: The description of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.GroupTag
      description: The group tag of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.LogForwardingProfile
      description: The log forwarding profile applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.NegateSource
      description: Indicates whether the source is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfileGroup
      description: The security profile group assigned to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile
      description: The security profile settings applied to the security rule.
      type: Unknown
    - contextPath: Panorama.SecurityRule.SecurityProfile.file-blocking
      description: The security profile setting for file-blocking in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.data-filtering
      description: The security profile setting for data filtering in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.wildfire-analysis
      description: The security profile setting for wildfire-analysis in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.spyware
      description: The security profile setting for spyware in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.vulnerability
      description: The security profile setting for vulnerability in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.virus
      description: The security profile setting for viruses in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SecurityProfile.url-filtering
      description: The security profile setting for url-filtering in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Target.devices
      description: The devices targeted by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Target.negate
      description: Indicates whether the target is negated in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Name
      description: The name of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.From
      description: The source zone of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.DestinationDevice
      description: The destination device of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Action
      description: The action taken by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SourceDevice
      description: The source device of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Tags
      description: The tags associated with the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.SourceUser
      description: The source user of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Application
      description: The application used in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Service
      description: The service used in the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.To
      description: The destination zone of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Source
      description: The source address of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.CustomUrlCategory
      description: The custom URL category targeted by the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Destination
      description: The destination address of the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.LogAtSessionStart
      description: Indicates whether the session start is logged.
      type: String
    - contextPath: Panorama.SecurityRule.Options.LogForwarding
      description: Indicates whether log forwarding is enabled for the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.Schedule
      description: The schedule applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.QoSMarking
      description: The QoS marking applied to the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.Options.DisableServerResponseInspection
      description: Specifies whether to disable server response inspection for the security rule.
      type: String
    - contextPath: Panorama.SecurityRule.DeviceGroup
      description: The device group of the security rule (Panorama instances only).
      type: String
    - contextPath: Panorama.SecurityRule.Type
      description: Represents the type of the security rule (e.g., pre-rule, post-rule, intra-zone, inter-zone).
      type: String
  - arguments:
    - description: The log type.
      name: log-type
      required: true
      auto: PREDEFINED
      predefined:
      - threat
      - traffic
      - wildfire
      - url
      - data
      - corr
      - system
      - decryption
    - description: "The query string by which to match criteria for the logs. This is similar to the query provided in the web interface under the Monitor tab when viewing the logs. Do not use the query arguemnt in combination with the following arugments: time-generated, time-generated-after, addr-src, addr-dst, zone-src, zone-dst, action, port-dst, rule, url, filedigest."
      name: query
    - description: |-
        The time the log was generated from the timestamp and prior to it.
        For example "2019/08/11 01:10:44, will get logs before the specified date.".
      name: time-generated
    - description: |-
        The time the log was generated from the timestamp and prior to it.
        For example "2019/08/11 01:10:44", will get logs after the specified date.
      name: time-generated-after
    - description: The source address.
      isArray: true
      name: addr-src
    - description: The destination address.
      isArray: true
      name: addr-dst
    - description: The source or destination IP address.
      isArray: true
      name: ip
    - description: The source zone.
      isArray: true
      name: zone-src
    - description: The destination source.
      isArray: true
      name: zone-dst
    - description: The rule action.
      isArray: true
      name: action
    - description: The destination port.
      isArray: true
      name: port-dst
    - description: The rule name, for example "Allow all outbound".
      isArray: true
      name: rule
    - description: The URL, for example "safebrowsing.googleapis.com".
      isArray: true
      name: url
    - description: The file hash (for WildFire logs only).
      isArray: true
      name: filedigest
    - defaultValue: '100'
      description: The maximum number of logs to retrieve. If empty, the default is 100. The maximum is 5,000.
      name: number_of_logs
    - auto: PREDEFINED
      description: Whether to use polling.
      defaultValue: 'false'
      name: polling
      predefined:
      - 'true'
      - 'false'
    - description: Job ID to use in polling commands. (automatically filled by polling).
      name: query_log_job_id
      deprecated: true
    - description: The timeout (in seconds) when polling.
      name: timeout
      defaultValue: '120'
    - description: The interval (in seconds) when polling.
      name: interval_in_seconds
      defaultValue: '10'
    - description: whether to hide the polling result (automatically filled by polling).
      name: hide_polling_output
      deprecated: true
    - description: Whether to show only `after-change-preview`, and `before-change-preview`, or get full data for it.  The full data are under the fields `after-change-detail`, and `before-change-detail`.
      name: show-detail
      predefined:
      - yes
      - no
      auto: PREDEFINED
      defaultValue: no
    description: The query logs in Panorama.
    name: pan-os-query-logs
    outputs:
    - contextPath: Panorama.Monitor.JobID
      description: The job ID of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Status
      description: The status of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Message
      description: The message of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Logs.Action
      description: The action taken for the session. Can be "alert", "allow", "deny", "drop", "drop-all-packets", "reset-client", "reset-server", "reset-both", or "block-url".
      type: String
    - contextPath: Panorama.Monitor.Logs.Application
      description: The application associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Category
      description: The URL category of the URL subtype. For WildFire subtype, it is the verdict on the file, and can be either "malicious", "phishing", "grayware", or "benign". For other subtypes, the value is "any".
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceName
      description: The hostname of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationAddress
      description: The original session destination IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationUser
      description: The username of the user to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationCountry
      description: The destination country or internal region for private addresses. Maximum length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationPort
      description: The destination port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileDigest
      description: Only for the WildFire subtype, all other types do not use this field. The filedigest string shows the binary hash of the file sent to be analyzed by the WildFire service.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileName
      description: |-
        File name or file type when the subtype is file.
        File name when the subtype is virus.
        File name when the subtype is wildfire-virus.
        File name when the subtype is wildfire.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileType
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the type of file that the firewall forwarded for WildFire analysis.
      type: String
    - contextPath: Panorama.Monitor.Logs.FromZone
      description: The zone from which the session was sourced.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLOrFilename
      description: |-
        The actual URL when the subtype is url.
        The file name or file type when the subtype is file.
        The file name when the subtype is virus.
        The file name when the subtype is wildfire-virus.
        The file name when the subtype is wildfire.
        The URL or file name when the subtype is vulnerability (if applicable).
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationIP
      description: The post-NAT destination IP address if destination NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationPort
      description: The post-NAT destination port.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourceIP
      description: The post-NAT source IP address if source NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourcePort
      description: The post-NAT source port.
      type: String
    - contextPath: Panorama.Monitor.Logs.PCAPid
      description: |-
        The packet capture (pcap) ID is a 64 bit unsigned integral denoting
        an ID to correlate threat pcap files with extended pcaps taken as a part of
        that flow. All threat logs will contain either a pcap_id of 0 (no associated
        pcap), or an ID referencing the extended pcap file.
      type: String
    - contextPath: Panorama.Monitor.Logs.IPProtocol
      description: The IP protocol associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Recipient
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the name of the receiver of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.Rule
      description: The name of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.RuleID
      description: The ID of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.ReceiveTime
      description: The time the log was received at the management plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.Sender
      description: |-
        Only for the WildFire subtype; all other types do not use this field.
        Specifies the name of the sender of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.SessionID
      description: An internal numerical identifier applied to each session.
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceSN
      description: The serial number of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.Severity
      description: |-
        The severity associated with the threat. Can be "informational", "low",
        "medium", "high", or "critical".
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceAddress
      description: The original session source IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceCountry
      description: |-
        The source country or internal region for private addresses. Maximum
        length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceUser
      description: The username of the user who initiated the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourcePort
      description: The source port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.ThreatCategory
      description: |-
        The threat categories used to classify different types of
        threat signatures.
      type: String
    - contextPath: Panorama.Monitor.Logs.Name
      description: |-
        The Palo Alto Networks identifier for the threat. A description
        string followed by a 64-bit numerical identifier.
      type: String
    - contextPath: Panorama.Monitor.Logs.ID
      description: The Palo Alto Networks ID for the threat.
      type: String
    - contextPath: Panorama.Monitor.Logs.ToZone
      description: The zone to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.TimeGenerated
      description: The time the log was generated on the data plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLCategoryList
      description: |-
        A list of the URL filtering categories the firewall used to
        enforce the policy.
      type: String
    - contextPath: Panorama.Monitor.Logs.Bytes
      description: The total log bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesReceived
      description: The log bytes received.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesSent
      description: The log bytes sent.
      type: String
    - contextPath: Panorama.Monitor.Logs.Vsys
      description: The VSYS on the firewall that generated the log.
      type: String
    polling: true
  - arguments:
    - description: The job ID of the query.
      name: job_id
      isArray: true
      required: true
    description: Checks the status of a logs query.
    name: pan-os-check-logs-status
    outputs:
    - contextPath: Panorama.Monitor.JobID
      description: The job ID of the logs query.
      type: String
    - contextPath: Panorama.Monitor.Status
      description: The status of the logs query.
      type: String
  - arguments:
    - description: The job ID of the query.
      name: job_id
      required: true
      isArray: true
    - description: Whether to auto-enrich the War Room entry. If "true", entry is not auto-enriched. If "false", entry is auto-extracted.
      name: ignore_auto_extract
      defaultValue: 'true'
    description: Retrieves the data of a logs query.
    name: pan-os-get-logs
    outputs:
    - contextPath: Panorama.Monitor.Logs.Action
      description: The action taken for the session. Can be "alert", "allow", "deny", "drop", "drop-all-packets", "reset-client", "reset-server", "reset-both", or "block-url".
      type: String
    - contextPath: Panorama.Monitor.Logs.Application
      description: The application associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Category
      description: The URL category of the URL subtype. For WildFire subtype, it is the verdict on the file, and can be either "malicious", "phishing", "grayware", or "benign". For other subtypes, the value is "any".
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceName
      description: The hostname of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationAddress
      description: The original session destination IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationUser
      description: The username of the user to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationCountry
      description: The destination country or internal region for private addresses. Maximum length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.DestinationPort
      description: The destination port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileDigest
      description: Only for the WildFire subtype, all other types do not use this field. The filedigest string shows the binary hash of the file sent to be analyzed by the WildFire service.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileName
      description: |-
        File name or file type when the subtype is file.
        File name when the subtype is virus.
        File name when the subtype is wildfire-virus.
        File name when the subtype is wildfire.
      type: String
    - contextPath: Panorama.Monitor.Logs.FileType
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the type of file that the firewall forwarded for WildFire analysis.
      type: String
    - contextPath: Panorama.Monitor.Logs.FromZone
      description: The zone from which the session was sourced.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLOrFilename
      description: |-
        The actual URL when the subtype is url.
        The file name or file type when the subtype is file.
        The file name when the subtype is virus.
        The file name when the subtype is wildfire-virus.
        The file name when the subtype is wildfire.
        The URL or file name when the subtype is vulnerability (if applicable).
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationIP
      description: The post-NAT destination IP address if destination NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATDestinationPort
      description: The post-NAT destination port.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourceIP
      description: The post-NAT source IP address if source NAT was performed.
      type: String
    - contextPath: Panorama.Monitor.Logs.NATSourcePort
      description: The post-NAT source port.
      type: String
    - contextPath: Panorama.Monitor.Logs.PCAPid
      description: |-
        The packet capture (pcap) ID is a 64 bit unsigned integral denoting
        an ID to correlate threat pcap files with extended pcaps taken as a part of
        that flow. All threat logs will contain either a pcap_id of 0 (no associated
        pcap), or an ID referencing the extended pcap file.
      type: String
    - contextPath: Panorama.Monitor.Logs.IPProtocol
      description: The IP protocol associated with the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.Recipient
      description: |-
        Only for the WildFire subtype, all other types do not use this field.
        Specifies the name of the receiver of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.Rule
      description: The name of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.RuleID
      description: The ID of the rule that the session matched.
      type: String
    - contextPath: Panorama.Monitor.Logs.ReceiveTime
      description: The time the log was received at the management plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.Sender
      description: |-
        Only for the WildFire subtype; all other types do not use this field.
        Specifies the name of the sender of an email that WildFire determined to be malicious when analyzing an email link forwarded by the firewall.
      type: String
    - contextPath: Panorama.Monitor.Logs.SessionID
      description: An internal numerical identifier applied to each session.
      type: String
    - contextPath: Panorama.Monitor.Logs.DeviceSN
      description: The serial number of the firewall on which the session was logged.
      type: String
    - contextPath: Panorama.Monitor.Logs.Severity
      description: |-
        The severity associated with the threat. Can be "informational", "low",
        "medium", "high", or "critical".
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceAddress
      description: The original session source IP address.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceCountry
      description: |-
        The source country or internal region for private addresses. Maximum
        length is 32 bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourceUser
      description: The username of the user who initiated the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.SourcePort
      description: The source port utilized by the session.
      type: String
    - contextPath: Panorama.Monitor.Logs.ThreatCategory
      description: |-
        The threat categories used to classify different types of
        threat signatures.
      type: String
    - contextPath: Panorama.Monitor.Logs.Name
      description: |-
        The Palo Alto Networks identifier for the threat. A description
        string followed by a 64-bit numerical identifier.
      type: String
    - contextPath: Panorama.Monitor.Logs.ID
      description: The Palo Alto Networks ID for the threat.
      type: String
    - contextPath: Panorama.Monitor.Logs.ToZone
      description: The zone to which the session was destined.
      type: String
    - contextPath: Panorama.Monitor.Logs.TimeGenerated
      description: The time the log was generated on the data plane.
      type: String
    - contextPath: Panorama.Monitor.Logs.URLCategoryList
      description: |-
        A list of the URL filtering categories the firewall used to
        enforce the policy.
      type: String
    - contextPath: Panorama.Monitor.Logs.Bytes
      description: The total log bytes.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesReceived
      description: The log bytes received.
      type: String
    - contextPath: Panorama.Monitor.Logs.BytesSent
      description: The log bytes sent.
      type: String
    - contextPath: Panorama.Monitor.Logs.Vsys
      description: The VSYS on the firewall that generated the log.
      type: String
  - arguments:
    - description: The application name.
      name: application
    - description: The category name.
      name: category
    - description: The destination IP address.
      name: destination
      required: true
    - description: The destination port.
      name: destination-port
    - description: The from zone.
      name: from
    - description: The to zone.
      name: to
    - description: The IP protocol value.
      name: protocol
      required: true
    - description: The source IP address.
      name: source
      required: true
    - description: The source user.
      name: source-user
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
      isArray: true
    - description: The target VSYS of the firewall. Used only on a Panorama instance.
      name: vsys
      isArray: true
    description: Checks whether a session matches a specified security policy. This command is only available on firewall instances.
    name: pan-os-security-policy-match
    outputs:
    - contextPath: Panorama.SecurityPolicyMatch.Query
      description: The query for the session to test.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Name
      description: The matching rule name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Action
      description: The matching rule action.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Category
      description: The matching rule category.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Destination
      description: The matching rule destination.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.From
      description: The matching rule from zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.Source
      description: The matching rule source.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.Rules.To
      description: The matching rule to zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Application
      description: The application name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Category
      description: The category name.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Destination
      description: The destination IP address.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.DestinationPort
      description: The destination port.
      type: Number
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.From
      description: The query fields from zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.To
      description: The query fields to zone.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Protocol
      description: The IP protocol value.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.Source
      description: The destination IP address.
      type: String
    - contextPath: Panorama.SecurityPolicyMatch.QueryFields.SourceUser
      description: The source user.
      type: String
  - arguments:
    - description: The name of the virtual router for which to list the static routes.
      name: virtual_router
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    - description: Whether to show an uncommitted configuration. Default is "false".
      name: show_uncommitted
      auto: PREDEFINED
      defaultValue: 'false'
      predefined:
      - 'true'
      - 'false'
    description: Lists the static routes of a virtual router.
    name: pan-os-list-static-routes
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of a static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
    - contextPath: Panorama.StaticRoutes.Uncommitted
      description: Whether the static route is committed.
      type: Boolean
  - arguments:
    - description: The name of the virtual router to display the static route.
      name: virtual_router
      required: true
    - description: The name of the static route to display.
      name: static_route
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Returns the specified static route of a virtual router.
    name: pan-os-get-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
  - arguments:
    - description: Virtual router to which the routes will be added.
      name: virtual_router
      required: true
    - description: The name of the static route to add. The argument is limited to a maximum of 31 characters, is case-sensitive, and supports letters, numbers, spaces, hyphens, and underscores.
      name: static_route
      required: true
    - description: 'The IP address and network mask in Classless Inter-domain Routing (CIDR) notation: ip_address/mask. For example, 192.168.0.1/24 for IPv4 or 2001:db8::/32 for IPv6).'
      name: destination
      required: true
    - auto: PREDEFINED
      description: The type for the next hop.
      name: nexthop_type
      predefined:
      - ip-address
      - next-vr
      - fqdn
      - discard
      required: true
    - description: The next hop value.
      name: nexthop_value
      required: true
    - description: The metric port for the static route (1-65535).
      name: metric
    - description: The interface name in which to add the static route.
      name: interface
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Adds a static route.
    name: pan-os-add-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
  - arguments:
    - description: The name of the static route to delete.
      name: route_name
      required: true
    - description: The virtual router from which the routes will be deleted.
      name: virtual_router
      required: true
    - description: The template to use to run the command. Overrides the template parameter (Panorama instances).
      name: template
    description: Deletes a static route.
    name: pan-os-delete-static-route
    outputs:
    - contextPath: Panorama.StaticRoutes.Name
      description: The name of the static route to delete.
      type: String
    - contextPath: Panorama.StaticRoutes.BFDProfile
      description: The BFD profile of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Destination
      description: The destination of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.Metric
      description: The metric (port) of the static route.
      type: Number
    - contextPath: Panorama.StaticRoutes.NextHop
      description: The next hop of the static route. Can be an IP address, FQDN, or a virtual router.
      type: String
    - contextPath: Panorama.StaticRoutes.RouteTable
      description: The route table of the static route.
      type: String
    - contextPath: Panorama.StaticRoutes.VirtualRouter
      description: The virtual router to which the static router belongs.
      type: String
    - contextPath: Panorama.StaticRoutes.Template
      description: The template in which the static route is defined (Panorama instances only).
      type: String
    - contextPath: Panorama.StaticRoutes.Deleted
      description: Whether the static route was deleted.
      type: Boolean
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    description: Show firewall device software version.
    name: pan-os-show-device-version
    outputs:
    - contextPath: Panorama.Device.Info.Devicename
      description: The device name of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Model
      description: The model of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Serial
      description: The serial number of the PAN-OS.
      type: String
    - contextPath: Panorama.Device.Info.Version
      description: The version of the PAN-OS.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    description: Checks for the latest available dynamic update versions and returns a list of latest available / currently installed content. When running from a Panorama instance, the 'target' argument must be specified.
    name: pan-os-check-dynamic-updates-status
    outputs:
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.CurrentlyInstalled.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.IsUpToDate
      description: Whether the latest available AntiVirus package is active on the device.
      type: Boolean
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.AntiVirus.LatestAvailable.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.CurrentlyInstalled.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.IsUpToDate
      description: Whether the latest available App/Threat package is active on the device.
      type: Boolean
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.Content.LatestAvailable.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.ContentTypesOutOfDate.Count
      description: The total number of active Dynamic Updates that have updates available.
      type: Number
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.CurrentlyInstalled.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.IsUpToDate
      description: Whether the latest available GP Clientless VPN package is active on the device.
      type: Boolean
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.GP.LatestAvailable.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.CurrentlyInstalled.version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.IsUpToDate
      description: Whether the latest available WildFire package is active on the device.
      type: Boolean
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.app-version
      description: Version of the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.current
      description: Whether this version is currently active on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.downloaded
      description: Whether this version has been downloaded to the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.feature-desc
      description: Detailed description of features provided.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.features
      description: Features provided by this version.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.filename
      description: Filename of the dynamic update.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.installing
      description: Whether this version is being installed by a running job on the device.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.previous
      description: Whether this version was previously active on the system and can be reverted to.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.release-notes
      description: Link to release notes about the dynamic update package.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.released-on
      description: Date this version was released.
      type: Date
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.sha256
      description: SHA256 hash of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.size
      description: Size of the dynamic update package file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.size-kb
      description: Size (in KB) of the dynamic update file.
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.update-type
      description: Type of update package (Full, Incremental, etc).
      type: String
    - contextPath: Panorama.DynamicUpdates.WildFire.LatestAvailable.version
      description: Version of the dynamic update package.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Mandatory for Panorama instances.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the download job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the download status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the download status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Downloads the latest app/threat dynamic update.
    name: pan-os-download-latest-content-update
    outputs:
    - contextPath: Panorama.Content.Download.JobID
      description: The job ID of the app/threat download.
      type: String
    - contextPath: Panorama.Content.Download.Status
      description: The app/threat download status.
      type: String
    - contextPath: Panorama.Content.Download.Details
      description: The download job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the download job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the download status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the download status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Downloads the latest antivirus dynamic update.
    name: pan-os-download-latest-antivirus-update
    outputs:
    - contextPath: Panorama.AntiVirus.Download.JobID
      description: The job ID of the antivirus download.
      type: String
    - contextPath: Panorama.AntiVirus.Download.Status
      description: The antivirus download status.
      type: String
    - contextPath: Panorama.AntiVirus.Download.Details
      description: The download job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the download job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the download status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the download status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Downloads the latest WildFire dynamic update.
    name: pan-os-download-latest-wildfire-update
    outputs:
    - contextPath: Panorama.WildFire.Download.JobID
      description: The job ID of the WildFire download.
      type: String
    - contextPath: Panorama.WildFire.Download.Status
      description: The WildFire download status.
      type: String
    - contextPath: Panorama.WildFire.Download.Details
      description: The download job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the download job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the download status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the download status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Downloads the latest GlobalProtect Clientless VPN dynamic update.
    name: pan-os-download-latest-gp-update
    outputs:
    - contextPath: Panorama.GP.Download.JobID
      description: The job ID of the GlobalProtect Clientless VPN download.
      type: String
    - contextPath: Panorama.GP.Download.Status
      description: The GlobalProtect Clientless VPN download status.
      type: String
    - contextPath: Panorama.GP.Download.Details
      description: The download job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Checks the download status of an app/threat dynamic update.
    name: pan-os-content-update-download-status
    outputs:
    - contextPath: Panorama.Content.Download.JobID
      description: The job ID to monitor.
      type: String
    - contextPath: Panorama.Content.Download.Status
      description: The download status.
      type: String
    - contextPath: Panorama.Content.Download.Details
      description: The job ID details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the install job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the install status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the install status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Installs the latest app/threat dynamic update.
    name: pan-os-install-latest-content-update
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      description: The job ID of the installation.
      type: String
    - contextPath: Panorama.Content.Install.Status
      description: The installation status.
      type: String
    - contextPath: Panorama.Content.Install.Details
      description: The install job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the install job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the install status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the install status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Installs the latest Antivirus update.
    name: pan-os-install-latest-antivirus-update
    outputs:
    - contextPath: Panorama.AntiVirus.Install.JobID
      description: The job ID of the installation.
      type: String
    - contextPath: Panorama.AntiVirus.Install.Status
      description: The installation status.
      type: String
    - contextPath: Panorama.AntiVirus.Install.Details
      description: The install job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the install job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the install status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the install status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Installs the latest WildFire dynamic update.
    name: pan-os-install-latest-wildfire-update
    outputs:
    - contextPath: Panorama.WildFire.Install.JobID
      description: The job ID of the installation.
      type: String
    - contextPath: Panorama.WildFire.Install.Status
      description: The installation status.
      type: String
    - contextPath: Panorama.WildFire.Install.Details
      description: The install job details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: Job ID for a running download process. Used for status polling.
      name: job_id
      hidden: true
    - description: When set to false, the function will not use polling and will immediately return the ID of the install job.
      auto: PREDEFINED
      predefined:
      - "true"
      - "false"
      defaultValue: false
      name: polling
    - description: The polling timeout in seconds. When polling is enabled, the command will keep checking the install status until this timeout is reached.
      name: timeout_in_seconds
      defaultValue: '3600'
    - description: The polling interval in seconds. Controls how often the install status is checked.
      name: interval_in_seconds
      defaultValue: '30'
    description: Installs the latest GlobalProtect Clientless VPN dynamic update.
    name: pan-os-install-latest-gp-update
    polling: true
    outputs:
    - contextPath: Panorama.GP.Install.JobID
      description: The job ID of the installation.
      type: String
    - contextPath: Panorama.GP.Install.Status
      description: The installation status.
      type: String
    - contextPath: Panorama.GP.Install.Details
      description: The install job details.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The job ID of the content installation.
      name: job_id
      required: true
    description: Gets the installation status of the app/threat dynamic update.
    name: pan-os-content-update-install-status
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      description: The job ID of the content installation.
      type: String
    - contextPath: Panorama.Content.Install.Status
      description: The content installation status.
      type: String
    - contextPath: Panorama.Content.Install.Details
      description: The content installation status details.
      type: String
    polling: true
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    description: Checks the PAN-OS software version from the repository.
    name: pan-os-check-latest-panos-software
    outputs:
    - contextPath: Panorama.LatestVersions
      description: Latest software versions.
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The target version number to install.
      name: target_version
      required: true
    description: Downloads the target PAN-OS software version to install on the target device.
    name: pan-os-download-panos-version
    outputs:
    - contextPath: Panorama.PANOS.Download.JobID
      description: The job ID of the PAN-OS download.
      type: number
    - contextPath: Panorama.PANOS.Download.Status
      description: The status of the PAN-OS download.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Gets the download status of the target PAN-OS software.
    name: pan-os-download-panos-status
    outputs:
    - contextPath: Panorama.PANOS.Download.JobID
      description: The job ID of the PAN-OS download.
      type: string
    - contextPath: Panorama.PANOS.Download.Status
      description: The PAN-OS download status.
      type: String
    - contextPath: Panorama.PANOS.Download.Details
      description: The PAN-OS download details.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The target PAN-OS version to install.
      name: target_version
      required: true
    description: Installs the target PAN-OS version on the specified target device.
    name: pan-os-install-panos-version
    outputs:
    - contextPath: Panorama.PANOS.Install.JobID
      description: The job ID of the PAN-OS installation.
      type: string
    - contextPath: Panorama.PANOS.Install.Status
      description: The status of the PAN-OS installation.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    - description: The job ID to check.
      name: job_id
      required: true
    description: Gets the installation status of the PAN-OS software.
    name: pan-os-install-panos-status
    outputs:
    - contextPath: Panorama.PANOS.Install.JobID
      description: The job ID of the PAN-OS installation.
      type: number
    - contextPath: Panorama.PANOS.Install.Status
      description: The status of the PAN-OS installation.
      type: String
    - contextPath: Panorama.PANOS.Install.Details
      description: The PAN-OS installation details.
      type: String
  - arguments:
    - description: Serial number of the firewall on which to run the command. Use only for a Panorama instance.
      name: target
    description: Reboots the firewall device.
    name: pan-os-device-reboot
  - arguments:
    - name: ip_address
      description: The IP address from which to return information.
      required: true
    name: pan-os-show-location-ip
    description: Gets location information for an IP address.
    outputs:
    - contextPath: Panorama.Location.IP.country_code
      description: The IP address location country code.
      type: String
    - contextPath: Panorama.Location.IP.country_name
      description: The IP address location country name.
      type: String
    - contextPath: Panorama.Location.IP.ip_address
      description: The IP address.
      type: String
    - contextPath: Panorama.Location.IP.Status
      description: Whether the IP address was found.
      type: String
  - arguments: []
    description: Gets information about available PAN-OS licenses and their statuses.
    name: pan-os-get-licenses
    outputs:
    - contextPath: Panorama.License.Authcode
      description: The authentication code of the license.
      type: String
    - contextPath: Panorama.License.Base-license-name
      description: The base license name.
      type: String
    - contextPath: Panorama.License.Description
      description: The description of the license.
      type: String
    - contextPath: Panorama.License.Expired
      description: Whether the license has expired.
      type: String
    - contextPath: Panorama.License.Expires
      description: When the license will expire.
      type: String
    - contextPath: Panorama.License.Feature
      description: The feature of the license.
      type: String
    - contextPath: Panorama.License.Issued
      description: When the license was issued.
      type: String
    - contextPath: Panorama.License.Serial
      description: The serial number of the license.
      type: String
  - arguments:
    - name: security_profile
      description: The security profile for which to get information.
      auto: PREDEFINED
      predefined:
      - data-filtering
      - file-blocking
      - spyware
      - url-filtering
      - virus
      - vulnerability
      - wildfire-analysis
    - name: device-group
      description: The device group for which to return security profiles.
    description: Gets information for the specified security profile.
    name: pan-os-get-security-profiles
    outputs:
    - contextPath: Panorama.Spyware.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.Spyware.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Spyware.Rules.Category
      description: The category for which to apply the rule.
      type: String
    - contextPath: Panorama.Spyware.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Spyware.Rules.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Spyware.Rules.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Spyware.Rules.Threat-name
      description: The threat name to apply for the rule.
      type: String
    - contextPath: Panorama.URLFilter.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.URLFilter.Rules.Category.Action
      description: The rule action to apply to the category.
      type: String
    - contextPath: Panorama.URLFilter.Rules.Category.Name
      description: The category name.
      type: String
    - contextPath: Panorama.WildFire.Name
      description: The WildFire profile name.
      type: String
    - contextPath: Panorama.WildFire.Rules.Analysis
      description: The rule analysis.
      type: String
    - contextPath: Panorama.WildFire.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.WildFire.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.WildFire.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Name
      description: The vulnerability profile name.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Vendor-id
      description: The vendor ID to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Host
      description: The rule host.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Category
      description: The category to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.CVE
      description: The CVE to apply for the rule.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Vulnerability.Rules.Threat-name
      description: The threat to apply for the rule.
      type: String
    - contextPath: Panorama.Antivirus.Name
      description: The antivirus profile name.
      type: String
    - contextPath: Panorama.Antivirus.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Antivirus.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Antivirus.Rules.WildFire-action
      description: The WildFire action.
      type: String
    - contextPath: Panorama.FileBlocking.Name
      description: The file blocking profile name.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.FileBlocking.Rules.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.DataFiltering.Name
      description: The data filtering profile name.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Alert-threshold
      description: The alert threshold.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Application
      description: The application to apply for the rule.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Block-threshold
      description: The block threshold.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Data-object
      description: The data object.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Direction
      description: The rule direction.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.File-type
      description: The file type to apply for the rule.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Log-severity
      description: The log severity.
      type: String
    - contextPath: Panorama.DataFiltering.Rules.Name
      description: The rule name.
      type: String
  - arguments:
    - description: The security profile type.
      name: profile_type
      required: true
      auto: PREDEFINED
      predefined:
      - data-filtering
      - file-blocking
      - spyware
      - url-filtering
      - virus
      - vulnerability
      - wildfire-analysis
    - description: The rule name to apply.
      name: rule_name
      required: true
    - description: The profile name to apply to the rule.
      name: profile_name
      required: true
    - auto: PREDEFINED
      description: The location of the rules. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to apply security profiles.
      name: device-group
    description: Applies a security profile to specific rules or rules with a specific tag.
    name: pan-os-apply-security-profile
  - arguments:
    - description: The security profile type.
      name: profile_type
      required: true
      auto: PREDEFINED
      predefined:
      - data-filtering
      - file-blocking
      - spyware
      - url-filtering
      - virus
      - vulnerability
      - wildfire-analysis
    - description: The rule name to apply.
      name: rule_name
      required: true
    - auto: PREDEFINED
      description: The location of the rules. Mandatory for Panorama instances.
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: The device group for which to apply security profiles.
      name: device-group
    description: Removes a security profile to specific rules or rules with a specific tag.
    name: pan-os-remove-security-profile
  - arguments:
    - description: The location of the rules. Mandatory for Panorama instances.
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Gets SSL decryption rules.
    name: pan-os-get-ssl-decryption-rules
    outputs:
    - contextPath: Panorama.SSLRule.From
      description: The SSL rule from the source.
      type: String
    - contextPath: Panorama.SSLRule.Name
      description: The name of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Destination
      description: The destination of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Target
      description: The target of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.Service
      description: The SSL rule service.
      type: String
    - contextPath: Panorama.SSLRule.Action
      description: The SSL rule action.
      type: String
    - contextPath: Panorama.SSLRule.Type
      description: The SSL rule type.
      type: String
    - contextPath: Panorama.SSLRule.Source
      description: The source of the SSL rule.
      type: String
    - contextPath: Panorama.SSLRule.To
      description: The SSL rule to destination.
      type: String
    - contextPath: Panorama.SSLRule.UUID
      description: The SSL rule UUID.
      type: String
    - contextPath: Panorama.SSLRule.Description
      description: The SSL rule description.
      type: String
    - contextPath: Panorama.SSLRule.Source-user
      description: The SSL rule source user.
      type: String
    - contextPath: Panorama.SSLRule.Category
      description: The SSL rule category.
      type: String
  - arguments:
    - description: The template name.
      name: template
      required: true
    description: Retrieves the Wildfire configuration.
    name: pan-os-get-wildfire-configuration
    outputs:
    - contextPath: Panorama.WildFire.Name
      description: The file type.
      type: String
    - contextPath: Panorama.WildFire.Size-limit
      description: The file size limit.
      type: String
    - contextPath: Panorama.WildFire.recurring
      description: The schedule that is recurring.
      type: String
  - arguments:
    - description: The URL filtering profile name. Gets the name by running the get-security-profiles command.
      name: profile_name
      required: true
    description: Sets default categories to block in the URL filtering profile.
    name: pan-os-url-filtering-block-default-categories
  - arguments: []
    description: Get anti-spyware best practices.
    name: pan-os-get-anti-spyware-best-practice
    outputs:
    - contextPath: Panorama.Spyware.BotentDomain.Name
      description: The botnet domain name.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Action
      description: The botnet domain action.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Packet-capture
      description: Whether packet capture is enabled.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Sinkhole.ipv4-address
      description: The botnet domain IPv4 address.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Sinkhole.ipv6-address
      description: The Botnet domain IPv6 address.
      type: String
    - contextPath: Panorama.Spyware.Rule.Category
      description: The rule category.
      type: String
    - contextPath: Panorama.Spyware.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Spyware.Rule.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Spyware.Rule.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Spyware.Rule.Threat-name
      description: The rule threat name.
      type: String
    - contextPath: Panorama.Spyware.BotentDomain.Max_version
      description: The botnet domain max version.
      type: String
  - arguments:
    - description: The name of the anti spyware profile. If the profile exists, the command will operate on it, otherwise, if a new name is given, a new anti-spyware profile will be created.
      name: anti_spyware_profile_name
      required: true
    - name: dns_signature_source
      description: The EDL name to link to the profile.
      required: true
    - name: ipv4_sinkhole_address
      description: The IPv4 sinkhole address. Only relevant when the action arguemnt is set to 'sinkhole'.
    - name: ipv6_sinkhole_address
      description: The IPv6 sinkhole address. Only relevant when the action arguemnt is set to 'sinkhole'.
    - auto: PREDEFINED
      description: The action on the DNS queries.
      name: action
      predefined:
      - alert
      - allow
      - block
      - sinkhole
      required: true
    - auto: PREDEFINED
      description: Allows capturing packets on match. Select "single-packet" to capture the first packet of the session or "extended-capture" to set between 1-50 packets. Packet capture can be very CPU intensive and can degrade firewall performance. Only use this feature when necessary and make sure you turn it off after you collect the required packets.
      name: packet_capture
      predefined:
      - disable
      - single-packet
      - extended-capture
      defaultValue: disable
    description: Enables assigning EDL to the anti-spyware profile under "DNS Signature Policies".
    name: pan-os-apply-dns-signature-policy
  - arguments: []
    description: Gets file-blocking best practices.
    name: pan-os-get-file-blocking-best-practice
    outputs:
    - contextPath: Panorama.FileBlocking.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.Application
      description: The rule application.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.File-type
      description: The rule file type.
      type: String
    - contextPath: Panorama.FileBlocking.Rule.Name
      description: The rule name.
      type: String
  - arguments: []
    description: Gets anti-virus best practices.
    name: pan-os-get-antivirus-best-practice
    outputs:
    - contextPath: Panorama.Antivirus.Decoder.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Antivirus.Decoder.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Antivirus.Decoder.WildFire-action
      description: The WildFire action.
      type: String
  - arguments: []
    description: Gets vulnerability-protection best practices.
    name: pan-os-get-vulnerability-protection-best-practice
    outputs:
    - contextPath: Panorama.Vulnerability.Rule.Action
      description: The rule action.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.CVE
      description: The rule CVE.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Category
      description: The rule category.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Host
      description: The rule host.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Name
      description: The rule name.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Severity
      description: The rule severity.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Threat-name
      description: The threat name.
      type: String
    - contextPath: Panorama.Vulnerability.Rule.Vendor-id
      description: The vendor ID.
      type: String
  - arguments: []
    description: Views WildFire best practices.
    name: pan-os-get-wildfire-best-practice
    outputs:
    - contextPath: Panorama.WildFire.Analysis
      description: The WildFire analysis.
      type: String
    - contextPath: Panorama.WildFire.Application
      description: The WildFire application.
      type: String
    - contextPath: Panorama.WildFire.File.File-size
      description: The recommended file size.
      type: String
    - contextPath: Panorama.WildFire.File.Name
      description: The file name.
      type: String
    - contextPath: Panorama.WildFire.File-type
      description: The WildFire profile file type.
      type: String
    - contextPath: Panorama.WildFire.Name
      description: The WildFire profile name.
      type: String
    - contextPath: Panorama.WildFire.SSLDecrypt
      description: The SSL decrypt content.
      type: String
    - contextPath: Panorama.WildFire.Schedule.Action
      description: The WildFire schedule action.
      type: String
    - contextPath: Panorama.WildFire.Schedule.Recurring
      description: The WildFire schedule recurring.
      type: String
  - arguments: []
    description: Views URL filtering best practices.
    name: pan-os-get-url-filtering-best-practice
    outputs:
    - contextPath: Panorama.URLFilter.Category.Action
      description: The action to perform on the category.
      type: String
    - contextPath: Panorama.URLFilter.Category.Name
      description: The category name.
      type: String
    - contextPath: Panorama.URLFilter.DeviceGroup
      description: The device group name.
      type: String
    - contextPath: Panorama.URLFilter.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-container-page-only
      description: The log container page only.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-referer
      description: The log HTTP header referrer.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-user
      description: The log HTTP header user.
      type: String
    - contextPath: Panorama.URLFilter.Header.log-http-hdr-xff
      description: The log HTTP header xff.
      type: String
  - arguments:
    - description: The template name.
      name: template
      required: true
    description: Enforces Wildfire best practices to upload files to the maximum size, forwards all file types, and updates the schedule.
    name: pan-os-enforce-wildfire-best-practice
  - arguments:
    - description: The name of the profile to create.
      name: profile_name
      required: true
    description: Creates an antivirus best practice profile.
    name: pan-os-create-antivirus-best-practice-profile
  - arguments:
    - description: The profile name to create.
      name: profile_name
      required: true
    description: Creates an Anti-Spyware best practice profile.
    name: pan-os-create-anti-spyware-best-practice-profile
  - arguments:
    - description: The profile name.
      name: profile_name
      required: true
    description: Creates a vulnerability protection best practice profile.
    name: pan-os-create-vulnerability-best-practice-profile
  - arguments:
    - description: The profile name.
      name: profile_name
      required: true
    description: Creates a URL filtering best practice profile.
    name: pan-os-create-url-filtering-best-practice-profile
  - arguments:
    - description: The name of the profile.
      name: profile_name
      required: true
    description: Creates a file blocking best practice profile.
    name: pan-os-create-file-blocking-best-practice-profile
  - arguments:
    - description: The name of the profile.
      name: profile_name
      required: true
    description: Creates a WildFire analysis best practice profile.
    name: pan-os-create-wildfire-best-practice-profile
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Shows the user ID interface configuration.
    name: pan-os-show-user-id-interfaces-config
    outputs:
    - contextPath: Panorama.UserInterfaces.Name
      description: The name of the user interface.
      type: String
    - contextPath: Panorama.UserInterfaces.Zone
      description: The zone to which the interface is connected.
      type: String
    - contextPath: Panorama.UserInterfaces.EnableUserIdentification
      description: Whether user identification is enabled.
      type: String
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if it exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Shows the zones configuration.
    name: pan-os-show-zones-config
    outputs:
    - contextPath: Panorama.Zone.Name
      description: The name of the zone.
      type: String
    - contextPath: Panorama.Zone.Network
      description: The network to which the zone is connected.
      type: String
    - contextPath: Panorama.Zone.EnableUserIdentification
      description: Whether user identification is enabled.
      type: String
    - contextPath: Panorama.Zone.ZoneProtectionProfile
      description: The zone protection profile.
      type: String
    - contextPath: Panorama.Zone.LogSetting
      description: The log setting for the zone.
      type: String
  - arguments:
    - description: The template to use when running the command. Overrides the template parameter (Panorama instances). If not given, will use the integration parameter.
      name: template
    - description: The template stack to use when running the command.
      name: template_stack
    - description: "The name of the virtual system to be configured. Will use the configured VSYS parameter if it exists. If given a value, will override the VSYS parameter. If neither the VSYS parameter and this argument are entered, will default to 'vsys1'. "
      name: vsys
    description: Retrieves a list of user-ID agents configured in the system.
    name: pan-os-list-configured-user-id-agents
    outputs:
    - contextPath: Panorama.UserIDAgents.Name
      type: String
      description: The user ID agent name.
    - contextPath: Panorama.UserIDAgents.Host
      description: The user ID agent host.
      type: String
    - contextPath: Panorama.UserIDAgents.Port
      description: The user ID agent port.
      type: Number
    - contextPath: Panorama.UserIDAgents.LdapProxy
      description: Whether LDAP proxy is used in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.NtlmAuth
      description: Whether NLTM authentication is used in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.EnableHipCollection
      type: String
      description: Whether HIP collection is enabled in the user ID agent.
    - contextPath: Panorama.UserIDAgents.IpUserMapping
      description: Whether IP user mapping is enabled in the user ID agent.
      type: String
    - contextPath: Panorama.UserIDAgents.SerialNumber
      description: The serial number associated with the user ID agent.
      type: Unknown
    - contextPath: Panorama.UserIDAgents.CollectorName
      description: The user ID agent collector name.
      type: String
    - contextPath: Panorama.UserIDAgents.Secret
      description: The user ID agent secret.
      type: String
    - contextPath: Panorama.UserIDAgents.Disabled
      description: Whether the user ID agent is disbaled.
      type: String
  - arguments:
    - description: Entry ID of the file to upload.
      name: entryID
      required: true
    - description: The category of the content.
      name: category
      required: true
      auto: PREDEFINED
      predefined:
      - wildfire
      - anti-virus
      - content
    description: >-
      Uploads a content file to Panorama.
    name: pan-os-upload-content-update-file
    outputs:
    - contextPath: Panorama.Content.Upload.Status
      type: string
      description: The content upload status.
    - contextPath: Panorama.Content.Upload.Message
      description: The content upload message.
      type: string
  - arguments:
    - description: The update file name to be installed on PAN-OS.
      name: version_name
      required: true
    - description: The category of the content.
      name: category
      required: true
      auto: PREDEFINED
      predefined:
      - wildfire
      - anti-virus
      - content
    - defaultValue: 'no'
      description: Skips the file validity check with the PAN-OS update server. Use this option for air-gapped networks and only if you trust the content file.
      name: skip_validity_check
      auto: PREDEFINED
      predefined:
      - yes
      - no
      required: true
    description: Installs a specific content update file.
    name: pan-os-install-file-content-update
    outputs:
    - contextPath: Panorama.Content.Install.JobID
      type: string
      description: The job ID of the installation.
    - contextPath: Panorama.Content.Install.Status
      description: The installation status.
      type: string
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: >-
      Gets all ARP tables from all firewalls in the topology.
    name: pan-os-platform-get-arp-tables
    outputs:
    - contextPath: PANOS.ShowArp.Summary.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.ShowArp.Summary.max
      description: The maximum number of supported ARP entries.
      type: String
    - contextPath: PANOS.ShowArp.Summary.total
      description: The total number of current ARP entries.
      type: String
    - contextPath: PANOS.ShowArp.Summary.timeout
      description: The ARP entry timeout.
      type: String
    - contextPath: PANOS.ShowArp.Summary.dp
      type: String
      description: The firewall dataplane associated with the entry.
    - contextPath: PANOS.ShowArp.Result.hostid
      description: The ID of the PAN-OS host.
      type: String
    - contextPath: PANOS.ShowArp.Result.interface
      description: The network interface learned ARP entry.
      type: String
    - contextPath: PANOS.ShowArp.Result.ip
      description: The layer 3 address.
      type: String
    - contextPath: PANOS.ShowArp.Result.mac
      description: The layer 2 address.
      type: String
    - contextPath: PANOS.ShowArp.Result.port
      description: The network interface matching entry.
      type: String
    - contextPath: PANOS.ShowArp.Result.status
      description: The ARP entry status.
      type: String
    - contextPath: PANOS.ShowArp.Result.ttl
      description: The time to live.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Pulls all route summary information from the topology.
    name: pan-os-platform-get-route-summary
    outputs:
    - contextPath: PANOS.ShowRouteSummary.Summary.hostid
      type: Number
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.ShowRouteSummary.Summary.total
      description: The total number of routes.
      type: Number
    - contextPath: PANOS.ShowRouteSummary.Summary.limit
      description: The maximum number of routes for the platform.
      type: Number
    - contextPath: PANOS.ShowRouteSummary.Summary.active
      description: The active routes in the routing table.
      type: Number
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Pulls all route summary information from the topology.
    name: pan-os-platform-get-routes
    outputs:
    - contextPath: PANOS.ShowRoute.Summary.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.ShowRoute.Summary.interface
      description: The next hop interface.
      type: String
    - contextPath: PANOS.ShowRoute.Summary.route_count
      description: The total number of routes seen on the virtual router interface.
      type: Number
    - contextPath: PANOS.ShowRoute.Result.hostid
      description: The ID of the PAN-OS host.
      type: String
    - contextPath: PANOS.ShowRoute.Result.virtual_router
      description: The virtual router this route belongs to.
      type: String
    - contextPath: PANOS.ShowRoute.Result.destination
      description: The network destination of the route.
      type: String
    - contextPath: PANOS.ShowRoute.Result.nexthop
      description: The next hop to the destination.
      type: String
    - contextPath: PANOS.ShowRoute.Result.metric
      description: The route metric.
      type: String
    - contextPath: PANOS.ShowRoute.Result.flags
      description: The route flags.
      type: String
    - contextPath: PANOS.ShowRoute.Result.age
      description: The age of the route.
      type: Number
    - contextPath: PANOS.ShowRoute.Result.interface
      description: The next hop interface.
      type: String
    - contextPath: PANOS.ShowRoute.Result.route_table
      description: The route table this route belongs to.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: >-
      Gets information from all PAN-OS systems in the topology.
    name: pan-os-platform-get-system-info
    outputs:
    - contextPath: PANOS.ShowSystemInfo.Summary.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.ShowSystemInfo.Summary.ip_address
      description: The management IP address.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Summary.sw_version
      description: The system software version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Summary.family
      description: The platform family.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Summary.model
      description: The platform model.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Summary.uptime
      type: String
      description: The total system uptime.
    - contextPath: PANOS.ShowSystemInfo.Summary.hostname
      type: String
      description: The system hostname.
    - contextPath: PANOS.ShowSystemInfo.Result.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.ShowSystemInfo.Result.ip_address
      type: String
      description: The management IP address.
    - contextPath: PANOS.ShowSystemInfo.Result.netmask
      type: String
      description: The management netmask.
    - contextPath: PANOS.ShowSystemInfo.Result.mac_address
      type: String
      description: The management MAC address.
    - contextPath: PANOS.ShowSystemInfo.Result.uptime
      type: String
      description: The total system uptime.
    - contextPath: PANOS.ShowSystemInfo.Result.family
      type: String
      description: The platform family.
    - contextPath: PANOS.ShowSystemInfo.Result.model
      description: The platform model.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.sw_version
      description: The system software version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.operational_mode
      description: The xurrent operational mode.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.ipv6_address
      description: The management IPv6 address.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.default_gateway
      description: The management default gateway.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.public_ip_address
      description: The firewall public IP address.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.hostname
      description: The device hostname.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.av_version
      description: The system anti-virus version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.av_release_date
      description: The release date of the antivirus content.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.app_version
      description: The app content version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.app_release_date
      description: The release date of the application content.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.threat_version
      description: The threat content version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.threat_release_date
      description: The release date of the threat content.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.wildfire_version
      description: The Wildfire content version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.wildfire_release_date
      description: The Wildfire release date.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.url_filtering_version
      description: The URL filtering content version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.global_protect_client_package_version
      description: The GlobalProtect client package version.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.advanced_routing
      description: Advanced routing feature.
      type: String
    - contextPath: PANOS.ShowSystemInfo.Result.multi_vsys
      description: Virtual system feature.
      type: String
  - arguments:
    - description: The Panorama hostname or serial number used to filter device groups. This command is specifically for Panorama and requires an exact match (substrings are not supported).
      name: device_filter_string
    description: Gets operational information for all device groups in the Panorama topology, including group names, hierarchy, and associated firewalls. If no filter is provided, the command returns all device groups within the Panorama instance.
    name: pan-os-platform-get-device-groups
    outputs:
    - contextPath: PANOS.DeviceGroupOp.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.DeviceGroupOp.serial
      description: The serial number of the firewall.
      type: String
    - contextPath: PANOS.DeviceGroupOp.connected
      description: Whether the firewall is currently connected.
      type: String
    - contextPath: PANOS.DeviceGroupOp.hostname
      description: The firewall hostname.
      type: String
    - contextPath: PANOS.DeviceGroupOp.last_commit_all_state_sp
      type: String
      description: The state of the last commit.
    - contextPath: PANOS.DeviceGroupOp.name
      description: The device group name.
      type: String
  - arguments:
    - description: 'The string by which to filter the results to only show specific hostnames or serial numbers.'
      name: device_filter_string
    description: >-
      Gets the operational information of the template stacks in the topology.
    name: pan-os-platform-get-template-stacks
    outputs:
    - contextPath: PANOS.TemplateStackOp.hostid
      type: String
      description: The ID of the PAN-OS host.
    - contextPath: PANOS.TemplateStackOp.serial
      description: The serial number of the firewall.
      type: String
    - contextPath: PANOS.TemplateStackOp.connected
      description: Whether the firewall is currently connected.
      type: String
    - contextPath: PANOS.TemplateStackOp.hostname
      description: The firewall hostname.
      type: String
    - contextPath: PANOS.TemplateStackOp.last_commit_all_state_tpl
      type: String
      description: The state of the last commit.
    - contextPath: PANOS.TemplateStackOp.name
      description: The template stack name.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Gets global counter information from all the PAN-OS firewalls in the topology.
    name: pan-os-platform-get-global-counters
    outputs:
    - contextPath: PANOS.ShowCounters.Summary.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ShowCounters.Summary.name
      description: The human readable counter name.
      type: String
    - contextPath: PANOS.ShowCounters.Summary.value
      description: The current counter value.
      type: Number
    - contextPath: PANOS.ShowCounters.Summary.rate
      description: The packets per second rate.
      type: Number
    - contextPath: PANOS.ShowCounters.Summary.desc
      type: String
      description: The human readable counter description.
    - contextPath: PANOS.ShowCounters.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ShowCounters.Result.category
      description: The counter category.
      type: String
    - contextPath: PANOS.ShowCounters.Result.name
      description: The human readable counter name.
      type: String
    - contextPath: PANOS.ShowCounters.Result.value
      description: The current counter value.
      type: Number
    - contextPath: PANOS.ShowCounters.Result.rate
      description: The packets per second rate.
      type: Number
    - contextPath: PANOS.ShowCounters.Result.aspect
      description: The PAN-OS aspect.
      type: String
    - contextPath: PANOS.ShowCounters.Result.desc
      description: The human readable counter description.
      type: String
    - contextPath: PANOS.ShowCounters.Result.id
      description: The counter ID.
      type: String
    - contextPath: PANOS.ShowCounters.Result.severity
      description: The counter severity.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Retrieves all BGP peer information from the PAN-OS firewalls in the topology.
    name: pan-os-platform-get-bgp-peers
    outputs:
    - contextPath: PANOS.ShowBGPPeers.Summary.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Summary.peer
      description: The name of the Border Gateway Protocol (BGP) peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Summary.status
      description: The peer connection status.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Summary.incoming_accepted
      description: The total number of accepted routes from the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.ShowBGPPeers.Result.peer
      description: The name of the Border Gateway Protocol (BGP) peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.vr
      description: The virtual router in which the peer resides.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.remote_as
      description: The remote AS (Autonomous System) of the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.status
      description: The peer connection status.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.peer_address
      description: The IP address and port of the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.local_address
      description: The local router address and port.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.incoming_total
      description: The total incoming routes from the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.incoming_accepted
      description: The total accepted routes from the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.incoming_rejected
      description: The total rejected routes from peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.policy_rejected
      description: The total routes rejected by the peer by policy.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.outgoing_total
      description: The total routes advertised to the peer.
      type: String
    - contextPath: PANOS.ShowBGPPeers.Result.outgoing_advertised
      description: The number of advertised routes to the peer.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Checks the devices for software that is available to be installed.
    name: pan-os-platform-get-available-software
    outputs:
    - contextPath: PANOS.SoftwareVersions.Summary.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.SoftwareVersions.Summary.version
      description: The software version in Major.Minor.Maint format.
      type: String
    - contextPath: PANOS.SoftwareVersions.Summary.filename
      description: The software version filename.
      type: String
    - contextPath: PANOS.SoftwareVersions.Summary.size
      description: The size of the software in MB.
      type: String
    - contextPath: PANOS.SoftwareVersions.Summary.size_kb
      type: String
      description: The size of the software in KB.
    - contextPath: PANOS.SoftwareVersions.Summary.release_notes
      description: The link to version release notes on PAN knowledge base.
      type: String
    - contextPath: PANOS.SoftwareVersions.Summary.downloaded
      description: True if the software version is present on the system.
      type: Boolean
    - contextPath: PANOS.SoftwareVersions.Summary.current
      description: True if this is the currently installed software on the system.
      type: Boolean
    - contextPath: PANOS.SoftwareVersions.Summary.latest
      description: True if this is the most recently released software for this platform.
      type: Boolean
    - contextPath: PANOS.SoftwareVersions.Summary.uploaded
      type: Boolean
      description: True if the software version has been uploaded to the system.
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Gets the HA state and associated details from the given device and any other details.
    name: pan-os-platform-get-ha-state
    outputs:
    - contextPath: PANOS.HAState.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.HAState.active
      description: Whether this is the active firewall in a pair. "True" if standalone as well.
      type: Boolean
    - contextPath: PANOS.HAState.status
      description: The string HA status.
      type: String
    - contextPath: PANOS.HAState.peer
      description: The HA peer.
      type: String
  - arguments:
    - description: 'The string by which to filter the results to only show specific hostnames or serial numbers.'
      name: device_filter_string
    - description: The filter to return jobs by status.
      name: status
    - description: The filter to return jobs by type.
      name: job_type
    - description: The filter to return jobs by ID. Required when "polling" is set to true.
      name: id
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Whether to poll the job status until it reaches a terminal state (FIN). Requires a single job "id" to be provided. When enabled, the "status" and "job_type" filters are ignored.
      name: polling
      predefined:
      - 'true'
      - 'false'
    - defaultValue: '30'
      description: The interval between poll attempts, in seconds.
      name: interval_in_seconds
    - defaultValue: '3600'
      description: The maximum time to wait for the job to reach a terminal state, in seconds. If the timeout is reached before the job finishes, the command returns the last known result.
      name: timeout_in_seconds
    description: >-
      Gets all the jobs from the devices in the environment, or a single job when the ID is specified.
      Supports polling when a single job ID is provided.
    name: pan-os-platform-get-jobs
    polling: true
    outputs:
    - contextPath: PANOS.JobStatus.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.JobStatus.id
      description: The ID of the job.
      type: Number
    - contextPath: PANOS.JobStatus.type
      description: The job type.
      type: String
    - contextPath: PANOS.JobStatus.tfin
      description: The time the job finished.
      type: String
    - contextPath: PANOS.JobStatus.status
      description: The status of the job.
      type: String
    - contextPath: PANOS.JobStatus.result
      type: String
      description: The result of the job.
    - contextPath: PANOS.JobStatus.user
      type: String
      description: The user who initiated the job.
    - contextPath: PANOS.JobStatus.tenq
      type: String
      description: The time the job was queued into the system.
    - contextPath: PANOS.JobStatus.stoppable
      type: String
      description: Whether the job can be stopped after it started.
    - contextPath: PANOS.JobStatus.description
      type: String
      description: The job description.
    - contextPath: PANOS.JobStatus.positionInQ
      type: String
      description: The position of the job in the current job queue.
    - contextPath: PANOS.JobStatus.progress
      type: String
      description: The numerical progress of the job.
    - contextPath: PANOS.JobStatus.warnings
      type: String
      description: The warnings of the job.
  - arguments:
    - description: The software version to upgrade to, for example, 9.1.2.
      name: version
      required: true
    - description: The string by which to filter the results to only install to specific devices or serial numbers.
      name: device_filter_string
    - defaultValue: 'false'
      description: If provided, runs the download synchronously. Make sure 'execution-timeout' is increased.
      name: sync
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Downloads the provided software version onto the device.
    name: pan-os-platform-download-software
    outputs:
    - contextPath: PANOS.DownloadStatus.Summary.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.DownloadStatus.Summary.started
      description: Whether the download process started.
      type: String
  - arguments:
    - description: The serial number, or IP address for a Panorama instance, to reboot.
      name: target
      required: true
    description: >
      Reboots the given device by host ID. Warning: This command has no confirmation and the device
      will immediately reboot. This command can be disruptive.
    name: pan-os-platform-reboot
    outputs:
    - contextPath: PANOS.RestartStatus.Summary.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.RestartStatus.Summary.started
      description: Whether the download process started.
      type: String
    execution: true
  - arguments:
    - description: The serial number, or IP address for a Panorama instance, to reboot.
      name: target
      required: true
    - auto: PREDEFINED
      description: Whether to use polling. When set to "true", the command polls the target device until it becomes available (operational mode "normal") or the timeout is reached.
      defaultValue: 'false'
      name: polling
      predefined:
      - 'true'
      - 'false'
    - description: The interval (in seconds) between polling attempts.
      name: interval_in_seconds
      defaultValue: '30'
    - description: The timeout (in seconds) when polling.
      name: timeout
      defaultValue: '1200'
    description: Checks the status of the given device, checking whether it's up or down and if the operational mode is normal. Supports polling to wait until the device becomes available.
    name: pan-os-platform-get-system-status
    polling: true
    outputs:
    - contextPath: PANOS.SystemStatus.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.SystemStatus.up
      description: Whether the host device is up or still unavailable.
      type: String
  - arguments:
    - description: The serial number, or IP address for a Panorama instance, to reboot.
      name: target
      required: true
    - description: The new state.
      name: state
      required: true
      auto: PREDEFINED
      predefined:
      - functional
      - peer
      - suspend
    description: Checks the status of the given device, checking whether it's up or down and if the operational mode is normal.
    name: pan-os-platform-update-ha-state
    outputs:
    - contextPath: PANOS.HAStateUpdate.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.HAStateUpdate.state
      description: The new HA state.
      type: String
  - arguments:
    - description: The string by which to filter so that only the given device is checked.
      name: device_filter_string
    description: Checks that at least one log forwarding profile is configured according to best practices.
    name: pan-os-hygiene-check-log-forwarding
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      description: The description of the hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: Number
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: The parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The string by which to filter so that only the given device is checked.
      name: device_filter_string
    - description: A comma-separated list of severities that must be in drop/reset/block-ip mode.
      name: minimum_block_severities
      defaultValue: critical,high
      isArray: true
    - defaultValue: medium,low
      description: A comma-separated list of severities that must be in alert/default or higher mode.
      isArray: true
      name: minimum_alert_severities
    - auto: PREDEFINED
      defaultValue: 'no'
      description: Whether or not to return details about profiles that do not conform to best practices.
      name: return_nonconforming_profiles
      predefined:
      - 'yes'
      - 'no'
    description: Checks the configured vulnerability profiles to ensure at least one meets best practices.
    name: pan-os-hygiene-check-vulnerability-profiles
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      type: String
      description: The description of the hygiene check.
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: Number
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: The parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: 'Software version to upgrade to, for example: 9.1.2.'
      name: version
      required: true
    - description: The string by which to filter to only install to specific devices or serial numbers.
      name: device_filter_string
    - description: If provided, runs the download synchronously. Make sure 'execution-timeout' is increased.
      name: sync
      defaultValue: 'false'
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    description: Installs the given software version onto the device. Downloads the software first with panorama-download-panos-version.
    name: pan-os-platform-install-software
    outputs:
    - contextPath: PANOS.InstallStatus.Summary.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.InstallStatus.Summary.started
      description: Whether the download process has started.
      type: String
  - arguments:
    - description: The string by which to filter to only check given devices.
      name: device_filter_string
    - description: A CSV list of severities that must be in drop/reset/block-ip mode.
      name: minimum_block_severities
      defaultValue: critical,high
    - description: A CSV list of severities that must be in alert/default or higher mode.
      name: minimum_alert_severities
      defaultValue: medium,low
    - auto: PREDEFINED
      defaultValue: 'no'
      description: Whether or not to return details about profiles that do not conform to best practices.
      name: return_nonconforming_profiles
      predefined:
      - 'yes'
      - 'no'
    description: Checks the configured anti-spyware profiles to ensure at least one meets best practices.
    name: pan-os-hygiene-check-spyware-profiles
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      type: String
      description: The description of the check.
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    - auto: PREDEFINED
      defaultValue: 'no'
      description: Whether or not to return details about profiles that do not conform to best practices.
      name: return_nonconforming_profiles
      predefined:
      - 'yes'
      - 'no'
    description: Checks the configured URL filtering profiles to ensure at least one meets best practices of blocking the following URL categories - abused-drugs, adult, command-and-control, compromised-websites, gambling, grayware, hacking, malware, phishing, questionable, ransomware, scanning-activity, weapons.
    name: pan-os-hygiene-check-url-filtering-profiles
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      type: String
      description: The description of the check.
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    description: Returns a list of existing PANOS URL filtering objects that conform to best practices.
    name: pan-os-hygiene-conforming-url-filtering-profiles
    outputs:
    - contextPath: PANOS.PanosObject.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.PanosObject.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.PanosObject.name
      description: The PAN-OS object name.
      type: String
    - contextPath: PANOS.PanosObject.object_type
      description: The PAN-OS-Python object type.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    - description: A CSV list of severities that must be in drop/reset/block-ip mode.
      name: minimum_block_severities
      defaultValue: critical,high
    - description: A CSV list of severities that must be in alert/default or higher mode.
      name: minimum_alert_severities
      defaultValue: medium,low
    description: Returns all anti-spyware profiles that conform to best practices.
    name: pan-os-hygiene-conforming-spyware-profiles
    outputs:
    - contextPath: PANOS.PanosObject.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.PanosObject.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.PanosObject.name
      description: The PAN-OS object name.
      type: String
    - contextPath: PANOS.PanosObject.object_type
      description: The PAN-OS-Python object type.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    - description: A CSV list of severities that must be in drop/reset/block-ip mode.
      name: minimum_block_severities
      defaultValue: critical,high
    - description: A CSV list of severities that must be in alert/default or higher mode.
      name: minimum_alert_severities
      defaultValue: medium,low
    description: Returns all vulnerability profiles that conform to best practices.
    name: pan-os-hygiene-conforming-vulnerability-profiles
    outputs:
    - contextPath: PANOS.PanosObject.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.PanosObject.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.PanosObject.name
      description: The PAN-OS object name.
      type: String
    - contextPath: PANOS.PanosObject.object_type
      description: The PAN-OS-Python object type.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    description: Checks that configured security zones have correct settings.
    name: pan-os-hygiene-check-security-zones
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      description: The description of the check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The string to filter to only check a given device.
      name: device_filter_string
    description: Checks that security rules are configured correctly.
    name: pan-os-hygiene-check-security-rules
    outputs:
    - contextPath: PANOS.ConfigurationHygiene.Summary.description
      description: The description of the check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_code
      description: The shorthand code for this hygiene check.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.result
      description: Whether the check passed or failed.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Summary.issue_count
      description: The total number of matching issues.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.description
      description: The human readable description of issue.
      type: String
    - contextPath: PANOS.ConfigurationHygiene.Result.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The Dictionary of Hygiene issue, from a hygiene check command. Can be a list.
      name: issue
      isArray: true
      required: true
    description: Fixes log forwarding issues identified by pan-os-hygiene-check-log-forwarding.
    name: pan-os-hygiene-fix-log-forwarding
    outputs:
    - contextPath: PANOS.ConfigurationHygieneFix.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The Dictionary of Hygiene issue, from a hygiene check command. Can be a list.
      name: issue
      required: true
      isArray: true
    - description: The name of the log forwarding profile to set.
      name: log_forwarding_profile_name
      required: true
    description: Fixes security zones that are configured without a valid log forwarding profile.
    name: pan-os-hygiene-fix-security-zone-log-settings
    outputs:
    - contextPath: PANOS.ConfigurationHygieneFix.hostid
      type: String
      description: The host ID.
    - contextPath: PANOS.ConfigurationHygieneFix.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The Dictionary of Hygiene issue, from a hygiene check command. Can be a list.
      name: issue
      required: true
      isArray: true
    - description: The name of the log forwarding profile.
      name: log_forwarding_profile_name
      required: true
    description: Fixes security rules that have incorrect log settings by adding a log forwarding profile and setting.
    name: pan-os-hygiene-fix-security-rule-log-settings
    outputs:
    - contextPath: PANOS.ConfigurationHygieneFix.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The Dictionary of Hygiene issue, from a hygiene check command. Can be a list.
      name: issue
      required: true
      isArray: true
    - description: The name of the security profile group to use as the log setting.
      name: security_profile_group_name
      required: true
    description: Fixes security rules that have incorrect log settings by adding a log forwarding profile and setting.
    name: pan-os-hygiene-fix-security-rule-profile-settings
    outputs:
    - contextPath: PANOS.ConfigurationHygieneFix.hostid
      description: The host ID.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.container_name
      description: What parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.issue_code
      description: The shorthand code for the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.description
      description: The human readable description of the issue.
      type: String
    - contextPath: PANOS.ConfigurationHygieneFix.name
      description: The affected object name.
      type: String
  - arguments:
    - description: The type of object to search. See https://pandevice.readthedocs.io/en/latest/module-objects.html.
      name: object_type
      auto: PREDEFINED
      predefined:
      - AddressObject
      - AddressGroup
      - ServiceGroup
      - ServiceObject
      - ApplicationObject
      - ApplicationGroup
      - LogForwardingProfile
      - SecurityProfileGroup
      - SecurityRule
      - NatRule
      required: true
    - description: If provided, only objects from the given device are returned.
      name: device_filter_string
    - description: The name of the object reference to return if looking for a specific object. Supports regex if "use_regex" is set.
      name: object_name
    - description: The parent vsys or device group to search. If not provided, all will be returned.
      name: parent
    - description: Enables regex matching on an object name.
      name: use_regex
    description: Searches and returns a reference for the given object type and name. If no name is provided, all objects of the given type will be returned. Note this ONLY returns the object name and its location in the configuration hierachy, not the entire object.
    name: pan-os-config-get-object
    outputs:
    - contextPath: PANOS.PanosObject.hostid
      description: Host ID.
      type: String
    - contextPath: PANOS.PanosObject.container_name
      description: The parent container (DG, Template, VSYS) this object belongs to.
      type: String
    - contextPath: PANOS.PanosObject.name
      description: The PAN-OS object name.
      type: String
    - contextPath: PANOS.PanosObject.object_type
      description: The PAN-OS python object type.
      type: String
  - arguments:
    - description: Serial number of the device from which to fetch the device state.
      name: target
      required: true
    - description: Name of the file for the state file to be saved. Default will use the hostname as the filename.
      name: filename
    - description: The IP Address of a Panorama managed firewall. Default will use Panorama-supplied IP Address.
      name: ip_address
    description: Get the device state from the provided device. Note; This will attempt to connect directly to the provided target to get the device state. If the IP address as reported in "show system info" is unreachable, this command will fail.
    name: pan-os-platform-get-device-state
    outputs:
    - contextPath: InfoFile.Name
      description: Filename.
      type: String
    - contextPath: InfoFile.EntryID
      description: Entry ID.
      type: String
    - contextPath: InfoFile.Size
      description: Size of the file.
      type: String
    - contextPath: InfoFile.Type
      description: Type of the file.
      type: String
    - contextPath: InfoFile.Info
      description: Basic information of the file.
      type: String
  - arguments:
    - description: The name of the template to retrieve. If not provided then all available templates will be returned.
      name: template_name
    - description: The maximum number of templates to retrieve. This value is used by default if page argument is not provided.
      name: limit
      defaultValue: '50'
    - description: The page size of the templates to return.
      name: page_size
      defaultValue: '50'
    - description: The page at which to start listing templates. This must be a positive number.
      name: page
    description: Returns a list of available templates. (To be used only in Panorama instances).
    name: pan-os-list-templates
    outputs:
    - contextPath: Panorama.Template.Name
      description: The name of the template.
      type: String
    - contextPath: Panorama.Template.Description
      description: The description of the template.
      type: String
    - contextPath: Panorama.Template.Variable.Name
      description: The variable name of the template.
      type: String
    - contextPath: Panorama.Template.Variable.Type
      description: The type of template.
      type: String
    - contextPath: Panorama.Template.Variable.Value
      description: The value of the variable of the template.
      type: String
    - contextPath: Panorama.Template.Variable.Description
      description: The description of the variable of the template.
      type: String
  - arguments:
    - description: The name of the NAT rule to retrieve. If not mentioned, will bring all the NAT rules.
      name: name
    - description: The device group in which the NAT rules are part of.
      name: device-group
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    - auto: PREDEFINED
      description: Whether to show the un-committed rules or not.
      name: show_uncommitted
      predefined:
      - 'true'
      - 'false'
      defaultValue: 'false'
    - description: Whether to retrieve the disabled rules. If not mentioned, will retrieve all the NAT rules.
      name: disabled
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - auto: PREDEFINED
      description: The type of the NAT rules to retrieve. If not mentioned, will retrieve all the NAT rules.
      name: nat_type
      predefined:
      - ipv4
      - nat64
      - nptv6
    - description: A comma-separated list of tags of the NAT rules to retrieve. If not mentioned, will retrieve all the NAT rules.
      isArray: true
      name: tags
    - description: Free query to retrieve NAT rule. If not mentioned, will retrieve all the NAT rules.
      name: query
    - defaultValue: '50'
      description: The maximum number of rules to retrieve. Will be used by default if page argument was not provided.
      name: limit
    - defaultValue: '50'
      description: The page size of the NAT rules to return.
      name: page_size
    - description: The page at which to start listing NAT rules. Must be a positive number.
      name: page
    description: Returns a list of NAT rules of either a Panorama/firewall instance.
    name: pan-os-list-nat-rules
    outputs:
    - contextPath: Panorama.NAT.Name
      description: The name of the rule.
      type: String
    - contextPath: Panorama.NAT.Location
      description: The device group that the rule is part of.
      type: String
    - contextPath: Panorama.NAT.Tags
      description: The tags in which the rule is part of.
      type: String
    - contextPath: Panorama.NAT.SourceZone
      description: The source zone of the rule.
      type: String
    - contextPath: Panorama.NAT.DestinationZone
      description: The destination zone of the rule.
      type: String
    - contextPath: Panorama.NAT.SourceAddress
      description: The source address of the rule.
      type: String
    - contextPath: Panorama.NAT.DestinationAddress
      description: The destination address of the rule.
      type: String
    - contextPath: Panorama.NAT.DestinationInterface
      description: The destination interface of the rule.
      type: String
    - contextPath: Panorama.NAT.Service
      description: The service in which the rule has.
      type: String
    - contextPath: Panorama.NAT.Description
      description: The description of the rule.
      type: String
    - contextPath: Panorama.NAT.SourceTranslation
      description: The source translation of the rule.
      type: Unknown
    - contextPath: Panorama.NAT.DestinationTranslation
      description: The destination translation of the rule.
      type: Unknown
    - contextPath: Panorama.NAT.DynamicDestinationTranslation
      description: The dynamic destination translation of the rule.
      type: Unknown
    - contextPath: Panorama.NAT.Disabled
      description: Whether the rule is disabled.
      type: String
  - arguments:
    - description: The name of the NAT rule to create.
      name: rulename
      required: true
    - description: The description that the new NAT rule should have.
      name: description
    - description: The device-group in which the new rule should be created (Panorama instances only).
      name: device-group
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    - defaultValue: 'ipv4'
      description: The NAT type in which the rule will be created.
      name: nat_type
      auto: PREDEFINED
      predefined:
      - ipv4
      - nat64
      - nptv6
    - description: A comma-separated list of source zones.
      name: source_zone
      isArray: true
      defaultValue: 'any'
    - description: The destination zone.
      name: destination_zone
    - description: The destination interface for the rule.
      name: destination_interface
      defaultValue: 'any'
    - description: The service in which the rule will be created with.
      name: service
      defaultValue: 'any'
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      isArray: true
      name: source_address
      defaultValue: 'any'
    - description: A comma-separated list of address object names, address group object names, or EDL object names.
      isArray: true
      name: destination_address
      defaultValue: 'any'
    - defaultValue: 'none'
      auto: PREDEFINED
      predefined:
      - static-ip
      - dynamic-ip
      - dynamic-ip-and-port
      - none
      description: The source translation type in which the rule will be created.
      name: source_translation_type
    - defaultValue: 'translated-address'
      auto: PREDEFINED
      predefined:
      - translated-address
      - interface-address
      description: The source translation address type in which the rule will be created.
      name: source_translated_address_type
    - description: A comma-separated list of source translation addresses. If source_translation_type == static_ip, must be a single value.
      isArray: true
      name: source_translated_address
    - description: The source translation interface.
      name: source_translated_interface
    - auto: PREDEFINED
      defaultValue: 'none'
      predefined:
      - static_ip
      - dynamic_ip
      - none
      description: The destination translation type.
      name: destination_translation_type
    - description: A comma-separated list of destination translated addresses.
      isArray: true
      name: destination_translated_address
    - description: The destination translated port.
      name: destination_translated_port
    - description: The destination translation distribution method.
      name: destination_translation_distribution_method
      auto: PREDEFINED
      predefined:
      - round-robin
      - source-ip-hash
      - ip-modulo
      - ip-hash
      - least-sessions
    - description: Whether to use negate destination.
      name: negate_destination
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - description: The DNS rewrite direction.
      name: destination_dns_rewrite_direction
      auto: PREDEFINED
      predefined:
      - forward
      - reverse
    - description: An audit comment for the rule.
      name: audit_comment
    description: Creates a new NAT rule in a Panorama/firewall instance.
    name: pan-os-create-nat-rule
  - arguments:
    - description: The name of the NAT rule to delete. Can be retrieved from the pan-os-list-nat-rules command.
      name: rulename
      required: true
    - description: The device-group from which the NAT rule should be deleted. Only for a Panorama instance.
      name: device-group
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Deletes a NAT rule.
    name: pan-os-delete-nat-rule
  - arguments:
    - description: The name of the NAT rule to edit. Can be retrieved from the pan-os-list-nat-rules command.
      name: rulename
      required: true
    - description: The device-group that the NAT rule is part of. Only for a Panorama instance.
      name: device-group
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    - auto: PREDEFINED
      description: The operation to perform on the rule.
      name: behavior
      predefined:
      - 'replace'
      - 'add'
      - remove
      defaultValue: 'replace'
    - description: The element to change.
      name: element_to_change
      auto: PREDEFINED
      required: true
      predefined:
      - tags
      - service
      - nat_type
      - description
      - source_zone
      - destination_zone
      - source_address
      - destination_address
      - destination_interface
      - negate_destination
      - source_translation_dynamic_ip_and_port
      - source_translation_interface
      - source_translation_dynamic_ip
      - source_translation_static_ip
      - destination_translation_port
      - destination_translation_ip
      - destination_translation_dynamic_port
      - destination_translation_dynamic_ip
      - destination_translation_dynamic_distribution_method
      - disabled
      - audit-comment
    - description: The value of the element to change. Can be a list for certain elements.
      isArray: true
      name: element_value
      required: true
    description: Edits a NAT rule.
    name: pan-os-edit-nat-rule
  - arguments:
    - description: The name of the virtual router to retrieve. If not mentioned, will bring all the virtual routers.
      name: virtual_router
    - description: The template that the virtual router is part of. Use only for Panorama instances.
      name: template
    - auto: PREDEFINED
      description: Whether to show the un-committed virtual routers or not.
      name: show_uncommitted
      predefined:
      - 'true'
      - 'false'
      defaultValue: 'false'
    - description: The maximum number of virtual routers to retrieve. Will be used by default if the page argument was not provided.
      name: limit
      defaultValue: '50'
    - description: The size of virtual-routers to return.
      name: page_size
      defaultValue: '50'
    - description: The page at which to start listing virtual-routers. Must be a positive number.
      name: page
    description: Returns a list of virtual routers of either a Panorama/firewall instance.
    name: pan-os-list-virtual-routers
    outputs:
    - contextPath: Panorama.VirtualRouter.Name
      description: The name of the virtual router.
      type: String
    - contextPath: Panorama.VirtualRouter.Interface
      description: The interface(s) that the virtual router uses.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.RIP
      description: Information about the RIP of the virtual router.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.OSPF
      description: Information about the OSPF of the virtual router.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.OSPFv3
      description: Information about the OSPFv3 of the virtual router.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.BGP
      description: Information about the BGP of the virtual router.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.RedistributionProfile
      description: The redistribution profile(s) that the virtual router uses.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.Multicast
      description: Information about the multicast of the virtual router.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.StaticRoute
      description: The static routes(s) that the virtual router uses.
      type: Unknown
    - contextPath: Panorama.VirtualRouter.ECMP
      description: The ECMP defined for the virtual router.
      type: Unknown
  - arguments:
    - description: Redistribution profile name.
      name: name
    - description: The name of the virtual router that has the redistribution profiles retrieve. Can be retrieved from pan-os-list-virtual-routers.
      name: virtual_router
      required: true
    - description: The template that the redistribution profiles and virtual-router are part of. Use only for Panorama instances.
      name: template
    - defaultValue: '50'
      description: The maximum number of redistribution-profiles to retrieve.
      name: limit
    description: Returns a list of redistribution-profiles of a specific virtual-router of either a Panorama/firewall instance.
    name: pan-os-list-redistribution-profiles
    outputs:
    - contextPath: Panorama.RedistributionProfile.Name
      description: The name of the profile.
      type: String
    - contextPath: Panorama.RedistributionProfile.Priority
      description: The priority of the profile.
      type: String
    - contextPath: Panorama.RedistributionProfile.Action
      description: The action of the profile.
      type: String
    - contextPath: Panorama.RedistributionProfile.FilterInterface
      description: The filter interface(s).
      type: Unknown
    - contextPath: Panorama.RedistributionProfile.FilterType
      description: The filter type(s).
      type: Unknown
    - contextPath: Panorama.RedistributionProfile.FilterDestination
      description: The filter destination(s).
      type: Unknown
    - contextPath: Panorama.RedistributionProfile.FilterNextHop
      description: The filter next hop.
      type: Unknown
    - contextPath: Panorama.RedistributionProfile.BGP
      description: The BGP of the profile.
      type: Unknown
    - contextPath: Panorama.RedistributionProfile.OSPF
      description: The OSPF of the profile.
      type: Unknown
  - arguments:
    - description: The name of the redistribution profile to create.
      name: name
      required: true
    - description: The virtual router that the redistribution profile will be created on.
      name: virtual_router
      required: true
    - description: The template that the virtual-router is in. Use only for Panorama instances.
      name: template
    - description: Comma-separated list of the filter source types.
      name: filter_source_type
      auto: PREDEFINED
      predefined:
      - 'bgp'
      - 'ospf'
      - rip
      - static
      isArray: true
    - description: A comma-separated list of destination to filter by.
      name: destination
      isArray: true
    - description: A comma-separated list of next-hops to filter by.
      name: nexthop
      isArray: true
    - description: A comma-separated list of interfaces to filter by.
      isArray: true
      name: interface
    - description: The priority of the profile. (1-255).
      name: priority
      required: true
    - description: The action of the profile.
      name: action
      auto: PREDEFINED
      predefined:
      - redist
      - no-redist
    - description: A comma-separated list of areas for the OSPF.
      isArray: true
      name: filter_ospf_area
    - description: A comma-separated list of tags for the OSPF.
      isArray: true
      name: filter_ospf_tag
    - auto: PREDEFINED
      predefined:
      - ext-1
      - ext-2
      - inter-area
      - intra-area
      description: A comma-separated list of path types for the OSPF.
      isArray: true
      name: filter_ospf_path_type
    - description: A comma-separated list of community filters for the BGP. 32-bit value in decimal or hex or in AS:VAL format where AS and VAL are each in 0 - 65535 range. (Max 10 values).
      isArray: true
      name: filter_bgp_community
    - description: A comma-separated list of community filters for the BGP. 64-bit value in hex, or in TYPE:AS:VAL, TYPE:IP:VAL format. TYPE is 16-bit, the other two are 16-bit and 32-bit each. (Max 5 values).
      isArray: true
      name: filter_bgp_extended_community
    description: Creates a new redistribution-profile under a virtual-router for a Panorama/firewall instance.
    name: pan-os-create-redistribution-profile
  - arguments:
    - description: The name of the redistribution-profile to edit.
      name: name
      required: true
    - description: The name of the virtual-router that the redistribution-profile is part of.
      name: virtual_router
      required: true
    - description: The template that the virtual-router is in. Only for Panorama instances.
      name: template
    - description: The element to change.
      name: element_to_change
      auto: PREDEFINED
      predefined:
      - 'filter_type'
      - 'filter_destination'
      - filter_nexthop
      - filter_interface
      - priority
      - action
      - filter_ospf_area
      - filter_ospf_tag
      - filter_ospf_path_type
      - filter_bgp_community
      - filter_bgp_extended_community
      required: true
    - description: The value of the element to change. Can be a list for all the elements except priority and action.
      name: element_value
      isArray: true
      required: true
    - auto: PREDEFINED
      description: The operation to perform on the profile.
      name: behavior
      predefined:
      - replace
      - add
      - remove
      defaultValue: 'replace'
    description: Edits a redistribution-profile in a virtual-router.
    name: pan-os-edit-redistribution-profile
  - arguments:
    - description: The name of the redistribution-profile to delete.
      name: name
      required: true
    - description: The name of the virtual-router that the redistribution-profile is part of.
      name: virtual_router
      required: true
    - description: The template that the virtual-router is in. Only for panorama instances.
      name: template
    description: Deletes a redistribution-profile from a virtual-router.
    name: pan-os-delete-redistribution-profile
  - arguments:
    - description: The name of the pbf-rule to retrieve. If not mentioned, will bring all the pbf rules.
      name: rulename
    - description: The device-group that the pbf-rules are part of.
      name: device-group
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - defaultValue: 'false'
      description: Whether to show the un-committed rules or not.
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
      name: show_uncommitted
    - description: Whether to retrieve the disabled rules. If not mentioned, will retrieve all the PBF rules.
      name: disabled
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - description: The action of the PBF rules to retrieve. If not mentioned, will retrieve all the PBF rules.
      name: action
      auto: PREDEFINED
      predefined:
      - discard
      - forward
      - no-pbf
    - description: A comma-separated list of tags of the PBF rules to retrieve. If not mentioned, will retrieve all the PBF rules.
      isArray: true
      name: tags
    - description: Free query to retrieve PBF rule. If not mentioned, will retrieve all the PBF rules.
      name: query
    - defaultValue: '50'
      description: The maximum number of rules to retrieve. Will be used by default if page argument was not provided.
      name: limit
    - defaultValue: '50'
      description: The size of pbf-rules to return.
      name: page_size
    - description: The page at which to start listing pbf-rules. Must be a positive number.
      name: page
    description: Returns a list of pbf-rules of either a Panorama/firewall instance.
    name: pan-os-list-pbf-rules
    outputs:
    - contextPath: Panorama.PBF.Name
      description: The name of the PBF rule.
      type: String
    - contextPath: Panorama.PBF.Description
      description: The description of the PBF rule.
      type: String
    - contextPath: Panorama.PBF.Tags
      description: The tags of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.SourceZone
      description: The source-zones of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.SourceInterface
      description: The source-interfaces of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.SourceAddress
      description: The source-addresses of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.SourceUser
      description: The source-users of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.DestinationAddress
      description: The destination-addresses of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.EnforceSymmetricReturn
      description: The enforce-symmetric-return of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.Target
      description: The target of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.Application
      description: The applications of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.Service
      description: The services of the PBF rule.
      type: Unknown
    - contextPath: Panorama.PBF.Disabled
      description: Whether the rule is disabled.
      type: String
  - arguments:
    - description: The name of the PBF-rule to create.
      name: rulename
      required: true
    - description: The description that the new PBF-rule should have.
      name: description
    - name: device-group
      description: The device-group in which the new rule should be created. Only for a Panorama instance.
    - auto: PREDEFINED
      description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      predefined:
      - pre-rulebase
      - post-rulebase
    - description: A comma-separated list of tags.
      isArray: true
      name: tags
    - description: A comma-separated list of source zones.
      isArray: true
      name: source_zone
    - description: A comma-separated list of source addresses.
      isArray: true
      name: source_address
      defaultValue: 'any'
    - description: A comma-separated list of source users.
      name: source_user
      defaultValue: 'any'
    - description: A comma-separated list of services.
      isArray: true
      name: service
      defaultValue: 'any'
    - description: A comma-separated list of destination addresses.
      isArray: true
      name: destination_address
      defaultValue: 'any'
    - description: A comma-separated list of applications.
      isArray: true
      name: application
      defaultValue: 'any'
    - auto: PREDEFINED
      predefined:
      - forward
      - discard
      - no-pbf
      description: The action that the rule will be created with.
      name: action
      required: true
    - description: The egress interface the rule will be created with. Must be provided if action == forward.
      name: egress_interface
    - defaultValue: 'none'
      auto: PREDEFINED
      predefined:
      - ip-address
      - fqdn
      - none
      description: The next-hop. Relevant only when action = forward.
      name: nexthop
    - description: The next-hop value when action = forward. Could be an IP address or FQDN. Required when nexthop is not none.
      name: nexthop_value
    - description: Whether to enforce symmetric return.
      defaultValue: 'no'
      name: enforce_symmetric_return
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - defaultValue: 'no'
      auto: PREDEFINED
      predefined:
      - yes
      - no
      description: Whether to negate the source.
      name: negate_source
    - description: Whether to negate the destination.
      name: negate_destination
      defaultValue: 'no'
      auto: PREDEFINED
      predefined:
      - yes
      - no
    - description: The nexthop addresses list for the symmetric return.
      isArray: true
      name: nexthop_address_list
    - description: An audit comment for the rule.
      name: audit_comment
    description: Creates a new policy-based-forwarding (PBF) rule in a Panorama/firewall instance.
    name: pan-os-create-pbf-rule
  - arguments:
    - description: The name of the PBF rule to edit. Can be retrieved from the pan-os-list-pbf-rules command.
      name: rulename
      required: true
    - description: The device-group that the PBF rule is in.
      name: device-group
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - 'pre-rulebase'
      - 'post-rulebase'
    - description: The element to change.
      name: element_to_change
      auto: PREDEFINED
      predefined:
      - 'source_zone'
      - 'source_address'
      - source_user
      - service
      - destination_address
      - application
      - negate_source
      - negate_destination
      - nexthop_address_list
      - enforce_symmetric_return
      - action_forward_egress_interface
      - action_forward_nexthop_ip
      - action_forward_nexthop_fqdn
      - action_forward_discard
      - action_forward_no_pbf
      - disabled
      - audit-comment
      required: true
    - description: The value of the element to change. Can be a list for some of the elements. When element_to_change == 'action_forward_egress_interface', the action of the rule will be changed to 'forward' automatically.
      name: element_value
      isArray: true
      required: true
    - auto: PREDEFINED
      description: The operation to perform on the PBF rule.
      name: behavior
      predefined:
      - replace
      - add
      - remove
      defaultValue: 'replace'
    description: Edits a PBF rule.
    name: pan-os-edit-pbf-rule
  - arguments:
    - description: The name of the pbf-rule to delete. Can be retrieved from the pan-os-list-pbf-rules command.
      name: rulename
      required: true
    - description: The device-group from which the pbf-rule should be deleted. Only for a Panorama instance.
      name: device-group
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Deletes a PBF rule.
    name: pan-os-delete-pbf-rule
  - arguments:
    - description: The name of the application-group to retrieve. If not mentioned, will bring all the application-groups.
      name: name
    - description: The device-group that the nat-rules are part of.
      name: device-group
    - description: Whether to show the un-committed application-groups or not.
      name: show_uncommitted
      defaultValue: 'false'
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
    - description: The maximum number of application-groups to retrieve. Will be used by default if page argument was not provided.
      name: limit
      defaultValue: '50'
    - defaultValue: '50'
      description: The page size of the application-groups to return.
      name: page_size
    - description: The page at which to start listing application-groups. Must be a positive number.
      name: page
    description: Returns a list of application-groups of either a Panorama/firewall instance.
    name: pan-os-list-application-groups
    outputs:
    - contextPath: Panorama.ApplicationGroup.Name
      description: The name of the application-group object.
      type: String
    - contextPath: Panorama.ApplicationGroup.Applications
      description: The list of the applications that the application-group has.
      type: Unknown
    - contextPath: Panorama.ApplicationGroup.Members
      description: The number of the application that are part of the application-group.
      type: Number
  - arguments:
    - description: The name for the application-group to be created with.
      name: name
      required: true
    - description: Comma-separated list of applications. Can be retrieved using the command pan-os-list-applications.
      name: applications
      isArray: true
      required: true
    - description: The device-group in which the application-group should be created. Only for a Panorama instance.
      name: device-group
    name: pan-os-create-application-group
    description: Creates a new application group rule in a Panorama/firewall instance.
    outputs:
    - contextPath: Panorama.ApplicationGroup.Name
      description: The name of the application-group object.
      type: String
    - contextPath: Panorama.ApplicationGroup.Applications
      description: The list of the applications that the application-group has.
      type: Unknown
    - contextPath: Panorama.ApplicationGroup.Members
      description: The number of the applications that are part of the application-group.
      type: Number
  - name: pan-os-edit-application-group
    arguments:
    - name: name
      description: The name for the application-group to be edit. Can be retrieved from the pan-os-list-application-groups command.
      required: true
    - name: applications
      description: Comma-separated list of applications. Can be retrieved using the command pan-os-list-applications.
      required: true
      isArray: true
    - name: device-group
      description: The device-group in which the application-group should be created. Only for a Panorama instance.
    - description: The action to perform on the application-group.
      name: action
      required: true
      auto: PREDEFINED
      predefined:
      - 'add'
      - 'remove'
      defaultValue: 'add'
    description: Edits an application-group.
    outputs:
    - contextPath: Panorama.ApplicationGroup.Name
      description: The name of the application-group object.
      type: String
    - contextPath: Panorama.ApplicationGroup.Applications
      description: The list of the applications that the application-group has.
      type: Unknown
    - contextPath: Panorama.ApplicationGroup.Members
      description: The number of the applications that are part of the application-group.
      type: Number
  - arguments:
    - description: The name of the application-group to delete. Can be retrieved from the pan-os-list-application-groups command.
      name: name
      required: true
    - description: "The device-group in which the application-group is part of. Only for a Panorama instance."
      name: device-group
    description: Deletes an application-group.
    name: pan-os-delete-application-group
  - arguments:
    - description: Whether to include shared tags in the list.
      name: include_shared_tags
      auto: PREDEFINED
      predefined:
      - 'Yes'
      - 'No'
      defaultValue: 'No'
    - description: "The device group that the tags are part of."
      name: device-group
    description: Returns a list of tags from Panorama.
    name: pan-os-list-tag
    outputs:
    - contextPath: Panorama.Tag.name
      description: The name of the tag.
      type: String
    - contextPath: Panorama.Tag.color
      description: The color of the tag.
      type: String
    - contextPath: Panorama.Tag.comment
      description: The comment in the tag.
      type: String
    - contextPath: Panorama.Tag.disable-override
      description: Whether overriding the tag is disabled.
      type: String
    - contextPath: Panorama.Tag.location
      description: The tag's device group location.
      type: String
  - arguments:
    - description: The name for the new tag to be created.
      name: name
      required: true
    - description: "The device group that the tag will be part of."
      name: device-group
    - description: Whether to disable overriding the tag (Panorama instances).
      name: disable_override
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
      defaultValue: 'false'
    - description: Whether the tag should be generated in a shared location.
      name: is_shared
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
      defaultValue: 'false'
    - description: The comment for the tag.
      name: comment
    description: Creates a new tag in Panorama.
    name: pan-os-create-tag
  - arguments:
    - description: The existing name for the tag to be edited.
      name: name
      required: true
    - description: The new name for the tag to be replaced with.
      name: new_name
    - description: The device group of the tag.
      name: device-group
    - description: Whether to disable overriding the tag (Panorama instances).
      name: disable_override
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
    - description: The comment for the tag.
      name: comment
    description: Edits a tag in Panorama.
    name: pan-os-edit-tag
  - arguments:
    - description: The name of the tag to delete.
      name: name
      required: true
    description: Deletes a tag from Panorama.
    name: pan-os-delete-tag
  - name: pan-os-list-device-groups
    description: 'Returns all device groups from Panorama (use only in Panorama instances).'
    arguments: []
    outputs:
    - contextPath: Panorama.DeviceGroupNames
      description: The list of device groups.
      type: string
  - name: pan-os-export-tech-support-file
    description: 'Exports a tech support file (TSF).'
    arguments:
    - description: The polling interval (in seconds).
      name: interval_in_seconds
      defaultValue: "30"
    - description: "The polling timeout (in seconds)."
      name: timeout
      defaultValue: "1200"
    - description: The job ID to use when polling.
      name: job_id
      hidden: true
    polling: true
  - name: pan-os-list-security-profile-group
    description: Returns a list of security profile groups from Panorama.
    arguments:
    - description: A given group name to return the data for.
      name: group_name
    - description: "The device group that the security profile groups are part of."
      name: device-group
    outputs:
    - contextPath: Panorama.ProfileGroup.name
      description: The name of the group.
      type: String
    - contextPath: Panorama.ProfileGroup.location
      description: The security profile group's device group location.
      type: String
    - contextPath: Panorama.ProfileGroup.virus
      description: The antivirus profile.
      type: String
    - contextPath: Panorama.ProfileGroup.spyware
      description: The anti-spyware profile.
      type: String
    - contextPath: Panorama.ProfileGroup.vulnerability
      description: The vulnerability protection profile.
      type: String
    - contextPath: Panorama.ProfileGroup.url-filtering
      description: The URL filtering profile.
      type: String
    - contextPath: Panorama.ProfileGroup.file-blocking
      description: The file blocking profile.
      type: String
    - contextPath: Panorama.ProfileGroup.data-filtering
      description: The data filtering profile.
      type: String
    - contextPath: Panorama.ProfileGroup.wildfire-analysis
      description: The WildFire analysis profile.
      type: String
    - contextPath: Panorama.ProfileGroup.disable-override
      description: Whether overriding the security profile group is disabled.
      type: String
  - name: pan-os-create-security-profile-group
    description: Creates a new security profile group in Panorama.
    arguments:
    - description: The name of the security profile group.
      name: group_name
      required: true
    - description: The device group that the security profile group will be part of.
      name: device-group
    - description: The antivirus profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: antivirus_profile
    - description: The anti-spyware profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: anti_spyware_profile
    - description: The vulnerability protection profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: vulnerability_protection_profile
    - description: The URL filtering profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: URL_filtering_profile
    - description: The file blocking profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: file_blocking_profile
    - description: The data filtering profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: data_filtering_profile
    - description: The WildFire analysis profile of the group. You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: wildfire_analysis_profile
  - name: pan-os-edit-security-profile-group
    description: Edits the security profile group in Panorama.
    arguments:
    - description: The name of the security profile group to edit.
      name: group_name
      required: true
    - description: The profile to edit in the group.
      name: profile_to_change
      auto: PREDEFINED
      predefined:
      - 'Antivirus Profile'
      - 'Anti-Spyware Profile'
      - 'Vulnerability Protection Profile'
      - 'URL Filtering Profile'
      - 'File Blocking Profile'
      - 'Data Filtering  Profile'
      - 'WildFire Analysis Profile'
      required: true
    - description: The value to set in the profile. If you want the profile value to be empty, set the value to "None". You can get the possible values for this argument by running the pan-os-get-security-profile command.
      name: profile_value
      required: true
    - description: The device group that the security profile group is part of.
      name: device-group
  - name: pan-os-delete-security-profile-group
    description: 'Deletes a security profile group from Panorama.'
    arguments:
    - description: The name of the security profile group to delete.
      name: group_name
      required: true
    - description: The device group that the security profile group is part of.
      name: device-group
  - name: pan-os-get-audit-comment
    description: 'Gets the audit comment of a rule.'
    arguments:
    - description: The rule name to apply.
      name: rule_name
      required: true
    - description: The rule type.
      name: rule_type
      required: true
      auto: PREDEFINED
      predefined:
      - Security Rule
      - NAT Rule
      - PBF Rule
    - description: The pre-rule or post-rule (Panorama instances only).
      name: pre_post
      auto: PREDEFINED
      predefined:
      - Pre
      - Post
    - description: The device group that the rule is part of.
      name: device-group
    outputs:
    - contextPath: Panorama.AuditComment.comment
      description: The audit comment ot the rule.
      type: String
    - contextPath: Panorama.AuditComment.rule_name
      description: The rule name.
      type: String
    - contextPath: Panorama.AuditComment.rule_type
      description: The rule type.
      type: String
  - name: pan-os-add-profile-exception
    description: Add an exception to a Vulnerability Protection profile or Anti Spyware profile.
    arguments:
    - description: The profile name.
      name: profile_name
      required: true
    - description: "The requested threat name/CVE/ID to add."
      name: threat
      required: true
    - description: The profile type.
      name: profile_type
      required: false
      auto: PREDEFINED
      predefined:
      - Vulnerability Protection Profile
      - Anti Spyware Profile
    - description: The action type of the exception. Default value is 'default'.
      name: action
      auto: PREDEFINED
      required: false
      predefined:
      - Alert
      - Allow
      - Block IP
      - Drop
      - Reset Both
      - Reset Client
      - Reset Server
    - description: To configure the firewall to take a packet capture when it detects a threat.
      name: packet_capture
      required: false
      auto: PREDEFINED
      predefined:
      - Disable
      - Single Packet
      - Extended Capture
    - description: An IP address. Configure an exempt IP address to enforce a threat exception only when the associated session has either a matching source or destination IP address; for all other sessions, the threat is enforced based on the default signature action.
      name: exempt_ip
      required: false
    - description: Device group. This will override any configured device group or vsys.
      name: device_group
      required: false
    - description: Specify whether to Track By and block the IP address using the IP source or the IP source and destination. If action = Block IP , this argument is mandatory.
      name: ip_track_by
      required: false
      auto: PREDEFINED
      predefined:
      - Source
      - Source And Destination
    - description: Specify the time period (in seconds) after which to trigger the action. If action = Block IP , this argument is mandatory.
      name: ip_duration_sec
      required: false
  - name: pan-os-edit-profile-exception
    description: Edit an exception to a Vulnerability Protection profile or Anti Spyware profile.
    arguments:
    - description: The profile name.
      name: profile_name
      required: true
    - description: "The requested threat name/CVE/ID to edit."
      name: threat
      required: true
    - description: The profile type.
      name: profile_type
      required: false
      auto: PREDEFINED
      predefined:
      - Vulnerability Protection Profile
      - Anti Spyware Profile
    - description: The action type of the exception. Default value is 'default'.
      name: action
      required: false
      auto: PREDEFINED
      predefined:
      - Alert
      - Allow
      - Block IP
      - Drop
      - Reset Both
      - Reset Client
      - Reset Server
    - description: To configure the firewall to take a packet capture when it detects a threat.
      name: packet_capture
      required: false
      auto: PREDEFINED
      predefined:
      - Disable
      - Single Packet
      - Extended Capture
    - description: An IP address. Configure an exempt IP address to enforce a threat exception only when the associated session has either a matching source or destination IP address; for all other sessions, the threat is enforced based on the default signature action.
      name: exempt_ip
      required: false
    - description: Device group. This will override any configured device group or vsys.
      name: device_group
      required: false
    - description: Specify whether to Track By and block the IP address using the IP source or the IP source and destination. If action = Block IP , this argument is mandatory.
      name: ip_track_by
      required: false
      auto: PREDEFINED
      predefined:
      - Source
      - Source And Destination
    - description: Specify the time period (in seconds) after which to trigger the action. If action = Block IP , this argument is mandatory.
      name: ip_duration_sec
      required: false
  - name: pan-os-delete-profile-exception
    description: Delete an exception to a Vulnerability Protection profile or Anti Spyware profile.
    arguments:
    - description: The profile name.
      name: profile_name
      required: true
    - description: "The requested threat name/CVE/ID to delete."
      name: threat
      required: true
    - description: The profile type.
      name: profile_type
      required: false
      auto: PREDEFINED
      predefined:
      - Vulnerability Protection Profile
      - Anti Spyware Profile
  - name: pan-os-list-profile-exception
    description: List the exceptions in a Vulnerability Protection profile or Anti Spyware profile.
    arguments:
    - description: The profile name.
      name: profile_name
      required: true
    - description: The profile type.
      name: profile_type
      required: false
      auto: PREDEFINED
      predefined:
      - Vulnerability Protection Profile
      - Anti Spyware Profile
    outputs:
    - contextPath: Panorama.Vulnerability.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.name
      description: The exception name.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.id
      description: The exception ID.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.CVE
      description: The exception CVE if exist.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.action
      description: The exception action.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.exempt-id
      description: The exception exempt ID.
      type: String
    - contextPath: Panorama.Vulnerability.Exception.packet-capture
      description: The exception packet capture.
      type: String
    - contextPath: Panorama.Spyware.Name
      description: The profile name.
      type: String
    - contextPath: Panorama.Spyware.Exception.name
      description: The exception name.
      type: String
    - contextPath: Panorama.Spyware.Exception.id
      description: The exception ID.
      type: String
    - contextPath: Panorama.Spyware.Exception.CVE
      description: The exception CVE if exist.
      type: String
    - contextPath: Panorama.Spyware.Exception.action
      description: The exception action.
      type: String
    - contextPath: Panorama.Spyware.Exception.exempt-id
      description: The exception exempt ID.
      type: String
    - contextPath: Panorama.Spyware.Exception.packet-capture
      description: The exception packet capture.
      type: String
  - arguments:
    - description: The string by which to filter the results to only show specific hostnames or serial numbers.
      name: device_filter_string
    - description: The target number of the firewall. Used only on a Panorama instance.
      name: target
    - auto: PREDEFINED
      defaultValue: security
      description: The firewall rulebase to check.
      name: rulebase
      predefined:
      - application-override
      - authentication
      - decryption
      - dos
      - nat
      - network-packet-broker
      - pbf
      - qos
      - sdwan
      - security
      - tunnel-inspect
    - defaultValue: all
      description: The firewall VSYS name to check.  Returns results for all VSYSs if left blank.
      name: vsys
    - defaultValue: all
      description: Comma-separated list of rule names to check.  Returns results for all rules if left blank.
      isArray: true
      name: rules
    - auto: PREDEFINED
      defaultValue: 'false'
      description: If set to true, only returns rules with a hit count of 0.
      name: unused_only
      predefined:
      - 'true'
      - 'false'
    - description: Shows rules that have had hits, but not after the date provided (in the format YYYY/MM/DD HH:MM:SS).
      name: no_new_hits_since
    - description: The pre-rule or post-rule (Panorama instances only). When set, only rules pushed from Panorama at the specified position are returned.
      name: pre_post
      auto: PREDEFINED
      predefined:
      - pre-rulebase
      - post-rulebase
    description: Gets rule hit counts from the firewall.  When connected to Panorama this command can be run on any firewall managed by it.
    name: pan-os-get-rule-hitcounts
    outputs:
    - contextPath: PANOS.RuleHitCount.first_hit_timestamp
      description: Timestamp when the rule was first hit.
      type: Date
    - contextPath: PANOS.RuleHitCount.from_dg_name
      description: Name of the device group the rule is inherited from.
      type: String
    - contextPath: PANOS.RuleHitCount.hit_count
      description: Number of hits for the rule.
      type: Number
    - contextPath: PANOS.RuleHitCount.hostid
      description: Serial number of the firewall the entry was fetched from.
      type: String
    - contextPath: PANOS.RuleHitCount.instanceName
      description: Name of the PAN-OS Integration Instance used to fetch the entry.
      type: String
    - contextPath: PANOS.RuleHitCount.instanceType
      description: The type of the PAN-OS Integration Instance running the command (Panorama or firewall).
      type: String
    - contextPath: PANOS.RuleHitCount.is_from_panorama
      description: Indicates if the rule was pushed from Panorama (true) or is local to the firewall (false).
      type: Boolean
    - contextPath: PANOS.RuleHitCount.last_hit_timestamp
      description: Timestamp when the rule was most recently hit.
      type: Date
    - contextPath: PANOS.RuleHitCount.last_reset_timestamp
      description: Timestamp when hit count data was last reset.
      type: Date
    - contextPath: PANOS.RuleHitCount.latest
      description: Value of the `latest` property returned by the API.
      type: String
    - contextPath: PANOS.RuleHitCount.name
      description: Name of the rule.
      type: String
    - contextPath: PANOS.RuleHitCount.position
      description: Indicates the position of the rule pushed from Panorama (pre_rulebase or post_rulebase).
      type: String
    - contextPath: PANOS.RuleHitCount.rule_creation_timestamp
      description: Timestamp when the rule was created.
      type: Date
    - contextPath: PANOS.RuleHitCount.rule_modification_timestamp
      description: Timestamp when the rule was most recently modified.
      type: Date
    - contextPath: PANOS.RuleHitCount.rulebase
      description: The rulebase of the rule (security, nat, and so on).
      type: String
    - contextPath: PANOS.RuleHitCount.vsys
      description: The name of the firewall VSYS.
      type: String
  - name: pan-os-get-master-key-details
    description: Show the details of the default master key that encrypts all the private keys and passwords in the configuration.
    outputs:
    - contextPath: Panorama.MasterKey.auto-renew-mkey
      type: String
      description: Whether the master key will be automatically renewed on expiry.
    - contextPath: Panorama.MasterKey.expire-at
      type: String
      description: The date and time when the key is set to expire.
    - contextPath: Panorama.MasterKey.hours-to-expiry
      type: String
      description: The number of hours remaining before the key expires.
    - contextPath: Panorama.MasterKey.hours-to-reminder
      type: String
      description: The number of hours remaining before being notified that the key is set to expire.
    - contextPath: Panorama.MasterKey.minutes-to-expiry
      type: String
      description: The number of minutes remaining before the key expires.
    - contextPath: Panorama.MasterKey.minutes-to-reminder
      type: String
      description: The number of minutes remaining before being notified that the key is set to expire.
    - contextPath: Panorama.MasterKey.on-hsm
      type: String
      description: Whether the master key is encrypted using a key stored on a Hardware Security Module (HSM).
    - contextPath: Panorama.MasterKey.remind-at
      type: String
      description: The date and time when to be notified that the key is set to expire.
    - contextPath: Panorama.MasterKey.seconds-to-expiry
      type: String
      description: The number of seconds remaining before the key expires.
    - contextPath: Panorama.MasterKey.seconds-to-reminder
      type: String
      description: The number of seconds remaining before being notified that the key is set to expire.
  - name: pan-os-create-master-key
    description: 'Create a default master key that encrypts all the private keys and passwords in the configuration. This command is harmful because it invalidates the current API key and requires re-configuration of the integration instance.'
    execution: true  # This command is harmful
    arguments:
    - description: The encryption master key. Must be exactly 16 characters.
      name: master_key
      type: String
      required: true
      isArray: false
    - description: The lifetime of the key in hours.
      name: lifetime_in_hours
      type: Number
      required: true
      isArray: false
    - description: The time to be notified of the key's expiration in hours.
      name: reminder_in_hours
      type: Number
      required: true
      isArray: false
  - name: pan-os-update-master-key
    description: 'Update the default master key that encrypts all the private keys and passwords in the configuration. This command is harmful because it invalidates the current API key and requires re-configuration of the integration instance.'
    execution: true  # This command is harmful
    arguments:
    - description: The new encryption master key. Must be exactly 16 characters.
      name: new_master_key
      type: String
      required: true
      isArray: false
    - description: The current encryption master key.
      name: current_master_key
      type: String
      required: true
      isArray: false
    - description: The lifetime of the new key in hours.
      name: lifetime_in_hours
      type: Number
      required: true
      isArray: false
    - description: The time to be notified of new the new key's expiration in hours.
      name: reminder_in_hours
      type: Number
      required: true
      isArray: false
  - name: pan-os-get-certificate-info
    description: Gathers the name, expiration date, and expiration status of certificates configured locally on a Firewall or pushed from Panorama, as seen under Certificate Management.
    arguments:
    - description: Show only expired certificates.
      name: show_expired_only
      type: Boolean
    outputs:
    - contextPath: Panorama.Certificate.name
      type: String
      description: Name of the certificate.
    - contextPath: Panorama.Certificate.device
      type: String
      description: Device where this certificate was found.
    - contextPath: Panorama.Certificate.subject
      type: String
      description: Subject of the certificate.
    - contextPath: Panorama.Certificate.expiration_date
      type: String
      description: Expiration date of the certificate.
    - contextPath: Panorama.Certificate.expiration_status
      type: String
      description: Status of certificate - Expired, Expiring in 30 days, Expiring in 60 days, Expiring in 90 days or Valid.
    - contextPath: Panorama.Certificate.location
      type: String
      description: Where this certificate was configured - Firewall or Panorama.
    - contextPath: Panorama.Certificate.cert_type
      type: String
      description: Whether this certificate was pushed from Panorama, Local to Firewall, or predefined on Panorama or a Firewall.
    - contextPath: Panorama.Certificate.devices_using_certificate
      type: Unknown
      description: List of devices using this certificate if it was pushed from Panorama.
  dockerimage: demisto/pan-os-python:1.0.0.10133006
  isfetch: true
  runonce: false
  script: ''
  subtype: python3
  type: python
fromversion: 5.0.0
tests:
- palo_alto_firewall_test_pb
- palo_alto_panorama_test_pb
- PAN-OS-firewall-topology-test-pb
- PAN-OS-panorama-topology-test-pb
- test_playbook_pan_os_firewall_exceptions_commands
defaultmapperin: Panorama Mapper
defaultclassifier: Panorama Classifier