Class: JSS::Policy

Inherits:
APIObject show all
Includes:
Categorizable, Creatable, Scopable, SelfServable, Sitable, Updatable, Uploadable
Defined in:
lib/jss/api_object/policy.rb,
lib/jss.rb

Overview

A class implementing a JSS Policy.

Like many API objects, the data comes from the API in sections, and the items in the :general section are mapped to direct attributes of this Class.

Policy instances are partially read-only:

  • Due to limitations in the API implementation of policies, as well as the complexity of policy objects, only these attributes can be set and updated via the Policy class:

    • name

    • frequency

    • target_drive

    • offline

    • enabled

    • category

    • triggers

    • client maintenance tasks

    • files and processes

    • reboot options

All other values and sections must be edited via the Web App.

Policies may be deleted via this class

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'policies'.freeze
RSRC_LIST_KEY =

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

:policies
RSRC_OBJECT_KEY =

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

:policy
SUBSETS =

subsets available for fetching TODO: FilesProcesses and Maintenance don’t seem to work

%i[
  general
  scope
  selfservice
  self_service
  packages
  scripts
  printers
  dockitems
  dock_items
  reboot
  userinteraction
  user_interaction
  disk_encryption
  diskencryption
  accountmaintenance
  account_maintenance
].freeze
UPLOAD_TYPES =

policies can take uploaded icons

{ icon: :policies }.freeze
SELF_SERVICE_TARGET =

policies are available in macOS self Serviec

:macos
SELF_SERVICE_PAYLOAD =

policies via self services are still polcies

:policy
SECTIONS = 
%i[
  general
  maintenance
  account_maintenance
  scripts
  self_service
  package_configuration
  scope
  user_interaction
  reboot
  files_processes
  dock_items
  disk_encryption
  printers
].freeze
FREQUENCIES = 
{
  ongoing: 'Ongoing',
  once_per_computer: 'Once per computer',
  once_per_user: 'Once per user',
  once_per_user_per_computer: 'Once per user per computer',
  daily: 'Once every day',
  weekly: 'Once every week',
  monthly: 'Once every month'
}.freeze
RESTART_WHEN = 
{
  if_pkg_requires: 'Restart if a package or update requires it',
  now: 'Restart immediately',
  delayed: 'Restart',
  dont: 'Do not restart'
}.freeze
RESTART_DISKS = 
{
  current: 'Current Startup Disk',
  selected: 'Currently Selected Startup Disk (No Bless)',
  netboot: 'NetBoot',
  os_installer: 'inPlaceOSUpgradeDirectory'
}.freeze
ACCOUNT_ACTIONS =

Note: any other value in :specify_startup is a path to some other drive to boot from, e.g. /Volumes/Foo

{
  create: 'Create',
  change_pw: 'Reset',
  delete: 'Delete',
  disable_fv2: 'DisableFileVault'
}.freeze
MGMT_ACCOUNT_ACTIONS = 
{
  no_change: 'doNotChange',
  change_pw: 'specified',
  generate_pw: 'random',
  enable_fv2: 'fileVaultEnable',
  disable_fv2: 'fileVaultDisable'
}.freeze
PACKAGE_ACTIONS = 
{
  install: 'Install',
  remove: 'Uninstall',
  cache: 'Cache',
  install_cache: 'Install Cached'
}.freeze
SCRIPT_PRIORITIES = 
{
  pre: 'Before',
  before: 'Before',
  post: 'After',
  after: 'After'
}.freeze
PRINTER_ACTIONS = 
{
  map: 'install',
  unmap: 'uninstall'
}.freeze
DOCK_ITEM_ACTIONS = 
{
  add_start: 'Add To Beginning',
  add_end: 'Add To End', remove: 'Remove'
}.freeze
NETWORK_REQUIREMENTS = 
{
  any: 'Any',
  ethernet: 'EtherNet'
}.freeze
TRIGGER_TYPES = 
{
  event: 'EVENT',
  user: 'USER_INITIATED'
}.freeze
TRIGGER_EVENTS = 
{
  startup: :trigger_startup,
  login: :trigger_login,
  logout: :trigger_logout,
  checkin: :trigger_checkin,
  network_state: :trigger_network_state_changed,
  enrollment: :trigger_enrollment_complete,
  custom: :trigger_other
}.freeze
NO_USER_LOGGED_IN = 
[
  'Do not restart',
  'Restart immediately',
  'Restart if a package or update requires it'
].freeze
USER_LOGGED_IN = 
[
  'Do not restart',
  'Restart',
  'Restart if a package or update requires it',
  'Restart immediately'
].freeze
SCOPE_TARGET_KEY = 
:computers
LOG_FLUSH_RSRC =

Log Flushing

'logflush'.freeze
LOG_FLUSH_INTERVAL_INTEGERS = 
{
  0 => 'Zero',
  1 => 'One',
  2 => 'Two',
  3 => 'Three',
  6 => 'Six'
}.freeze
LOG_FLUSH_INTERVAL_PERIODS = 
{
  day: 'Day',
  days: 'Day',
  week: 'Week',
  weeks: 'Week',
  month: 'Month',
  months: 'Month',
  year: 'Year',
  years: 'Year'
}.freeze
OBJECT_HISTORY_OBJECT_TYPE =

the object type for this object in the object history table. See APIObject#add_object_history_entry

3
SITE_SUBSET =

Where is the Site data in the API JSON?

:general
CATEGORY_SUBSET =

Where is the Category in the API JSON?

:general
CATEGORY_DATA_TYPE =

How is the category stored in the API data?

Hash

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Policy

Returns a new instance of Policy.

See Also:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/jss/api_object/policy.rb', line 602

