Processor CURLTextSearcher - autopkg/autopkg GitHub Wiki

CURLTextSearcher

[!NOTE] This page is automatically generated by GitHub Actions when a new release is tagged. Updates to the information on this page should be submitted as pull requests to the AutoPkg repository. Processors are located here.

Description

Downloads a URL using curl and performs a regular expression match on the text.

Introduced in AutoPkg version 0.5.1.

[!WARNING] This processor was deprecated in AutoPkg version 0.6.0 and may be removed in a future release.

Input Variables

  • re_pattern:
    • required: True
    • description: Regular expression (Python) to match against page.
  • url:
    • required: True
    • description: URL to search for the regex pattern.
  • result_output_var_name:
    • required: False
    • description: The name of the output variable that is returned by the match. If not specified then a default of "match" will be used.
    • default: match
  • request_headers:
    • required: False
    • description: Optional dictionary of headers to include with the download request.
  • curl_opts:
    • required: False
    • description: Optional array of curl options to include with the download request.
  • re_flags:
    • required: False
    • description: Optional array of strings of Python regular expression flags. E.g. IGNORECASE.

Output Variables

  • result_output_var_name:
    • description: First matched sub-pattern from input found on the fetched URL. Note the actual name of variable depends on the input variable "result_output_var_name" or is assigned a default of "match."