Module: Xolo::Server::Mixins::TitleJamfAccess

Included in:: Title

Defined in:: lib/xolo/server/mixins/title_jamf_access.rb

Overview

This is mixed in to Xolo::Server::Title to define Title-related access to the Jamf Pro server

Class Method Summary collapse

.included(includer) ⇒ Object
when this module is included.

Instance Method Summary collapse

#accept_jamf_patch_ea ⇒ void
This method should only be called when we expect to need to accept the EA - not only when we first activate a title with a version script, but when the version_script has changed, or been added, replacing app_name and app_bundle_id.
#accept_jamf_patch_ea_via_api ⇒ void
API call to accept the version-script EA in Jamf Pro This never happens for subscribed titles.
#activate_jamf_patch_title ⇒ Object
activate the patch title in jamf, whatever it's source.
#add_title_to_self_service(pol = nil) ⇒ void
Add the jamf_manual_install_released_policy to self service if needed.
#auto_accept_patch_ea_in_thread ⇒ Object
Wait for up to an hour for Jamf to notice that our TEd EA needs to be accepted, and then do it.
#configure_jamf_expire_policy ⇒ Object
Configure the expiration policy.
#configure_jamf_installed_group ⇒ void
Set the configuration of jamf_installed_group.
#configure_jamf_manual_install_released_policy(pol) ⇒ void
Configure the settings for the manual_install_released_policy Be sure to call .save on the policy after this to save the changes.
#configure_jamf_uninstall_policy(pol = nil) ⇒ Object
Configure the uninstall policy.
#configure_jamf_uninstall_script ⇒ void
Configure the uninstall script in jamf with our uninstall_script contents.
#configure_pol_for_self_service(pol = nil) ⇒ void
configure the self-service settings of the manual_install_released_policy NOTE this doesn't actually add it to self service, just configures the settings See add_title_to_self_service.
#create_jamf_manual_install_released_policy ⇒ Object
The manual install policy for the current release is always scoped to all computers, with exclusions.
#create_title_in_jamf ⇒ void
Create title-level things in jamf when creating a title.
#delete_jamf_expire_policy ⇒ Object
#delete_jamf_frozen_group ⇒ void
Delete the 'frozen' static group.
#delete_jamf_installed_group ⇒ void
Delete the 'installed' smart group.
#delete_jamf_manual_install_released_policy ⇒ Object
#delete_jamf_patch_title ⇒ Object
Delete the patch title NOTE: jamf api user must have 'delete computer ext.
#delete_jamf_uninstall_policy ⇒ Object
delete the policy first if it exists.
#delete_jamf_uninstall_script ⇒ Object
#delete_title_from_jamf ⇒ Object
Delete an entire title from Jamf Pro alway delete policies first, then scripts, then groups, then EAs, then the patch title.
#freeze_computers(computers:) ⇒ Object
freeze some computers see #freeze_or_thaw_computers.
#freeze_or_thaw_computers(action:, computers:) ⇒ Hash
Freeze or thaw an array of computers for a title.
#frozen_computers ⇒ Hash{String => String}
Return the members of the 'frozen' static group for a title.
#jamf_active_managed_titles(refresh: false) ⇒ Hash {String => Integer}
The managed titles active in Jamf Patch Management from the Title Editor A hash keyed by the title, with values of the jamf patch title id.
#jamf_active_subscribed_titles(refresh: false) ⇒ Hash {String => Integer}
The subscribed xolo titles that are active in Jamf Patch Management and their Jamf::PatchTitle id.
#jamf_available_managed_titles ⇒ Array<String>
The titles available from the Title Editor via its Jamf Patch Source.
#jamf_expire_policy ⇒ Jamf::Policy
Create or fetch the policy that expires a title.
#jamf_expire_policy_exist? ⇒ Boolean
Does the jamf_expire_policy exist?.
#jamf_expire_policy_url ⇒ String
The URL for the uninstall policy in Jamf Pro.
#jamf_frozen_group ⇒ Jamf::ComputerGroup^?
Create or fetch static in jamf that contains macs with this title 'frozen' If we are deleting and it doesn't exist, return nil.
#jamf_frozen_group_exist? ⇒ Boolean
Does the jamf_frozen_group exist?.
#jamf_frozen_group_url ⇒ String
The URL for the Frozen static group in Jamf Pro.
#jamf_gui_url ⇒ String
The start of the Jamf Pro URL for GUI/WebApp access.
#jamf_installed_group ⇒ Jamf::ComputerGroup^?
Create or fetch he smartgroup in jamf that contains all macs with any version of this title installed.
#jamf_installed_group_criteria ⇒ Array<Jamf::Criteriable::Criterion>
The criteria for the smart group in Jamf that contains all Macs with any version of this title installed.
#jamf_installed_group_exist? ⇒ Boolean
Does the jamf_installed_group exist?.
#jamf_installed_group_url ⇒ String
The URL for the Frozen statig group in Jamf Pro.
#jamf_managed_patch_source ⇒ Jamf::PatchSource
The Jamf Patch Source that is connected to the Title Editor This must be manually configured in the Jamf server and the Xolo server.
#jamf_managed_title_available? ⇒ Boolean
Is this xolo title available in Jamf?.
#jamf_manual_install_released_policy ⇒ Jamf::Policy
Create or fetch the manual install policy for the currently released version.
#jamf_manual_install_released_policy_exist? ⇒ Boolean
Does the jamf_manual_install_released_policy exist?.
#jamf_manual_install_released_policy_url ⇒ String
The URL for the manual install policy in Jamf Pro.
#jamf_patch_ea_awaiting_acceptance? ⇒ Boolean
Does the Jamf Title currently need its EA to be accepted, according to Jamf Pro?.
#jamf_patch_ea_contents ⇒ String^?
the script contents of the Jamf Patch EA that comes from our version_script.
#jamf_patch_ea_data ⇒ Hash
The version_script as a Jamf Extension Attribute, once the title as been activated in Jamf.
#jamf_patch_ea_matches_version_script? ⇒ Boolean^?
Does the EA for this title in Jamf match the version script we know about?.
#jamf_patch_ea_url ⇒ String
The URL for the Patch EA in Jamf Pro.
#jamf_patch_title(refresh: false) ⇒ Jamf::PatchTitle^?
Create or fetch the patch title object for this xolo title.
#jamf_patch_title_url ⇒ String
The URL for the Patch Title in Jamf Pro.
#jamf_title_active? ⇒ Boolean
Is this xolo title currently active in Jamf?.
#jamf_uninstall_policy ⇒ Jamf::Policy
Create or fetch the policy that runs the jamf uninstall script.
#jamf_uninstall_policy_exist? ⇒ Boolean
Does the jamf_uninstall_policy exist?.
#jamf_uninstall_policy_url ⇒ String
The URL for the uninstall policy in Jamf Pro.
#jamf_uninstall_script ⇒ Jamf::Script
Create or fetch the script that uninstalls this title from a Mac.
#jamf_uninstall_script_exist? ⇒ Boolean
Does the uninstall script exist in jamf?.
#jamf_uninstall_script_url ⇒ String
The URL for the uninstall script in Jamf Pro.
#jp_api_filter_string_for_version(vers) ⇒ String
given a version, return a patch report filter with it properly quoted and URL escaped.
#need_to_accept_jamf_patch_ea? ⇒ Boolean
Do we need to accept the patch ea in jamf?.
#need_to_delete_jamf_uninstall_script? ⇒ Boolean
do we need to delete the uninstall script stuff in jamf?.
#need_to_update_description? ⇒ Boolean
do we need to update the description? True if our incoming changes include :description.
#need_to_update_expiration? ⇒ Boolean
do we need to create or delete the expire policy? True if our incoming changes include :expiration.
#need_to_update_jamf_uninstall_script? ⇒ Boolean
do we need to update the uninstall scriptin jamf? true if our incoming changes include :uninstall_script OR :uninstall_ids and the new value of at least one of them is not empty.
#patch_report(vers: nil) ⇒ Arrah<Hash>
Get the patch report for this title.
#patch_versions(version: nil, refresh: false) ⇒ Array<Hash>
Returns an array of known patch versions for this title from Jamf These are not necessarily in xolo, but they are available from the Patch Source.
#remove_title_from_self_service(pol = nil) ⇒ void
Add the jamf_manual_install_released_policy to self service if needed.
#repair_frozen_group ⇒ Object
repair the frozen group.
#repair_jamf_expire_policy ⇒ Object
repair the expire policy in jamf.
#repair_jamf_manual_install_released_policy ⇒ Object
repair the jamf_manual_install_released_policy - the policy that installs whatever is the current release.
#repair_jamf_title_objects ⇒ Object
Repair this title in Jamf Pro - TODO: activate title in patch mgmt - TODO: Accept Patch EA - title-installed smart group 'xolo--installed' - frozen static group 'xolo-<title>-frozen' - manual/SSvc install-current-release policy 'xolo-<title>-install' - trigger 'xolo-<title>-install' - ssvc icon - ssvc category - description - if uninstallable - uninstall script 'xolo-<title>-uninstall' - uninstall policy 'xolo-<title>-uninstall' - if expirable - expire policy 'xolo-<title>-expire' - trigger 'xolo-<title>-expire'.</div> </li> <li class="public "> <a href="#repair_jamf_uninstall_policy-instance_method" title="#repair_jamf_uninstall_policy (instance method)">#repair_jamf_uninstall_policy ⇒ Object </a> <div class='inline'>repair the uninstall script and policy in jamf.</div> </li> <li class="public "> <a href="#repair_jamf_uninstall_script-instance_method" title="#repair_jamf_uninstall_script (instance method)">#repair_jamf_uninstall_script ⇒ Object </a> <div class='inline'>repair the uninstall script and policy in jamf.</div> </li> <li class="public "> <a href="#run_autopkg_recipe-instance_method" title="#run_autopkg_recipe (instance method)">#run_autopkg_recipe ⇒ Object </a> <div class='inline'>run the autopkg recipe if defined See Helpers::AutoPkg for more details.</div> </li> <li class="public "> <a href="#thaw_computers-instance_method" title="#thaw_computers (instance method)">#thaw_computers(computers:) ⇒ Object </a> <div class='inline'>thaw some computers see #freeze_or_thaw_computers.</div> </li> <li class="public "> <a href="#toggle_jamf_manual_install_released_policy-instance_method" title="#toggle_jamf_manual_install_released_policy (instance method)">#toggle_jamf_manual_install_released_policy(pol, vobj = nil) ⇒ Object </a> <div class='inline'>enable or disable the manual install policy for the current release, depending on whether or not we have a released version return [void].</div> </li> <li class="public "> <a href="#update_description_in_jamf-instance_method" title="#update_description_in_jamf (instance method)">#update_description_in_jamf ⇒ void </a> <div class='inline'>Update the description in Jamfy places it appears At the moment, this is only the manual install policy if its in self service.</div> </li> <li class="public "> <a href="#update_ssvc-instance_method" title="#update_ssvc (instance method)">#update_ssvc ⇒ Object </a> <div class='inline'>Update whether or not we are in self service, based on the setting in the title.</div> </li> <li class="public "> <a href="#update_title_in_jamf-instance_method" title="#update_title_in_jamf (instance method)">#update_title_in_jamf ⇒ void </a> <div class='inline'>Apply any changes to Jamf as needed Mostly this just sets flags indicating what needs to be updated in the various version-related things in jamf - policies, self service, etc.</div> </li> <li class="public "> <a href="#update_versions_for_title_changes_in_jamf-instance_method" title="#update_versions_for_title_changes_in_jamf (instance method)">#update_versions_for_title_changes_in_jamf ⇒ void </a> <div class='inline'>If any title changes require updates to existing versions in Jamf, this loops thru the versions and applies them.</div> </li> <li class="public "> <a href="#wait_for_managed_title_to_become_available-instance_method" title="#wait_for_managed_title_to_become_available (instance method)">#wait_for_managed_title_to_become_available ⇒ Object </a> <div class='inline'>wait up to 60secs for a managed title to become available to be activated subscribed titles are already available.</div> </li> </ul> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="included-class_method"> .included(includer) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> when this module is included </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 37 38 39</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 37 def self.included(includer) <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>.verbose_include includer, self end</pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="accept_jamf_patch_ea-instance_method"> #accept_jamf_patch_ea ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.This method should only be called when we expect to need to accept the EA - not only when we first activate a title with a version script, but when the version_script has changed, or been added, replacing app_name and app_bundle_id. If the EA needs acceptance when this method starts, we accept it and we're done. If not (there is no EA, or it's already accepted) then we spin off a thread that waits up to an hour for Jamf to notice the change from the Title Editor and require re-acceptance. As soon as we see that Jamf shows accepted: false, we'll accept it and be done. If we make it for an hour and never see the expected need for acceptance, we log it and send an alert about it. TODO: when this is implemented in ruby-jss, use the implementation NOTE: PATCHing the ea of the title requires CRUD privs for computer ext attrs </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 365 def accept_jamf_patch_ea # give the server a moment to catch up with the new EA before we check on it log_debug "Jamf: Checking if we need to accept the version-script EA for title '#{title}'" sleep 5 awating_acceptance = jamf_patch_ea_awaiting_acceptance? # return with warning if we aren't auto-accepting, or for all subscribed titles if awating_acceptance && (subscribed? || !<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>.<a href="../../Server.html#config-class_method" title="Xolo::Server.config (method)">config</a>.jamf_auto_accept_xolo_eas) msg = "Jamf: IMPORTANT: The Extension Attribute (version-script) for title '#{title}' must be accepted manually in Jamf Pro at #{jamf_patch_ea_url} under the 'Extension Attribute' tab (click 'Edit'). If you cannot do this yourself, please contact your Xolo server admins for assistance. Deployment will not happen until this is done." progress msg, log: :warn, alert: true log_debug 'Admin informed about accepting EA/version-script manually' return end return unless need_to_accept_jamf_patch_ea? # this is true if the Jamf server already knows it needs to be accepted # so just do it now if jamf_patch_ea_awaiting_acceptance? progress "Jamf: Auto-accepting use of version-script ExtensionAttribute '#{ted_ea_key}'", log: :info accept_jamf_patch_ea_via_api return end # If not, we are here because we expect it will need acceptance soon # So we call this method to wait for Jamf to notice that, # checking in the background for up to an hour. auto_accept_patch_ea_in_thread end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="accept_jamf_patch_ea_via_api-instance_method"> #accept_jamf_patch_ea_via_api ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.API call to accept the version-script EA in Jamf Pro This never happens for subscribed titles TODO: when this gets implemented in ruby-jss, use that implementation </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 528 529 530 531 532 533 534 535 536 537 538 539 540 541</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 528 def accept_jamf_patch_ea_via_api patchdata = <<~ENDPATCHDATA { "extensionAttributes": [ { "accepted": true, "eaId": "#{ted_ea_key}" } ] } ENDPATCHDATA jamf_cnx.jp_patch "v2/patch-software-title-configurations/#{jamf_patch_title_id}", patchdata log_debug "Jamf: Auto-accepted ExtensionAttribute '#{ted_ea_key}'" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="activate_jamf_patch_title-instance_method"> #activate_jamf_patch_title ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> activate the patch title in jamf, whatever it's source </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1248 def activate_jamf_patch_title if jamf_title_active? log_debug "Jamf: Title '#{title}' is already active in Jamf Patch" return end # patch_source and title_id are required when adding subbed titles # but pre-defined for managed if managed? log_debug "Jamf: Title '#{title}' is managed, so using pre-defined patch source and title_id" log_debug "Jamf: Display Name in managed?: #{display_name}" self.patch_source = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>.<a href="../../Server.html#config-class_method" title="Xolo::Server.config (method)">config</a>.ted_patch_source self.title_id = title log_debug "Jamf: Display Name in managed? after setting patch_source and title_id: #{display_name}" # display name is required for managed titles, but will be empty for subbed # so for subbed, we look it up from the patch source else log_debug "Jamf: Title '#{title}' is subscribed, so looking up patch source and title_id from" log_debug "Jamf: Display Name in NOT managed?: #{display_name}" if display_name.pix_empty? self.display_name = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchSource.available_titles(patch_source, cnx: jamf_cnx).select { |t| t[:name_id] == title_id }.first&.dig :app_name end end # if managed log_debug "Jamf: class: #{self.class}, display_name: #{display_name}, patch_source: #{patch_source}, title_id: #{title_id}" msg = "Jamf: Activating Patch Title '#{display_name}' (#{title}) from the Patch Source '#{patch_source}'" progress msg, log: :info jamf_patch_title = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchTitle.create( name: display_name, source: patch_source, name_id: title_id, cnx: jamf_cnx ) jamf_patch_title.category = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../../Server.html#JAMF_XOLO_CATEGORY-constant" title="Xolo::Server::JAMF_XOLO_CATEGORY (constant)">JAMF_XOLO_CATEGORY</a> self.jamf_patch_title_id = jamf_patch_title.save log_debug "Activated Jamf Patch Title '#{display_name}' (#{title}) with id #{jamf_patch_title_id}" jamf_patch_title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="add_title_to_self_service-instance_method"> #add_title_to_self_service(pol = nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Add the jamf_manual_install_released_policy to self service if needed </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The jamf_manual_install_released_policy, which may not be saved yet.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1496 def add_title_to_self_service(pol = nil) pol ||= jamf_manual_install_released_policy unless pol.in_self_service? msg = "Jamf: Adding Manual Install Policy '#{pol.name}' to Self Service." progress msg, log: :info pol.add_to_self_service end configure_pol_for_self_service(pol) pol.save # loop thru versions to make any SSvc changes version_objects.each do |vobj| ppol = vobj.jamf_patch_policy vobj.configure_patch_pol_for_self_service ppol ppol.save end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="auto_accept_patch_ea_in_thread-instance_method"> #auto_accept_patch_ea_in_thread ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Wait for up to an hour for Jamf to notice that our TEd EA needs to be accepted, and then do it </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 399 def auto_accept_patch_ea_in_thread # don't do this if there's already one running for this instance if @auto_accept_ea_thread&.alive? log_debug "Jamf: auto_accept_ea_thread already running. Caller: #{caller_locations.first}" return end progress "Jamf: version-script ExtAttr for this title '#{ted_ea_key}' will be auto-accepted when Jamf sees the changes in the Title Editor" @auto_accept_ea_thread = Thread.new do log_debug "Jamf: Starting auto_accept_ea_thread for #{title}" start_time = Time.now max_time = start_time + <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Constants.html#MAX_JAMF_WAIT_FOR_TITLE_EDITOR-constant" title="Xolo::Server::Constants::MAX_JAMF_WAIT_FOR_TITLE_EDITOR (constant)">MAX_JAMF_WAIT_FOR_TITLE_EDITOR</a> start_time = start_time.strftime '%F %T' did_it = false while Time.now < max_time sleep 30 # refresh our jamf connection cuz it might expire if this takes a while, esp if using # an APIClient jamf_cnx(refresh: true) if jamf_cnx.token.secs_remaining < 90 log_debug "Jamf: checking for expected (re)acceptance of version-script ExtensionAttribute '#{ted_ea_key}' since #{start_time}" next unless jamf_patch_ea_awaiting_acceptance? accept_jamf_patch_ea_via_api log_info "Jamf: Auto-accepted use of version-script ExtensionAttribute '#{ted_ea_key}'" did_it = true break end # while unless did_it msg = "Jamf: Expected to (re)accept version-script ExtensionAttribute '#{ted_ea_key}', but Jamf hasn't seen the change in over #{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Constants.html#MAX_JAMF_WAIT_FOR_TITLE_EDITOR-constant" title="Xolo::Server::Constants::MAX_JAMF_WAIT_FOR_TITLE_EDITOR (constant)">MAX_JAMF_WAIT_FOR_TITLE_EDITOR</a>} secs. Please investigate." log_error msg, alert: true end end # thread @auto_accept_ea_thread.name = "auto_accept_ea_thread for #{title}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_expire_policy-instance_method"> #configure_jamf_expire_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Configure the expiration policy </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) — <div class='inline'>the policy to configure</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1062 def configure_jamf_expire_policy pol = jamf_expire_policy pol.category = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../../Server.html#JAMF_XOLO_CATEGORY-constant" title="Xolo::Server::JAMF_XOLO_CATEGORY (constant)">JAMF_XOLO_CATEGORY</a> pol.run_command = "#{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Title.html" title="Xolo::Server::Title (class)">Title</a>::<a href="../Title.html#CLIENT_EXPIRE_COMMAND-constant" title="Xolo::Server::Title::CLIENT_EXPIRE_COMMAND (constant)">CLIENT_EXPIRE_COMMAND</a>} #{title}" pol.set_trigger_event :checkin, true pol.set_trigger_event :custom, jamf_expire_policy_name pol.scope.add_target(:computer_group, jamf_installed_group_name) pol.scope.set_exclusions :computer_groups, [valid_forced_exclusion_group_name] if valid_forced_exclusion_group_name pol.frequency = :daily pol.enable pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_installed_group-instance_method"> #configure_jamf_installed_group ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Set the configuration of jamf_installed_group </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 790 791 792 793 794 795 796 797</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 790 def configure_jamf_installed_group progress "Jamf: Configuring smart group '#{jamf_installed_group_name}'", log: :info jamf_installed_group.criteria = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Criteriable::Criteria.new(jamf_installed_group_criteria) jamf_installed_group.save log_debug 'Jamf: Sleeping 30 secs to let Jamf server see changes to Installed smart group.' sleep 30 end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_manual_install_released_policy-instance_method"> #configure_jamf_manual_install_released_policy(pol) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Configure the settings for the manual_install_released_policy Be sure to call .save on the policy after this to save the changes. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) — <div class='inline'>the policy we are configuring</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1411 def configure_jamf_manual_install_released_policy(pol) pol.category = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../../Server.html#JAMF_XOLO_CATEGORY-constant" title="Xolo::Server::JAMF_XOLO_CATEGORY (constant)">JAMF_XOLO_CATEGORY</a> pol.set_trigger_event :checkin, false pol.set_trigger_event :custom, jamf_manual_install_released_policy_name pol.frequency = :ongoing pol.recon = false pol.scope.set_all_targets # clear any existing packages pol.package_names.each { |pkg_name| pol.remove_package pkg_name } toggle_jamf_manual_install_released_policy pol # figure out the exclusions. # # explicit exlusions for the title excls = changes_for_update&.key?(:excluded_groups) ? changes_for_update[:excluded_groups][:new].dup : excluded_groups.dup excls ||= [] # plus the frozen group excls << jamf_frozen_group_name # plus any forced group from the server config excls << valid_forced_exclusion_group_name if valid_forced_exclusion_group_name # NOTE: we do not exclude existing installs, so that manual re-installs can be a thing. log_debug "Setting exclusions for manual install policy for current release: #{excls}" pol.scope.set_exclusions :computer_groups, excls if self_service? add_title_to_self_service(pol) else remove_title_from_self_service(pol) end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_uninstall_policy-instance_method"> #configure_jamf_uninstall_policy(pol = nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Configure the uninstall policy </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>the policy to configure</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 696 def configure_jamf_uninstall_policy(pol = nil) progress "Jamf: Configuring uninstall policy '#{jamf_uninstall_policy_name}'", log: :info pol ||= jamf_uninstall_policy pol.category = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../../Server.html#JAMF_XOLO_CATEGORY-constant" title="Xolo::Server::JAMF_XOLO_CATEGORY (constant)">JAMF_XOLO_CATEGORY</a> pol.add_script jamf_uninstall_script_name pol.set_trigger_event :checkin, false pol.set_trigger_event :custom, jamf_uninstall_policy_name # pol.scope.add_target(:computer_group, jamf_installed_group_name) # all targets, cus jamf doesn't like some policies with scoped # smart groups using 'latest version' pol.scope.set_all_targets pol.scope.set_exclusions :computer_groups, [valid_forced_exclusion_group_name] if valid_forced_exclusion_group_name pol.frequency = :ongoing pol.enable pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_uninstall_script-instance_method"> #configure_jamf_uninstall_script ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Configure the uninstall script in jamf with our uninstall_script contents </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 598 599 600 601 602 603 604 605</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 598 def configure_jamf_uninstall_script # if we don't have an uninstall script, nothing to do, it will be deleted elsewhere return unless uninstall_script_contents progress "Jamf: Congfiguring the uninstall script '#{jamf_uninstall_script_name}'", log: :info jamf_uninstall_script.code = uninstall_script_contents jamf_uninstall_script.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_pol_for_self_service-instance_method"> #configure_pol_for_self_service(pol = nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.configure the self-service settings of the manual_install_released_policy NOTE this doesn't actually add it to self service, just configures the settings See add_title_to_self_service </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The jamf_manual_install_released_policy, which may not be saved yet.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1576 def configure_pol_for_self_service(pol = nil) pol ||= jamf_manual_install_released_policy new_cat = changes_for_update&.dig(:self_service_category, :new) || self_service_category if new_cat progress "Jamf: Setting Self Service category to '#{new_cat}'", log: :debug # clear existing categories, re-add correct one pol.self_service_categories.each { |cat| pol.remove_self_service_category cat } pol.add_self_service_category new_cat if new_cat end new_display_name = changes_for_update&.dig(:display_name, :new) || display_name progress "Jamf: Setting Self Service display name to '#{new_display_name}'", log: :debug pol.self_service_display_name = new_display_name new_desc = changes_for_update&.dig(:description, :new) || description progress "Jamf: Setting Self Service description to '#{new_desc}'", log: :debug pol.self_service_description = new_desc pol.self_service_install_button_text = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Title.html" title="Xolo::Server::Title (class)">Title</a>::<a href="../Title.html#SELF_SERVICE_INSTALL_BTN_TEXT-constant" title="Xolo::Server::Title::SELF_SERVICE_INSTALL_BTN_TEXT (constant)">SELF_SERVICE_INSTALL_BTN_TEXT</a> return unless ssvc_icon_file # TODO: Is this needed if we already have a ssvc_icon_id ?? progress 'Jamf: Uploading Self Service icon', log: :debug pol.save # won't do anything unless needed, but has to exist before we can upload icons pol.upload :icon, ssvc_icon_file # re-fetch the pol to get the icon id self.ssvc_icon_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch(id: pol.id, cnx: jamf_cnx).icon.id end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_manual_install_released_policy-instance_method"> #create_jamf_manual_install_released_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> The manual install policy for the current release is always scoped to all computers, with exclusions The policy has a custom trigger, or can be installed via self service if desired </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1395 def create_jamf_manual_install_released_policy msg = "Jamf: Creating manual install policy for current release: '#{jamf_manual_install_released_policy_name}'" progress msg, log: :info pol = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_manual_install_released_policy_name, cnx: jamf_cnx configure_jamf_manual_install_released_policy(pol) pol.save pol end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_title_in_jamf-instance_method"> #create_title_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Create title-level things in jamf when creating a title. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 62 def create_title_in_jamf log_debug "Display Name in create_title_in_jamf: #{display_name}" # create/activate the Jamf::PatchTitle # this notes the jamf id of the PatchTitle # and sets the display name if needed for subbed titles jamf_patch_title # This creates the installed group # must happen after activating the title in jamf jamf_installed_group if uninstall_script || !uninstall_ids.pix_empty? configure_jamf_uninstall_script # this creates the policy to use the script # must happen after the uninstall script is created jamf_uninstall_policy # this creates the expire policy if needed jamf_expire_policy if expiration && !expire_paths.pix_empty? end # Create the static group that will contain computers where this title is 'frozen' # Just calling this will create it if it doesn't exist. jamf_frozen_group # This either notifies, or does it # TODO: EAs for subscribed titles can change at any time and need # re-accepted - Notifications must happen. accept_jamf_patch_ea end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_expire_policy-instance_method"> #delete_jamf_expire_policy ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 1076 1077 1078 1079 1080 1081</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1076 def delete_jamf_expire_policy return unless jamf_expire_policy_exist? progress "Jamf: Deleting expiration policy '#{jamf_expire_policy_name}'", log: :info jamf_expire_policy.delete end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_frozen_group-instance_method"> #delete_jamf_frozen_group ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete the 'frozen' static group </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1009 1010 1011 1012 1013 1014 1015</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1009 def delete_jamf_frozen_group grp_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.valid_id jamf_frozen_group_name, cnx: jamf_cnx return unless grp_id progress "Jamf: Deleting static group '#{jamf_frozen_group_name}'", log: :info <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.delete grp_id, cnx: jamf_cnx end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_installed_group-instance_method"> #delete_jamf_installed_group ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete the 'installed' smart group </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 828 829 830 831 832 833 834 835 836</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 828 def delete_jamf_installed_group return unless jamf_installed_group_exist? progress "Jamf: Deleting smart group '#{jamf_installed_group_name}'", log: :info jamf_installed_group.delete # give the server time to see the deletion log_debug 'Sleeping to let server see deletion of smart group' sleep 10 end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_manual_install_released_policy-instance_method"> #delete_jamf_manual_install_released_policy ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 1484 1485 1486 1487 1488 1489 1490</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1484 def delete_jamf_manual_install_released_policy return unless jamf_manual_install_released_policy_exist? msg = "Jamf: Deleting the manual/Self Service install policy for the current release '#{jamf_manual_install_released_policy_name}'" progress msg, log: :info jamf_manual_install_released_policy.delete end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_patch_title-instance_method"> #delete_jamf_patch_title ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Delete the patch title NOTE: jamf api user must have 'delete computer ext. attribs' permmissions </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1316 def delete_jamf_patch_title log_debug "Jamf: Deleting patch title '#{display_name}' (#{title})" unless jamf_title_active? log_debug "Jamf: Patch title '#{display_name}' (#{title}) is not active in Jamf, nothing to delete" return end # # subscribed titles often have name_id's like "1B7" # # whereas managed titles have name_id's that are the same as the title, # # so we have to look up the id differently for subbed vs managed # key = subscribed? ? title_id : title # pt_id = Jamf::PatchTitle.map_all(:id, to: :name_id, cnx: jamf_cnx).invert[key] # unless pt_id # log_debug "Jamf: Cannot find patch title '#{display_name}' (#{title}) in Jamf, cannot delete" # return # end # # the pt_id SHOULD match the jamf_patch_title_id we have stored, but just in case, we'll use the one we looked up here # unless pt_id.to_s == jamf_patch_title_id.to_s # log_warn "Jamf: Stored patch title id #{jamf_patch_title_id} does not match id #{pt_id} looked up for '#{display_name}' (#{title}). We are deleting the stored id." # end msg = "Jamf: Deleting (deactivating) title '#{display_name}' (#{title}}) in Jamf Patch Management" progress msg, log: :info <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchTitle.delete jamf_patch_title_id, cnx: jamf_cnx end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_uninstall_policy-instance_method"> #delete_jamf_uninstall_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> delete the policy first if it exists </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 725 726 727 728 729 730</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 725 def delete_jamf_uninstall_policy return unless jamf_uninstall_policy_exist? progress "Jamf: Deleting uninstall policy '#{jamf_uninstall_policy_name}'", log: :info jamf_uninstall_policy.delete end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_uninstall_script-instance_method"> #delete_jamf_uninstall_script ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 626 627 628 629 630 631</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 626 def delete_jamf_uninstall_script return unless jamf_uninstall_script_exist? progress "Jamf: Deleting uninstall script '#{jamf_uninstall_script_name}'", log: :info jamf_uninstall_script.delete end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_title_from_jamf-instance_method"> #delete_title_from_jamf ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Delete an entire title from Jamf Pro alway delete policies first, then scripts, then groups, then EAs, then the patch title </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 174 def delete_title_from_jamf # ORDER MATTERS delete_jamf_expire_policy delete_jamf_uninstall_policy delete_jamf_manual_install_released_policy delete_jamf_uninstall_script sleep 5 # must delete this group before the patch title # since the group criteria references the patch title delete_jamf_installed_group sleep 5 delete_jamf_patch_title # static group deleted last, # was used in scopes for patch and normal policies delete_jamf_frozen_group end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="freeze_computers-instance_method"> #freeze_computers(computers:) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> freeze some computers see #freeze_or_thaw_computers </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 927 def freeze_computers(computers:) result = {} freezes_to_log = [] comp_names = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Computer.all_names cnx: jamf_cnx grp_members = jamf_frozen_group.member_names computers.each do |comp| if grp_members.include? comp log_info "Not freezing computer '#{comp}' for title '#{title}', already frozen" result[comp] = "#{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::ERROR}: Already frozen" elsif comp_names.include? comp log_info "Freezing computer '#{comp}' for title '#{title}'" jamf_frozen_group.add_member comp result[comp] = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::OK freezes_to_log << comp else log_debug "Cannot freeze computer '#{comp}' for title '#{title}', no such computer" result[comp] = "#{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::ERROR}: No computer with that name" end # if comp_names.include end # computers.each [result, freezes_to_log] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="freeze_or_thaw_computers-instance_method"> #freeze_or_thaw_computers(action:, computers:) ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> Freeze or thaw an array of computers for a title </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> action (<tt>Symbol</tt>) — <div class='inline'>:freeze or :thaw</div> </li> <li> computers (<tt>Array<String></tt>, <tt>String</tt>) — <div class='inline'>The computer <a href="s">name</a> to freeze or thaw. To thaw all computers pass Xolo::TARGET_ALL (freeze all is not allowed)</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>Keys are computer names, values are Xolo::OK or an error message</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 895 def freeze_or_thaw_computers(action:, computers:) return unless %i[freeze thaw].include? action # convert to an array if it's a single string computers = [computers].flatten result, changes_to_log = if action == :thaw thaw_computers(computers: computers) else freeze_computers(computers: computers) end # if action == jamf_frozen_group.save unless changes_to_log.empty? action_msg = if action == :freeze "Froze computers: #{changes_to_log.join(', ')}" else "Thawed computers: #{changes_to_log.join(', ')}" end log_change msg: action_msg end result end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="frozen_computers-instance_method"> #frozen_computers ⇒ <tt>Hash{String => String}</tt> </h3><div class="docstring"> <div class="discussion"> Return the members of the 'frozen' static group for a title </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash{String => String}</tt>) — <div class='inline'>computer name => user name</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 987 988 989 990 991 992 993 994 995 996</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 987 def frozen_computers members = {} comps = jamf_frozen_group.member_names comps_to_users = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Computer.map_all :name, to: :username, cnx: jamf_cnx comps.each { |comp| members[comp] = comps_to_users[comp] || 'unknown' } members end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_active_managed_titles-instance_method"> #jamf_active_managed_titles(refresh: false) ⇒ <tt>Hash {String => Integer}</tt> </h3><div class="docstring"> <div class="discussion"> The managed titles active in Jamf Patch Management from the Title Editor A hash keyed by the title, with values of the jamf patch title id </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash {String => Integer}</tt>) — <div class='inline'>The managed xolo titles that are active in Jamf Patch Management and their Jamf::PatchTitle id</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1179 def jamf_active_managed_titles(refresh: false) @jamf_active_managed_titles = nil if refresh return @jamf_active_managed_titles if @jamf_active_managed_titles @jamf_active_managed_titles = {} all_patch_titles = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchTitle.all(cnx: jamf_cnx) active_from_ted = all_patch_titles.select do |t| # log_debug "Jamf: Checking if active patch title '#{t[:name]}' with id #{t[:id]} is from the Title Editor's patch source" t[:source_id] == jamf_managed_patch_source.id end managed_titles = server_app_instance.managed_title_objects.select(&:managed?).map(&:title) active_from_ted.each do |t| @jamf_active_managed_titles[t[:name_id]] = t[:id] if managed_titles.include? t[:name_id] end @jamf_active_managed_titles end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_active_subscribed_titles-instance_method"> #jamf_active_subscribed_titles(refresh: false) ⇒ <tt>Hash {String => Integer}</tt> </h3><div class="docstring"> <div class="discussion"> Returns The subscribed xolo titles that are active in Jamf Patch Management and their Jamf::PatchTitle id. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash {String => Integer}</tt>) — <div class='inline'>The subscribed xolo titles that are active in Jamf Patch Management and their Jamf::PatchTitle id</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1202 def jamf_active_subscribed_titles(refresh: false) @jamf_active_subscribed_titles = nil if refresh return @jamf_active_subscribed_titles if @jamf_active_subscribed_titles @jamf_active_subscribed_titles = {} all_active_patchtitles = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchTitle.all :refresh, cnx: jamf_cnx server_app_instance.subscribed_title_objects.each do |st| next unless all_active_patchtitles.any? do |pt| pt[:source_id] == st.jamf_patch_source_id && pt[:name_id] == st.title_id end @jamf_active_subscribed_titles[st.title] = pt[:id] end @jamf_active_subscribed_titles end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_available_managed_titles-instance_method"> #jamf_available_managed_titles ⇒ <tt>Array<String></tt> </h3><div class="docstring"> <div class="discussion"> The titles available from the Title Editor via its Jamf Patch Source. These are titles have have been enabled in the Title Editor but have not yet been activated in Jamf Patch. available_titles returns a Hash for each available title, with these keys: <pre class="code ruby"><code class="ruby">name_id: [String] The Xolo 'title' or the Title Editor 'id' current_version: [String] NOTE: This may be a version that is in 'pilot' from Xolo's POV, but from the TEd's POV, it has been made available to Jamf. publisher: [String] last_modified: [Time] app_name: [String] The Xolo 'display_name' </code></pre> but we map it to just the name_id </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Array<String></tt>) — <div class='inline'>info about the available titles</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1145 def jamf_available_managed_titles # Don't cache this in an instance var, it changes during the # life of our title instance # jamf_managed_patch_source.available_titles.map { |t| t[:name_id] } # Also NOTE: "available" means not only enabled # in the title editor, but also not already active in jamf. # So any given title will either be here or in # jamf_active_managed_titles, but never both. jamf_managed_patch_source.available_name_ids end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_expire_policy-instance_method"> #jamf_expire_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the policy that expires a title </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>The Jamf Policy for expiring this title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1042 def jamf_expire_policy return @jamf_expire_policy if @jamf_expire_policy if jamf_expire_policy_exist? @jamf_expire_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch name: jamf_expire_policy_name, cnx: jamf_cnx else return if deleting? progress "Jamf: Creating Expiration policy: '#{jamf_expire_policy_name}'", log: :info @jamf_expire_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_expire_policy_name, cnx: jamf_cnx configure_jamf_expire_policy end @jamf_expire_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_expire_policy_exist?-instance_method"> #jamf_expire_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the jamf_expire_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the jamf_expire_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1034 1035 1036</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1034 def jamf_expire_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(:refresh, cnx: jamf_cnx).include? jamf_expire_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_expire_policy_url-instance_method"> #jamf_expire_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the uninstall policy in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the uninstall policy in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1097 def jamf_expire_policy_url return @jamf_expire_policy_url if @jamf_expire_policy_url return unless uninstallable? return unless expiration pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_expire_policy_name, cnx: jamf_cnx return unless pol_id @jamf_expire_policy_url = "#{jamf_gui_url}/policies.html?id=#{pol_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_frozen_group-instance_method"> #jamf_frozen_group ⇒ <tt>Jamf::ComputerGroup</tt>? </h3><div class="docstring"> <div class="discussion"> Create or fetch static in jamf that contains macs with this title 'frozen' If we are deleting and it doesn't exist, return nil. There really isn't any configuration or repairing to do, it's just a static group. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::ComputerGroup</tt>, <tt>nil</tt>) — <div class='inline'>The Jamf ComputerGroup for this title's frozen computers</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 865 def jamf_frozen_group return @jamf_frozen_group if @jamf_frozen_group if jamf_frozen_group_exist? @jamf_frozen_group = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.fetch name: jamf_frozen_group_name, cnx: jamf_cnx else return if deleting? progress "Jamf: Creating static group '#{jamf_frozen_group_name}' with no members at the moment", log: :info @jamf_frozen_group = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.create( name: jamf_frozen_group_name, type: :static, cnx: jamf_cnx ) @jamf_frozen_group.save end @jamf_frozen_group end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_frozen_group_exist?-instance_method"> #jamf_frozen_group_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the jamf_frozen_group exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the jamf_frozen_group exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 855 856 857</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 855 def jamf_frozen_group_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.all_names(:refresh, cnx: jamf_cnx).include? jamf_frozen_group_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_frozen_group_url-instance_method"> #jamf_frozen_group_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Frozen static group in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Frozen static group in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1019 1020 1021 1022 1023 1024 1025 1026</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1019 def jamf_frozen_group_url return @jamf_frozen_group_url if @jamf_frozen_group_url gr_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.valid_id jamf_frozen_group_name, cnx: jamf_cnx return unless gr_id @jamf_frozen_group_url = "#{jamf_gui_url}/staticComputerGroups.html?id=#{gr_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_gui_url-instance_method"> #jamf_gui_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns The start of the Jamf Pro URL for GUI/WebApp access. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The start of the Jamf Pro URL for GUI/WebApp access</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 54 55 56</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 54 def jamf_gui_url server_app_instance.jamf_gui_url end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_installed_group-instance_method"> #jamf_installed_group ⇒ <tt>Jamf::ComputerGroup</tt>? </h3><div class="docstring"> <div class="discussion"> Create or fetch he smartgroup in jamf that contains all macs with any version of this title installed. If we are deleting and it doesn't exist, return nil. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::ComputerGroup</tt>, <tt>nil</tt>) — <div class='inline'>The Jamf ComputerGroup for this title's installed computers</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 760 def jamf_installed_group return @jamf_installed_group if @jamf_installed_group if jamf_installed_group_exist? @jamf_installed_group = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.fetch( name: jamf_installed_group_name, cnx: jamf_cnx ) else return if deleting? progress "Jamf: Creating smart group '#{jamf_installed_group_name}'", log: :info @jamf_installed_group = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.create( name: jamf_installed_group_name, type: :smart, cnx: jamf_cnx ) @jamf_installed_group.save configure_jamf_installed_group end @jamf_installed_group end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_installed_group_criteria-instance_method"> #jamf_installed_group_criteria ⇒ <tt>Array<Jamf::Criteriable::Criterion></tt> </h3><div class="docstring"> <div class="discussion"> The criteria for the smart group in Jamf that contains all Macs with any version of this title installed We use the "Patch Reporting: #display_name" criterion so that we don't care whether the title uses a version-script or app data. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Array<Jamf::Criteriable::Criterion></tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 807 def jamf_installed_group_criteria [ <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Criteriable::Criterion.new( and_or: :and, name: "Patch Reporting: #{display_name}", search_type: 'less than or equal', value: 'Latest Version' ), <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Criteriable::Criterion.new( and_or: :or, name: "Patch Reporting: #{display_name}", search_type: 'is', value: 'Unknown Version' ) ] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_installed_group_exist?-instance_method"> #jamf_installed_group_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the jamf_installed_group exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the jamf_installed_group exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 750 751 752</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 750 def jamf_installed_group_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.all_names(:refresh, cnx: jamf_cnx).include? jamf_installed_group_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_installed_group_url-instance_method"> #jamf_installed_group_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Frozen statig group in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Frozen statig group in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 840 841 842 843 844 845 846 847</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 840 def jamf_installed_group_url return @jamf_installed_group_url if @jamf_installed_group_url gr_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.valid_id jamf_installed_group_name, cnx: jamf_cnx return unless gr_id @jamf_installed_group_url = "#{jamf_gui_url}/smartComputerGroups.html?id=#{gr_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_managed_patch_source-instance_method"> #jamf_managed_patch_source ⇒ <tt>Jamf::PatchSource</tt> </h3><div class="docstring"> <div class="discussion"> The Jamf Patch Source that is connected to the Title Editor This must be manually configured in the Jamf server and the Xolo server </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::PatchSource</tt>) — <div class='inline'>The Jamf Patch Source</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1117 1118 1119 1120</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1117 def jamf_managed_patch_source @jamf_managed_patch_source ||= <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchSource.fetch(name: <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>.<a href="../../Server.html#config-class_method" title="Xolo::Server.config (method)">config</a>.ted_patch_source, cnx: jamf_cnx) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_managed_title_available?-instance_method"> #jamf_managed_title_available? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Is this xolo title available in Jamf?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Is this xolo title available in Jamf?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1158 1159 1160</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1158 def jamf_managed_title_available? jamf_available_managed_titles.include? title end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_released_policy-instance_method"> #jamf_manual_install_released_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the manual install policy for the currently released version. If we are deleting and it doesn't exist, return nil. Also return nil if we have no version released </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>The manual-install-policy for this version, if it exists</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1366 def jamf_manual_install_released_policy @jamf_manual_install_released_policy ||= if jamf_manual_install_released_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch(name: jamf_manual_install_released_policy_name, cnx: jamf_cnx) else return if deleting? create_jamf_manual_install_released_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_released_policy_exist?-instance_method"> #jamf_manual_install_released_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the jamf_manual_install_released_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the jamf_manual_install_released_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1356 1357 1358</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1356 def jamf_manual_install_released_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(:refresh, cnx: jamf_cnx).include? jamf_manual_install_released_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_released_policy_url-instance_method"> #jamf_manual_install_released_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the manual install policy in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the manual install policy in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1379 1380 1381 1382 1383 1384 1385 1386</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1379 def jamf_manual_install_released_policy_url return @jamf_manual_install_released_policy_url if @jamf_manual_install_released_policy_url pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_manual_install_released_policy_name, cnx: jamf_cnx return unless pol_id @jamf_manual_install_released_policy_url = "#{jamf_gui_url}/policies.html?id=#{pol_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_ea_awaiting_acceptance?-instance_method"> #jamf_patch_ea_awaiting_acceptance? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Does the Jamf Title currently need its EA to be accepted, according to Jamf Pro? NOTE: Jamf might not see the need for this immediately, so we set and use them to determine if we should wait for this to become true. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 448 449 450 451 452 453</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 448 def jamf_patch_ea_awaiting_acceptance? ead = jamf_patch_ea_data return unless ead !ead[:accepted] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_ea_contents-instance_method"> #jamf_patch_ea_contents ⇒ <tt>String</tt>? </h3><div class="docstring"> <div class="discussion"> the script contents of the Jamf Patch EA that comes from our version_script </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>, <tt>nil</tt>) — <div class='inline'>nil if there is none, or the title isn't active yet</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 546 547 548 549 550 551</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 546 def jamf_patch_ea_contents jea_data = jamf_patch_ea_data return unless jea_data && jea_data[:scriptContents] Base64.decode64 jea_data[:scriptContents] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_ea_data-instance_method"> #jamf_patch_ea_data ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> The version_script as a Jamf Extension Attribute, once the title as been activated in Jamf. This is a hash of data returned from the JP API endpoint: <pre class="code ruby"><code class="ruby">"v2/patch-software-title-configurations/#{jamf_patch_title_id}/extension-attributes" </code></pre> which has these keys: <pre class="code ruby"><code class="ruby">:accepted [Boolean] has it been accepted for the title? :eaId [String] the 'key' of the EA from the title editor :displayName [String] the displayname from the title editor, for titles maintained by xolo, it's the same as the eaId :scriptContent [String] the Base64-encoded script of the EA. </code></pre> TODO: when this gets implemented in ruby-jss, use that implementation and return the patch title ea object. NOTE: The title must be activated in Jamf before accessing this. NOTE: We fetch this hash every time this method is called, since we may be waiting for jamf to notice that the EA has changed in the Title Editor and needs re-acceptance NOTE: While Jamf Patch allows for multiple EAs per title, the Title Editor only allows for one. So even tho the data comes back in an array, we only care about the first (and only) value. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>the data from the JPAPI endpoint, nil if the title has no EA at the moment</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 515 516 517 518 519</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 515 def jamf_patch_ea_data return unless jamf_patch_title_id jamf_cnx.jp_get("v2/patch-software-title-configurations/#{jamf_patch_title_id}/extension-attributes").first end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_ea_matches_version_script?-instance_method"> #jamf_patch_ea_matches_version_script? ⇒ <tt>Boolean</tt>? </h3><div class="docstring"> <div class="discussion"> Does the EA for this title in Jamf match the version script we know about? If we don't have a version script, then we don't really care what Jamf has at the moment, Jamf's should go away once it catches up with the title editor. But if we do have one, and Jamf has something different, we'll need to accept it, if configured to do so automatically. This method just tells us the current situation about our version script vs the Jamf Patch EA. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> new_version_script (<tt>String</tt>, <tt>nil</tt>) — <div class='inline'>If updating, this is the new incoming version script.</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Boolean</tt>, <tt>nil</tt>) — <div class='inline'>nil if we have no version script, otherwise, does jamf match our version_script?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 471 472 473 474 475 476 477 478 479 480 481</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 471 def jamf_patch_ea_matches_version_script? # our current version script - nil if we currently don't have one our_version_script = version_script_contents # we don't have one, so if Jamf does at the moment, it'll go away soon # when jamf catches up with the title editor. return unless our_version_script # does jamf's script match ours? our_version_script.chomp == jamf_patch_ea_contents.chomp end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_ea_url-instance_method"> #jamf_patch_ea_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Patch EA in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Patch EA in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 555 556 557 558 559 560</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 555 def jamf_patch_ea_url return @jamf_patch_ea_url if @jamf_patch_ea_url return unless version_script || (subscribed? && jamf_patch_ea_data) @jamf_patch_ea_url = "#{jamf_patch_title_url}?tab=extension" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_title-instance_method"> #jamf_patch_title(refresh: false) ⇒ <tt>Jamf::PatchTitle</tt>? </h3><div class="docstring"> <div class="discussion"> Create or fetch the patch title object for this xolo title. If we are deleting and it doesn't exist, return nil. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> refresh (<tt>Boolean</tt>) (defaults to: <tt>false</tt>) — <div class='inline'>re-fetch the patch title from Jamf?</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Jamf::PatchTitle</tt>, <tt>nil</tt>) — <div class='inline'>The Jamf Patch Title for this Xolo Title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1226 def jamf_patch_title(refresh: false) @jamf_patch_title = nil if refresh return @jamf_patch_title if @jamf_patch_title # wait up to 60secs for a managed title to become available. # subscribed titles are already available wait_for_managed_title_to_become_available # Jamf::PatchTitle object already active, just fetch it if jamf_patch_title_id # jamf_title_active? || subscribed? @jamf_patch_title = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchTitle.fetch(id: jamf_patch_title_id, cnx: jamf_cnx) # not yet active, so activate/create the Jamf::PatchTitle object else return if deleting? @jamf_patch_title = activate_jamf_patch_title end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_title_url-instance_method"> #jamf_patch_title_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Patch Title in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Patch Title in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1346 1347 1348</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1346 def jamf_patch_title_url @jamf_patch_title_url ||= "#{jamf_gui_url}/view/computers/patch/#{jamf_patch_title_id}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_title_active?-instance_method"> #jamf_title_active? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Is this xolo title currently active in Jamf?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Is this xolo title currently active in Jamf?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1164 1165 1166 1167 1168 1169 1170 1171</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1164 def jamf_title_active? !jamf_patch_title_id.pix_empty? # if subscribed? # jamf_active_subscribed_titles(refresh: true).key? title # else # jamf_active_managed_titles(refresh: true).key? title # end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_policy-instance_method"> #jamf_uninstall_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the policy that runs the jamf uninstall script </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>The Jamf Policy for uninstalling this title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 677 def jamf_uninstall_policy return @jamf_uninstall_policy if @jamf_uninstall_policy if jamf_uninstall_policy_exist? @jamf_uninstall_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch name: jamf_uninstall_policy_name, cnx: jamf_cnx else return if deleting? progress "Jamf: Creating Uninstall policy: '#{jamf_uninstall_policy_name}'", log: :info @jamf_uninstall_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_uninstall_policy_name, cnx: jamf_cnx configure_jamf_uninstall_policy(jamf_uninstall_policy) end @jamf_uninstall_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_policy_exist?-instance_method"> #jamf_uninstall_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the jamf_uninstall_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the jamf_uninstall_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 669 670 671</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 669 def jamf_uninstall_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(:refresh, cnx: jamf_cnx).include? jamf_uninstall_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_policy_url-instance_method"> #jamf_uninstall_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the uninstall policy in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the uninstall policy in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 734 735 736 737 738 739 740 741 742</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 734 def jamf_uninstall_policy_url return @jamf_uninstall_policy_url if @jamf_uninstall_policy_url return unless uninstallable? pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_uninstall_policy_name, cnx: jamf_cnx return unless pol_id @jamf_uninstall_policy_url = "#{jamf_gui_url}/policies.html?id=#{pol_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_script-instance_method"> #jamf_uninstall_script ⇒ <tt>Jamf::Script</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the script that uninstalls this title from a Mac </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Script</tt>) — <div class='inline'>The Jamf Script for uninstalling this title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 576 def jamf_uninstall_script return @jamf_uninstall_script if @jamf_uninstall_script if jamf_uninstall_script_exist? @jamf_uninstall_script = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Script.fetch name: jamf_uninstall_script_name, cnx: jamf_cnx else return if deleting? progress "Jamf: Creating Uninstall script '#{jamf_uninstall_script_name}'", log: :info @jamf_uninstall_script = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Script.create( name: jamf_uninstall_script_name, cnx: jamf_cnx ) @jamf_uninstall_script.save end @jamf_uninstall_script end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_script_exist?-instance_method"> #jamf_uninstall_script_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns Does the uninstall script exist in jamf?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>Does the uninstall script exist in jamf?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 568 569 570</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 568 def jamf_uninstall_script_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Script.all_names(:refresh, cnx: jamf_cnx).include? jamf_uninstall_script_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_uninstall_script_url-instance_method"> #jamf_uninstall_script_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the uninstall script in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the uninstall script in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 653 654 655 656 657 658 659 660 661</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 653 def jamf_uninstall_script_url return @jamf_uninstall_script_url if @jamf_uninstall_script_url return unless uninstallable? scr_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Script.valid_id jamf_uninstall_script_name, cnx: jamf_cnx return unless scr_id @jamf_uninstall_script_url = "#{jamf_gui_url}/view/settings/computer-management/scripts/#{scr_id}?tab=script" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jp_api_filter_string_for_version-instance_method"> #jp_api_filter_string_for_version(vers) ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> given a version, return a patch report filter with it properly quoted and URL escaped e.g. this string: 7.1.5 (84650) becomes: version=="7.1.5 (84650)" becomes: version%3D%3D%227.1.5+%2884650%29%22 becomes: &filter=version%3D%3D%227.1.5+%2884650%29%22 Use CGI.escape because it encodes all special cars, like parens, which we want here, rather than URI::Parser.new.escape which is meant to parse whole URLs leaving URL functional characters. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> vers (<tt>String</tt>) — <div class='inline'>the version the filter for</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the quoted and escaped filter string</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 315 316 317 318 319</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 315 def jp_api_filter_string_for_version(vers) raw_fiter_query = "version==\"#{vers}\"" escaped_filter_query = CGI.escape raw_fiter_query "&filter=#{escaped_filter_query}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="need_to_accept_jamf_patch_ea?-instance_method"> #need_to_accept_jamf_patch_ea? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Do we need to accept the patch ea in jamf? True if <ul> <li> title activation, and version_script </li> <li> any time version_script changes </li> <li> any time we switch from bundle data to version_script </li> <li> Title#create_ted_ea </li> <li> Title#update_ted_ea </li> </ul> </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 338 339 340 341 342</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 338 def need_to_accept_jamf_patch_ea? return unless managed? @need_to_accept_jamf_patch_ea end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="need_to_delete_jamf_uninstall_script?-instance_method"> #need_to_delete_jamf_uninstall_script? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> do we need to delete the uninstall script stuff in jamf? </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 647 648 649</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 647 def need_to_delete_jamf_uninstall_script? uninstall_script_contents.pix_empty? end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="need_to_update_description?-instance_method"> #need_to_update_description? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> do we need to update the description? True if our incoming changes include :description </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 243 244 245</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 243 def need_to_update_description? changes_for_update.key?(:description) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="need_to_update_expiration?-instance_method"> #need_to_update_expiration? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> do we need to create or delete the expire policy? True if our incoming changes include :expiration Ignore the expire paths - even when disabling expiration they can stay there, they won't mean anything. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 255 256 257</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 255 def need_to_update_expiration? changes_for_update.key?(:expiration) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="need_to_update_jamf_uninstall_script?-instance_method"> #need_to_update_jamf_uninstall_script? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> do we need to update the uninstall scriptin jamf? true if our incoming changes include :uninstall_script OR :uninstall_ids and the new value of at least one of them is not empty (in which case we'll delete it) </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 615 616 617 618 619 620 621 622 623</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 615 def need_to_update_jamf_uninstall_script? if changes_for_update.key?(:uninstall_script) !changes_for_update[:uninstall_script][:new].pix_empty? elsif changes_for_update.key?(:uninstall_ids) !changes_for_update[:uninstall_ids][:new].pix_empty? else false end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="patch_report-instance_method"> #patch_report(vers: nil) ⇒ <tt>Arrah<Hash></tt> </h3><div class="docstring"> <div class="discussion"> Get the patch report for this title. It's the JPAPI report data with each hash having a frozen: key added TODO: rework this when all the paging stuff is handled by ruby-jss </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> vers (<tt>String</tt>, <tt>nil</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>Limit the report to a specific version</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Arrah<Hash></tt>) — <div class='inline'>Data for each computer with any version of this title installed</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 268 def patch_report(vers: nil) vers = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Helpers.html" title="Xolo::Server::Helpers (module)">Helpers</a>::<a href="../Helpers/JamfPro.html" title="Xolo::Server::Helpers::JamfPro (module)">JamfPro</a>::<a href="../Helpers/JamfPro.html#PATCH_REPORT_UNKNOWN_VERSION-constant" title="Xolo::Server::Helpers::JamfPro::PATCH_REPORT_UNKNOWN_VERSION (constant)">PATCH_REPORT_UNKNOWN_VERSION</a> if vers == <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::UNKNOWN page_size = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Helpers.html" title="Xolo::Server::Helpers (module)">Helpers</a>::<a href="../Helpers/JamfPro.html" title="Xolo::Server::Helpers::JamfPro (module)">JamfPro</a>::<a href="../Helpers/JamfPro.html#PATCH_REPORT_JPAPI_PAGE_SIZE-constant" title="Xolo::Server::Helpers::JamfPro::PATCH_REPORT_JPAPI_PAGE_SIZE (constant)">PATCH_REPORT_JPAPI_PAGE_SIZE</a> page = 0 paged_rsrc = +"#{patch_report_rsrc}?page=#{page}&page-size=#{page_size}" filter = vers ? jp_api_filter_string_for_version(vers) : nil paged_rsrc << filter if filter report = [] loop do data = jamf_cnx.jp_get(paged_rsrc)[:results] log_debug "GOT #{paged_rsrc} >>> results size: #{data.size}" break if data.empty? report += data page += 1 paged_rsrc = "#{patch_report_rsrc}?page=#{page}&page-size=#{page_size}" paged_rsrc << filter if filter end # log_debug "REPORT: #{report}" frozen_comps = frozen_computers.keys report.each do |h| h[:frozen] = frozen_comps.include? h[:computerName] h[:version] = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::UNKNOWN if h[:version] == <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Helpers.html" title="Xolo::Server::Helpers (module)">Helpers</a>::<a href="../Helpers/JamfPro.html" title="Xolo::Server::Helpers::JamfPro (module)">JamfPro</a>::<a href="../Helpers/JamfPro.html#PATCH_REPORT_UNKNOWN_VERSION-constant" title="Xolo::Server::Helpers::JamfPro::PATCH_REPORT_UNKNOWN_VERSION (constant)">PATCH_REPORT_UNKNOWN_VERSION</a> end report end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="patch_versions-instance_method"> #patch_versions(version: nil, refresh: false) ⇒ <tt>Array<Hash></tt> </h3><div class="docstring"> <div class="discussion"> Returns an array of known patch versions for this title from Jamf These are not necessarily in xolo, but they are available from the Patch Source. One or more Hashes like this: { "version": "143.0.7499.170", "releaseDate": "2025-12-18T20:31:01Z", "standalone": true, "minimumOperatingSystem": "12.0", "rebootRequired": false, "killApps": [ { "appName": "Google Chrome" } ], "absoluteOrderId": "0" } </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> version (<tt>String</tt>, <tt>Symbol</tt>, <tt>nil</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>If a string, only return info about that version, if :latest, only the latest version, otherwise all available versions known by the patch source.</div> </li> <li> refresh (<tt>Boolean</tt>) (defaults to: <tt>false</tt>) — <div class='inline'>re-read the data from the Jamf Pro API</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Array<Hash></tt>) — <div class='inline'>Data about available patch versions for this title</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1641 def patch_versions(version: nil, refresh: false) @patch_versions = nil if refresh @patch_versions ||= [] if @patch_versions.empty? page = 0 loop do jpapi_path = "#{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Constants.html#JPAPI_PATCH_TITLE_ENDPOINT-constant" title="Xolo::Server::Constants::JPAPI_PATCH_TITLE_ENDPOINT (constant)">JPAPI_PATCH_TITLE_ENDPOINT</a>}/#{jamf_patch_title_id}/definitions?page=#{page}&page-size=1000&sort=absoluteOrderId%3Aasc" log_debug "Jamf: Fetching patch versions for title '#{title}' from Jamf API endpoint '#{jpapi_path}'" data = jamf_cnx.jp_get jpapi_path break if data[:results].empty? @patch_versions += data[:results] page += 1 end # loop end # if case version when nil @patch_versions when :latest @patch_versions.select { |p| p[:absoluteOrderId] == '0' } else @patch_versions.select { |p| p[:version] == version } end # case end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove_title_from_self_service-instance_method"> #remove_title_from_self_service(pol = nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Add the jamf_manual_install_released_policy to self service if needed </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The jamf_manual_install_released_policy, which may not be saved yet.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1520 def remove_title_from_self_service(pol = nil) pol ||= jamf_manual_install_released_policy return unless pol.in_self_service? msg = "Jamf: Removing Manual Install Policy '#{pol.name}' from Self Service." progress msg, log: :info pol.remove_from_self_service pol.save # loop thru versions to make any SSvc changes version_objects.each do |vobj| progress "Jamf: Removing patch policy for version '#{vobj.version}' of title '#{title}' from Self Service'", log: :info ppol = vobj.jamf_patch_policy ppol.remove_from_self_service ppol.save end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_frozen_group-instance_method"> #repair_frozen_group ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the frozen group </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1000 1001 1002 1003 1004</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1000 def repair_frozen_group progress 'Jamf: Ensuring frozen static group exists', log: :debug # This creates it if it doesn't exist. Nothing more we can do here. jamf_frozen_group end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_expire_policy-instance_method"> #repair_jamf_expire_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the expire policy in jamf </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1085 1086 1087 1088 1089 1090 1091 1092 1093</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1085 def repair_jamf_expire_policy if expiration && !expire_paths.pix_empty? progress "Jamf: Repairing expiration policy '#{jamf_expire_policy_name}'" configure_jamf_expire_policy else delete_jamf_expire_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_manual_install_released_policy-instance_method"> #repair_jamf_manual_install_released_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the jamf_manual_install_released_policy - the policy that installs whatever is the current release </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1474 1475 1476 1477 1478 1479 1480 1481</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1474 def repair_jamf_manual_install_released_policy return unless released_version progress 'Jamf: Repairing the manual/Self Service install policy for the current release' pol = jamf_manual_install_released_policy configure_jamf_manual_install_released_policy(pol) pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_title_objects-instance_method"> #repair_jamf_title_objects ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Repair this title in Jamf Pro <ul> <li>TODO: activate title in patch mgmt <ul> <li>TODO: Accept Patch EA</li> </ul> </li> <li>title-installed smart group 'xolo-<title>-installed'</li> <li>frozen static group 'xolo-<title>-frozen'</li> <li>manual/SSvc install-current-release policy 'xolo-<title>-install' <ul> <li>trigger 'xolo-<title>-install'</li> <li>ssvc icon</li> <li>ssvc category</li> <li>description</li> </ul> </li> <li>if uninstallable <ul> <li>uninstall script 'xolo-<title>-uninstall'</li> <li>uninstall policy 'xolo-<title>-uninstall'</li> <li>if expirable <ul> <li>expire policy 'xolo-<title>-expire' <ul> <li>trigger 'xolo-<title>-expire'</li> </ul> </li> </ul> </li> </ul> </li> </ul> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 160 161 162 163 164 165 166 167 168 169</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 160 def repair_jamf_title_objects progress "Jamf: Repairing Jamf objects for title '#{title}'", log: :info configure_jamf_installed_group repair_jamf_uninstall_policy repair_jamf_uninstall_script repair_jamf_expire_policy repair_frozen_group repair_jamf_manual_install_released_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_uninstall_policy-instance_method"> #repair_jamf_uninstall_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the uninstall script and policy in jamf </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 715 716 717 718 719 720 721</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 715 def repair_jamf_uninstall_policy if uninstall_script_contents configure_jamf_uninstall_policy else delete_jamf_uninstall_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_uninstall_script-instance_method"> #repair_jamf_uninstall_script ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the uninstall script and policy in jamf </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 635 636 637 638 639 640 641</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 635 def repair_jamf_uninstall_script if uninstall_script_contents configure_jamf_uninstall_script else delete_jamf_uninstall_script end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="run_autopkg_recipe-instance_method"> #run_autopkg_recipe ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> run the autopkg recipe if defined See Helpers::AutoPkg for more details </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1609 1610 1611</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1609 def run_autopkg_recipe server_app_instance.run_autopkg_recipe self end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="thaw_computers-instance_method"> #thaw_computers(computers:) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> thaw some computers see #freeze_or_thaw_computers </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 955 def thaw_computers(computers:) result = {} thaws_to_log = [] if computers.include? <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::TARGET_ALL log_info "Thawing all computers for title: '#{title}'" jamf_frozen_group.clear result[<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::TARGET_ALL] = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::OK thaws_to_log << <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::TARGET_ALL else grp_members = jamf_frozen_group.member_names computers.each do |comp| if grp_members.include? comp jamf_frozen_group.remove_member comp log_info "Thawed computer '#{comp}' for title '#{title}'" result[comp] = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::OK thaws_to_log << comp else log_debug "Cannot thaw computer '#{comp}' for title '#{title}', not frozen" result[comp] = "#{<a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::ERROR}: Not frozen" end # if grp_members.include? comp end # computers.each end # if computers.include? [result, thaws_to_log] end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="toggle_jamf_manual_install_released_policy-instance_method"> #toggle_jamf_manual_install_released_policy(pol, vobj = nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> enable or disable the manual install policy for the current release, depending on whether or not we have a released version return [void] </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>) — <div class='inline'>the manual install policy for the current release, which may or may not be saved yet.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1450 def toggle_jamf_manual_install_released_policy(pol, vobj = nil) # remove any current pkg payload pol.package_ids.each { |pid| pol.remove_package pid } unless vobj desired_vers = releasing_version || released_version vobj = desired_vers ? version_object(desired_vers) : nil end if vobj progress "Jamf: Setting policy #{jamf_manual_install_released_policy_name} to install the package for version '#{vobj.version}'", log: :info pol.add_package vobj.jamf_pkg_id progress "Jamf: Enabling policy #{jamf_manual_install_released_policy_name}", log: :info pol.enable else progress "Jamf: Disabling policy #{jamf_manual_install_released_policy_name}, no released version", log: :info pol.disable end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_description_in_jamf-instance_method"> #update_description_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Update the description in Jamfy places it appears At the moment, this is only the manual install policy if its in self service. The package notes are updated by the versions themselves via the update_versions_for_title_changes_in_jamf method </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 223 224 225 226 227 228 229 230 231 232 233 234 235 236</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 223 def update_description_in_jamf return unless need_to_update_description? # Update the manual install policy return unless self_service pol = jamf_manual_install_released_policy return unless pol progress "Jamf: Updating Description for Self Service in policy '#{pol.name}'.", log: :info new_desc = changes_for_update[:description][:new] || description pol.self_service_description = new_desc pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_ssvc-instance_method"> #update_ssvc ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Update whether or not we are in self service, based on the setting in the title </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1542 def update_ssvc pol = jamf_manual_install_released_policy adding_to_ssvc = changes_for_update.dig :self_service, :new updating_config = changes_for_update.dig :self_service_category, :new updating_config ||= changes_for_update.dig :description, :new updating_config ||= changes_for_update.dig :display_name, :new # if adding_to_ssvc is nil, we aren't changing it at all # it must be false to indicate removal. removing_from_ssvc = adding_to_ssvc == false if adding_to_ssvc add_title_to_self_service(pol) elsif updating_config configure_pol_for_self_service(pol) # we should not be in SSvc, remove it, but leave all the settings elsif removing_from_ssvc remove_title_from_self_service(pol) end pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_title_in_jamf-instance_method"> #update_title_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Apply any changes to Jamf as needed Mostly this just sets flags indicating what needs to be updated in the various version-related things in jamf - policies, self service, etc. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 100 def update_title_in_jamf # ORDER MATTERS # if the exclusions have changed update the manual install released policy if changes_for_update[:excluded_groups] progress "Jamf: Updating excluded groups for Manual Released Policy '#{jamf_manual_install_released_policy_name}'." configure_jamf_manual_install_released_policy(jamf_manual_install_released_policy) end # Do we need to update (vs delete) the uninstall script? if need_to_update_jamf_uninstall_script? configure_jamf_uninstall_script configure_jamf_uninstall_policy # this creates the policy to use the script, if needed # which needs both the uninstall script and the installed group to exist jamf_uninstall_policy # or delete it if no longer needed elsif need_to_delete_jamf_uninstall_script? delete_jamf_uninstall_policy delete_jamf_uninstall_script end # Do we need to add or delete the expire policy? # NOTE: if the uninstall script was deleted, # expiration won't do anything. if need_to_update_expiration? changes_for_update.dig(:expiration, :new).to_i.positive? ? jamf_expire_policy : delete_jamf_expire_policy end update_description_in_jamf update_ssvc # TODO: deal with icon changes: if changes_for_update&.key? :self_service_icon if jamf_title_active? update_versions_for_title_changes_in_jamf else log_debug "Jamf: Title '#{display_name}' (#{title}) is not yet active to Jamf, nothing to update in versions." end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_versions_for_title_changes_in_jamf-instance_method"> #update_versions_for_title_changes_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.If any title changes require updates to existing versions in Jamf, this loops thru the versions and applies them This should happen after the incoming changes have been applied to this title instance Jamf Stuff <ul> <li>update any policy scopes</li> <li>update any policy SSvc settings</li> </ul> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 207 208 209 210 211 212 213</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 207 def update_versions_for_title_changes_in_jamf version_objects.each do |vers_obj| vers_obj.update_release_groups(ttl_obj: self) if changes_for_update&.key? :release_groups vers_obj.update_excluded_groups(ttl_obj: self) if changes_for_update&.key? :excluded_groups vers_obj.update_jamf_package_notes(ttl_obj: self) if need_to_update_description? end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="wait_for_managed_title_to_become_available-instance_method"> #wait_for_managed_title_to_become_available ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> wait up to 60secs for a managed title to become available to be activated subscribed titles are already available </div> </div> <div class="tags"> Raises: <ul class="raise"> <li> (<tt>Xolo::NoSuchItemError</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/title_jamf_access.rb', line 1295 def wait_for_managed_title_to_become_available return unless managed? return if jamf_title_active? counter = 0 until jamf_title_active? || jamf_managed_title_available? || counter == 12 log_debug "Jamf: Waiting for title '#{display_name}' (#{title}) to become available from the Title Editor" sleep 5 counter += 1 end return if jamf_managed_title_available? || jamf_title_active? msg = "Jamf: Title '#{title}' is not yet available to Jamf. Make sure it has at least one version enabled in the Title Editor" log_error msg raise <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::NoSuchItemError, msg end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sat Jul 25 19:07:59 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.44 (ruby-4.0.2). </div> </div> </body> </html>