Class: Jamf::RestrictedSoftware

Inherits:
APIObject show all
Includes:
Creatable, Scopable, Sitable, Updatable
Defined in:
lib/jamf/api/classic/api_objects/restricted_software.rb

Overview

Restricted Software items in the JSS.

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'restrictedsoftware'.freeze
RSRC_LIST_KEY =

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

:restricted_software
RSRC_OBJECT_KEY =

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

:restricted_software
SCOPE_TARGET_KEY =

Our scopes deal with computers

:computers
OBJECT_HISTORY_OBJECT_TYPE =

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

5
SITE_SUBSET =

Where is the Site data in the API JSON?

:general

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestrictedSoftware

Instance Methods



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 73

def initialize(**args)
  super

  @init_data[:general] ||= {}
  @process_name = @init_data[:general][:process_name]
  @match_exact_process_name = @init_data[:general][:match_exact_process_name]
  @send_notification = @init_data[:general][:send_notification]
  @kill_process = @init_data[:general][:kill_process]
  @delete_executable = @init_data[:general][:delete_executable]
  @display_message = @init_data[:general][:display_message]
  @site = Jamf::APIObject.get_name(@init_data[:general][:site])
  @site ||= 'None'
  @scope ||= Jamf::Scopable::Scope.new SCOPE_TARGET_KEY, nil
end

Instance Attribute Details

#delete_executable ⇒ Boolean Also known as: delete_executable? 



62
63
64
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 62

def delete_executable
  @delete_executable
end

#display_message ⇒ String 



65
66
67
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 65

def display_message
  @display_message
end

#kill_process ⇒ Boolean Also known as: kill_process? 



59
60
61
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 59

def kill_process
  @kill_process
end

#match_exact_process_name ⇒ Boolean Also known as: match_exact_process_name? 



53
54
55
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 53

def match_exact_process_name
  @match_exact_process_name
end

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

#process_name ⇒ String 



50
51
52
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 50

def process_name
  @process_name
end

#scope ⇒ Object Originally defined in module Scopable

Attribtues

#send_notification ⇒ Boolean Also known as: send_notification? 



56
57
58
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 56

def send_notification
  @send_notification
end

#site ⇒ Hash 



68
69
70
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 68

def site
  @site
end

Instance Method Details

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

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

Raises:

#create ⇒ Object

Raises:



135
136
137
138
139
140
141
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 135

def create
  raise Jamf::MissingDataError, 'process_name must be set before creating' if @process_name.to_s.empty?
  raise Jamf::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh,
                                                                                                                          cnx: @cnx).include? @name

  super
end

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

This method returns an undefined value.

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

Raises:

#parse_scope ⇒ void Originally defined in module Scopable

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

This method returns an undefined value.

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

#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_assigned? ⇒ Boolean Originally defined in module Sitable

Does this object have a site assigned?

#site_id ⇒ Integer Originally defined in module Sitable

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’

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

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

#unset_site ⇒ void Originally defined in module Sitable

This method returns an undefined value.

Set the site to nothing

#update ⇒ Object

Raises:



143
144
145
146
147
 
# File 'lib/jamf/api/classic/api_objects/restricted_software.rb', line 143

def update
  raise Jamf::MissingDataError, 'process_name must be set before updating' if @process_name.to_s.empty?

  super
end