osVersionRequirements

osVersionRequirements - Type: Array, Default Value: []

The required components necessary to enforce an Operating System version through Nudge.

Specify one array to enforce a single Operating System version across all machines or specify multiple arrays for specific enforcements.

aboutUpdateURL - Type: String, Default Value: None, Required: No

A single URL, enabling the More Info button URL path.

Note: If this value is passed with aboutUpdateURLs, the aboutUpdateURLs key will be ignored.

aboutUpdateURLs - Type: Array, Default Value: [], Required: No

A list of arrays, enabling localization of the More Info button URL path. Please see the aboutUpdateURLs wiki article for more information.

Note: If this value is not passed, the more_info button will be hidden.

majorUpgradeAppPath - Type: String, Default Value: "", Required: No

The app path for a major upgrade.

Note: This logic is not fully written as it cannot be tested until the next major Operating System is released. A future version of Nudge will finalize support for this feature.

requiredInstallationDate - Type: String, Default Value: "", Required: Yes

The required installation date for Nudge to enforce the required operating system version.

You must follow standard a date string as YYYY-MM-DDTHH:MM:SSZ - Example: "2021-01-31T00:00:00Z"

requiredMinimumOSVersion - Type: String, Default Value: "", Required: Yes

The required minimum operating system version.

Note: When passing versions such as 11.2.0 it will be normalized to 11.2. It is recommended to leave the trailing zero from the version number.

targetedOSVersions - Type: Array, Default Value: []

The versions of macOS that require a security update.

You can specify single version or multiple versions, but they must be within an array.

Examples:

"targetedOSVersions": [
  "11.0"
]

"targetedOSVersions": [
  "11.0",
  "11.0.1",
  "11.1",
  "11.2"
]

Example (JSON)

{
    "osVersionRequirements": [
      {
        "aboutUpdateURLs": [
          {
            "_language": "en",
            "aboutUpdateURL": "https://support.apple.com/en-us/HT211896#macos112"
          }
        ],
        "majorUpgradeAppPath": "/Applications/Install macOS Big Sur.app",
        "requiredInstallationDate": "2021-02-28T00:00:00Z",
        "requiredMinimumOSVersion": "11.2.1",
        "targetedOSVersions": [
          "11.0",
          "11.0.1",
          "11.1",
          "11.2"
        ]
      }
    ]
}

{
  "osVersionRequirements": [
    {
      "aboutUpdateURLs": [
        {
          "_language": "en",
          "aboutUpdateURL": "https://support.apple.com/en-us/HT211896#macos112"
        },
        {
          "_language": "es",
          "aboutUpdateURL": "https://support.apple.com/es-es/HT211896#macos112"
        },
        {
          "_language": "fr",
          "aboutUpdateURL": "https://support.apple.com/fr-fr/HT211896#macos112"
        }
      ],
      "majorUpgradeAppPath": "/Applications/Install macOS Big Sur.app",
      "requiredInstallationDate": "2021-02-28T00:00:00Z",
      "requiredMinimumOSVersion": "11.2",
      "targetedOSVersions": [
        "11.0",
        "11.0.1",
        "11.1"
      ]
    },
    {
      "aboutUpdateURLs": [
        {
          "_language": "en",
          "aboutUpdateURL": "https://support.apple.com/en-us/HT211896#macos1121"
        },
        {
          "_language": "es",
          "aboutUpdateURL": "https://support.apple.com/es-es/HT211896"
        },
        {
          "_language": "fr",
          "aboutUpdateURL": "https://support.apple.com/fr-fr/HT211896"
        }
    ],
      "majorUpgradeAppPath": "/Applications/Install macOS Big Sur.app",
      "requiredInstallationDate": "2021-02-28T00:00:00Z",
      "requiredMinimumOSVersion": "11.2.1",
      "targetedOSVersions": [
        "11.2"
      ]
    }
  ]
}

Example (Mobile Configuration)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>PayloadContent</key>
    <array>
      <dict>
        <key>PayloadDescription</key>
        <string>Configures osVersionRequirements preferences</string>
        <key>PayloadDisplayName</key>
        <string>Nudge Preferences</string>
        <key>PayloadIdentifier</key>
        <string>com.github.macadmins.Nudge.preferences.example.osVersionRequirements</string>
        <key>PayloadOrganization</key>
        <string></string>
        <key>PayloadType</key>
        <string>com.github.macadmins.Nudge</string>
        <key>PayloadUUID</key>
        <string>CA02957C-7472-446B-9F77-3E0414405556</string>
        <key>PayloadVersion</key>
        <integer>1</integer>
        <key>osVersionRequirements</key>
        <array>
          <dict>
            <key>aboutUpdateURLs</key>
            <array>
              <dict>
                <key>_language</key>
                <string>en</string>
                <key>aboutUpdateURL</key>
                <string>https://support.apple.com/en-us/HT211896#macos1121</string>
              </dict>
              <dict>
                <key>_language</key>
                <string>es</string>
                <key>aboutUpdateURL</key>
                <string>https://support.apple.com/es-es/HT211896</string>
              </dict>
              <dict>
                <key>_language</key>
                <string>fr</string>
                <key>aboutUpdateURL</key>
                <string>https://support.apple.com/fr-fr/HT211896</string>
              </dict>
              <dict>
                <key>_language</key>
                <string>de</string>
                <key>aboutUpdateURL</key>
                <string>https://support.apple.com/de-de/HT211896</string>
              </dict>
            </array>
            <key>majorUpgradeAppPath</key>
            <string>/Applications/Install macOS Big Sur.app</string>
            <key>requiredInstallationDate</key>
            <date>2021-02-28T00:00:00Z</date>
            <key>requiredMinimumOSVersion</key>
            <string>11.2.1</string>
            <key>targetedOSVersions</key>
            <array>
              <string>11.0</string>
              <string>11.0.1</string>
              <string>11.1</string>
              <string>11.2</string>
            </array>
          </dict>
      </dict>
    </array>
    <key>PayloadDescription</key>
    <string>Configures Nudge application</string>
    <key>PayloadDisplayName</key>
    <string>Nudge</string>
    <key>PayloadIdentifier</key>
    <string>com.github.macadmins.Nudge.example.osVersionRequirements</string>
    <key>PayloadOrganization</key>
    <string>Nudge</string>
    <key>PayloadScope</key>
    <string>System</string>
    <key>PayloadType</key>
    <string>Configuration</string>
    <key>PayloadUUID</key>
    <string>2F54F734-132D-4539-B583-F1DCF23DB5EB</string>
    <key>PayloadVersion</key>
    <integer>1</integer>
  </dict>
</plist>