def initialize(args = {})
  super

  if @in_jss
    gen = @init_data[:general]
    @frequency = gen[:frequency]
    @target_drive = gen[:target_drive]
    @offline = gen[:offline]
    @enabled = gen[:enabled]
    @site = JSS::APIObject.get_name(gen[:site][:name])
    @override_default_settings = gen[:override_default_settings]
    @trigger = gen[:trigger]
    @trigger_events = {
      trigger_startup: gen[:trigger_startup],
      trigger_login: gen[:trigger_login],
      trigger_logout: gen[:trigger_logout],
      trigger_checkin: gen[:trigger_checkin],
      trigger_network_state_changed: gen[:trigger_network_state_changed],
      trigger_enrollment_complete: gen[:trigger_enrollment_complete],
      trigger_other: gen[:trigger_other]
    }

    dtl = gen[:date_time_limitations]

    @server_side_limitations = {
      activation: JSS.epoch_to_time(dtl[:activation_date_epoch]),
      expiration: JSS.epoch_to_time(dtl[:expiration_date_epoch])
    }

    @client_side_limitations = {
      no_execute_on: dtl[:no_execute_on], # NOTE- there's a bug in the JSON output, it's been reported to JAMF.
      no_execute_start: dtl[:no_execute_start], # String like "1:01 AM"
      no_execute_end: dtl[:no_execute_end], # String like "2:02 PM"
      network_requirements: gen[:network_requirements]
    }

    maint = @init_data[:maintenance]
    @verify_startup_disk = maint[:verify]
    @permissions_repair = maint[:permissions]
    @recon = maint[:recon]
    @fix_byhost = maint[:byhost]
    @reset_name = maint[:reset_name]
    @flush_system_cache = maint[:system_cache]
    @install_cached_pkgs = maint[:install_all_cached_packages]
    @flush_user_cache = maint[:user_cache]

    amaint = @init_data[:account_maintenance]
    @directory_bindings = amaint[:directory_bindings]
    @open_firmware_efi_password = amaint[:open_firmware_efi_password]
    @management_account = amaint[:management_account]
    @accounts = amaint[:accounts]

    @packages = @init_data[:package_configuration][:packages] ? @init_data[:package_configuration][:packages] : []

    @scripts = @init_data[:scripts]

    uint = @init_data[:user_interaction]
    @user_may_defer = uint[:allow_users_to_defer]
    @user_may_defer_until = JSS.parse_datetime uint[:allow_deferral_until_utc]
    @user_message_start =  uint[:message_start]
    @user_message_finish = uint[:message_finish]

    @reboot_options = @init_data[:reboot]

    @files_processes = @init_data[:files_processes]

    @dock_items = @init_data[:dock_items]

    @disk_encryption = @init_data[:disk_encryption]

    @printers = @init_data[:printers]

    # Not in jss yet
  end

  # set non-nil defaults
  @enabled ||= false
  @frequency ||= 'Once per computer'
  @target_drive ||= '/'
  @offline ||= false
  @override_default_settings ||= {}
  @scripts ||= []
  @server_side_limitations ||= {}
  @client_side_limitiations ||= {}
  @trigger_events ||= {}
  @directory_bindings ||= []
  @open_firmware_efi_password ||= {}
  @management_account ||= {}
  @accounts  ||= []
  @packages  ||= []
  @scripts ||= []
  @self_service ||= {}
  @dock_items ||= []
  @disk_encryption ||= {}
  @printers ||= []
  @files_processes ||= {}
  unless @reboot_options
    @reboot_options = {}
    @reboot_options[:user_logged_in] = 'Do not restart'
    @reboot_options[:no_user_logged_in] = 'Do not restart'
  end

  @scope ||= JSS::Scopable::Scope.new(:computers, all_computers: false)
end

Instance Attribute Details

#accounts ⇒ Array<Hash> (readonly)

Local accts acted-upon by this policy

Keys are:

  • :action => “Create”,

  • :hint => “foo bar”,

  • :picture => “/path/to/pic.tif”,

  • :admin => true,

  • :home => “/Users/chrisltest”,

  • :realname => “ChrisTest Lasell”,

  • :filevault_enabled => true,

  • :username => “chrisltest”,

  • :password_md5 => “3858f62230ac3c915f300c664312c63f”,

  • :password => “foobar”,

  • :password_sha256=> “c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2”

TODO: make individial getters/setters as for @files_processes

Returns:



488
489
490
 
# File 'lib/jss/api_object/policy.rb', line 488

def accounts
  @accounts
end

#client_side_limitations ⇒ Hash (readonly)

The client-side limitations of this policy.

The keys are:

  • :no_execute_on - An array of short day names as strings, e.g. [“Sun”, “Mon”, “Tue”]

  • :no_execute_start - Time

  • :no_execute_end - Time

  • :network_connection - String

The data for the first three comes from the API in the date_time_limitations hash of the general section. The fourth comes from the network_requirements of the general section of the API, but the UI shows them in the Client Side Limitations area.

This attribute is just for convience and consistency, and just refers to the data in their API locations

Returns:



377
378
379
 
# File 'lib/jss/api_object/policy.rb', line 377

def client_side_limitations
  @client_side_limitations
end

#directory_bindings ⇒ Array<Hash> (readonly)

The directory bindings applied

each hash is like: {:name => “LDAP”, :id => 4} TODO: handle as for packages & scripts

Returns:



451
452
453
 
# File 'lib/jss/api_object/policy.rb', line 451

def directory_bindings
  @directory_bindings
end

#disk_encryption ⇒ Hash (readonly)

Disk encryption options for this policy

The hash looks like {:disk_encryption_configuration_id => 3, :action => “apply”}

Returns:



587
588
589
 
# File 'lib/jss/api_object/policy.rb', line 587

def disk_encryption
  @disk_encryption
end

#dock_items ⇒ Array<Hash> (readonly)

The dock items handled by this policy

each item hash looks like: {:name => “Mail”, :id => 14, :action => “Add To Beginning”}

Returns:



580
581
582
 
# File 'lib/jss/api_object/policy.rb', line 580

def dock_items
  @dock_items
end

#enabled ⇒ Boolean Also known as: enabled?

Returns is the policy enabled?.

Returns:

  • (Boolean) —

    is the policy enabled?



295
296
297
 
# File 'lib/jss/api_object/policy.rb', line 295

def enabled
  @enabled
end

#fix_byhost ⇒ Boolean

Should this policy fix the ByHost prefs?

Returns:

  • (Boolean) —

    client maintenance task



427
428
429
 
# File 'lib/jss/api_object/policy.rb', line 427

def fix_byhost
  @fix_byhost
end

#flush_system_cache ⇒ Boolean

Should this policy flush the system cache?

Returns:

  • (Boolean) —

    client maintenance task



435
436
437
 
# File 'lib/jss/api_object/policy.rb', line 435

def flush_system_cache
  @flush_system_cache
end

#flush_user_cache ⇒ Boolean

Should this policy flush the user cache?

Returns:

  • (Boolean) —

    client maintenance task



443
444
445
 
# File 'lib/jss/api_object/policy.rb', line 443

def flush_user_cache
  @flush_user_cache
end

#frequency ⇒ String

Returns how often to run the policy on each computer.

Returns:

  • (String) —

    how often to run the policy on each computer



286
287
288
 
