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.

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": [
        {
            "aboutUpdateURL": "https://support.apple.com/en-us/HT211896",
            "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"
            ]
        }
    ]
}