Class: Jamf::ClientCheckInSettings

Inherits:

SingletonResource

• Object
• JSONObject
• Resource
• SingletonResource
• Jamf::ClientCheckInSettings

Extended by:

ChangeLog

Includes:

ChangeLog

Defined in:

lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb

Overview

The client checkin settings for the Jamf Pro Server

Constant Summary

UPDATABLE =

Constants

true

RSRC_VERSION =

'v1'.freeze

RSRC_PATH =

'check-in'.freeze

OBJECT_MODEL =

{

  # @!attribute checkInFrequency
  #   @return [integer]
  checkInFrequency: {
    class: :integer
  },

  # @!attribute isCreateHooks
  #   @return [Boolean]
  isCreateHooks: {
    class: :boolean
  },

  # @!attribute isHookLog
  #   @return [Boolean]
  isHookLog: {
    class: :boolean
  },

  # @!attribute isHookPolicies
  #   @return [Boolean]
  isHookPolicies: {
    class: :boolean
  },

  # @!attribute isHookHideRestore
  #   @return [Boolean]
  isHookHideRestore: {
    class: :boolean
  },

  # @!attribute isHookMCX
  #   @return [Boolean]
  isHookMCX: {
    class: :boolean
  },

  # @!attribute isBackgroundHooks
  #   @return [Boolean]
  isBackgroundHooks: {
    class: :boolean
  },

  # @!attribute isHookDisplayStatus
  #   @return [Boolean]
  isHookDisplayStatus: {
    class: :boolean
  },

  # @!attribute isCreateStartupScript
  #   @return [Boolean]
  isCreateStartupScript: {
    class: :boolean
  },

  # @!attribute isStartupLog
  #   @return [Boolean]
  isStartupLog: {
    class: :boolean
  },

  # @!attribute isStartupPolicies
  #   @return [Boolean]
  isStartupPolicies: {
    class: :boolean
  },

  # @!attribute isStartupSSH
  #   @return [Boolean]
  isStartupSSH: {
    class: :boolean
  },

  # @!attribute isStartupMCX
  #   @return [Boolean]
  isStartupMCX: {
    class: :boolean
  },

  # @!attribute isEnableLocalConfigurationProfiles
  #   @return [Boolean]
  isEnableLocalConfigurationProfiles: {
    class: :boolean
  }

}.freeze

Instance Attribute Summary

• #checkInFrequency ⇒ integer
• #isBackgroundHooks ⇒ Boolean
• #isCreateHooks ⇒ Boolean
• #isCreateStartupScript ⇒ Boolean
• #isEnableLocalConfigurationProfiles ⇒ Boolean
• #isHookDisplayStatus ⇒ Boolean
• #isHookHideRestore ⇒ Boolean
• #isHookLog ⇒ Boolean
• #isHookMCX ⇒ Boolean
• #isHookPolicies ⇒ Boolean
• #isStartupLog ⇒ Boolean
• #isStartupMCX ⇒ Boolean
• #isStartupPolicies ⇒ Boolean
• #isStartupSSH ⇒ Boolean

Class Method Summary

• .add_change_log_note(note, cnx: Jamf.cnx) ⇒ void extended from ChangeLog

  Add a note to this resource’s change log.

• .change_log(refresh = false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeHistoryEntry> extended from ChangeLog

  The change and note history for this resource.

Instance Method Summary

• #add_change_log_note(note, cnx: Jamf.cnx) ⇒ void included from ChangeLog

  Add a note to this resource’s change log.

• #change_log(refresh = false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeHistoryEntry> included from ChangeLog

  The change and note history for this resource.

Constructor Details

This class inherits a constructor from Jamf::JSONObject

Instance Attribute Details

#checkInFrequency ⇒ integer

Returns:

• (integer)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 49

#isBackgroundHooks ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 85

#isCreateHooks ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 55

#isCreateStartupScript ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 97

#isEnableLocalConfigurationProfiles ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 127

#isHookDisplayStatus ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 91

#isHookHideRestore ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 73

#isHookLog ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 61

#isHookMCX ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 79

#isHookPolicies ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 67

#isStartupLog ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 103

#isStartupMCX ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 121

#isStartupPolicies ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 109

#isStartupSSH ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb', line 115

Class Method Details

.add_change_log_note(note, cnx: Jamf.cnx) ⇒ void Originally defined in module ChangeLog

This method returns an undefined value.

Add a note to this resource’s change log.

If the change history has been cached already, it is recached after adding the note.

Parameters:

• note (String) —

  The note to add. It cannot be empty.

.change_log(refresh = false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeHistoryEntry> Originally defined in module ChangeLog

The change and note history for this resource.

The history is cached internally and only re-fetched when a truthy parameter is given.

Parameters:

• refresh (Boolean) (defaults to: false) —

  re-fetch and re-cache the history

Returns:

• (Array<Jamf::ChangeHistoryEntry>) —

  The change and note history for this resource

Instance Method Details

#add_change_log_note(note, cnx: Jamf.cnx) ⇒ void Originally defined in module ChangeLog

This method returns an undefined value.

Add a note to this resource’s change log.

If the change history has been cached already, it is recached after adding the note.

Parameters:

• note (String) —

  The note to add. It cannot be empty.

#change_log(refresh = false, cnx: Jamf.cnx) ⇒ Array<Jamf::ChangeHistoryEntry> Originally defined in module ChangeLog

The change and note history for this resource.

The history is cached internally and only re-fetched when a truthy parameter is given.

Parameters:

• refresh (Boolean) (defaults to: false) —

  re-fetch and re-cache the history

Returns:

• (Array<Jamf::ChangeHistoryEntry>) —

  The change and note history for this resource