# File 'lib/jss/api_object/policy.rb', line 286

def frequency
  @frequency
end

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

Returns The icon used in self-service.

Returns:

  • (JSS::Icon, nil) —

    The icon used in self-service

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

Returns Is this thing available in Self Service?.

Returns:

  • (Boolean) —

    Is this thing available in Self Service?

#install_cached_pkgs ⇒ Boolean

Should this policy install any cached JSS packages?

Returns:

  • (Boolean) —

    client maintenance task



439
440
441
 
# File 'lib/jss/api_object/policy.rb', line 439

def install_cached_pkgs
  @install_cached_pkgs
end

#management_account ⇒ Hash (readonly)

The management accout changes applied by the policy

The keys are:

  • :action see MGMT_ACCOUNT_ACTIONS

  • :managed_password

  • :managed_password_md5

  • :managed_password_sha256

  • :managed_password_length # for random generating pws

TODO: make individial getters/setters as for @files_processes

Returns:



468
469
470
 
# File 'lib/jss/api_object/policy.rb', line 468

def 
  @management_account
end

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

Returns do we have unsaved changes?.

Returns:

  • (Boolean) —

    do we have unsaved changes?

#offline ⇒ Boolean

Returns should be policy be available offline.

Returns:

  • (Boolean) —

    should be policy be available offline



292
293
294
 
# File 'lib/jss/api_object/policy.rb', line 292

def offline
  @offline
end

#open_firmware_efi_password ⇒ Hash (readonly)

Returns the open firmware mode and password.

Returns:

  • (Hash) —

    the open firmware mode and password



454
455
456
 
# File 'lib/jss/api_object/policy.rb', line 454

def open_firmware_efi_password
  @open_firmware_efi_password
end

#override_default_settings ⇒ Hash (readonly)

Overrides for various defaults

NOTE: There’s an API bug in both XML and JSON with the

:distribution_point and :target_drive values.
First off, it's not clear what the :target_drive value here
is overriding, since there's a :target_drive value in the
main General hash.
Second off - when you set a non-default dist.point in the
packages section of the UI, that value shows up in both
this :target_drive and the general one, but the :distribution_point
value here stays empty.

The hash looks like: :distribution_point => “”, :force_afp_smb => false, :netboot_server => “current”, :target_drive => “default”, :sus => “default”

Returns:



322
323
324
 
# File 'lib/jss/api_object/policy.rb', line 322

def override_default_settings
  @override_default_settings
end

#packages ⇒ Array<Hash> (readonly) Also known as: pkgs

The pkgs handled by this policy

Hash keys are:

  • :action => “Install”

  • :update_autorun => false,

  • :feu => false,

  • :name => “rbgem-json-1.6.5-4.pkg”,

  • :id => 1073

Returns:



501
502
503
 
# File 'lib/jss/api_object/policy.rb', line 501

def packages
  @packages
end

#permissions_repair ⇒ Boolean

Should this policy run a permission repair?

Returns:

  • (Boolean) —

    client maintenance task



418
419
420
 
# File 'lib/jss/api_object/policy.rb', line 418

def permissions_repair
  @permissions_repair
end

#printers ⇒ Array<Hash> (readonly)

The printers handled by this policy

Each Hash looks like: {:make_default => false, :name => “torlan”, :id => 3, :action => “install”}

Returns:



594
595
596
 
# File 'lib/jss/api_object/policy.rb', line 594

def printers
  @printers
end

#reboot_options ⇒ Hash (readonly)

Reboot options for the policy

The hash keys are:

  • :user_logged_in => “Do not restart”,

  • :minutes_until_reboot => 5,

  • :message=> “This computer will restart in 5 minutes. yaddayadda.”,

  • :startup_disk => “Current Startup Disk”,

  • :specify_startup => “”,

  • :no_user_logged_in => “Do not restart”

  • :file_vault_2_reboot => false

Returns:



558
559
560
 
# File 'lib/jss/api_object/policy.rb', line 558

def reboot_options
  @reboot_options
end

#recon ⇒ Boolean Also known as: update_inventory

Should this policy run a recon?

Returns:

  • (Boolean) —

    client maintenance task



422
423
424
 
# File 'lib/jss/api_object/policy.rb', line 422

def recon
  @recon
end

#reset_name ⇒ Boolean

Should this policy reset the local hostname?

Returns:

  • (Boolean) —

    client maintenance task



431
432
433
 
# File 'lib/jss/api_object/policy.rb', line 431

def reset_name
  @reset_name
end

#scope ⇒ Object Originally defined in module Scopable

Attribtues

#scripts ⇒ Array<Hash> (readonly)

The scripts run by this policy

Hash keys are:

  • :name => “chromegetter.sh”,

  • :parameter4 => “”,

  • :parameter5 => “”,

  • :parameter6 => “”,

  • :parameter7 => “”,

  • :parameter8 => “”,

  • :parameter9 => “”,

  • :parameter10 => “”,

  • :parameter11 => “”,

  • :id => 1428,

  • :priority => “After”

Returns:



521
522
523
 
# File 'lib/jss/api_object/policy.rb', line 521

def scripts
  @scripts
end

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

Each Hash has these keys about the category

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

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

Most objects also include one or both of these keys:

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

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

Returns:

  • (Array<Hash>) —

    The categories in which this item should appear in SSvc

#self_service_description ⇒ String Originally defined in module SelfServable

Returns The verbage that appears in SelfSvc for this item.

Returns:

  • (String) —

    The verbage that appears in SelfSvc for this item

#self_service_display_name ⇒ String Also known as: self_service_dislay_name Originally defined in module SelfServable

Returns The name to display in macOS Self Service.

Returns:

  • (String) —

    The name to display in macOS Self Service.

#self_service_feature_on_main_page ⇒ Boolean Originally defined in module SelfServable

Only applicable to macOS targets

Returns:

  • (Boolean) —

    Should this item feature on the main page of SSvc?

#self_service_force_users_to_view_description ⇒ Boolean Originally defined in module SelfServable

Returns Should an extra window appear before the user can install the item? (OSX SSvc only).

Returns:

  • (Boolean) —

    Should an extra window appear before the user can install the item? (OSX SSvc only)

#self_service_install_button_text ⇒ String Originally defined in module SelfServable

defaults to ‘Install’

Returns:

  • (String) —

    The text label on the install button in SSvc (OSX SSvc only)

#self_service_notification_message ⇒ String Originally defined in module SelfServable

Returns The message text of the notification.

