Class: Jamf::Peripheral

Inherits:
APIObject show all
Includes:
Creatable, Locatable, Purchasable, Sitable, Updatable, Uploadable
Defined in:
lib/jamf/api/classic/api_objects/peripheral.rb

Overview

A peripheral in the JSS

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'peripherals'
RSRC_LIST_KEY =

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

:peripherals
RSRC_OBJECT_KEY =

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

:peripheral
OBJECT_HISTORY_OBJECT_TYPE =

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

8
SITE_SUBSET =

Where is the Site data in the API JSON?

:general

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Peripheral

Returns a new instance of Peripheral.

See Also:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 98

def initialize(**args)
  ### periphs don't really have names, and the JSS module list method for
  ### periphs gives the computer_id as the name, so give it a temp
  ### name of "-1", which shouldn't ever exist in the JSS
  args[:name] ||= '-1'

  super

  if args[:id] == :new
    raise Jamf::InvalidDataError, 'New Peripherals must have a :type, which must be one of those defined in the JSS.' unless args[:type]

    @type = args[:type]
    raise Jamf::InvalidDataError, "No peripheral type '#{@type}' in the JSS" unless Jamf::PeripheralType.all_names(:refresh, cnx: @cnx).include? @type

    @fields = {}
    @rest_rsrc = 'peripherals/id/-1'
    @site = 'None'
    return
  end

  @type = @init_data[:general][:type]
  @site = Jamf::APIObject.get_name(@init_data[:general][:site])
  @bar_code_1 = @init_data[:general][:bar_code_1]
  @bar_code_2 = @init_data[:general][:bar_code_2]
  @computer_id = @init_data[:general][:computer_id]

  ### fill in the fields
  @fields = {}
  @init_data[:general][:fields].each { |f| @fields[f[:name]] = f[:value] }

  ### get the field defs for this PeriphType, omitting the leading nil
  @field_defs ||= Jamf::PeripheralType.fetch(name: @type).fields.compact
end

Instance Attribute Details

#applecare_id ⇒ String Originally defined in module Purchasable

Returns:

#bar_code_1 ⇒ String Also known as: barcode_1, barcode1

Returns the “bar code 1” value.

Returns:

  • (String) —

    the “bar code 1” value



83
84
85
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 83

def bar_code_1
  @bar_code_1
end

#bar_code_2 ⇒ String Also known as: barcode_2, barcode2

Returns the “bar code 2” value.

Returns:

  • (String) —

    the “bar code 2” value



86
87
88
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 86

def bar_code_2
  @bar_code_2
end

#building ⇒ String Originally defined in module Locatable

Returns:

#computer_id ⇒ Integer (readonly)

Returns the id number of the computer to which this periph is connected.

Returns:

  • (Integer) —

    the id number of the computer to which this periph is connected



89
90
91
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 89

def computer_id
  @computer_id
end

#department ⇒ String Originally defined in module Locatable

Returns:

#email_address ⇒ String Originally defined in module Locatable

Returns:

#fields ⇒ Hash (readonly)

Returns the field values of the peripheral Each key is the fields name, as a String and the value is the fields value, also as a String.

Returns:

  • (Hash) —

    the field values of the peripheral Each key is the fields name, as a String and the value is the fields value, also as a String



156
157
158
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 156

def fields
  @fields
end

#is_leased ⇒ Boolean Also known as: leased? Originally defined in module Purchasable

Returns:

  • (Boolean)

#is_purchased ⇒ Boolean Also known as: purchased? Originally defined in module Purchasable

Returns:

  • (Boolean)

#lease_expires ⇒ Time Originally defined in module Purchasable

Returns:

#life_expectancy ⇒ Integer Originally defined in module Purchasable

Returns:

  • (Integer)

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

Returns do we have unsaved changes?.

Returns:

  • (Boolean) —

    do we have unsaved changes?

#phone ⇒ String Originally defined in module Locatable

Returns:

#po_date ⇒ Time Originally defined in module Purchasable

Returns:

#po_number ⇒ String Originally defined in module Purchasable

Returns:

#position ⇒ String Originally defined in module Locatable

Returns:

#purchase_price ⇒ Float Originally defined in module Purchasable

Returns:

  • (Float)

#purchasing_account ⇒ String Originally defined in module Purchasable

Returns:

#purchasing_contact ⇒ String Originally defined in module Purchasable

Returns:

#real_name ⇒ String Originally defined in module Locatable

Returns:

#room ⇒ String Originally defined in module Locatable

Returns:

#type ⇒ String (readonly)

Returns the type of peripheral.

Returns:

  • (String) —

    the type of peripheral



