Class: JSS::OSXConfigurationProfile

Inherits:
APIObject show all
Includes:
Scopable, SelfServable, Updatable
Defined in:
lib/jss/api_object/osx_configuration_profile.rb,
lib/jss.rb

Overview

An OS X Configuration Profile in the JSS.

Note that the profile payloads and the profile UUID cannot be edited or updated with this via this class. Use the web UI.

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

"osxconfigurationprofiles"
RSRC_LIST_KEY =

the hash key used for the JSON list output of all objects in the JSS

:os_x_configuration_profiles
RSRC_OBJECT_KEY =

The hash key used for the JSON object output. It’s also used in various error messages

:os_x_configuration_profile
VALID_DATA_KEYS =

these keys, as well as :id and :name, are present in valid API JSON data for this class

[:distribution_method, :scope, :redeploy_on_update]
SCOPE_TARGET_KEY =

Our scopes deal with computers

:computers
SELF_SERVICE_TARGET =

Our SelfService happens on OSX

:osx
SELF_SERVICE_PAYLOAD =

Our SelfService deploys profiles

:profile
DISTRIBUTION_METHODS =

The possible values for the :distribution_method

["Install Automatically", "Make Available in Self Service"]
SELF_SERVICE_DIST_METHOD = 
"Make Available in Self Service"
LEVELS =

The possible values for :level

["user", "computer"]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ OSXConfigurationProfile

See JSS::APIObject#initialize



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 133

def initialize (args = {})

  super

  @description = @main_subset[:description]
  @distribution_method = @main_subset[:distribution_method]
  @user_removable = @main_subset[:user_removable]
  @level = @main_subset[:level]
  @uuid = @main_subset[:uuid]
  @redeploy_on_update = @main_subset[:redeploy_on_update]
  @payloads = @main_subset[:payloads]
end

Instance Attribute Details

#description ⇒ String 



106
107
108
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 106

def description
  @description
end

#distribution_method ⇒ String 



109
110
111
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 109

def distribution_method
  @distribution_method
end

#icon ⇒ JSS::Icon? Also known as: self_service_icon Originally defined in module SelfServable

#in_self_service ⇒ Boolean (readonly) Also known as: in_self_service? Originally defined in module SelfServable

#level ⇒ String 



115
116
117
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 115

def level
  @level
end

#need_to_update ⇒ Boolean (readonly) Originally defined in module Updatable

#payloads ⇒ String (readonly) 



124
125
126
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 124

def payloads
  @payloads
end

#redeploy_on_update ⇒ Boolean (readonly) 



121
122
123
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 121

def redeploy_on_update
  @redeploy_on_update
end

#scope ⇒ Object Originally defined in module Scopable

Attribtues

#self_service_categories ⇒ Array<Hash> (readonly) Originally defined in module SelfServable

Each Hash has these keys about the category

  • :id => [Integer] the JSS id of the category

  • :name => [String] the name of the category

Most objects also include one or both of these keys:

  • :display_in => [Boolean] should the item be displayed in this category in SSvc? (not MobDevConfProfiles)

  • :feature_in => [Boolean] should the item be featured in this category in SSVC? (macOS targets only)

#self_service_description ⇒ String Originally defined in module SelfServable

#self_service_feature_on_main_page ⇒ Boolean Originally defined in module SelfServable

Only applicable to macOS targets

#self_service_force_users_to_view_description ⇒ Boolean Originally defined in module SelfServable

#self_service_install_button_text ⇒ String Originally defined in module SelfServable

#self_service_removal_password ⇒ String (readonly) Originally defined in module SelfServable

#self_service_user_removable ⇒ Symbol Originally defined in module SelfServable

#user_removable ⇒ Boolean 



112
113
114
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 112

def user_removable
  @user_removable
end

#uuid ⇒ String (readonly) 



118
119
120
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 118

def uuid
  @uuid
end

Instance Method Details

#add_self_service_category(new_cat, display_in: true, feature_in: false) ⇒ void Also known as: set_self_service_category, change_self_service_category Originally defined in module SelfServable

This method returns an undefined value.

Add or change one of the categories for this item in self service

Raises:

#add_to_self_service ⇒ void Originally defined in module SelfServable

This method returns an undefined value.

Add this object to self service if not already there.

#in_self_service? ⇒ Boolean 



203
204
205
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 203

def in_self_service?
  @distribution_method == SELF_SERVICE_DIST_METHOD
end

#name=(newname) ⇒ void Originally defined in module Updatable

This method returns an undefined value.

Change the name of this item Remember to #update to push changes to the server.

Raises:

#parse_scope ⇒ void Originally defined in module Scopable

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Call this during initialization of objects that have a scope and the scope instance will be created from @init_data

#parsed_payloads ⇒ Hash 



219
220
221
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 219

def parsed_payloads
  Plist.parse_xml @payloads
end

#payload_content ⇒ Array<Hash> 



226
227
228
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 226

def payload_content
  parsed_payloads['PayloadContent']
end

#payload_types ⇒ Array<String> 



233
234
235
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 233

def payload_types
  payload_content.map{|p| p['PayloadType'] }
end

#remove_from_self_service ⇒ void Originally defined in module SelfServable

This method returns an undefined value.

Remove this object from self service if it’s there.

#remove_self_service_category(cat) ⇒ void Originally defined in module SelfServable

This method returns an undefined value.

Remove a category from those for this item in SSvc

#self_service_payload ⇒ Symbol Originally defined in module SelfServable

What does this object deploy to the device via self service?

#self_service_targets ⇒ Array<Symbol> Originally defined in module SelfServable

What devices types can get this thing in Self Service

#should_update ⇒ void Originally defined in module Scopable

This method returns an undefined value.

When the scope changes, it calls this to tell us that an update is needed.

#update ⇒ Object Originally defined in module Scopable

A wrapper around the update method, to try catching RestClient::Conflict 409 errors when we couldn’t verify all ldap users/groups due to lack of ldap connections

#upload(type, local_file) ⇒ String Originally defined in module Uploadable

Upload a file to the JSS via the REST Resource of the object to which this module is mixed in.

Raises:

#user_removable? ⇒ Boolean 



211
212
213
 
# File 'lib/jss/api_object/osx_configuration_profile.rb', line 211

def user_removable?
  @user_removable
end