Returns:

  • (String) —

    The message text of the notification

#self_service_notification_subject ⇒ String Originally defined in module SelfServable

object name.

Returns:

  • (String) —

    The subject text of the notification. Defaults to the

#self_service_notification_type ⇒ Symbol Originally defined in module SelfServable

Returns How should notifications be sent either :ssvc_only or :ssvc_and_nctr.

Returns:

  • (Symbol) —

    How should notifications be sent either :ssvc_only or :ssvc_and_nctr

#self_service_notifications_enabled ⇒ Boolean Also known as: self_service_notifications_enabled? Originally defined in module SelfServable

Returns Should jamf send notifications to self service?.

Returns:

  • (Boolean) —

    Should jamf send notifications to self service?

#self_service_reinstall_button_text ⇒ String Originally defined in module SelfServable

defaults to ‘Reinstall’

Returns:

  • (String) —

    The text label on the reinstall button in SSvc (OSX SSvc only)

#self_service_reminder_frequency ⇒ Integer Originally defined in module SelfServable

Returns How often (in days) should reminders be given.

Returns:

  • (Integer) —

    How often (in days) should reminders be given

#self_service_reminders_enabled ⇒ Boolean Also known as: self_service_reminders_enabled? Originally defined in module SelfServable

Returns Should self service give reminders by displaying the notification repeatedly?.

Returns:

  • (Boolean) —

    Should self service give reminders by displaying the notification repeatedly?

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

Returns The password needed for removal, in plain text.

Returns:

  • (String) —

    The password needed for removal, in plain text.

#self_service_user_removable ⇒ Symbol Originally defined in module SelfServable

Returns one of the keys in PROFILE_REMOVAL_BY_USER.

Returns:

  • (Symbol) —

    one of the keys in PROFILE_REMOVAL_BY_USER

#server_side_limitations ⇒ Hash (readonly)

The server-side limitations of this policy.

The keys are :activation and :expiration, both are Times.

the data comes from the API in the date_time_limitations hash of the general section, but the UI shows them in the Server Side Limitations area. This attribute is just for convience and consistency, and just refers to the data in their API locations

Returns:



359
360
361
 
# File 'lib/jss/api_object/policy.rb', line 359

def server_side_limitations
  @server_side_limitations
end

#site ⇒ String (readonly)

Returns a string with the site name.

Returns:

  • (String) —

    a string with the site name



299
300
301
 
# File 'lib/jss/api_object/policy.rb', line 299

def site
  @site
end

#target_drive ⇒ String

Returns which drive should the policy target.

Returns:

  • (String) —

    which drive should the policy target



289
290
291
 
# File 'lib/jss/api_object/policy.rb', line 289

def target_drive
  @target_drive
end

#trigger ⇒ String (readonly)

Either EVENT or USER_INITIATED

If it’s EVENT, then one or more of the members @trigger_events must true.

Returns:



384
385
386
 
# File 'lib/jss/api_object/policy.rb', line 384

def trigger
  @trigger
end

#trigger_events ⇒ Hash (readonly)

The triggers that cause this policy to execute on a client when the @trigger is “EVENT”

This is a hash with the following keys. Each comes from the API as a key in the :general hash, but they make more sense separated out like this.

  • :trigger_startup => Bool

  • :trigger_login => Bool

  • :trigger_logout => Bool

  • :trigger_checkin => Bool

  • :trigger_network_state_changed => Bool

  • :trigger_enrollment_complete => Bool

  • :trigger_other => the String that causes a custom trigger

To edit a value, call

set_trigger_event(type, new_val)

where type is one of the keys in TRIGGER_EVENTS and new val is the new value (usually boolean)

Returns:



405
406
407
 
# File 'lib/jss/api_object/policy.rb', line 405

def trigger_events
  @trigger_events
end

#user_may_defer ⇒ Boolean (readonly)

Returns can the user defer the policy?.

Returns:

  • (Boolean) —

    can the user defer the policy?



534
535
536
 
# File 'lib/jss/api_object/policy.rb', line 534

def user_may_defer
  @user_may_defer
end

#user_may_defer_until ⇒ Time (readonly)

Returns when is the user no longer allowed to defer?.

Returns:

  • (Time) —

    when is the user no longer allowed to defer?



537
538
539
 
# File 'lib/jss/api_object/policy.rb', line 537

def user_may_defer_until
  @user_may_defer_until
end

#user_message_finish ⇒ String (readonly)

Returns the message shown the user at policy end.

Returns:

  • (String) —

    the message shown the user at policy end



543
544
545
 
# File 'lib/jss/api_object/policy.rb', line 543

def user_message_finish
  @user_message_finish
end

#user_message_start ⇒ String (readonly)

Returns the message shown the user at policy start.

Returns:

  • (String) —

    the message shown the user at policy start



540
541
542
 
# File 'lib/jss/api_object/policy.rb', line 540

def user_message_start
  @user_message_start
end

#verify_startup_disk ⇒ Boolean

Should this policy verify the startup disk?

Returns:

  • (Boolean) —

    client maintenance task



414
415
416
 
# File 'lib/jss/api_object/policy.rb', line 414

def verify_startup_disk
  @verify_startup_disk
end

Instance Method Details

#add_package(identifier, **opts) ⇒ Array?

Add a package to the list of pkgs handled by this policy. If the pkg already exists in the policy, nil is returned and no changes are made.

Parameters:

  • identifier (String, Integer) —

    the name or id of the package to add to this policy

  • position (Symbol, Integer) —

    where to add this pkg among the list of pkgs. Zero-based, :start and 0 are the same, as are :end and -1. Defaults to :end

  • action (String) —

    One of the values of PACKAGE_ACTIONS

  • feu (Boolean) —

    Overrides the setting for the pkg itself Defaults to false

  • fut (Boolean) —

    Overrides the setting for the pkg itself Defaults to false

  • update_autorun (Boolean) —

    Defaults to false

Returns:

  • (Array, nil) —

    the new @packages array, nil if pkg was already in the policy



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/jss/api_object/policy.rb', line 1159

def add_package(identifier, **opts)
  id = validate_package_opts(identifier, opts)

  return nil if @packages.map { |p| p[:id] }.include? id

  name = JSS::Package.map_all_ids_to(:name, api: @api)[id]

  pkg_data = {
    id: id,
    name: name,
    action: PACKAGE_ACTIONS[opts[:action]],
    feu: opts[:feu],
    fut: opts[:feu],
    update_autorun: opts[:update_autorun]
  }

  @packages.insert opts[:position], pkg_data

  @need_to_update = true
  @packages
