JamfMSUPlanUploader

JamfMSUPlanUploader

Description

A processor for AutoPkg that will create a Managed Software Update Plan. Currently restricted to the DOWNLOAD_INSTALL_SCHEDULE plan type (the only DDM plan available in Jamf Pro).

Input variables

• JSS_URL:
  • required: True
  • description: URL to a Jamf Pro server that the API user has write access to, optionally set as a key in the com.github.autopkg preference file.
• API_USERNAME:
  • required: False
  • description: Username of account with appropriate access to jss, optionally set as a key in the com.github.autopkg preference file.
• API_PASSWORD:
  • required: False
  • description: Password of api user, optionally set as a key in the com.github.autopkg preference file.
• CLIENT_ID:
  • required: False
  • description: Client ID with access to access to jss, optionally set as a key in the com.github.autopkg preference file.
• CLIENT_SECRET:
  • required: False
  • description: Secret associated with the Client ID, optionally set as a key in the com.github.autopkg preference file.
• BEARER_TOKEN:
  • required: False
  • description: A pre-existing bearer token for the Jamf Pro API. If provided, the token will be validated and used directly, bypassing credential-based authentication.
• JAMF_CLI_PROFILE:
  • required: False
  • description: A jamf-cli profile to use to obtain a bearer token. Requires jamf-cli to be installed and in the PATH. Set to a profile name to enable.
  • default: ""
• PLATFORM_API_REGION:
  • required: False
  • description: Region for Jamf Platform API Gateway (e.g., 'us1', 'eu1', 'au1'). Required for Platform API authentication.
  • default: ""
• PLATFORM_API_TENANT_ID:
  • required: False
  • description: Tenant ID for Jamf Platform API Gateway. Required for Platform API authentication.
  • default: ""
• device_type:
  • required: False
  • description: Device type, must be one of 'computer', 'mobile-device', 'apple-tv' (case-insensitive).
• group_name:
  • required: True
  • description: Name of the target computer group or mobile device group.
• version:
  • required: False
  • description: OS Version to deploy, must be one of 'latest-minor', 'latest-major', 'latest-any', or a valid specific version string for the OS to be applied.
• days_until_force_install:
  • required: False
  • description: Days until forced installation of planned managed software update.
  • default: 7
• sleep:
  • required: False
  • description: Pause after running this processor for specified seconds.
  • default: "0"
• max_tries:
  • required: False
  • description: Maximum number of attempts to upload the account. Must be an integer between 1 and 10.
  • default: "5"
• dry_run:
  • required: False
  • description: If True, perform read-only checks and report what would change without making any writes.
  • default: False
• skip_if:
  • required: False
  • description: Skip the process if a supplied predicate is met.

Output variables

• jamfmsuplanuploader_summary_result:
  • description: Description of interesting results.
• device_type:
  • description: Device type.
• version_type:
  • description: Version type, one of 'latest_minor', 'latest_major', 'latest_any', or 'specific_version'.
• specific_version:
  • description: Specific version, if 'version_type' is set to 'specific_version'.
• force_install_local_datetime:
  • description: The date and time of the plan's forced installation deadline.
• process_skipped:
  • description: Boolean - True if the process was skipped due to skip_if predicate resolved to True.
• dry_run_summary_result:
  • description: Summary of what would have been changed (only set when dry_run is True).