80
81
82
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 80

def type
  @type
end

#username ⇒ String Also known as: user Originally defined in module Locatable

Returns:

#vendor ⇒ String Originally defined in module Purchasable

Returns:

#warranty_expires ⇒ Time Originally defined in module Purchasable

Returns:

Instance Method Details

#associate(computer) ⇒ void Also known as: assign_to

This method returns an undefined value.

Associate this peripheral with a computer.

Parameters:

  • computer (String, Integer) —

    the name or id of a computer in the JSS



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 204

def associate(computer)
  if computer =~ /^d+$/
    raise Jamf::NoSuchItemError, "No computer in the JSS with id #{computer}" unless Jamf::Computer.all_ids(cnx: @cnx).include? computer

    @computer_id = computer
  else
    raise Jamf::NoSuchItemError, "No computer in the JSS with name #{computer}" unless Jamf::Computer.all_names(cnx: @cnx).include? computer

    @computer_id = Jamf::Computer.map_all_ids_to(:name, cnx: @cnx).invert[computer]
  end
  @need_to_update = true
end

#clear_location ⇒ void Originally defined in module Locatable

This method returns an undefined value.

Clear all location data

#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

Parameters:

  • name (String) —

    the name for the new object

  • cnx (Jamf::Connection) (defaults to: nil) —

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

Returns:

  • (APIObject) —

    An unsaved clone of this APIObject with the given name

Raises:

#create ⇒ Object

reset the restrsrc after creation

See Also:

  • Creatable#create


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

def create
  super
  @rest_rsrc = "peripherals/id/#{@id}"
  @id
end

#disassociate ⇒ void Also known as: unassign

This method returns an undefined value.

Disassociate this peripheral from any computer.

This seems to have no effect in the JSS, the computer/user/location data always shows the most recent.



225
226
227
228
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 225

def disassociate
  @computer_id = nil
  @need_to_update = true
end

#has_location? ⇒ Boolean Originally defined in module Locatable

Returns Does this item have location data?.

Returns:

  • (Boolean) —

    Does this item have location data?

#has_purchasing? ⇒ Boolean Originally defined in module Purchasable

Returns does this item have any purchasing info?.

Returns:

  • (Boolean) —

    does this item have any purchasing info?

#location ⇒ Hash<String> Originally defined in module Locatable

All the location data in a Hash, as it comes from the API.

The reason it isn’t stored this way is to prevent editing of the hash directly.

Returns:

#location_xml ⇒ REXML::Element Originally defined in module Locatable

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.

Return a REXML <location> element to be included in the rest_xml of objects that have a Location subset

Returns:

  • (REXML::Element)

#name=(_newname) ⇒ Object

periphs don’t have names

Raises:



146
147
148
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 146

def name=(_newname)
  raise Jamf::UnsupportedError, "Peripherals don't have names."
end

#parse_location ⇒ void Originally defined in module Locatable

This method returns an undefined value.

Call this during initialization of objects that have a Location subset and the location attributes will be populated (as primary attributes) from @init_data

#parse_purchasing ⇒ Object Originally defined in module Purchasable

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.

Call this during initialization of objects that have a Purchasing subset and the purchasing attribute will be populated from @init_data

#purchasing ⇒ Hash<String> Originally defined in module Purchasable

All the purchasing data in a Hash, as it comes from the API.

The reason it isn’t stored this way is to prevent editing of the hash directly.

Returns:

#purchasing_xml ⇒ REXML::Element Originally defined in module Purchasable

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.

Returns A <purchasing> element to be included in the rest_xml of objects that mix-in this module.

Returns:

  • (REXML::Element) —

    A <purchasing> element to be included in the rest_xml of objects that mix-in this module.

#set_field(field, value) ⇒ void

This method returns an undefined value.

Set the value of a field. It will be checked to ensure validity.

Parameters:

  • field (String) —

    the field to set

  • value (String) —

    the new value for the field



167
168
169
170
171
 
# File 'lib/jamf/api/classic/api_objects/peripheral.rb', line 167

def set_field(field, value)
  check_field(field, value)
  @fields[field] = value
  @need_to_update = true
end

#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 ⇒ Jamf::Site Originally defined in module Sitable

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

Returns:

  • (Jamf::Site) —

    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

#upload(type, local_file, force_ipa_upload: false) ⇒ Boolean Originally defined in module Uploadable

instance method wrapper for class method

Upload a file to the JSS to be stored with this instance of the class mixing in the Uploadable module

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.

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

    Should the server upload the .ipa file to JCDS or AWS if such are confgured for use?

Returns:

  • (Boolean) —

    was the upload successful?

Raises: