Clarify OS update enforcement details in REST API docs (#23464)
This applies some consistency fixes as well (e.g. noting that Mac/Win enforcement requires MDM). Also removed mention of MDM on iOS/iPadOS enforcement as if an iOS/iPadOS host is enrolled, it's enrolled via MDM. See #21998
This commit is contained in:
Ian Littman
+14
-14
@@ -1725,8 +1725,8 @@ _Available in Fleet Premium._
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| minimum_version | string | Hosts that belong to no team will be nudged until their macOS is at or above this version. |
|
||||
| deadline | string | Hosts that belong to no team won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | Hosts that belong to no team and are enrolled into Fleet's MDM will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | Hosts that belong to no team and are enrolled into Fleet's MDM will be forced to update their OS after this deadline (noon local time for hosts already on macOS 14 or above, 20:00 UTC for hosts on earlier macOS versions). |
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -1738,8 +1738,8 @@ _Available in Fleet Premium._
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| minimum_version | string | Hosts that belong to no team and are enrolled into Fleet's MDM will be nudged until their iOS is at or above this version. |
|
||||
| deadline | string | Hosts that belong to no team and are enrolled into Fleet's MDM won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | Hosts that belong to no team will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | Hosts that belong to no team will be forced to update their OS after this deadline (noon local time). |
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -1751,8 +1751,8 @@ _Available in Fleet Premium._
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| minimum_version | string | Hosts that belong to no team and are enrolled into Fleet's MDM will be nudged until their iPadOS is at or above this version. |
|
||||
| deadline | string | Hosts that belong to no team and are enrolled into Fleet's MDM won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | Hosts that belong to no team will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | Hosts that belong to no team will be forced to update their OS after this deadline (noon local time). |
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -1764,8 +1764,8 @@ _Available in Fleet Premium._
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| deadline_days | integer | Hosts that belong to no team will have this number of days before updates are installed on Windows. |
|
||||
| grace_period_days | integer | Hosts that belong to no team will have this number of days before Windows restarts to install updates. |
|
||||
| deadline_days | integer | Hosts that belong to no team and are enrolled into Fleet's MDM will have this number of days before updates are installed on Windows. |
|
||||
| grace_period_days | integer | Hosts that belong to no team and are enrolled into Fleet's MDM will have this number of days before Windows restarts to install updates. |
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -10420,14 +10420,14 @@ _Available in Fleet Premium_
|
||||
| enable_failing_policies | boolean | body | Whether or not that Zendesk integration is enabled for failing policies. Only one failing policy automation can be enabled at a given time (enable_failing_policies_webhook and enable_failing_policies). |
|
||||
| mdm | object | body | MDM settings for the team. |
|
||||
| macos_updates | object | body | macOS updates settings. |
|
||||
| minimum_version | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM will be nudged until their macOS is at or above this version. |
|
||||
| deadline | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM will be forced to update their OS after this deadline (noon local time for hosts already on macOS 14 or above, 20:00 UTC for hosts on earlier macOS versions). |
|
||||
| ios_updates | object | body | iOS updates settings. |
|
||||
| minimum_version | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM will be nudged until their iOS is at or above this version. |
|
||||
| deadline | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | body | Hosts that belong to this team will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | body | Hosts that belong to this team will be forced to update their OS after this deadline (noon local time). |
|
||||
| ipados_updates | object | body | iPadOS updates settings. |
|
||||
| minimum_version | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM will be nudged until their iPadOS is at or above this version. |
|
||||
| deadline | string | body | Hosts that belong to this team and are enrolled into Fleet's MDM won't be able to dismiss the Nudge window once this deadline is past. |
|
||||
| minimum_version | string | body | Hosts that belong to this team will be prompted to update when their OS is below this version. |
|
||||
| deadline | string | body | Hosts that belong to this team will be forced to update their OS after this deadline (noon local time). |
|
||||
| windows_updates | object | body | Windows updates settings. |
|
||||
| deadline_days | integer | body | Hosts that belong to this team and are enrolled into Fleet's MDM will have this number of days before updates are installed on Windows. |
|
||||
| grace_period_days | integer | body | Hosts that belong to this team and are enrolled into Fleet's MDM will have this number of days before Windows restarts to install updates. |
|
||||
|
||||
Reference in New Issue
Block a user