Class: Jamf::OAPISchemas::MacOsManagedSoftwareUpdate

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb

Overview

OAPI Object Model and Enums for: MacOsManagedSoftwareUpdate

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.46.0-t1681398190

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/macos-managed-software-updates/send-updates:POST' needs permissions:
  - Send Computer Remote Command to Download and Install OS X Update

Constant Summary collapse

UPDATE_ACTION_OPTIONS =

Enums used by this class or others

[
  'DOWNLOAD_AND_INSTALL',
  'DOWNLOAD_ONLY'
]
PRIORITY_OPTIONS = 
[
  'HIGH',
  'LOW'
]
OAPI_PROPERTIES = 
{

  # @!attribute deviceIds
  #   @return [Array<String>]
  deviceIds: {
    class: :string,
    multi: true
  },

  # @!attribute groupId
  #   @return [String]
  groupId: {
    class: :string
  },

  # Allow users to defer the update the provided number of times before macOS forces the update. If a value is provided, the Software Update will use the InstallLater install action.
  # @!attribute maxDeferrals
  #   @return [Integer]
  maxDeferrals: {
    class: :integer,
    minimum: 0
  },

  # If no value is provided, the version will default to latest version based on device eligibility.
  # @!attribute version
  #   @return [String]
  version: {
    class: :string
  },

  # If no value is provided, the skipVersionVerification will default to false. If a value is provided, the specified version will be forced to complete DownloadAndInstall install action.
  # @!attribute skipVersionVerification
  #   @return [Boolean]
  skipVersionVerification: {
    class: :boolean
  },

  # ApplyMajorUpdate setting is available only when updating to the latest version based on device eligibility. If no value is provided, the calculated latest version will only include minor version updates. If a value is provided, the calculated latest version will include minor and major version updates.
  # @!attribute applyMajorUpdate
  #   @return [Boolean]
  applyMajorUpdate: {
    class: :boolean
  },

  # MaxDeferral is ignored if using the DownloadOnly install action.
  # @!attribute updateAction
  #   @return [String]
  updateAction: {
    class: :string,
    enum: UPDATE_ACTION_OPTIONS
  },

  # If not set, forceRestart will default to false. Can only be true if using the DownloadAndInstall install action and the devices the command is sent to are on macOs 11 or higher. If true, the DownloadAndInstall action is performed, a restart will be forced. MaxDeferral will be ignored if defined. 
  # @!attribute forceRestart
  #   @return [Boolean]
  forceRestart: {
    class: :boolean
  },

  # Priority can only be configured on macOS 12.3 and above, for minor updates only. Any version below 12.3 is always Low and cannot be changed until prerequisites are met. When qualified, if not explicitly set, priority will default to High
  # @!attribute priority
  #   @return [String]
  priority: {
    class: :string,
    enum: PRIORITY_OPTIONS
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#applyMajorUpdate ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 115

#deviceIds ⇒ Array<String>

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 80

#forceRestart ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 130

#groupId ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 87

#maxDeferrals ⇒ Integer

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 93

#priority ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 137

#skipVersionVerification ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 108

#updateAction ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 122

#version ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/mac_os_managed_software_update.rb', line 101