Module: Xolo::Server::Mixins::VersionJamfAccess

Included in:: Version

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

Overview

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

Constant Summary collapse

JAMF_SMART_GROUP_NAME_INSTALLED_SFX = The group of macs with this version installed is named the full prefix plus this suffix.

'installed'

JAMF_POLICY_NAME_MANUAL_INSTALL_SFX = The policy that does initial installs on-demand (via 'xolo install <version') is named the full prefix plus this suffix. </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code">'manual-install'</pre></dd> <dt id="JAMF_POLICY_NAME_AUTO_INSTALL_SFX-constant" class="">JAMF_POLICY_NAME_AUTO_INSTALL_SFX = <div class="docstring"> <div class="discussion"> The policy that does auto-installs is named the full prefix plus this suffix. The scope is changed as needed when a version's status changes </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code">'auto-install'</pre></dd> <dt id="JAMF_POLICY_NAME_AUTO_REINSTALL_SFX-constant" class="">JAMF_POLICY_NAME_AUTO_REINSTALL_SFX = <div class="docstring"> <div class="discussion"> The policy that does auto-re-installs is named the full prefix plus this suffix. The scope is changed as needed when a version's status changes </div> </div> <div class="tags"> </div> </dt> <dd><pre class="code">'auto-reinstall'</pre></dd> <dt id="PATCH_POL_SSVC_NOTIFICATION_TYPE-constant" class="">PATCH_POL_SSVC_NOTIFICATION_TYPE = </dt> <dd><pre class="code">:ssvc_and_nctr</pre></dd> <dt id="PATCH_POL_SSVC_INSTALL_BTN_TXT-constant" class="">PATCH_POL_SSVC_INSTALL_BTN_TXT = </dt> <dd><pre class="code">'Update'</pre></dd> <dt id="PATCH_POL_SSVC_REMINDER_FREQ_HRS-constant" class="">PATCH_POL_SSVC_REMINDER_FREQ_HRS = </dt> <dd><pre class="code">24</pre></dd> <dt id="PATCH_POL_SSVC_DEADLINE_DAYS-constant" class="">PATCH_POL_SSVC_DEADLINE_DAYS = </dt> <dd><pre class="code">7</pre></dd> <dt id="PATCH_POL_GRACE_PERIOD_MINUTES-constant" class="">PATCH_POL_GRACE_PERIOD_MINUTES = </dt> <dd><pre class="code">15</pre></dd> <dt id="PATCH_POL_GRACE_PERIOD_SUBJ-constant" class="">PATCH_POL_GRACE_PERIOD_SUBJ = </dt> <dd><pre class="code">'Important'</pre></dd> <dt id="PATCH_POL_GRACE_PERIOD_MSG-constant" class="">PATCH_POL_GRACE_PERIOD_MSG = </dt> <dd><pre class="code">'$APP_NAMES will quit in $DELAY_MINUTES minutes so that $SOFTWARE_TITLE can be updated. Please save anything you are working on and quit the app(s).'</pre></dd> </dl> <h2> Class Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#extended-class_method" title="extended (class method)">.extended(extender) ⇒ Object </a> <div class='inline'>when this module is extended.</div> </li> <li class="public "> <a href="#included-class_method" title="included (class method)">.included(includer) ⇒ Object </a> <div class='inline'>when this module is included.</div> </li> </ul> <h2> Instance Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#activate_managed_patch_version_in_jamf-instance_method" title="#activate_managed_patch_version_in_jamf (instance method)">#activate_managed_patch_version_in_jamf ⇒ void </a> <div class='inline'>Wait until the version is visible from the title editor then assign the pkg to it in Jamf Patch, and create the patch policy.</div> </li> <li class="public "> <a href="#activate_patch_version_in_jamf-instance_method" title="#activate_patch_version_in_jamf (instance method)">#activate_patch_version_in_jamf ⇒ void </a> <div class='inline'>Assign the package for this version to the Jamf::PatchTitle::Version in Jamf and create the patch policy for this version.</div> </li> <li class="public "> <a href="#activate_subscribed_patch_version_in_jamf-instance_method" title="#activate_subscribed_patch_version_in_jamf (instance method)">#activate_subscribed_patch_version_in_jamf ⇒ Object </a> <div class='inline'>Patches for subscribed titles are already visible in Jamf Patch Management So we just need to assign the pkg to the patch version, and create the patch policy.</div> </li> <li class="public "> <a href="#assign_pkg_to_patch_in_jamf-instance_method" title="#assign_pkg_to_patch_in_jamf (instance method)">#assign_pkg_to_patch_in_jamf ⇒ void </a> <div class='inline'>Assign the Package to the Jamf::PatchTitle::Version for this Xolo version.</div> </li> <li class="public "> <a href="#configure_jamf_auto_install_policy-instance_method" title="#configure_jamf_auto_install_policy (instance method)">#configure_jamf_auto_install_policy(pol = nil) ⇒ Object </a> <div class='inline'>Configure the given policy as the auto-install policy for this version.</div> </li> <li class="public "> <a href="#configure_jamf_auto_reinstall_policy-instance_method" title="#configure_jamf_auto_reinstall_policy (instance method)">#configure_jamf_auto_reinstall_policy(pol) ⇒ Object </a> <div class='inline'>Set the proper config for the auto reinstall policy.</div> </li> <li class="public "> <a href="#configure_jamf_installed_group-instance_method" title="#configure_jamf_installed_group (instance method)">#configure_jamf_installed_group(grp) ⇒ void </a> <div class='inline'>Set the configuration of the given smart group as needed for the jamf_installed_group.</div> </li> <li class="public "> <a href="#configure_jamf_manual_install_policy-instance_method" title="#configure_jamf_manual_install_policy (instance method)">#configure_jamf_manual_install_policy(pol) ⇒ Object </a> <div class='inline'>Configure the given policy as the manual-install policy for this version.</div> </li> <li class="public "> <a href="#configure_jamf_patch_policy-instance_method" title="#configure_jamf_patch_policy (instance method)">#configure_jamf_patch_policy(ppol) ⇒ Object </a> <div class='inline'>Configure the patch policy NOTE: This doesn't save the changes!.</div> </li> <li class="public "> <a href="#configure_patch_pol_deployment-instance_method" title="#configure_patch_pol_deployment (instance method)">#configure_patch_pol_deployment(ppol: nil, ttl_obj: nil) ⇒ void </a> <div class='inline'>Configure the patch policy for self service or automatic deployment NOTE: Does NOT save the policy changes! ###############################.</div> </li> <li class="public "> <a href="#create_in_jamf-instance_method" title="#create_in_jamf (instance method)">#create_in_jamf ⇒ Object </a> <div class='inline'>Create everything we need in Jamf.</div> </li> <li class="public "> <a href="#create_jamf_auto_install_policy-instance_method" title="#create_jamf_auto_install_policy (instance method)">#create_jamf_auto_install_policy ⇒ Jamf::Policy </a> <div class='inline'>The auto install policy is triggered by checkin but may have narrow scope targets, or may be targeted to 'all' (after release) Before release, the targets are those defined in #pilot_groups_to_use.</div> </li> <li class="public "> <a href="#create_jamf_auto_reinstall_policy-instance_method" title="#create_jamf_auto_reinstall_policy (instance method)">#create_jamf_auto_reinstall_policy ⇒ Jamf::Policy </a> <div class='inline'>The auto rionstall policy, for when a pkg is re-uploaded for this version.</div> </li> <li class="public "> <a href="#create_jamf_installed_group-instance_method" title="#create_jamf_installed_group (instance method)">#create_jamf_installed_group ⇒ Jamf::ComputerGroup </a> <div class='inline'>Create the smart group of macs with this version installed.</div> </li> <li class="public "> <a href="#create_jamf_manual_install_policy-instance_method" title="#create_jamf_manual_install_policy (instance method)">#create_jamf_manual_install_policy ⇒ Object </a> <div class='inline'>The manual install policy is always scoped to all computers, with exclusions.</div> </li> <li class="public "> <a href="#create_jamf_package-instance_method" title="#create_jamf_package (instance method)">#create_jamf_package ⇒ Jamf::JPackage </a> <div class='inline'>Create the Jamf::JPackage object for this version and return it.</div> </li> <li class="public "> <a href="#create_jamf_patch_policy-instance_method" title="#create_jamf_patch_policy (instance method)">#create_jamf_patch_policy ⇒ Jamf::PatchPolicy </a> <div class='inline'>The xolo patch policy for this version.</div> </li> <li class="public "> <a href="#delete_jamf_package-instance_method" title="#delete_jamf_package (instance method)">#delete_jamf_package ⇒ void </a> <div class='inline'>Delete the package for this version from Jamf Pro.</div> </li> <li class="public "> <a href="#delete_version_from_jamf-instance_method" title="#delete_version_from_jamf (instance method)">#delete_version_from_jamf ⇒ void </a> <div class='inline'>Delete an entire version from Jamf Pro This includes the package, the manual install policy, the auto install policy, and the patch policy.</div> </li> <li class="public "> <a href="#deploy_via_mdm-instance_method" title="#deploy_via_mdm (instance method)">#deploy_via_mdm(targets) ⇒ Hash </a> <div class='inline'>Install this version on a one or more computers via MDM.</div> </li> <li class="public "> <a href="#disable_policies_for_deprecation_or_skipping-instance_method" title="#disable_policies_for_deprecation_or_skipping (instance method)">#disable_policies_for_deprecation_or_skipping(reason) ⇒ void </a> <div class='inline'>Disable the auto-install and patch policies for this version when it is deprecated or skipped.</div> </li> <li class="public "> <a href="#expand_groups_for_deploy-instance_method" title="#expand_groups_for_deploy (instance method)">#expand_groups_for_deploy(groups, removals) ⇒ Array<Integer> </a> <div class='inline'>expand computer groups given for deploy_via_mdm.</div> </li> <li class="public "> <a href="#jamf_auto_install_policy-instance_method" title="#jamf_auto_install_policy (instance method)">#jamf_auto_install_policy ⇒ Jamf::Policy </a> <div class='inline'>Create or fetch the auto install policy for this version If we are deleting and it doesn't exist, return nil.</div> </li> <li class="public "> <a href="#jamf_auto_install_policy_exist%3F-instance_method" title="#jamf_auto_install_policy_exist? (instance method)">#jamf_auto_install_policy_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_auto_install_policy exist?.</div> </li> <li class="public "> <a href="#jamf_auto_install_policy_url-instance_method" title="#jamf_auto_install_policy_url (instance method)">#jamf_auto_install_policy_url ⇒ String </a> <div class='inline'>The URL for the Jamf Pro Policy that does auto-installs of this version.</div> </li> <li class="public "> <a href="#jamf_auto_reinstall_policy-instance_method" title="#jamf_auto_reinstall_policy (instance method)">#jamf_auto_reinstall_policy ⇒ Jamf::Policy </a> <div class='inline'>Create or fetch the auto re-install policy for this version If we are deleting and it doesn't exist, return nil.</div> </li> <li class="public "> <a href="#jamf_auto_reinstall_policy_exist%3F-instance_method" title="#jamf_auto_reinstall_policy_exist? (instance method)">#jamf_auto_reinstall_policy_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_auto_reinstall_policy exist?.</div> </li> <li class="public "> <a href="#jamf_auto_reinstall_policy_url-instance_method" title="#jamf_auto_reinstall_policy_url (instance method)">#jamf_auto_reinstall_policy_url ⇒ String </a> <div class='inline'>The URL for the Jamf Pro Policy that does auto reinstalls of this version.</div> </li> <li class="public "> <a href="#jamf_gui_url-instance_method" title="#jamf_gui_url (instance method)">#jamf_gui_url ⇒ String </a> <div class='inline'>The start of the Jamf Pro URL for GUI/WebApp access.</div> </li> <li class="public "> <a href="#jamf_installed_group-instance_method" title="#jamf_installed_group (instance method)">#jamf_installed_group ⇒ Jamf::ComputerGroup </a> <div class='inline'>Create or fetch the smart group of macs with this version installed If we are deleting and it doesn't exist, return nil.</div> </li> <li class="public "> <a href="#jamf_installed_group_criteria-instance_method" title="#jamf_installed_group_criteria (instance method)">#jamf_installed_group_criteria ⇒ Array<Jamf::Criteriable::Criterion> </a> <div class='inline'>The criteria for the smart group in Jamf that contains all Macs with this version of this title installed.</div> </li> <li class="public "> <a href="#jamf_installed_group_exist%3F-instance_method" title="#jamf_installed_group_exist? (instance method)">#jamf_installed_group_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_installed_group exist?.</div> </li> <li class="public "> <a href="#jamf_installed_group_url-instance_method" title="#jamf_installed_group_url (instance method)">#jamf_installed_group_url ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="#jamf_manual_install_policy-instance_method" title="#jamf_manual_install_policy (instance method)">#jamf_manual_install_policy ⇒ Jamf::Policy </a> <div class='inline'>Create or fetch the manual install policy for this version If we are deleting and it doesn't exist, return nil.</div> </li> <li class="public "> <a href="#jamf_manual_install_policy_exist%3F-instance_method" title="#jamf_manual_install_policy_exist? (instance method)">#jamf_manual_install_policy_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_manual_install_policy exist?.</div> </li> <li class="public "> <a href="#jamf_manual_install_policy_url-instance_method" title="#jamf_manual_install_policy_url (instance method)">#jamf_manual_install_policy_url ⇒ String </a> <div class='inline'>The URL for the Jamf Pro Policy that does manual installs of this version.</div> </li> <li class="public "> <a href="#jamf_package-instance_method" title="#jamf_package (instance method)">#jamf_package ⇒ Jamf::JPackage </a> <div class='inline'>Create or fetch the Jamf::JPackage object for this version Returns nil if the package doesn't exist and we're deleting.</div> </li> <li class="public "> <a href="#jamf_package_exist%3F-instance_method" title="#jamf_package_exist? (instance method)">#jamf_package_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_package exist?.</div> </li> <li class="public "> <a href="#jamf_package_notes-instance_method" title="#jamf_package_notes (instance method)">#jamf_package_notes(ttl_obj: nil) ⇒ String </a> <div class='inline'>The 'notes' text for the Jamf::JPackage object for this version.</div> </li> <li class="public "> <a href="#jamf_package_url-instance_method" title="#jamf_package_url (instance method)">#jamf_package_url ⇒ String </a> <div class='inline'>The URL for the Package that installs this version in Jamf Pro.</div> </li> <li class="public "> <a href="#jamf_patch_policy-instance_method" title="#jamf_patch_policy (instance method)">#jamf_patch_policy ⇒ Jamf::PatchPolicy? </a> <div class='inline'>Fetch or create the patch policy for this version If we are deleting and it doesn't exist, return nil.</div> </li> <li class="public "> <a href="#jamf_patch_policy_exist%3F-instance_method" title="#jamf_patch_policy_exist? (instance method)">#jamf_patch_policy_exist? ⇒ Boolean </a> <div class='inline'>Does the jamf_patch_policy exist?.</div> </li> <li class="public "> <a href="#jamf_patch_policy_url-instance_method" title="#jamf_patch_policy_url (instance method)">#jamf_patch_policy_url ⇒ String </a> <div class='inline'>The URL for the Jamf Pro Patch Policy that updates to this version.</div> </li> <li class="public "> <a href="#jamf_patch_version-instance_method" title="#jamf_patch_version (instance method)">#jamf_patch_version ⇒ Jamf::PatchTitle::Version </a> <div class='inline'>Xolo version.</div> </li> <li class="public "> <a href="#patch_report-instance_method" title="#patch_report (instance method)">#patch_report ⇒ Arrah<Hash> </a> <div class='inline'>Get the patch report for this version.</div> </li> <li class="public "> <a href="#remove_exclusions_from_deploy-instance_method" title="#remove_exclusions_from_deploy (instance method)">#remove_exclusions_from_deploy(targets, removals) ⇒ void </a> <div class='inline'>Remove exclusions from the list of targets for deploy_via_mdm.</div> </li> <li class="public "> <a href="#remove_invalid_computers_for_deploy-instance_method" title="#remove_invalid_computers_for_deploy (instance method)">#remove_invalid_computers_for_deploy(targets, removals) ⇒ void </a> <div class='inline'>remove invalid computers from the list of targets for deploy_via_mdm.</div> </li> <li class="public "> <a href="#repair_jamf_auto_install_policy-instance_method" title="#repair_jamf_auto_install_policy (instance method)">#repair_jamf_auto_install_policy ⇒ Object </a> <div class='inline'>repair the auto-install policy only.</div> </li> <li class="public "> <a href="#repair_jamf_auto_reinstall_policy-instance_method" title="#repair_jamf_auto_reinstall_policy (instance method)">#repair_jamf_auto_reinstall_policy ⇒ Object </a> <div class='inline'>Reset the configuration of the jamf_installed_group.</div> </li> <li class="public "> <a href="#repair_jamf_installed_group-instance_method" title="#repair_jamf_installed_group (instance method)">#repair_jamf_installed_group ⇒ Object </a> <div class='inline'>Reset the configuration of the jamf_installed_group but only if there's been a re-upload of the pkg.</div> </li> <li class="public "> <a href="#repair_jamf_manual_install_policy-instance_method" title="#repair_jamf_manual_install_policy (instance method)">#repair_jamf_manual_install_policy ⇒ Object </a> <div class='inline'>repair the manual-install policy only.</div> </li> <li class="public "> <a href="#repair_jamf_package-instance_method" title="#repair_jamf_package (instance method)">#repair_jamf_package ⇒ Object </a> <div class='inline'>repair the package object only.</div> </li> <li class="public "> <a href="#repair_jamf_patch_policy-instance_method" title="#repair_jamf_patch_policy (instance method)">#repair_jamf_patch_policy ⇒ Object </a> <div class='inline'>repair the patch policy only.</div> </li> <li class="public "> <a href="#repair_jamf_version_objects-instance_method" title="#repair_jamf_version_objects (instance method)">#repair_jamf_version_objects ⇒ Object </a> <div class='inline'>Validate and fix any Jamf::JPackage objects that related to this version: - the package object - the installed-group - the auto-install policy - the manual-install policy - the auto-reinstall policy - the patch policy.</div> </li> <li class="public "> <a href="#reset_policies_to_pilot-instance_method" title="#reset_policies_to_pilot (instance method)">#reset_policies_to_pilot ⇒ void </a> <div class='inline'>reset all the policies for this version to pilot.</div> </li> <li class="public "> <a href="#set_patch_policy_ssvc_icon-instance_method" title="#set_patch_policy_ssvc_icon (instance method)">#set_patch_policy_ssvc_icon(ppol, icon_id) ⇒ Void </a> <div class='inline'>Set an existing ssvc icon for a given patch policy.</div> </li> <li class="public "> <a href="#set_policy_exclusions-instance_method" title="#set_policy_exclusions (instance method)">#set_policy_exclusions(pol, ttl_obj: nil) ⇒ Object </a> <div class='inline'>set excluded groups in a [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER.</div> </li> <li class="public "> <a href="#set_policy_pilot_groups-instance_method" title="#set_policy_pilot_groups (instance method)">#set_policy_pilot_groups(pol) ⇒ void </a> <div class='inline'>set target groups in a pilot [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER.</div> </li> <li class="public "> <a href="#set_policy_release_groups-instance_method" title="#set_policy_release_groups (instance method)">#set_policy_release_groups(pol, ttl_obj: nil) ⇒ void </a> <div class='inline'>set target groups in a non=pilot [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER.</div> </li> <li class="public "> <a href="#set_policy_to_all_targets-instance_method" title="#set_policy_to_all_targets (instance method)">#set_policy_to_all_targets(pol) ⇒ void </a> <div class='inline'>Set a policy to be scoped to all targets REMEMBER TO SAVE THE POLICY LATER.</div> </li> <li class="public "> <a href="#update_excluded_groups-instance_method" title="#update_excluded_groups (instance method)">#update_excluded_groups(ttl_obj: nil) ⇒ Object </a> <div class='inline'>Update all the excluded_groups policy scopes for this version when either the title or version has changed them.</div> </li> <li class="public "> <a href="#update_jamf_package_notes-instance_method" title="#update_jamf_package_notes (instance method)">#update_jamf_package_notes(ttl_obj: nil) ⇒ void </a> <div class='inline'>update the description for the Jamf::JPackage.</div> </li> <li class="public "> <a href="#update_jamf_patch_policy_patch_unknown-instance_method" title="#update_jamf_patch_policy_patch_unknown (instance method)">#update_jamf_patch_policy_patch_unknown ⇒ void </a> <div class='inline'>update the :patch_unknown for the patch policy.</div> </li> <li class="public "> <a href="#update_jamf_pkg_min_os-instance_method" title="#update_jamf_pkg_min_os (instance method)">#update_jamf_pkg_min_os ⇒ void </a> <div class='inline'>update the min_os setting for the Jamf::JPackage.</div> </li> <li class="public "> <a href="#update_jamf_pkg_reboot-instance_method" title="#update_jamf_pkg_reboot (instance method)">#update_jamf_pkg_reboot ⇒ void </a> <div class='inline'>update the reboot setting for the Jamf::JPackage.</div> </li> <li class="public "> <a href="#update_patch_policy_deployment-instance_method" title="#update_patch_policy_deployment (instance method)">#update_patch_policy_deployment(ttl_obj:) ⇒ Object </a> <div class='inline'>Update the patch policy deployment settings if they were changed in the title.</div> </li> <li class="public "> <a href="#update_pilot_groups-instance_method" title="#update_pilot_groups (instance method)">#update_pilot_groups ⇒ Object </a> <div class='inline'>Update all the pilot_groups policy scopes for this version when either the title or version has changed them.</div> </li> <li class="public "> <a href="#update_release_groups-instance_method" title="#update_release_groups (instance method)">#update_release_groups(ttl_obj: nil) ⇒ Object </a> <div class='inline'>Update all the release_groups policy scopes for this version when either the title or version has changed them.</div> </li> <li class="public "> <a href="#update_version_in_jamf-instance_method" title="#update_version_in_jamf (instance method)">#update_version_in_jamf ⇒ Object </a> <div class='inline'>Apply edits to the Xolo version to Jamf as needed This includes scope changes in policies, changes to pkg 'reboot' setting and changes to pkg 'os_requirements' Uploading a new .pkg installer happen separately.</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="extended-class_method"> .extended(extender) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> when this module is extended </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 173 174 175</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 173 def self.extended(extender) <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>.verbose_extend extender, self end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " 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"> 168 169 170</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 168 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="activate_managed_patch_version_in_jamf-instance_method"> #activate_managed_patch_version_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Wait until the version is visible from the title editor then assign the pkg to it in Jamf Patch, and create the patch policy. Do this in a thread so the xadm user doesn't wait up to ?? minutes. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1350 def activate_managed_patch_version_in_jamf # don't do this if there's already one running for this instance if @activate_patch_version_thread&.alive? log_debug "Jamf: activate_patch_version_thread already running. Caller: #{caller_locations.first}" return end msg = "Jamf: Will assign Jamf pkg '#{jamf_pkg_name}' and create the patch policy when this version becomes visible to Jamf Pro from the Title Editor." progress msg, log: :debug @activate_patch_version_thread = Thread.new do log_debug "Jamf: Starting activate_patch_version_thread waiting for version #{version} of title #{title} to become visible from the title editor" 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 15 log_debug "Jamf: checking for version #{version} of title #{title} to become visible from the title editor since #{start_time}" # check for the existence of the jamf_patch_title every time, since it might have gone away # if the title was deleted while this was happening. next unless title_object.jamf_patch_title(refresh: true) && title_object.jamf_patch_title.versions.key?(version) did_it = true break end if did_it activate_patch_version_in_jamf msg = "Jamf: Version '#{version}' of title '#{title}' is now visible in Jamf Pro. Package assigned and Patch policy created." log_info msg, alert: true else msg = "Jamf: ERROR: Version '#{version}' of title '#{title}' has not become visible from the Title Editor 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>} seconds. The package has not been assigned, and no patch policy was created." log_error msg, alert: true end end # thread @activate_patch_version_thread.name = "activate_patch_version_thread-#{title}-#{version}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="activate_patch_version_in_jamf-instance_method"> #activate_patch_version_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Assign the package for this version to the Jamf::PatchTitle::Version in Jamf and create the patch policy for this version. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1407 def activate_patch_version_in_jamf log_debug "Jamf: Activating patch version in Jamf for version '#{version}' of title '#{title}'" # create the Jamf::JPackage object if needed jamf_package title_object.jamf_patch_title(refresh: true) sleep 3 assign_pkg_to_patch_in_jamf # give jamf a moment to catch up and refresh the patch title # so we see the pkg has been assigned sleep 2 title_object.jamf_patch_title(refresh: true) create_jamf_patch_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="activate_subscribed_patch_version_in_jamf-instance_method"> #activate_subscribed_patch_version_in_jamf ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Patches for subscribed titles are already visible in Jamf Patch Management So we just need to assign the pkg to the patch version, and create the patch policy. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1396 1397 1398 1399 1400</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1396 def activate_subscribed_patch_version_in_jamf msg = "Jamf: Assigning package and creating patch policy for version '#{version}' of subscribed title '#{title}'" log_info msg activate_patch_version_in_jamf end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="assign_pkg_to_patch_in_jamf-instance_method"> #assign_pkg_to_patch_in_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Assign the Package to the Jamf::PatchTitle::Version for this Xolo version. This 'activates' the version in Jamf Patch, and must happen before patch policies can be created Jamf::PatchTitle::Version objects are contained in the matching Jamf::PatchTitle, and to make or save changes, we have to fetch the title, update the version, and save the title. NOTE: This can't happen until Jamf see's the version in the title editor otherwise you'll get an error. The methods that call this should ensure the version is visible. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1438 def assign_pkg_to_patch_in_jamf patch_vers_obj = jamf_patch_version if patch_vers_obj.nil? && repairing? msg = "Jamf: Cant re-assign package '#{jamf_pkg_name}' to patch version '#{version}' of title '#{title}' at this time. If there are problems with it, try 'repair' again later." progress msg, log: :info return end progress "Jamf: Assigning package '#{jamf_pkg_name}' to patch version '#{version}' of title '#{title}'", log: :info log_debug "Jamf: jamf_patch_version is: #{patch_vers_obj}" patch_vers_obj.package = jamf_pkg_name log_debug "Jamf: jamf_patch_version after assignment is: #{patch_vers_obj}" title_object.jamf_patch_title.save log_debug 'Jamf: Saved jamf_patch_title after assigning package to version.' end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_auto_install_policy-instance_method"> #configure_jamf_auto_install_policy(pol = nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Configure the given policy as the auto-install policy for this version </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"> 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 541 def configure_jamf_auto_install_policy(pol = nil) pol ||= jamf_auto_install_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.set_trigger_event :checkin, true pol.set_trigger_event :custom, <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::BLANK pol.frequency = :once_per_computer pol.retry_event = :checkin pol.retry_attempts = 5 pol.recon = false pol.package_names.each { |pkg_name| pol.remove_package pkg_name } pol.add_package jamf_pkg_name # exclusions are for always set_policy_exclusions pol # set the scope targets based on status if pilot? set_policy_pilot_groups pol else set_policy_release_groups pol end # enable or disable based on status if pilot? || released? || releasing? pol.enable else pol.disable end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_auto_reinstall_policy-instance_method"> #configure_jamf_auto_reinstall_policy(pol) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Set the proper config for the auto reinstall 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"> 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 816 def configure_jamf_auto_reinstall_policy(pol) # this creates the installed group if it doesn't already exist jamf_installed_group 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, true pol.set_trigger_event :custom, <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::BLANK pol.frequency = :once_per_computer pol.recon = false pol.retry_event = :checkin pol.retry_attempts = 5 pol.scope.set_targets :computer_groups, [jamf_installed_group.name] # exclusions are for always set_policy_exclusions pol pol.package_names.each { |pkg_name| pol.remove_package pkg_name } pol.add_package jamf_pkg_name # NOTE: this policy is not enabled by default - it will be enabled # if/when the pkg for the policy is re-uploaded pol.enable if reupload_date.is_a? Time end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_installed_group-instance_method"> #configure_jamf_installed_group(grp) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Set the configuration of the given smart group as needed for the jamf_installed_group </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> grp (<tt>Jamf::ComputerGroup</tt>) — <div class='inline'>the group to configure</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 733 734 735 736</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 733 def configure_jamf_installed_group(grp) progress "Jamf: Setting criteria for smart group '#{grp.name}'", log: :info grp.criteria = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Criteriable::Criteria.new(jamf_installed_group_criteria) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_manual_install_policy-instance_method"> #configure_jamf_manual_install_policy(pol) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Configure the given policy as the manual-install policy for this version </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"> 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 637 def configure_jamf_manual_install_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_trigger pol.frequency = :ongoing pol.recon = false pol.package_names.each { |pkg_name| pol.remove_package pkg_name } pol.add_package jamf_pkg_name set_policy_to_all_targets pol set_policy_exclusions pol # These policies shouldn't be in ssvc # only the title's jamf_manual_install_released_policy is pol.remove_from_self_service if pol.in_self_service? pol.enable end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_jamf_patch_policy-instance_method"> #configure_jamf_patch_policy(ppol) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Configure the patch policy NOTE: This doesn't save the changes! </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 929 def configure_jamf_patch_policy(ppol) progress "Jamf: Configuring Patch Policy for Version '#{version}' of Title '#{title}'.", log: :info ppol.name = jamf_patch_policy_name ppol.target_version = version # This should default to false, so that # we don't accidentally downgrade non-xolo test installs, # or server-pushed updates (like with commvault or cisco VPN) # The ternary operator is used here so that nils become # explicit false ppol.patch_unknown = patch_unknown ? true : false # when first creating a patch policy, its status is always # 'pilot' so the scope targets are the pilot groups, if any. # When the version is released, the patch policy will be # rescoped to all targets (limited by eligibility) if pilot? set_policy_pilot_groups ppol else ppol.scope.set_all_targets end # exclusions are for always set_policy_exclusions ppol # deployment method configure_patch_pol_deployment ppol: ppol # only pilot and released versions should have the patch policy enabled if pilot? || released? || creating? || releasing? ppol.enable else ppol.disable end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="configure_patch_pol_deployment-instance_method"> #configure_patch_pol_deployment(ppol: nil, ttl_obj: nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Configure the patch policy for self service or automatic deployment NOTE: Does NOT save the policy changes! ############################### </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ppol (<tt>Jamf::PatchPolicy</tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The patch policy to configure</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 984 def configure_patch_pol_deployment(ppol: nil, ttl_obj: nil) ppol ||= jamf_patch_policy ttl_obj ||= title_object use_ssvc_updates = if ttl_obj.changes_for_update&.dig :self_service_updates ttl_obj.changes_for_update[:self_service_updates][:new] else ttl_obj.self_service_updates end # always set the grace period regardless of deployment type progress "Jamf: Configuring Patch Policy grace period for version '#{version}' of title '#{title}' ", log: :info ppol.grace_period = <a href="#PATCH_POL_GRACE_PERIOD_MINUTES-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_GRACE_PERIOD_MINUTES (constant)">PATCH_POL_GRACE_PERIOD_MINUTES</a> ppol.grace_period_subject = <a href="#PATCH_POL_GRACE_PERIOD_SUBJ-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_GRACE_PERIOD_SUBJ (constant)">PATCH_POL_GRACE_PERIOD_SUBJ</a> ppol.grace_period_message = <a href="#PATCH_POL_GRACE_PERIOD_MSG-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_GRACE_PERIOD_MSG (constant)">PATCH_POL_GRACE_PERIOD_MSG</a> # Self Service deployment if use_ssvc_updates progress "Jamf: Configuring Patch Policy for version '#{version}' of title '#{title}' for Self Service", log: :info ppol.add_to_self_service msg = "#{title_object.display_name} is ready to be updated to version #{version}" ppol.self_service_install_button_text = <a href="#PATCH_POL_SSVC_INSTALL_BTN_TXT-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_SSVC_INSTALL_BTN_TXT (constant)">PATCH_POL_SSVC_INSTALL_BTN_TXT</a> ppol.self_service_description = msg ppol.self_service_notifications_enabled = true ppol.self_service_notification_type = <a href="#PATCH_POL_SSVC_NOTIFICATION_TYPE-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_SSVC_NOTIFICATION_TYPE (constant)">PATCH_POL_SSVC_NOTIFICATION_TYPE</a> ppol.self_service_notification_subject = "#{title_object.display_name} update available" ppol.self_service_notification_message = msg ppol.self_service_reminders_enabled = true ppol.self_service_reminder_frequency = <a href="#PATCH_POL_SSVC_REMINDER_FREQ_HRS-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_SSVC_REMINDER_FREQ_HRS (constant)">PATCH_POL_SSVC_REMINDER_FREQ_HRS</a> ppol.deadline = <a href="#PATCH_POL_SSVC_DEADLINE_DAYS-constant" title="Xolo::Server::Mixins::VersionJamfAccess::PATCH_POL_SSVC_DEADLINE_DAYS (constant)">PATCH_POL_SSVC_DEADLINE_DAYS</a> return unless title_object.ssvc_icon_id set_patch_policy_ssvc_icon ppol, title_object.ssvc_icon_id # Automatic deployment else progress "Jamf: Configuring Patch Policy for version '#{version}' of title '#{title}' for automatic deployment", log: :info ppol.remove_from_self_service end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_in_jamf-instance_method"> #create_in_jamf ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Create everything we need in Jamf </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 189 def create_in_jamf # this will create the JPackage object jamf_package # The # - jamf_installed_group # - jamf_auto_reinstall_policy # aren't needed until there's a pkg re-upload # and they will be created then if they doesn't already exist # these will create the policies jamf_auto_install_policy jamf_manual_install_policy if subscribed? activate_subscribed_patch_version_in_jamf else activate_managed_patch_version_in_jamf end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_auto_install_policy-instance_method"> #create_jamf_auto_install_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> The auto install policy is triggered by checkin but may have narrow scope targets, or may be targeted to 'all' (after release) Before release, the targets are those defined in #pilot_groups_to_use After release, the targets are changed to those in title_object#release_groups This policy is never in self service </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>the auto install policy for this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 521 522 523 524 525 526 527 528</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 521 def create_jamf_auto_install_policy progress "Jamf: Creating Auto Install Policy: #{jamf_auto_install_policy_name}", log: :debug @jamf_auto_install_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_auto_install_policy_name, cnx: jamf_cnx configure_jamf_auto_install_policy @jamf_auto_install_policy.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_auto_reinstall_policy-instance_method"> #create_jamf_auto_reinstall_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> The auto rionstall policy, for when a pkg is re-uploaded for this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>the auto install policy for this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 796 797 798 799 800 801 802</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 796 def create_jamf_auto_reinstall_policy progress "Jamf: Creating Auto Re-Install Policy: #{jamf_auto_reinstall_policy_name}", log: :debug pol = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_auto_reinstall_policy_name, cnx: jamf_cnx configure_jamf_auto_reinstall_policy(pol) pol.save pol end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_installed_group-instance_method"> #create_jamf_installed_group ⇒ <tt>Jamf::ComputerGroup</tt> </h3><div class="docstring"> <div class="discussion"> Create the smart group of macs with this version installed </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::ComputerGroup</tt>) — <div class='inline'>the smart group.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 702 703 704 705 706 707 708 709 710 711 712 713</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 702 def create_jamf_installed_group 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 ) configure_jamf_installed_group @jamf_installed_group @jamf_installed_group.save @jamf_installed_group end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_manual_install_policy-instance_method"> #create_jamf_manual_install_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> The manual install policy is always scoped to all computers, with exclusions The policy has a custom trigger, or can be installed via self service </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 616 617 618 619 620 621 622 623</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 616 def create_jamf_manual_install_policy progress "Jamf: Creating Manual Install Policy: #{jamf_manual_install_policy_name}", log: :info pol = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.create name: jamf_manual_install_policy_name, cnx: jamf_cnx configure_jamf_manual_install_policy(pol) pol.save pol end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_package-instance_method"> #create_jamf_package ⇒ <tt>Jamf::JPackage</tt> </h3><div class="docstring"> <div class="discussion"> Returns Create the Jamf::JPackage object for this version and return it. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::JPackage</tt>) — <div class='inline'>Create the Jamf::JPackage object for this version and return it</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 338 def create_jamf_package progress "Jamf: Creating Jamf::JPackage '#{jamf_pkg_name}'", log: :info # The filename is temporary, and will be replaced when the file is uploaded pkg = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.create( cnx: jamf_cnx, packageName: jamf_pkg_name, fileName: "#{jamf_pkg_name}.pkg", rebootRequired: reboot, notes: jamf_package_notes, categoryId: jamf_xolo_category_id, osRequirements: ">=#{min_os}" ) # TODO: Implement max_os, either here, or by maintaining a smart group? # I really wish jamf would improve how package objects handle # OS requirements, building in the concept of min/max self.jamf_pkg_id = pkg.save # save the data now so the pkg_id is available for immeadiate use, e.g. by pkg upload save_local_data pkg rescue => e msg = "Jamf: Failed to create Jamf::JPackage '#{jamf_pkg_name}': #{e.class}: #{e}" log_error msg raise <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::ServerError, msg end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="create_jamf_patch_policy-instance_method"> #create_jamf_patch_policy ⇒ <tt>Jamf::PatchPolicy</tt> </h3><div class="docstring"> <div class="discussion"> Returns The xolo patch policy for this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::PatchPolicy</tt>) — <div class='inline'>The xolo patch policy for this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 878 def create_jamf_patch_policy progress "Jamf: Creating Patch Policy for Version '#{version}' of Title '#{title}'.", log: :info ppol = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchPolicy.create( cnx: jamf_cnx, name: jamf_patch_policy_name, patch_title: title_object.jamf_patch_title.id, target_version: version ) configure_jamf_patch_policy(ppol) # This is always false to start will be set to true as needed if # a rollback is being done ppol.allow_downgrade = false ppol.save # refetch it rather than using the one we just created <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchPolicy.fetch(name: jamf_patch_policy_name, cnx: jamf_cnx) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_jamf_package-instance_method"> #delete_jamf_package ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete the package for this version from Jamf Pro. Package deletion takes a long time, so we do it in a threadpool and tell the admin to check the Alert Tool for completion (if we have an alert tool in place) or to wait at least 5 min before re-adding the same version. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 448 def delete_jamf_package pkg_id = jamf_pkg_id || <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.valid_id(packageName: jamf_pkg_name, cnx: jamf_cnx) return unless pkg_id msg = "Jamf: Starting deletion of Package '#{jamf_pkg_name}' id #{jamf_pkg_id} at #{Time.now.strftime '%F %T'}" progress msg, log: :info warning = +"IMPORTANT: Package deletion can be slow. If you plan to re-add this version, '#{version}', please\n " warning << if <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>.alert_tool 'check your Xolo alerts for completion, which can take up to 5 minutes,' else 'wait at least 5 minutes' end warning << ' before re-adding this version.' progress warning, log: nil self.class.pkg_deletion_pool.post do start = Time.now log_info "Jamf: Started threadpool deletion of Package '#{jamf_pkg_name}' id #{jamf_pkg_id} at #{start}" jamf_cnx.timeout = 3600 <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.delete pkg_id, cnx: jamf_cnx finish = Time.now duration = (finish - start).to_i.pix_humanize_secs log_info "Jamf: Deleted Package '#{jamf_pkg_name}' id #{jamf_pkg_id} in #{duration}", alert: true rescue => e log_error "Package Deletion thread: #{e.class}: #{e}" e.backtrace.each { |l| log_error "..#{l}" } end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="delete_version_from_jamf-instance_method"> #delete_version_from_jamf ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Delete an entire version from Jamf Pro This includes the package, the manual install policy, the auto install policy, and the patch policy. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 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</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 251 def delete_version_from_jamf log_debug "Deleting Version '#{version}' from Jamf" # The Policies pols = [ jamf_manual_install_policy, jamf_auto_install_policy, jamf_auto_reinstall_policy, jamf_patch_policy ] pols.each do |pol| next unless pol progress "Jamf: Deleting #{pol.class} '#{pol.name}'", log: :info pol.delete end # The Installed Group if jamf_installed_group progress "Jamf: Deleting #{jamf_installed_group.class} '#{jamf_installed_group.name}'", log: :info jamf_installed_group.delete end # Delete package object # This is slow and it blocks, so do it in a thread and update progress every # 15 secs delete_jamf_package # The code below is used when we want real-time progress updates to xadm # while deletion is happening. It's slow, so we're not using it now. # msg = "Jamf: Starting deletion of Package '#{jamf_pkg_name}' id #{jamf_pkg_id} at #{Time.now.strftime '%F %T'}..." # progress msg, log: :debug # # do this in another thread, so we can report the progress while its happening # pkg_del_thr = Thread.new { Jamf::JPackage.fetch(packageName: jamf_pkg_name, cnx: jamf_cnx).delete } # pkg_del_thr.name = "package-deletion-thread-#{session[:xolo_id]}" # sleep 15 # while pkg_del_thr.alive? # progress "... #{Time.now.strftime '%F %T'} still deleting, this is slow, sorry." # sleep 15 # end # msg = "Jamf: Deleted Package '#{jamf_pkg_name}' id #{jamf_pkg_id} at #{Time.now.strftime '%F %T'}" # progress msg, log: :debug end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="deploy_via_mdm-instance_method"> #deploy_via_mdm(targets) ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> Install this version on a one or more computers via MDM. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> targets (<tt>Hash</tt>) — <div class='inline'>With the following keys <ul> <li>computers: [Array<String, Integer>] The computer identifiers to install on. Identifiers are either serial numbers, names, or Jamf IDs.</li> <li>groups: [Array<String, Integer>] The names or ids of computer groups to install on.</li> </ul></div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>The results of the install with the following keys <ul> <li>removals: [Array<Hash>] { device: <String>, group: <InteStringger>, reason: <String> }</li> <li>queuedCommands: [Array<Hash>] { device: <String>, commandUuid: <String> }</li> <li>errors: [Array<Hash>] { device: <String>, group: <Integer>, reason: <String> }</li> </ul></div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1481 def deploy_via_mdm(targets) unless dist_pkg raise <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::UnsupportedError, 'MDM deployment is not supported for this version, it is not a Distribution Package.' end all_targets = targets[:computers] || [] removals = [] # expand groups into computers, all_targets += expand_groups_for_deploy(targets[:groups], removals) if targets[:groups] # remove duplicates all_targets.uniq! # remove invalid computers, after this all_targets will be valid computer ids remove_invalid_computers_for_deploy(all_targets, removals) # remove members of excluded groups from the list of targets remove_exclusions_from_deploy(all_targets, removals) if all_targets.empty? log_info "Jamf: No valid computers to deploy to for version '#{version}' of title '#{title}'." queued_cmds = [] deploy_errs = [] else # deploy the package to the computers jamf_package.deploy_via_mdm computer_ids: all_targets # convert ids to names for the response comp_ids_to_names = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Computer.map_all(:id, to: :name, cnx: jamf_cnx) queued_cmds = jamf_package.deploy_response[:queuedCommands].map do |qc| { device: comp_ids_to_names[qc[:device]], commandUuid: qc[:commandUuid] } end deploy_errs = jamf_package.deploy_response[:errors].map do |err| { device: comp_ids_to_names[err[:device]], reason: err[:reason] } end log_info "Jamf: Deployed version '#{version}' of title '#{title}' to #{all_targets.size} computers via MDM" end removals.each { |r| log_info "Jamf: Removal #{r}" } queued_cmds.each { |qc| log_info "Jamf: Queued Command #{qc}" } deploy_errs.each { |err| log_info "Jamf: Error #{err}" } { removals: removals, queuedCommands: queued_cmds, errors: deploy_errs } end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="disable_policies_for_deprecation_or_skipping-instance_method"> #disable_policies_for_deprecation_or_skipping(reason) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Disable the auto-install and patch policies for this version when it is deprecated or skipped Leave the manual install policy active, but remove it from self-service </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> reason (<tt>Symbol</tt>) — <div class='inline'>:deprecated or :skipped</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1168 def disable_policies_for_deprecation_or_skipping(reason) progress "Jamf: Disabling auto-install policy for #{reason} version '#{version}'" pol = jamf_auto_install_policy pol.disable pol.save # don't disable the auto-reinstall policy - it may be needed # for any re-uploads of the pkg for this version, even if deprecated/skipped progress "Jamf: Disabling patch policy for #{reason} version '#{version}'" ppol = jamf_patch_policy ppol.disable # ensure patch policy is NOT set to 'allow downgrade' ppol.allow_downgrade = false ppol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="expand_groups_for_deploy-instance_method"> #expand_groups_for_deploy(groups, removals) ⇒ <tt>Array<Integer></tt> </h3><div class="docstring"> <div class="discussion"> expand computer groups given for deploy_via_mdm </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> groups (<tt>Array<String, Integer></tt>) — <div class='inline'>The names or ids of computer groups to install on.</div> </li> <li> removals (<tt>Array<Hash></tt>) — <div class='inline'>The groups that are not valid, for reporting back to the caller</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Array<Integer></tt>) — <div class='inline'>The ids of the computers in the groups</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1543 def expand_groups_for_deploy(groups, removals) log_debug "Expanding group targets for MDM deployment of title '#{title}', version '#{version}'" computers = [] groups.each do |g| gid = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.valid_id g, cnx: jamf_cnx if gid jgroup = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.fetch id: gid, cnx: jamf_cnx if excluded_groups_to_use.include? jgroup.name log_debug "Jamf: Group '#{jgroup.name}' is in the excluded groups list. Removing." removals << { device: nil, group: g, reason: "Group '#{jgroup.name}' is in the excluded groups list" } next end log_debug "Jamf: Adding computers from group '#{jgroup.name}' to deployment targets" computers += jgroup.member_ids else log_debug "Jamf: Group '#{g}' not found in Jamf Pro. Removing." removals << { device: nil, group: g, reason: 'Group not found in Jamf Pro' } end end computers end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_auto_install_policy-instance_method"> #jamf_auto_install_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the auto install policy for this version If we are deleting and it doesn't exist, return nil. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>The auto-install-policy for this version, if it exists</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 495 496 497 498 499 500 501 502 503 504 505 506 507 508</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 495 def jamf_auto_install_policy # This is imporant to avoid infinite recursion return @jamf_auto_install_policy if @jamf_auto_install_policy if jamf_auto_install_policy_exist? @jamf_auto_install_policy = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch(name: jamf_auto_install_policy_name, cnx: jamf_cnx) else return if deleting? # this sets @jamf_auto_install_policy create_jamf_auto_install_policy end @jamf_auto_install_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_auto_install_policy_exist?-instance_method"> #jamf_auto_install_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns does the jamf_auto_install_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>does the jamf_auto_install_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 486 487 488</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 486 def jamf_auto_install_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(cnx: jamf_cnx).include? jamf_auto_install_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_auto_install_policy_url-instance_method"> #jamf_auto_install_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Jamf Pro Policy that does auto-installs of this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Jamf Pro Policy that does auto-installs of this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 575 576 577 578 579 580 581 582</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 575 def jamf_auto_install_policy_url return @jamf_auto_install_policy_url if @jamf_auto_install_policy_url pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_auto_install_policy_name, cnx: jamf_cnx return unless pol_id @jamf_auto_install_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_auto_reinstall_policy-instance_method"> #jamf_auto_reinstall_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the auto re-install policy for this version If we are deleting and it doesn't exist, return nil. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::Policy</tt>) — <div class='inline'>The auto-install-policy for this version, if it exists</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 782 783 784 785 786 787 788 789 790 791</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 782 def jamf_auto_reinstall_policy @jamf_auto_reinstall_policy ||= if jamf_auto_reinstall_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch(name: jamf_auto_reinstall_policy_name, cnx: jamf_cnx) else return if deleting? create_jamf_auto_reinstall_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_auto_reinstall_policy_exist?-instance_method"> #jamf_auto_reinstall_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns does the jamf_auto_reinstall_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>does the jamf_auto_reinstall_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 773 774 775</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 773 def jamf_auto_reinstall_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(:refresh, cnx: jamf_cnx).include? jamf_auto_reinstall_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_auto_reinstall_policy_url-instance_method"> #jamf_auto_reinstall_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Jamf Pro Policy that does auto reinstalls of this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Jamf Pro Policy that does auto reinstalls of this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 842 843 844 845 846 847 848 849</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 842 def jamf_auto_reinstall_policy_url return @jamf_auto_reinstall_policy_url if @jamf_auto_reinstall_policy_url pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_auto_reinstall_policy_name, cnx: jamf_cnx return unless pol_id @jamf_auto_reinstall_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_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"> 300 301 302</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 300 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 the smart group of macs with this version 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>) — <div class='inline'>the smart group.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 682 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? create_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 this version of this title installed We use the "Patch Reporting: #Xolo::Server::Mixins::VersionJamfAccess.title_objecttitle_object.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"> 746 747 748 749 750 751 752 753 754 755</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 746 def jamf_installed_group_criteria [ <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Criteriable::Criterion.new( and_or: :or, name: "Patch Reporting: #{title_object.display_name}", search_type: 'is', value: 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"> 673 674 675</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 673 def jamf_installed_group_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.all_names(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>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 758 759 760 761 762 763 764 765</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 758 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_manual_install_policy-instance_method"> #jamf_manual_install_policy ⇒ <tt>Jamf::Policy</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the manual install policy for this version If we are deleting and it doesn't exist, return nil. </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"> 599 600 601 602 603 604 605 606 607 608</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 599 def jamf_manual_install_policy @jamf_manual_install_policy ||= if jamf_manual_install_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.fetch(name: jamf_manual_install_policy_name, cnx: jamf_cnx) else return if deleting? create_jamf_manual_install_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_policy_exist?-instance_method"> #jamf_manual_install_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns does the jamf_manual_install_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>does the jamf_manual_install_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 590 591 592</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 590 def jamf_manual_install_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.all_names(cnx: jamf_cnx).include? jamf_manual_install_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_manual_install_policy_url-instance_method"> #jamf_manual_install_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Jamf Pro Policy that does manual installs of this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Jamf Pro Policy that does manual installs of this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 658 659 660 661 662 663 664 665</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 658 def jamf_manual_install_policy_url return @jamf_manual_install_policy_url if @jamf_manual_install_policy_url pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy.valid_id jamf_manual_install_policy_name, cnx: jamf_cnx return unless pol_id @jamf_manual_install_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_package-instance_method"> #jamf_package ⇒ <tt>Jamf::JPackage</tt> </h3><div class="docstring"> <div class="discussion"> Create or fetch the Jamf::JPackage object for this version Returns nil if the package doesn't exist and we're deleting </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::JPackage</tt>) — <div class='inline'>the Package object associated with this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 313 def jamf_package return @jamf_package if @jamf_package id = jamf_pkg_id || <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.valid_id(name: jamf_pkg_name, cnx: jamf_cnx) @jamf_package = if id log_debug "Jamf: Fetching Jamf::JPackage '#{id}'" self.jamf_pkg_id = id # in case we only had the name before, now we have the id, so save it save_local_data <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.fetch id: id, cnx: jamf_cnx else return if deleting? create_jamf_package end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_package_exist?-instance_method"> #jamf_package_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns does the jamf_package exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>does the jamf_package exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 332 333 334</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 332 def jamf_package_exist? !<a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::JPackage.valid_id(packageName: jamf_pkg_name, cnx: jamf_cnx).nil? end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_package_notes-instance_method"> #jamf_package_notes(ttl_obj: nil) ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the 'notes' text for the Jamf::JPackage object for this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the 'notes' text for the Jamf::JPackage object for this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 368 369 370 371 372 373 374 375 376 377 378 379 380 381</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 368 def jamf_package_notes(ttl_obj: nil) ttl_obj ||= title_object pkg_notes = <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Version.html" title="Xolo::Server::Version (class)">Version</a>::<a href="../Version.html#JAMF_PKG_NOTES_PREFIX-constant" title="Xolo::Server::Version::JAMF_PKG_NOTES_PREFIX (constant)">JAMF_PKG_NOTES_PREFIX</a>.sub( <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Version.html" title="Xolo::Server::Version (class)">Version</a>::<a href="../Version.html#JAMF_PKG_NOTES_VERS_PH-constant" title="Xolo::Server::Version::JAMF_PKG_NOTES_VERS_PH (constant)">JAMF_PKG_NOTES_VERS_PH</a>, version ) pkg_notes.sub!( <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Version.html" title="Xolo::Server::Version (class)">Version</a>::<a href="../Version.html#JAMF_PKG_NOTES_TITLE_PH-constant" title="Xolo::Server::Version::JAMF_PKG_NOTES_TITLE_PH (constant)">JAMF_PKG_NOTES_TITLE_PH</a>, title ) desc = ttl_obj.changes_for_update.dig(:description, :new) || ttl_obj.description pkg_notes << desc pkg_notes end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_package_url-instance_method"> #jamf_package_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Package that installs this version in Jamf Pro. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Package that installs this version in Jamf Pro</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 429 430 431 432 433 434 435 436 437 438</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 429 def jamf_package_url return @jamf_package_url if @jamf_package_url return unless jamf_pkg_id # the old url # @jamf_package_url = "#{jamf_gui_url}/packages.html?id=#{jamf_pkg_id}&o=r" @jamf_package_url = "#{jamf_gui_url}/view/settings/computer-management/packages/#{jamf_pkg_id}?tab=general" # https://casper.pixar.com:8443/view/settings/computer-management/packages/12042?tab=general end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_policy-instance_method"> #jamf_patch_policy ⇒ <tt>Jamf::PatchPolicy</tt>? </h3><div class="docstring"> <div class="discussion"> Fetch or create the patch policy for this version If we are deleting and it doesn't exist, return nil. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::PatchPolicy</tt>, <tt>nil</tt>) — <div class='inline'>The patch policy for this version, if it exists</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 865 866 867 868 869 870 871 872 873 874</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 865 def jamf_patch_policy @jamf_patch_policy ||= if jamf_patch_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchPolicy.fetch(name: jamf_patch_policy_name, cnx: jamf_cnx) else return if deleting? create_jamf_patch_policy end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_policy_exist?-instance_method"> #jamf_patch_policy_exist? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Returns does the jamf_patch_policy exist?. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>does the jamf_patch_policy exist?</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 857 858 859</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 857 def jamf_patch_policy_exist? <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchPolicy.all_names(:refresh, cnx: jamf_cnx).include? jamf_patch_policy_name end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_policy_url-instance_method"> #jamf_patch_policy_url ⇒ <tt>String</tt> </h3><div class="docstring"> <div class="discussion"> Returns the URL for the Jamf Pro Patch Policy that updates to this version. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>the URL for the Jamf Pro Patch Policy that updates to this version</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1063 def jamf_patch_policy_url return @jamf_patch_policy_url if @jamf_patch_policy_url title_id = title_object.jamf_patch_title_id pol_id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::PatchPolicy.valid_id jamf_patch_policy_name, cnx: jamf_cnx return unless pol_id @jamf_manual_install_policy_url = "#{jamf_gui_url}/patchDeployment.html?softwareTitleId=#{title_id}&id=#{pol_id}&o=r" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="jamf_patch_version-instance_method"> #jamf_patch_version ⇒ <tt>Jamf::PatchTitle::Version</tt> </h3><div class="docstring"> <div class="discussion"> Xolo version </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Jamf::PatchTitle::Version</tt>) — <div class='inline'>The Jamf::PatchTitle::Version for this</div> </li> </ul> Raises: <ul class="raise"> <li> (<tt>Xolo::NoSuchItemError</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1318 def jamf_patch_version return @jamf_patch_version if @jamf_patch_version # NOTE: in the line below, use the title_object's call to #jamf_patch_title # because that will cache the Jamf::PatchTitle instance, and we need to # use it to save changes to its Versions. # Using the class method won't cache the instance we will need in the # future. @jamf_patch_version = title_object.jamf_patch_title.versions[version] return @jamf_patch_version if @jamf_patch_version if repairing? # if we're repairing, and the version isn't visible in Jamf, then # jamf polled the title editor in the few moments it was disabled. # and jamf will see it again within 5 minutes. return nil end # TODO: wait for it to appear when adding, or re-appear when repairing? msg = "Jamf: Version '#{version}' of Title '#{title}' is not visible in Jamf. Is the Patch 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 class="method_details "> <h3 class="signature " id="patch_report-instance_method"> #patch_report ⇒ <tt>Arrah<Hash></tt> </h3><div class="docstring"> <div class="discussion"> Get the patch report for this version </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Arrah<Hash></tt>) — <div class='inline'>Data for each computer with this version of this title installed</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1461 1462 1463</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1461 def patch_report title_object.patch_report vers: version end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove_exclusions_from_deploy-instance_method"> #remove_exclusions_from_deploy(targets, removals) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Remove exclusions from the list of targets for deploy_via_mdm </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> targets (<tt>Array<Integer></tt>) — <div class='inline'>The ids of computers to install on.</div> </li> <li> removals (<tt>Array<Hash></tt>) — <div class='inline'>The computers that are not valid, for reporting back to the caller</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1595 def remove_exclusions_from_deploy(targets, removals) log_debug "Removing excluded computer targets for MDM deployment of title '#{title}', version '#{version}'" excluded_groups_to_use.each do |group| gid = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.valid_id group, cnx: jamf_cnx unless gid log_error "Jamf: Excluded group '#{group}' not found in Jamf Pro. Skipping." next end # unless gid jgroup = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::ComputerGroup.fetch id: gid, cnx: jamf_cnx jgroup.members.each do |member| next unless targets.include? member[:id] log_debug "Jamf: Removing computer '#{member[:name]}' (#{member[:id]}) from deployment targets because it is in excluded group '#{group}'" targets.delete member[:id] removals << { device: member[:name], group: nil, reason: "In excluded group '#{group}'" } end end # excluded_groups_to_use.each end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="remove_invalid_computers_for_deploy-instance_method"> #remove_invalid_computers_for_deploy(targets, removals) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.remove invalid computers from the list of targets for deploy_via_mdm </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> targets (<tt>Array<String, Integer></tt>) — <div class='inline'>The names or ids of computers to install on.</div> </li> <li> removals (<tt>Array<Hash></tt>) — <div class='inline'>The computers that are not valid, for reporting back to the caller</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1574 def remove_invalid_computers_for_deploy(targets, removals) log_debug "Removing invalid computer targets for MDM deployment of title '#{title}', version '#{version}'" targets.map! do |c| id = <a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Computer.valid_id c, cnx: jamf_cnx if id id else removals << { device: c, group: nil, reason: 'Computer not found in Jamf Pro' } nil end end.compact! end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_auto_install_policy-instance_method"> #repair_jamf_auto_install_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the auto-install policy only </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 532 533 534 535 536</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 532 def repair_jamf_auto_install_policy progress "Jamf: Repairing Auto Install Policy '#{jamf_auto_install_policy_name}'", log: :info configure_jamf_auto_install_policy jamf_auto_install_policy.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_auto_reinstall_policy-instance_method"> #repair_jamf_auto_reinstall_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Reset the configuration of the jamf_installed_group </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 806 807 808 809 810 811</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 806 def repair_jamf_auto_reinstall_policy return unless reupload_date progress "Jamf: Repairing Auto Re-Install Policy: #{jamf_auto_reinstall_policy_name}", log: :debug configure_jamf_auto_reinstall_policy jamf_auto_reinstall_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_installed_group-instance_method"> #repair_jamf_installed_group ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Reset the configuration of the jamf_installed_group but only if there's been a re-upload of the pkg </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 718 719 720 721 722 723 724 725</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 718 def repair_jamf_installed_group return unless reupload_date progress "Jamf: Repairing smart group '#{jamf_installed_group_name}'", log: :info configure_jamf_installed_group jamf_installed_group jamf_installed_group.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_manual_install_policy-instance_method"> #repair_jamf_manual_install_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the manual-install policy only </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 627 628 629 630 631 632</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 627 def repair_jamf_manual_install_policy pol = jamf_manual_install_policy progress "Jamf: Repairing Manual Install Policy '#{jamf_manual_install_policy_name}'", log: :info configure_jamf_manual_install_policy(pol) pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_package-instance_method"> #repair_jamf_package ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the package object only </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 415 416 417 418 419 420 421 422 423 424 425</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 415 def repair_jamf_package # If these values are all correct, nothing will be saved progress "Jamf: Repairing Package '#{jamf_pkg_name}'", log: :info jamf_package.packageName = jamf_pkg_name jamf_package.fileName = "#{jamf_pkg_name}.pkg" jamf_package.rebootRequired = reboot jamf_package.notes = jamf_package_notes jamf_package.categoryId = jamf_xolo_category_id jamf_package.osRequirements = ">=#{min_os}" jamf_package.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_patch_policy-instance_method"> #repair_jamf_patch_policy ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> repair the patch policy only </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 902 903 904 905 906 907 908 909 910 911</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 902 def repair_jamf_patch_policy progress "Jamf: Repairing Patch Policy '#{jamf_patch_policy_name}'", log: :info assign_pkg_to_patch_in_jamf ppol = jamf_patch_policy configure_jamf_patch_policy(ppol) ppol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="repair_jamf_version_objects-instance_method"> #repair_jamf_version_objects ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Validate and fix any Jamf::JPackage objects that related to this version: <ul> <li>the package object</li> <li>the installed-group</li> <li>the auto-install policy</li> <li>the manual-install policy</li> <li>the auto-reinstall policy</li> <li>the patch policy</li> </ul> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 235 236 237 238 239 240 241 242</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 235 def repair_jamf_version_objects repair_jamf_package repair_jamf_installed_group # wont happen if no reupload_date repair_jamf_auto_install_policy repair_jamf_manual_install_policy repair_jamf_auto_reinstall_policy # wont happen if no reupload_date repair_jamf_patch_policy end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="reset_policies_to_pilot-instance_method"> #reset_policies_to_pilot ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.reset all the policies for this version to pilot </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1189 def reset_policies_to_pilot # set scope targets of auto-install policy to pilot-groups and re-enable msg = "Jamf: Version '#{version}': Setting scope targets of auto-install policy to pilot_groups: #{pilot_groups_to_use.join(', ')}" progress msg, log: :info jamf_auto_install_policy.scope.set_targets :computer_groups, pilot_groups_to_use jamf_auto_install_policy.enable jamf_auto_install_policy.save msg = "Jamf: Version '#{version}': Setting scope targets of patch policy to pilot_groups" progress msg, log: :info # set scope targets of patch policy to pilot-groups and re-enable jamf_patch_policy.scope.set_targets :computer_groups, pilot_groups_to_use # ensure patch policy is NOT set to 'allow downgrade' jamf_patch_policy.allow_downgrade = false jamf_patch_policy.enable jamf_patch_policy.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_patch_policy_ssvc_icon-instance_method"> #set_patch_policy_ssvc_icon(ppol, icon_id) ⇒ <tt>Void</tt> </h3><div class="docstring"> <div class="discussion"> Set an existing ssvc icon for a given patch policy NOTE: Update this if/when ruby-jss and the JPAPI can handle PatchPolicy Icons. This shouldn't interfere with a future #save of a PatchPolicy object, since that xml won't contain self_service_icon data at all. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ppol (<tt>Jamf::PatchPolicy</tt>) — <div class='inline'>The Patch Pol. to set the icon for</div> </li> <li> icon_id (<tt>Integer</tt>, <tt>String</tt>) — <div class='inline'>The id of the existing icon to use.</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Void</tt>) </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 1058 1059</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1042 def set_patch_policy_ssvc_icon(ppol, icon_id) # this str can't be frozen for now icon_xml = +<<~ENDXML <?xml version="1.0" encoding="UTF-8"?> <patch_policy> <user_interaction> <self_service_icon> <id>#{icon_id}</id> </self_service_icon> </user_interaction> </patch_policy> ENDXML log_debug "Jamf: Adding existing SSvc icon to patch policy for version '#{version}' of title '#{title}'" # TODO: in ruby-jss, update c_put and related methods to # use unfrozen dups of strings for #gsub jamf_cnx.c_put ppol.rest_rsrc, icon_xml end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_policy_exclusions-instance_method"> #set_policy_exclusions(pol, ttl_obj: nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> set excluded groups in a [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER This applies more nuance to the 'excluded_groups_to_use' depending on the policy in question. E.g. manual-install policy should not have the installed-group excluded, to allow re-installs </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>, <tt>Jamf::PatchPolicy</tt>) </li> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The pre-instantiated title for ths version. if nil, we'll instantiate it now</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1135 def set_policy_exclusions(pol, ttl_obj: nil) ttl_obj ||= title_object # dup, so when we add the installed group below, we don't # keep that for future calls to this method. exclusions = excluded_groups_to_use(ttl_obj: ttl_obj).dup exclusions ||= [] # the initial auto-install policies must also exclude any mac with the title # already installed # # But the manual-install policy and the auto-reinstall should never exclude it - so that # it can be manually installed or automatically re-installed whenever needed if pol.is_a?(<a href="../../../Jamf.html" title="Jamf (module)">Jamf</a>::Policy) && pol.name == jamf_auto_install_policy_name # calling ttl_obj.jamf_installed_group will create the group if needed exclusions << ttl_obj.jamf_installed_group_name end log_debug "Jamf: updating exclusions for #{pol.class} '#{pol.name}' to: #{exclusions.join ', '}" exclusions.uniq! pol.scope.set_exclusions :computer_groups, exclusions end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_policy_pilot_groups-instance_method"> #set_policy_pilot_groups(pol) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.set target groups in a pilot [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>, <tt>Jamf::PatchPolicy</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1084 1085 1086 1087 1088 1089 1090</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1084 def set_policy_pilot_groups(pol) pilots = pilot_groups_to_use pilots ||= [] log_debug "Jamf: setting pilot scope targets for #{pol.class} '#{pol.name}' to: #{pilots.join ', '}" pol.scope.set_targets :computer_groups, pilots end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_policy_release_groups-instance_method"> #set_policy_release_groups(pol, ttl_obj: nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.set target groups in a non=pilot [patch] policy object's scope REMEMBER TO SAVE THE POLICY LATER </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>, <tt>Jamf::PatchPolicy</tt>) </li> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The pre-instantiated title for ths version. if nil, we'll instantiate it now</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1111 def set_policy_release_groups(pol, ttl_obj: nil) ttl_obj ||= title_object targets = release_groups_to_use(ttl_obj: ttl_obj) || [] log_debug "Jamf: setting release scope targets for #{pol.class} '#{pol.name}' to: #{targets.join ', '}" if targets.include? <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::TARGET_ALL pol.scope.set_all_targets else pol.scope.set_targets :computer_groups, targets end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="set_policy_to_all_targets-instance_method"> #set_policy_to_all_targets(pol) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.Set a policy to be scoped to all targets REMEMBER TO SAVE THE POLICY LATER </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> pol (<tt>Jamf::Policy</tt>, <tt>Jamf::PatchPolicy</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1098 1099 1100 1101</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1098 def set_policy_to_all_targets(pol) log_debug "Jamf: setting scope target for #{pol.class} '#{pol.name}' to all computers" pol.scope.set_all_targets end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_excluded_groups-instance_method"> #update_excluded_groups(ttl_obj: nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Update all the excluded_groups policy scopes for this version when either the title or version has changed them Applies regardless of status </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The pre-instantiated title for ths version. if nil, we'll instantiate it now</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1273 def update_excluded_groups(ttl_obj: nil) log_debug "Updating Excluded Groups for Version '#{version}' of Title '#{title}'" # - update the manual install policy pol = jamf_manual_install_policy if pol progress "Jamf: Updating excluded groups for Manual Install Policy '#{jamf_auto_install_policy_name}'." set_policy_exclusions(pol, ttl_obj: ttl_obj) pol.save end # - update the auto install policy pol = jamf_auto_install_policy if pol progress "Jamf: Updating excluded groups for Auto Install Policy '#{jamf_auto_install_policy_name}'." set_policy_exclusions(pol, ttl_obj: ttl_obj) pol.save end # - update the auto reinstall policy, but only if it exists if jamf_auto_reinstall_policy_exist? pol = jamf_auto_reinstall_policy if pol progress "Jamf: Updating excluded groups for Auto ReInstall Policy '#{jamf_auto_reinstall_policy_name}'." set_policy_exclusions(pol, ttl_obj: ttl_obj) pol.save end end # - update the patch policy pol = jamf_patch_policy return unless pol progress "Jamf: Updating excluded groups for Patch Policy '#{jamf_patch_policy_name}'." set_policy_exclusions(pol, ttl_obj: ttl_obj) pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_jamf_package_notes-instance_method"> #update_jamf_package_notes(ttl_obj: nil) ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.update the description for the Jamf::JPackage </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 385 386 387 388 389 390</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 385 def update_jamf_package_notes(ttl_obj: nil) ttl_obj ||= title_object progress "Jamf: Updating notes for Jamf::JPackage '#{jamf_pkg_name}'", log: :debug jamf_package.notes = jamf_package_notes(ttl_obj: ttl_obj) jamf_package.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_jamf_patch_policy_patch_unknown-instance_method"> #update_jamf_patch_policy_patch_unknown ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.update the :patch_unknown for the patch policy </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 916 917 918 919 920 921 922 923 924</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 916 def update_jamf_patch_policy_patch_unknown return unless changes_for_update&.key? :patch_unknown ppol = jamf_patch_policy action = changes_for_update[:patch_unknown][:new] ? 'Enabling' : 'Disabling' progress "Jamf: #{action} 'patch_unknown' for patch policy #{ppol.name}", log: :debug ppol.patch_unknown = changes_for_update[:patch_unknown][:new] ? true : false ppol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_jamf_pkg_min_os-instance_method"> #update_jamf_pkg_min_os ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.update the min_os setting for the Jamf::JPackage </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 405 406 407 408 409 410 411</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 405 def update_jamf_pkg_min_os new_min = changes_for_update&.key?(:min_os) ? changes_for_update[:min_os][:new] : min_os progress "Jamf: Updating os_requirement for Jamf::JPackage '#{jamf_pkg_name}' to '#{new_min}'", log: :debug jamf_package.osRequirements = ">=#{new_min}" jamf_package.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_jamf_pkg_reboot-instance_method"> #update_jamf_pkg_reboot ⇒ <tt>void</tt> </h3><div class="docstring"> <div class="discussion"> This method returns an undefined value.update the reboot setting for the Jamf::JPackage </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 395 396 397 398 399 400</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 395 def update_jamf_pkg_reboot new_reboot = changes_for_update&.key?(:reboot) ? changes_for_update[:reboot][:new] : reboot progress "Jamf: Updating reboot setting for Jamf::JPackage '#{jamf_pkg_name}' to '#{new_reboot}'", log: :debug jamf_package.rebootRequired = new_reboot jamf_package.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_patch_policy_deployment-instance_method"> #update_patch_policy_deployment(ttl_obj:) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Update the patch policy deployment settings if they were changed in the title. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) — <div class='inline'>the title object that is being changed.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 971 972 973 974 975 976 977</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 971 def update_patch_policy_deployment(ttl_obj:) return unless ttl_obj.changes_for_update[:self_service_updates] ppol = jamf_patch_policy configure_patch_pol_deployment ttl_obj: ttl_obj, ppol: ppol ppol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_pilot_groups-instance_method"> #update_pilot_groups ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Update all the pilot_groups policy scopes for this version when either the title or version has changed them Nothing to do if the version isn't currently in :pilot status </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) — <div class='inline'>The pre-instantiated title for ths version. if nil, we'll instantiate it now</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1217 def update_pilot_groups # nothing unless we're in pilot return unless status == <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Version.html" title="Xolo::Server::Version (class)">Version</a>::STATUS_PILOT # - no changes to the manual install policy: scope-target is all # - update the auto install policy progress "Jamf: Updating pilot groups for Auto Install Policy '#{jamf_auto_install_policy_name}'." pol = jamf_auto_install_policy set_policy_pilot_groups(pol) pol.save # - update the patch policy progress "Jamf: Updating pilot groups for Patch Policy '#{jamf_patch_policy_name}'." pol = jamf_patch_policy set_policy_pilot_groups(pol) pol.save end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_release_groups-instance_method"> #update_release_groups(ttl_obj: nil) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Update all the release_groups policy scopes for this version when either the title or version has changed them Nothing to do if the version is currently in pending or pilot status </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> ttl_obj (<tt><a href="../Title.html" title="Xolo::Server::Title (class)">Xolo::Server::Title</a></tt>) (defaults to: <tt>nil</tt>) — <div class='inline'>The pre-instantiated title for ths version. if nil, we'll instantiate it now</div> </li> </ul> </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</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 1248 def update_release_groups(ttl_obj: nil) return unless status == <a href="../../../Xolo.html" title="Xolo (module)">Xolo</a>::<a href="../../Server.html" title="Xolo::Server (module)">Server</a>::<a href="../Version.html" title="Xolo::Server::Version (class)">Version</a>::STATUS_RELEASED # - no changes to the manual install policy: scope-target is all # - update the auto-install policy pol = jamf_auto_install_policy return unless pol set_policy_release_groups(pol, ttl_obj: ttl_obj) pol.save progress "Jamf: updated release groups for Auto Install Policy '#{jamf_auto_install_policy_name}'.", log: :info # - no changes to the patch policy: scope-target is all once released end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="update_version_in_jamf-instance_method"> #update_version_in_jamf ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Apply edits to the Xolo version to Jamf as needed This includes scope changes in policies, changes to pkg 'reboot' setting and changes to pkg 'os_requirements' Uploading a new .pkg installer happen separately </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 215 216 217 218 219 220 221 222 223 224</pre> </td> <td> <pre class="code"># File 'lib/xolo/server/mixins/version_jamf_access.rb', line 215 def update_version_in_jamf update_pilot_groups if changes_for_update&.key? :pilot_groups update_release_groups(ttl_obj: title_object) if changes_for_update&.key? :release_groups update_excluded_groups(ttl_obj: title_object) if changes_for_update&.key? :excluded_groups update_jamf_pkg_reboot if changes_for_update&.key? :reboot update_jamf_pkg_min_os if changes_for_update&.key? :min_os update_jamf_patch_policy_patch_unknown if changes_for_update&.key? :patch_unknown end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sat Aug 15 01:14:45 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.2). </div> </div> </body> </html>