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.36.1-t1645562643

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'
]
OAPI_PROPERTIES = 
{

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

  # 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
  },

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

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#deviceIds ⇒ Array<String>

Returns:




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

#maxDeferrals ⇒ Integer

Returns:

  • (Integer) 



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

#updateAction ⇒ String

Returns:




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

#version ⇒ String

Returns:




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