end

#add_script(identifier, **opts) ⇒ Array?

Add a script to the list of SCRIPT_PRIORITIESipts run by this policy. If the script already exists in the policy, nil is returned and no changes are made.

Parameters:

  • identifier (String, Integer) —

    the name or id of the script to add to this policy

  • opts (Hash) —

    the options for this script

  • [Symbol, (Hash) —

    a customizable set of options

  • [Symbol] (Hash) —

    a customizable set of options

  • [String] (Hash) —

    a customizable set of options

Returns:

  • (Array, nil) —

    the new @scripts array, nil if script was already in the policy



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/jss/api_object/policy.rb', line 1244

def add_script(identifier, **opts)
  id = validate_script_opts(identifier, opts)

  return nil if @scripts.map { |s| s[:id] }.include? id

  name = JSS::Script.map_all_ids_to(:name, api: @api)[id]

  script_data = {
    id: id,
    name: name,
    priority: SCRIPT_PRIORITIES[opts[:priority]],
    parameter4: opts[:parameter4],
    parameter5: opts[:parameter5],
    parameter6: opts[:parameter6],
    parameter7: opts[:parameter7],
    parameter8: opts[:parameter8],
    parameter9: opts[:parameter9],
    parameter10: opts[:parameter10],
    parameter11: opts[:parameter11]
  }

  @scripts.insert opts[:position], script_data

  @need_to_update = true
  @scripts
end

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

This method returns an undefined value.

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

Parameters:

  • new_cat (String, Integer) —

    the name or id of a category where this object should appear in SelfSvc

  • display_in (Boolean) (defaults to: true) —

    should this item appear in the SelfSvc page for the category? Only meaningful in applicable classes

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

    should this item be featured in the SelfSvc page for the category? Only meaningful in applicable classes. NOTE: this will always be false if display_in is false.

Raises:

#add_to_self_service ⇒ void Originally defined in module SelfServable

This method returns an undefined value.

Add this object to self service if not already there.

#category=(new_cat) ⇒ void Originally defined in module Categorizable

This method returns an undefined value.

Change the category of this object. Any of the NON_CATEGORIES values will unset the category

Parameters:

  • new_cat (Integer, String) —

    The new category

Raises:

#category_assigned? ⇒ Boolean Also known as: categorized? Originally defined in module Categorizable

Does this object have a category assigned?

Returns:

  • (Boolean) —

    Does this object have a category assigned?

#category_id ⇒ Integer Originally defined in module Categorizable

The id of the category for this object.

Returns:

  • (Integer) —

    The id of the category for this object.

#category_name ⇒ String Also known as: category Originally defined in module Categorizable

The name of the category for this object. For backward compatibility, this is aliased to just ‘category’

Returns:

  • (String) —

    The name of the category for this object.

#category_object ⇒ JSS::Category Originally defined in module Categorizable

The JSS::Category instance for this object’s category

Returns:

  • (JSS::Category) —

    The JSS::Category instance for this object’s category

#clone(new_name, api: nil) ⇒ APIObject Originally defined in module Creatable

make a clone of this API object, with a new name. The class must be creatable

Parameters:

  • name (String) —

    the name for the new object

  • api (JSS::APIConnection) (defaults to: nil) —

    the API in which to create the object Defaults to the API used to instantiate this object

Returns:

  • (APIObject) —

    An uncreated clone of this APIObject with the given name

Raises:

#create ⇒ Object Originally defined in module SelfServable

HACK: ity hack hack… remove when jamf fixes these bugs

#delete_file? ⇒ Boolean Also known as: delete_path?

Returns Should the searched-for path be deleted if found?.

Returns:

  • (Boolean) —

    Should the searched-for path be deleted if found?



1063
1064
1065
 
# File 'lib/jss/api_object/policy.rb', line 1063

def delete_file?
  @files_processes[:delete_file]
end

#directory_binding_ids ⇒ Array

Returns the id’s of the directory_bindings handled by the policy.

Returns:

  • (Array) —

    the id’s of the directory_bindings handled by the policy



1286
1287
1288
 
# File 'lib/jss/api_object/policy.rb', line 1286

def directory_binding_ids
  @directory_bindings.map { |p| p[:id] }
end

#directory_binding_names ⇒ Array

Returns the names of the directory_bindings handled by the policy.

Returns:

  • (Array) —

    the names of the directory_bindings handled by the policy



1291
1292
1293
 
# File 'lib/jss/api_object/policy.rb', line 1291

def directory_binding_names
  @directory_bindings.map { |p| p[:name] }
end

#disable ⇒ Object

Shortcut for endabled = false



727
728
729
 
# File 'lib/jss/api_object/policy.rb', line 727

def disable
  self.enabled = false
end

#do_not_reboot ⇒ void

This method returns an undefined value.

Reboot Options Do Not Reboot Shortcut method to suppress Reboot Options



950
951
952
953
954
 
# File 'lib/jss/api_object/policy.rb', line 950

def do_not_reboot
  @reboot_options[:user_logged_in] = 'Do not restart'
  @reboot_options[:no_user_logged_in] = 'Do not restart'
  @need_to_update = true
end

#dock_item_ids ⇒ Array

Returns the id’s of the dock_items handled by the policy.

Returns:

  • (Array) —

    the id’s of the dock_items handled by the policy



1298
1299
1300
 
# File 'lib/jss/api_object/policy.rb', line 1298

def dock_item_ids
  @dock_items.map { |p| p[:id] }
end

#dock_item_names ⇒ Array

Returns the names of the dock_items handled by the policy.

Returns:

  • (Array) —

    the names of the dock_items handled by the policy



1303
1304
1305
 
# File 'lib/jss/api_object/policy.rb', line 1303

def dock_item_names
  @dock_items.map { |p| p[:name] }
end

#enable ⇒ Object

Shortcut for enabled = true



722
723
724
 
# File 'lib/jss/api_object/policy.rb', line 722

def enable
  self.enabled = true
end

#evaluate_new_category(new_cat) ⇒ Array<String, Integer> Originally defined in module Categorizable

Given a category name or id, return the name and id TODO: use APIObject.exist? and/or APIObject.valid_id

Parameters:

  • new_cat (String, Integer) —

    The name or id of a possible category

Returns:

  • (Array<String, Integer>) —

    The matching name and id, which may be nil.

#file_vault_2_reboot=(fv_bool) ⇒ void

This method returns an undefined value.

Reboot Options FileVault Authenticated Reboot

Parameters:

  • fv_bool (Boolean) —

    true or false

Raises:



976
977
978
979
980
 
# File 'lib/jss/api_object/policy.rb', line 976

def file_vault_2_reboot=(fv_bool)
  raise JSS::InvalidDataError, 'FileVault 2 Reboot must be a Boolean' unless fv_bool.jss_boolean?
  @reboot_options[:file_vault_2_reboot] = fv_bool
  @need_to_update = true
end

#flush_logs(older_than: 0, period: :days) ⇒ void

This method returns an undefined value.

Flush all policy logs for this policy older than some number of days, weeks, months or years.

With no parameters, flushes all logs

NOTE: Currently the API doesn’t have a way to flush only failed policies.

Parameters:

  • older_than (Integer) (defaults to: 0) —

    0, 1, 2, 3, or 6

  • period (Symbol) (defaults to: :days) —

    :days, :weeks, :months, or :years

Raises:



1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/jss/api_object/policy.rb', line 1357

def flush_logs(older_than: 0, period: :days)
  raise JSS::NoSuchItemError, "Policy doesn't exist in the JSS. Use #create first." unless @in_jss

  unless LOG_FLUSH_INTERVAL_INTEGERS.key?(older_than)
    raise JSS::InvalidDataError, "older_than must be one of these integers: #{LOG_FLUSH_INTERVAL_INTEGERS.keys.join ', '}"
  end

  unless LOG_FLUSH_INTERVAL_PERIODS.key?(period)
    raise JSS::InvalidDataError, "period must be one of these symbols: :#{LOG_FLUSH_INTERVAL_PERIODS.keys.join ', :'}"
  end

  interval = "#{LOG_FLUSH_INTERVAL_INTEGERS[older_than]}+#{LOG_FLUSH_INTERVAL_PERIODS[period]}"

  @api.delete_rsrc "#{LOG_FLUSH_RSRC}/policy/id/#{@id}/interval/#{interval}"
end

#kill_process? ⇒ Boolean

Returns Should the searched-for process be killed if found.

Returns:

  • (Boolean) —

    Should the searched-for process be killed if found.



1029
1030
1031
 
# File 'lib/jss/api_object/policy.rb', line 1029

def kill_process?
  @files_processes[:kill_process]
end

#locate_file ⇒ String

Returns The term to seach for using the locate command.

Returns:

  • (String) —

    The term to seach for using the locate command



1107
1108
1109
 
# File 'lib/jss/api_object/policy.rb', line 1107

def locate_file
  @files_processes[:locate_file]
end

#locate_file=(term) ⇒ void

This method returns an undefined value.

Set the term to seach for using the locate command

Parameters:

  • term (String) —

    the term to seach for using the locate command

Raises:



1117
1118
1119
1120
1121
 
# File 'lib/jss/api_object/policy.rb', line 1117

def locate_file=(term)
  raise JSS::InvalidDataError, 'Term to locate must be a String' unless term.is_a? String
  @files_processes[:locate_file] = term
  @need_to_update = true
end

#minutes_until_reboot=(minutes) ⇒ void

This method returns an undefined value.

Reboot Options Minutes Until Reboot

Parameters:

  • minutes (String) —

    The number of minutes to delay prior to reboot

Raises:



963
964
965
966
967
 
# File 'lib/jss/api_object/policy.rb', line 963

def minutes_until_reboot=(minutes)
  raise JSS::InvalidDataError, 'Minutes until reboot must be an Integer' unless minutes.is_a? Integer
  @reboot_options[:minutes_until_reboot] = minutes
  @need_to_update = true
end

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

This method returns an undefined value.

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

Parameters:

  • newname (String) —

    the new name

Raises:

#no_user_logged_in=(no_user_option) ⇒ void

This method returns an undefined value.

What to do at reboot when No User Logged In

Parameters:

  • no_user_option (String) —

    Any one of the Strings from NO_USER_LOGGED_IN

Raises:



886
887
888
889
890
 
# File 'lib/jss/api_object/policy.rb', line 886

def no_user_logged_in=(no_user_option)
  raise JSS::InvalidDataError, "no_user_logged_in options: #{NO_USER_LOGGED_IN.join(', ')}" unless NO_USER_LOGGED_IN.include? no_user_option
  @reboot_options[:no_user_logged_in] = no_user_option
  @need_to_update = true
end

#package_ids ⇒ Array

Returns the id’s of the packages handled by the policy.

Returns:

  • (Array) —

    the id’s of the packages handled by the policy



1130
1131
1132
 
# File 'lib/jss/api_object/policy.rb', line 1130

def package_ids
  @packages.map { |p| p[:id] }
end

#package_names ⇒ Array

Returns the names of the packages handled by the policy.

Returns:

  • (Array) —

    the names of the packages handled by the policy



1135
1136
1137
 
# File 'lib/jss/api_object/policy.rb', line 1135

def package_names
  @packages.map { |p| p[:name] }
end

#parse_scope ⇒ void Originally defined in module Scopable

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

This method returns an undefined value.

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

#printer_ids ⇒ Array

Returns the id’s of the printers handled by the policy.

Returns:

  • (Array) —

    the id’s of the printers handled by the policy



1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/jss/api_object/policy.rb', line 1308

def printer_ids
    begin
        @printers.map { |p| p[:id] }
        rescue TypeError
        return []
    end
end

#printer_names ⇒ Array

Returns the names of the printers handled by the policy.

Returns:

  • (Array) —

    the names of the printers handled by the policy



1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/jss/api_object/policy.rb', line 1317

def printer_names
    begin
        @printers.map { |p| p[:name] }
        rescue TypeError
        return []
    end
end

#reboot_message=(message) ⇒ void Also known as: message=

This method returns an undefined value.

Set Reboot Message

Parameters:

  • reboot_message (String) —

    Text of Reboot Message

Raises:



910
911
912
913
914
 
# File 'lib/jss/api_object/policy.rb', line 910

def reboot_message=(message)
  raise JSS::InvalidDataError, 'Reboot message must be a String' unless message.is_a? String
  @reboot_options[:message] = message
  @need_to_update = true
end

#remove_from_self_service ⇒ void Originally defined in module SelfServable

This method returns an undefined value.

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

#remove_package(identifier) ⇒ Array?

Remove a package from this policy by name or id

Parameters:

  • identfier (String, Integer) —

    the name or id of the package to remove

Returns:

  • (Array, nil) —

    the new packages array or nil if no change



1187
1188
1189
1190
1191
 
# File 'lib/jss/api_object/policy.rb', line 1187

def remove_package(identifier)
  removed = @packages.delete_if { |p| p[:id] == identifier || p[:name] == identifier }
  @need_to_update = true if removed
  removed
end

#remove_script(identifier) ⇒ Array?

Remove a script from this policy by name or id

Parameters:

  • identfier (String, Integer) —

    the name or id of the script to remove

Returns:

  • (Array, nil) —

    the new scripts array or nil if no change



1277
1278
1279
1280
1281
 
# File 'lib/jss/api_object/policy.rb', line 1277

def remove_script(identifier)
  removed = @scripts.delete_if { |s| s[:id] == identifier || s[:name] == identifier }
  @need_to_update = true if removed
  removed
end

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

This method returns an undefined value.

Remove a category from those for this item in SSvc

Parameters:

  • cat (String, Integer) —

    the name or id of the category to remove

#run(show_output = false) ⇒ Boolean? Also known as: execute

Try to execute this policy on this machine.

Parameters:

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

    should the stdout and stderr of the ‘jamf policy’ command be sent to stdout in realtime?

Returns:

  • (Boolean, nil) —

    The success of the ‘jamf policy’ command, or nil if the policy couldn’t be executed (out of scope, policy disabled, etc)



1335
1336
1337
1338
1339
1340
 
# File 'lib/jss/api_object/policy.rb', line 1335

def run(show_output = false)
  return nil unless enabled?
  output = JSS::Client.run_jamf('policy', "-id #{id}", show_output)
  return nil if output.include? 'No policies were found for the ID'
  $CHILD_STATUS.exitstatus.zero? ? true : false
end

#run_command ⇒ String Also known as: command_to_run

Returns The unix shell command to run on ths client.

Returns:

  • (String) —

    The unix shell command to run on ths client.



986
987
988
 
# File 'lib/jss/api_object/policy.rb', line 986

def run_command
  @files_processes[:run_command]
end

#run_command=(command) ⇒ void Also known as: command_to_run=

This method returns an undefined value.

Set the unix shell command to be run on the client

Parameters:

  • command (String) —

    the unix shell command to be run on the client

Raises:



997
998
999
1000
1001
 
# File 'lib/jss/api_object/policy.rb', line 997

def run_command=(command)
  raise JSS::InvalidDataError, 'Command to run must be a String' unless command.is_a? String
  @files_processes[:run_command] = command
  @need_to_update = true
end

#script_ids ⇒ Array

Returns the id’s of the scripts handled by the policy.

Returns:

  • (Array) —

    the id’s of the scripts handled by the policy



1196
1197
1198
 
# File 'lib/jss/api_object/policy.rb', line 1196

def script_ids
  @scripts.map { |p| p[:id] }
end

#script_names ⇒ Array

Returns the names of the scripts handled by the policy.

Returns:

  • (Array) —

    the names of the scripts handled by the policy



1201
1202
1203
 
# File 'lib/jss/api_object/policy.rb', line 1201

def script_names
  @scripts.map { |p| p[:name] }
end

#search_by_path ⇒ Pathname

Returns The path to search for.

Returns:



1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/jss/api_object/policy.rb', line 1053

def search_by_path
  if @files_processes[:search_by_path].nil?
    return nil
  else
    Pathname.new @files_processes[:search_by_path]
  end
end

#search_for_process ⇒ String

Returns The process name to search for on the client.

Returns:

  • (String) —

    The process name to search for on the client



1023
1024
1025
 
# File 'lib/jss/api_object/policy.rb', line 1023

def search_for_process
  @files_processes[:search_for_process]
end

#self_service_execute_url ⇒ String Originally defined in module SelfServable

Returns The url to view this thing in Self Service.

Returns:

  • (String) —

    The url to view this thing in Self Service

#self_service_payload ⇒ Symbol Originally defined in module SelfServable

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

Returns:

  • (Symbol) —

    :profile, :app, or :policy

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

What devices types can get this thing in Self Service

Returns:

  • (Array<Symbol>) —

    An array of :macos, :ios, or both.

#self_service_view_url ⇒ String Originally defined in module SelfServable

Returns The url to view this thing in Self Service.

Returns:

  • (String) —

    The url to view this thing in Self Service

#server_side_activation=(activation) ⇒ void

This method returns an undefined value.

Set Server Side Activation

Parameters:

  • activation (Time) —

    Activation date and time

Raises:



792
793
794
795
796
 
# File 'lib/jss/api_object/policy.rb', line 792

def server_side_activation=(activation)
  raise JSS::InvalidDataError, 'Activation must be a Time' unless activation.is_a? Time
  @server_side_limitations[:activation] = activation
  @need_to_update = true
end

#server_side_expiration=(expiration) ⇒ void

This method returns an undefined value.

Set Server Side Expiration

Parameters:

  • expiration (Time) —

    Expiration date and time

Raises:



804
805
806
807
808
 
# File 'lib/jss/api_object/policy.rb', line 804

def server_side_expiration=(expiration)
  raise JSS::InvalidDataError, 'Expiration must be a Time' unless expiration.is_a? Time
  @server_side_limitations[:expiration] = expiration
  @need_to_update = true
end

#set_search_by_path(path, delete = false) ⇒ void

This method returns an undefined value.

Set the path to search for, a String or Pathname, and whether or not to delete it if found.

Setter methods (which end with =) can’t easily take multiple arguments, so we instead name them “set_blah_blah” rather than “blah_blah=”

Parameters:

  • path (String, Pathname) —

    the path to search for

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

    should the path be deleted if found

Raises:



1080
1081
1082
1083
1084
1085
 
# File 'lib/jss/api_object/policy.rb', line 1080

def set_search_by_path(path, delete = false)
  raise JSS::InvalidDataError, 'Path to search for must be a String or a Pathname' unless path.is_a?(String) || path.is_a?(Pathname)
  @files_processes[:search_by_path] = path.to_s
  @files_processes[:delete_file] = delete ? true : false
  @need_to_update = true
end

#set_search_for_process(process, kill = false) ⇒ void

This method returns an undefined value.

Set the process name to search for, and if it should be killed if found.

Setter methods (which end with =) can’t easily take multiple arguments, so we instead name them “set_blah_blah” rather than “blah_blah=”

Parameters:

  • process (String) —

    the process name to search for

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

    should be process be killed if found



1045
1046
1047
1048
1049
 
# File 'lib/jss/api_object/policy.rb', line 1045

def set_search_for_process(process, kill = false)
  @files_processes[:search_for_process] = process.to_s
  @files_processes[:kill_process] = kill ? true : false
  @need_to_update = true
end

#set_trigger_event(type, new_val) ⇒ void

This method returns an undefined value.

Change a trigger event

Parameters:

  • type (Symbol) —

    the type of trigger, one of the keys of TRIGGER_EVENTS

  • new_val (Boolean) —

    whether the type of trigger is active or not.

Raises:



775
776
777
778
779
780
781
782
783
784
 
# File 'lib/jss/api_object/policy.rb', line 775

def set_trigger_event(type, new_val)
  raise JSS::InvalidDataError, "Trigger type must be one of #{TRIGGER_EVENTS.keys.join(', ')}" unless TRIGGER_EVENTS.key?(type)
  if type == :custom
    raise JSS::InvalidDataError, 'Custom triggers must be Strings' unless new_val.is_a? String
  else
    raise JSS::InvalidDataError, 'Non-custom triggers must be true or false' unless JSS::TRUE_FALSE.include? new_val
  end
  @trigger_events[TRIGGER_EVENTS[type]] = new_val
  @need_to_update = true
end

#should_update ⇒ void Originally defined in module Scopable

This method returns an undefined value.

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

#site=(new_site) ⇒ void Originally defined in module Sitable

This method returns an undefined value.

Change the site of this object. Any of the NON_SITES values will unset the site

Parameters:

  • new_site (Integer, String) —

    The new site

Raises:

#site_assigned? ⇒ Boolean Originally defined in module Sitable

Does this object have a site assigned?

Returns:

  • (Boolean) —

    Does this object have a site assigned?

#site_id ⇒ Integer Originally defined in module Sitable

The id of the site for this object.

Returns:

  • (Integer) —

    The id of the site for this object.

#site_name ⇒ String Also known as: site Originally defined in module Sitable

The name of the site for this object. For backward compatibility, this is aliased to just ‘site’

Returns:

  • (String) —

    The name of the site for this object.

#site_object ⇒ JSS::Site Originally defined in module Sitable

The JSS::Site instance for this object’s site

Returns:

  • (JSS::Site) —

    The JSS::Site instance for this object’s site

#specify_startup=(startup_volume) ⇒ void

This method returns an undefined value.

Specify Startup Volume Only Supports “Specify Local Startup Disk”

Parameters:

  • startup_volume (String) —

    a Volume to reboot to

Raises:



938
939
940
941
942
 
# File 'lib/jss/api_object/policy.rb', line 938

def specify_startup=(startup_volume)
  raise JSS::InvalidDataError, "#{startup_volume} is not a valid Startup Disk" unless startup_volume.is_a? String
  @reboot_options[:specify_startup] = startup_volume
  @need_to_update = true
end

#spotlight_search ⇒ String

Returns The term to search for using spotlight.

Returns:

  • (String) —

    The term to search for using spotlight



1089
1090
1091
 
# File 'lib/jss/api_object/policy.rb', line 1089

def spotlight_search
  @files_processes[:spotlight_search]
end

#spotlight_search=(term) ⇒ void

This method returns an undefined value.

Set the term to seach for using spotlight

Parameters:

  • term (String) —

    the term to seach for using spotlight

Raises:



1099
1100
1101
1102
1103
 
# File 'lib/jss/api_object/policy.rb', line 1099

def spotlight_search=(term)
  raise JSS::InvalidDataError, 'Spotlight search term must be a String' unless term.is_a? String
  @files_processes[:spotlight_search] = term
  @need_to_update = true
end

#startup_disk=(startup_disk_option) ⇒ void

This method returns an undefined value.

Set Startup Disk Only Supports ‘Specify Local Startup Disk’ at the moment

Parameters:

  • startup_disk_option (String)

Raises:



924
925
926
927
928
929
 
# File 'lib/jss/api_object/policy.rb', line 924

def startup_disk=(startup_disk_option)
  raise JSS::InvalidDataError, "#{startup_disk_option} is not a valid Startup Disk" unless startup_disk_option.is_a? String
  @reboot_options[:startup_disk] = 'Specify Local Startup Disk'
  self.specify_startup = startup_disk_option
  @need_to_update = true
end

#unset_category ⇒ void Originally defined in module Categorizable

This method returns an undefined value.

Set the category to nothing

#unset_site ⇒ void Originally defined in module Sitable

This method returns an undefined value.

Set the site to nothing

#update ⇒ Object Originally defined in module SelfServable

HACK: ity hack hack… remove when jamf fixes these bugs

#update_locate_database=(bool) ⇒ void

This method returns an undefined value.

Set whether or not to update the database used by the locate command.

Parameters:

  • bool (Boolean) —

    whether or not to update the database used by the locate command.



1016
1017
1018
1019
 
# File 'lib/jss/api_object/policy.rb', line 1016

def update_locate_database=(bool)
  @files_processes[:update_locate_database] = JSS::Validate.boolean bool
  @need_to_update = true
end

#update_locate_database? ⇒ Boolean

Returns Should we update the database used by the locate command?.

Returns:

  • (Boolean) —

    Should we update the database used by the locate command?



1006
1007
1008
 
# File 'lib/jss/api_object/policy.rb', line 1006

def update_locate_database?
  @files_processes[:update_locate_database]
end

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

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

Parameters:

  • type (Symbol) —

    the type of upload happening. Must be one of the keys defined in the class’s UPLOAD_TYPES Hash.

  • local_file (String, Pathname) —

    String or Pathname pointing to the locally-readable file to be uploaded.

Returns:

  • (String) —

    The xml response from the server.

Raises:

#user_logged_in=(logged_in_option) ⇒ void

This method returns an undefined value.

What to do at reboot when there is a User Logged In

Parameters:

  • logged_in_option (String) —

    Any one of the Strings from USER_LOGGED_IN

Raises:



898
899
900
901
902
 
# File 'lib/jss/api_object/policy.rb', line 898

def user_logged_in=(logged_in_option)
  raise JSS::InvalidDataError, "user_logged_in options: #{USER_LOGGED_IN.join(', ')}" unless USER_LOGGED_IN.include? logged_in_option
  @reboot_options[:user_logged_in] = logged_in_option
  @need_to_update = true
end

#user_removable? ⇒ Boolean? Originally defined in module SelfServable

Can this thing be removed by the user?

Returns:

  • (Boolean, nil) —

    nil means ‘not applicable’