Class: JSS::Computer

Inherits:
APIObject show all
Extended by:
Matchable
Includes:
Creatable, Extendable, Locatable, MDM, ManagementHistory, Purchasable, Sitable, Updatable, Uploadable
Defined in:
lib/jss/api_object/computer.rb,
lib/jss.rb,
lib/jss/api_object/computer/application_installs.rb

Overview

This class represents a Computer in the JSS.

Adding Computers to the JSS

At the moment, this class cannot be used to add new Computers to the JSS. Please use other methods (like the Recon App or QuickAdd package)

Editing values

Any data that arrives in the JSS via an “inventory update” (a.k.a. 'recon') cannot be modified through this class, or the API.

Data that can be modified are:

  • Management Account (see #set_management_to)

  • asset_tag

  • barcodes 1 and 2

  • ip_address

  • udid

  • mac_address & alt_mac_address

  • serial_number Note: Even tho the webUI doesn't allow editing the serial_number, the API does, and it can be useful for dealing with duplicates that arise when a logic-board swap causes a new computer record. to be created.

  • location data via the Locatable module

  • purchasing data via the Purchasable module

  • Extension Attribute values via the Extendable module Note: as with other 'recon' generated values, Ext. Attrs. populated by scripts cannot be modified via the API. (the change would be overwritten the next time the machine did a recon)

After making any changes, you must call #update to send those changes to the server.

MDM Commands

See the MDM mixin module for Class and Instance methods for sending MDM commands to computers.

To send MDM commands without fetching Computer instances, use the class methods, which can take multiple computer identifiers at once.

NOTE: the poorly named 'UnmanageDevice' mdm command is implemented as MDM#remove_mdm_profile (which is its name in the webUI) as well as MDM#unmanage_device. Calling that method will NOT fully unmanage a computer from the JSS's point of view, it will just remove the mdm management profile from the machine and all configuration profiles that were installed via the JSS. Those profiles may be re-installed automatically later if the computer is still in scope for them

To properly unmanage a computer, use the #make_unmanaged Instance method which removes the mdm profile, but also makes the machine unmanged by the JSS, setting the management acct to nil, and requring re-enrollment.

Management History & Logs

Computer Management History and logs can now be retrieved both from a Computer instance, and directly via class methods without fetching an instance. This is handled by the mixed-in ManagementHistory module, Q.V. for details.

Appication Usage History

Computer Instances now have access to their Application Usage history via the #application_usage method. Call the method with a start-date value (either a String or a Time object) and an optional end-date value. If you omite the end-date, the start-date is used and you'll see usage for just that day.

See #application_usage for details about the data returned.

NOTE: your JSS must be gathering Appication Usage data in order for any data to be returned, and the usage history will only go back as far as your setting for flushing of Application Usage Logs.

Management Data

The computers 'manamgement data', as presented on the 'Management' tab of the computer's detail page in the JSS web UI, is available from the #management_data method. That method may return a large dataset, unless a subset is requested.

Subsets of management data have their own methods, which are faster and only retrieve the subset requested. See #smart_groups, #static_groups, #policies, #configuration_profiles, #ebooks, #app_store_apps, #restricted_software, and #patch_titles

The subset methods can take an 'only:' parameter, which is a symbol specifying the value you care to see. For example #smart_groups returns an array of hashes, one for each smart_group the computer is in. Those hashes have two keys, :name, and :id. However if you only want an array of names, you can call `smart_groups only: :name`

When any of the manamgement data methods are used the first time, the data is read from the API and cached internally, the cache is then used for all future calls. To re-read the data from the API and re-cache it, provide `refresh: true` to any of the manamgement data methods.

Other Methods

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'computers'.freeze
LIST_RSRC =

The (temporary?) list-resource

"#{RSRC_BASE}/subset/basic".freeze
RSRC_LIST_KEY =

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

:computers
RSRC_OBJECT_KEY =

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

:computer
SITE_SUBSET =

Where is the Site data in the API JSON?

:general
VALID_DATA_KEYS =

these keys, as well as :id and :name, are present in valid API JSON data for this class

DEPRECATED, with be removed in a future release.
%i[sus distribution_point alt_mac_address].freeze
OTHER_LOOKUP_KEYS =

these keys, as well as :id and :name, can be used to look up objects of this class in the JSS

{
  udid: { rsrc_key: :udid, list: :all_udids },
  serialnumber: { rsrc_key: :serialnumber, list: :all_serial_numbers },
  serial_number: { rsrc_key: :serialnumber, list: :all_serial_numbers },
  macaddress: { rsrc_key: :macaddress, list: :all_mac_addresses },
  mac_address: { rsrc_key: :macaddress, list: :all_mac_addresses }
}.freeze
SEARCH_CLASS =

This class lets us seach for computers

JSS::AdvancedComputerSearch
EXT_ATTRIB_CLASS =

This is the class for relevant Extension Attributes

JSS::ComputerExtensionAttribute
BOOT_FLAG =

Boot partitions are noted with the string “(Boot Partition)” at the end

' (Boot Partition)'.freeze
UPLOAD_TYPES =

file uploads can send attachments to the JSS using :computers as the sub-resource.

{ attachment: :computers }.freeze
MDM_COMMAND_TARGET =

Tell the MDM module what kind of MDM commands we use.

:computers
APPLICATION_USAGE_RSRC =

The API resource for app usage

'computerapplicationusage'.freeze
APPLICATION_USAGE_DATE_FMT =

The date format for retrieving usage data

'%Y-%m-%d'.freeze
APPLICATION_USAGE_DATE_CLASSES =

The classes that can be used with the date format

[Time, DateTime, Date].freeze
APPLICATION_USAGE_KEY =

The top-level hash key of the raw app usage data

:computer_application_usage
MGMT_DATA_RSRC =

The API resource for computer_management data

'computermanagement'.freeze
MGMT_DATA_KEY =

The top-level hash key of the computer_management data

:computer_management
MGMT_DATA_SUBSETS =

Thes are both the subset names in the resrouce URLS (when converted to strings) and the second-level hash key of the returned subset data.

%i[
  smart_groups
  static_groups
  mac_app_store_apps
  policies
  ebooks
  os_x_configuration_profiles
  restricted_software
  patch_reporting_software_titles
].freeze
CHECKIN_RSRC =

The API Resource for the computer checkin settings

'computercheckin'.freeze
CHECKIN_KEY =

The top-level hash key for the checkin settings

:computer_check_in
INV_COLLECTION_RSRC =

The API Resource for the computer inventory collection settings

'computerinventorycollection'.freeze
INV_COLLECTION_KEY =

The top-level hash key for the inventory collection settings

:computer_inventory_collection
OBJECT_HISTORY_OBJECT_TYPE =

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

1
COMPUTER_APPLICATIONS_RSRC =
'computerapplications/application'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Computer

# When creating new records with .make, these can be provided in the arg, or after instantiation via setter methods:

serial_number:, udid:, asset_tag:, mac_address:
alt_mac_address:, barcode_1:, barcode_2:

Parameters:

  • args (Hash) (defaults to: {})

    the data for looking up, or constructing, a new object.



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'lib/jss/api_object/computer.rb', line 756

def initialize(args = {})
  super args
  if @in_jss

    # mutable stuff
    @alt_mac_address = @init_data[:general][:alt_mac_address]
    @asset_tag = @init_data[:general][:asset_tag]
    @barcode1 = @init_data[:general][:barcode_1]
    @barcode2 = @init_data[:general][:barcode_2]
    @mac_address = @init_data[:general][:mac_address]
    @managed = @init_data[:general][:remote_management][:managed]
    @management_username = @init_data[:general][:remote_management][:management_username]
    @serial_number = @init_data[:general][:serial_number]
    @udid = @init_data[:general][:udid]

    # immutable single-values
    @distribution_point = @init_data[:general][:distribution_point]
    @initial_entry_date = JSS.epoch_to_time @init_data[:general][:initial_entry_date_epoch]
    @last_enrolled = JSS.epoch_to_time @init_data[:general][:last_enrolled_date_epoch]
    @ip_address = @init_data[:general][:ip_address]
    @itunes_store_account_is_active = @init_data[:general][:itunes_store_account_is_active]
    @jamf_version = @init_data[:general][:jamf_version]
    @last_contact_time = JSS.epoch_to_time @init_data[:general][:last_contact_time_epoch]
    @mdm_capable = @init_data[:general][:mdm_capable]
    @mdm_capable_users = @init_data[:general][:mdm_capable_users].values
    @netboot_server = @init_data[:general][:netboot_server]
    @platform = @init_data[:general][:platform]
    @report_date = JSS.epoch_to_time @init_data[:general][:report_date_epoch]
    @sus = @init_data[:general][:sus]

    @configuration_profiles = @init_data[:configuration_profiles]

    @groups_accounts = @init_data[:groups_accounts]
    @hardware = @init_data[:hardware]
    @peripherals = @init_data[:peripherals]
    @software = @init_data[:software]
    @certificates = @init_data[:certificates].map do |cert|
      {
        expires: JSS.epoch_to_time(cert[:expires_epoch]),
        common_name: cert[:common_name],
        identity: cert[:identity],
        name: cert[:name]
      }
    end

    # Freeze immutable things.
    # These are updated via recon, and aren't sent
    # with #update, so changing them here is meaningless anyway.
    @configuration_profiles.freeze
    @certificates.freeze
    @groups_accounts.freeze
    @hardware.freeze
    @peripherals.freeze
    @software.freeze

    @management_password = nil
  else
    @udid = args[:udid]
    @serial_number = args[:serial_number]
    @asset_tag = args[:asset_tag]
    @mac_address = args[:mac_address]
    @alt_mac_address = args[:alt_mac_address]
    @barcode1 = args[:barcode_1]
    @barcode2 = args[:barcode_2]
  end
end

Instance Attribute Details

#alt_mac_addressString Also known as: alt_macaddress

Returns the secondary mac address

Returns:

  • (String)

    the secondary mac address



499
500
501
# File 'lib/jss/api_object/computer.rb', line 499

def alt_mac_address
  @alt_mac_address
end

#applecare_idString Originally defined in module Purchasable

Returns:

#asset_tagString

Returns the asset tag

Returns:



502
503
504
# File 'lib/jss/api_object/computer.rb', line 502

def asset_tag
  @asset_tag
end

#barcode1String Also known as: bar_code_1, barcode_1

Returns the barcodes

Returns:



505
506
507
# File 'lib/jss/api_object/computer.rb', line 505

def barcode1
  @barcode1
end

#barcode2String Also known as: bar_code_2, barcode_2

Returns the barcodes

Returns:



505
506
507
# File 'lib/jss/api_object/computer.rb', line 505

def barcode2
  @barcode2
end

#buildingString Originally defined in module Locatable

Returns:

#certificatesArray<Hash> (readonly)

Each Hash represents a certificate and has these keys:

common_name: [String] the name of the cert
identity: [Boolean] Is this an identiry cert?
expires: [Time] the certificate expiration time
name: [String] Display name for the certificate, if any

Returns:

  • (Array<Hash>)

    Data about all the certificates on the computer.



593
594
595
# File 'lib/jss/api_object/computer.rb', line 593

def certificates
  @certificates
end

#configuration_profiles(only: nil) ⇒ Object (readonly)

A shortcut for 'management_data subset: :os_x_configuration_profiles'



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

def configuration_profiles
  @configuration_profiles
end

#departmentString Originally defined in module Locatable

Returns:

#distribution_pointString (readonly)

Returns The name of the distribution point for this computer

Returns:

  • (String)

    The name of the distribution point for this computer



508
509
510
# File 'lib/jss/api_object/computer.rb', line 508

def distribution_point
  @distribution_point
end

#email_addressString Originally defined in module Locatable

Returns:

#ext_attrsHash (readonly) Originally defined in module Extendable

Returns A mapping of Ext Attrib names to their values

Returns:

  • (Hash)

    A mapping of Ext Attrib names to their values

#extension_attributesArray<Hash> (readonly) Originally defined in module Extendable

Returns The extension attribute values for the object

Returns:

  • (Array<Hash>)

    The extension attribute values for the object

#groups_accountsHash (readonly)

Info about the local accts and ComputerGroups to which this machine beloings

The Hash keys are:

  • :computer_group_memberships => An Array of names of ComputerGroups to which this computer belongs

  • :local_accounts => An Array of Hashes for each local user acct on this computer. Each hash has these keys:

    • :name => String, the login name of the acct

    • :realname => the real name of the acct

    • :uid => String, the uid of the acct

    • :home => String, the path to the home folder

    • :home_size => String, the size of the homedir as a string like “53245MB”

    • :home_size_mb => Integer, the size of the homedir as an integer like 53245

    • :administrator => Boolean

    • :filevault_enabled => Boolean

Returns:



611
612
613
# File 'lib/jss/api_object/computer.rb', line 611

def groups_accounts
  @groups_accounts
end

#hardwareHash (readonly)

A Hash with info about the hardware of this cmoputer.

These are the keys & sample data

  • :number_processors=>2,

  • :processor_speed_mhz=>2530,

  • :make=>“Apple”,

  • :cache_size=>3072,

  • :processor_type=>“Intel Core i5”,

  • :total_ram_mb=>8192,

  • :model=>“15-inch MacBook Pro (Mid 2010)”,

  • :available_ram_slots=>0,

  • :processor_architecture=>“i386”,

  • :bus_speed_mhz=>0,

  • :total_ram=>8192,

  • :os_name=>“Mac OS X”,

  • :optical_drive=>“HL-DT-ST DVDRW GS23N”,

  • :model_identifier=>“MacBookPro6,2”,

  • :cache_size_kb=>3072,

  • :boot_rom=>“MBP61.0057.B0F”,

  • :os_version=>“10.9.3”,

  • :mapped_printers=> An Array of Hashes, one per printer, with these keys

    • :name => the name of the printer

    • :location => the location of the printer

    • :type => the printer model

    • :uri => the uri to reach the printer on the network

  • :nic_speed=>“10/100/1000”,

  • :processor_speed=>2530,

  • :active_directory_status=>“Not Bound”,

  • :bus_speed=>0,

  • :os_build=>“13D65”,

  • :smc_version=>“1.58f17”,

  • :service_pack=>“”,

  • :battery_capacity=>87

  • :storage=> An Array of Hashes, one per Drive, with these keys

    • :smart_status=>“Verified”,

    • :connection_type=>“NO”,

    • :model=>“M4-CT256M4SSD2”,

    • :revision=>“040H”,

    • :serial_number=>“00000000130709JH7GhhC”,

    • :size=>262205,

    • :disk=>“disk0”,

    • :drive_capacity_mb=>262205}],

    • :partition=> A Hash with these keys

      • :filevault2_status=>“Encrypted”,

      • :type=>“boot”,

      • :filevault2_percent=>100,

      • :partition_capacity_mb=>38014,

      • :lvgUUID=>“C4883AF5-3E58-4F76-A56C-094D4CEC7E9F”,

      • :percentage_full=>61,

      • :lvUUID=>“745A262E-AEA6-4608-8A3A-6CDC225B4DE6”,

      • :filevault_status=>“Encrypted”,

      • :size=>38014,

      • :pvUUID=>“C38051CF-5066-442F-A442-1035060ED462”,

      • :name=>“KimDrive40 (Boot Partition)”,

      • :filevault_percent=>100

Returns:



671
672
673
# File 'lib/jss/api_object/computer.rb', line 671

def hardware
  @hardware
end

#initial_entry_dateTime (readonly)

Returns when was it added to the JSS

Returns:

  • (Time)

    when was it added to the JSS



511
512
513
# File 'lib/jss/api_object/computer.rb', line 511

def 
  @initial_entry_date
end

#ip_addressIPAddr

Returns the last known IP address

Returns:

  • (IPAddr)

    the last known IP address



514
515
516
# File 'lib/jss/api_object/computer.rb', line 514

def ip_address
  @ip_address
end

#is_leasedBoolean Also known as: leased? Originally defined in module Purchasable

Returns:

  • (Boolean)

#is_purchasedBoolean Also known as: purchased? Originally defined in module Purchasable

Returns:

  • (Boolean)

#itunes_store_account_is_activeBoolean (readonly)

Returns:

  • (Boolean)


517
518
519
# File 'lib/jss/api_object/computer.rb', line 517

def 
  @itunes_store_account_is_active
end

#jamf_versionString (readonly)

Returns the version of the jamf binary

Returns:

  • (String)

    the version of the jamf binary



520
521
522
# File 'lib/jss/api_object/computer.rb', line 520

def jamf_version
  @jamf_version
end

#last_contact_timeTime (readonly)

Returns the last contact time

Returns:

  • (Time)

    the last contact time



523
524
525
# File 'lib/jss/api_object/computer.rb', line 523

def last_contact_time
  @last_contact_time
end

#last_enrolledTime (readonly)

Returns the last time this machine was enrolled

Returns:

  • (Time)

    the last time this machine was enrolled



526
527
528
# File 'lib/jss/api_object/computer.rb', line 526

def last_enrolled
  @last_enrolled
end

#lease_expiresTime Originally defined in module Purchasable

Returns:

#life_expectancyInteger Originally defined in module Purchasable

Returns:

  • (Integer)

#mac_addressString

Returns the primary macaddress

Returns:

  • (String)

    the primary macaddress



529
530
531
# File 'lib/jss/api_object/computer.rb', line 529

def mac_address
  @mac_address
end

#managedBoolean (readonly) Also known as: managed?

Returns is this machine “managed” by Casper?

Returns:

  • (Boolean)

    is this machine “managed” by Casper?



532
533
534
# File 'lib/jss/api_object/computer.rb', line 532

def managed
  @managed
end

#management_usernameString (readonly)

Returns the name of the management account

Returns:

  • (String)

    the name of the management account



535
536
537
# File 'lib/jss/api_object/computer.rb', line 535

def management_username
  @management_username
end

#mdm_capableBoolean (readonly) Also known as: mdm?

Returns doesit support MDM?

Returns:

  • (Boolean)

    doesit support MDM?



538
539
540
# File 'lib/jss/api_object/computer.rb', line 538

def mdm_capable
  @mdm_capable
end

#mdm_capable_usersArray (readonly)

Returns user accts that support MDM? NOTE: This suffers from the JSON-Hash-treated-like_XML-Array-loses-data bug and only shows the last listed user, cuz it comes from the API as a hash, not an array.

Returns:

  • (Array)

    user accts that support MDM? NOTE: This suffers from the JSON-Hash-treated-like_XML-Array-loses-data bug and only shows the last listed user, cuz it comes from the API as a hash, not an array.



545
546
547
# File 'lib/jss/api_object/computer.rb', line 545

def mdm_capable_users
  @mdm_capable_users
end

#need_to_updateBoolean (readonly) Originally defined in module Updatable

Returns do we have unsaved changes?

Returns:

  • (Boolean)

    do we have unsaved changes?

#netboot_serverString (readonly)

Returns the name of the netboot server for this machine

Returns:

  • (String)

    the name of the netboot server for this machine



548
549
550
# File 'lib/jss/api_object/computer.rb', line 548

def netboot_server
  @netboot_server
end

#peripheralsArray<Hash> (readonly)

A Hash per peripheral

Each hash has these keys & sample data:

  • :id=>286,

  • :type=>“Display”,

  • :field_0=>“HP”,

  • :field_1=>“HP LP2480zx”,

  • :field_2=>“DreamColor”,

  • :field_3=>“3CM10800F4”,

  • :field_4=>“”,

  • :field_5=>“”

  • :field_6=>“”,

  • :bar_code_1=>“”,

  • :bar_code_2=>“”,

  • :purchasing=> A hash with these keys:

    • :warranty_expires_utc=>“”,

    • :is_leased=>false,

    • :po_date=>“”,

    • :lease_expires=>“”,

    • :po_number=>“”,

    • :po_date_epoch=>0,

    • :lease_expires_epoch=>0,

    • :vendor=>“”,

    • :attachments=>[],

    • :po_date_utc=>“”,

    • :lease_expires_utc=>“”,

    • :applecare_id=>“”,

    • :warranty_expires=>“”,

    • :life_expectancy=>0,

    • :purchase_price=>“”,

    • :warranty_expires_epoch=>0,

    • :is_purchased=>true,

    • :purchasing_contact=>“”,

    • :purchasing_account=>“”

Returns:



710
711
712
# File 'lib/jss/api_object/computer.rb', line 710

def peripherals
  @peripherals
end

#phoneString Originally defined in module Locatable

Returns:

#platformString (readonly)

Returns what kind of computer?

Returns:

  • (String)

    what kind of computer?



551
552
553
# File 'lib/jss/api_object/computer.rb', line 551

def platform
  @platform
end

#po_dateTime Originally defined in module Purchasable

Returns:

#po_numberString Originally defined in module Purchasable

Returns:

#positionString Originally defined in module Locatable

Returns:

#purchase_priceFloat Originally defined in module Purchasable

Returns:

  • (Float)

#purchasing_accountString Originally defined in module Purchasable

Returns:

#purchasing_contactString Originally defined in module Purchasable

Returns:

#real_nameString Originally defined in module Locatable

Returns:

#report_dateTime (readonly) Also known as: last_recon

Returns the last recon time

Returns:

  • (Time)

    the last recon time



554
555
556
# File 'lib/jss/api_object/computer.rb', line 554

def report_date
  @report_date
end

#roomString Originally defined in module Locatable

Returns:

#serial_numberString Also known as: sn, serialnumber

Returns the serial number

Returns:

  • (String)

    the serial number



557
558
559
# File 'lib/jss/api_object/computer.rb', line 557

def serial_number
  @serial_number
end

#siteHash (readonly)

Returns the :name and :id of the site for this machine

Returns:

  • (Hash)

    the :name and :id of the site for this machine



560
561
562
# File 'lib/jss/api_object/computer.rb', line 560

def site
  @site
end

#softwareHash (readonly)

A Hash of software data

The Hash has these keys:

  • :running_services => An Array of services running on the computer (if gathered) TODO - is each item a hash?

  • :installed_by_casper => An Array of Package names unstalled on this computer by Casper

  • :fonts => An Array of fonts on this computer (if gathered) TODO - is each item a hash?

  • :installed_by_installer_swu => An Array of pkg IDs for pkgs installed by SoftwareUpdate or the Apple Installer

  • :applications => An Array of Hashes, one per Application on the computer, with these keys:

    • :path => String, the path to the app

    • :name => String, the name of the app, including the .app suffix

    • :version => String, the version of the app at that path.

  • :cached_by_casper => An Array of Casper Package names cached on the machine, awaiting installation

  • :available_software_updates => An Array of available SoftwareUpdate (if gathered) TODO - is each item a hash?

  • :plugins => An Array of plugins installed on the machine (if gathered) TODO - is each item a hash?

  • :available_updates => A Hash - Deprecated?

  • :licensed_software => An Array, the names of Licenced Software (as defined in Casper) on this machine

  • :unix_executables => DEPRECATED

Returns:



732
733
734
# File 'lib/jss/api_object/computer.rb', line 732

def software
  @software
end

#susString (readonly)

Returns the name of the Software Update Server assigned to this machine.

Returns:

  • (String)

    the name of the Software Update Server assigned to this machine.



563
564
565
# File 'lib/jss/api_object/computer.rb', line 563

def sus
  @sus
end

#udidString

Returns the UDID of the computer

Returns:

  • (String)

    the UDID of the computer



566
567
568
# File 'lib/jss/api_object/computer.rb', line 566

def udid
  @udid
end

#usernameString Also known as: user Originally defined in module Locatable

Returns:

#vendorString Originally defined in module Purchasable

Returns:

#warranty_expiresTime Originally defined in module Purchasable

Returns:

Class Method Details

.all(refresh = false, api: JSS.api) ⇒ Array<Hash{:name=>String, :id=> Integer}>

A larger set of info about the computers in the JSS.

Casper 9.4 introduced the API Resource /computers/subset/basic that returns an array of hashes with more data than just /computers/ (which was just :name and :id). Similar to /mobildevices/, this new list includes :udid, :serial_number, and :mac_address, as well as :model, :managed, :building, :department, :username, and :report_date

Because this requires a different, unusual, resource path, we're completely re-defining APIObject.all for JSS::Computer. Hopefully some day the original /computers/ resource will be updated to return this data.

Parameters:

  • refresh (Boolean) (defaults to: false)

    should the data be re-queried from the API?

  • api (JSS::APIConnection)

    an API connection to use for the query. Defaults to the corrently active API. See APIConnection

Returns:



310
311
312
313
314
# File 'lib/jss/api_object/computer.rb', line 310

def self.all(refresh = false, api: JSS.api)
  api.object_list_cache[RSRC_LIST_KEY] = nil if refresh
  return api.object_list_cache[RSRC_LIST_KEY] if api.object_list_cache[RSRC_LIST_KEY]
  api.object_list_cache[RSRC_LIST_KEY] = api.get_rsrc(self::LIST_RSRC)[self::RSRC_LIST_KEY]
end

.all_desktops(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all desktop macs in the jss

Returns:

  • (Array<Hash>)

    all desktop macs in the jss



367
368
369
# File 'lib/jss/api_object/computer.rb', line 367

def self.all_desktops(refresh = false, api: JSS.api)
  all(refresh, api: api).reject { |d| d[:model] =~ /serve|book/i }
end

.all_imacs(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all imacs in the jss

Returns:



372
373
374
# File 'lib/jss/api_object/computer.rb', line 372

def self.all_imacs(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^imac/i }
end

.all_laptops(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all laptop computers in the jss

Returns:

  • (Array<Hash>)

    all laptop computers in the jss



342
343
344
# File 'lib/jss/api_object/computer.rb', line 342

def self.all_laptops(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /book/i }
end

.all_mac_addresses(refresh = false, api: JSS.api) ⇒ Array<String>

Returns all computer mac_addresses in the jss

Returns:

  • (Array<String>)

    all computer mac_addresses in the jss



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

def self.all_mac_addresses(refresh = false, api: JSS.api)
  all(refresh, api: api).map { |i| i[:mac_address] }
end

.all_macbookairs(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all macbookairs in the jss

Returns:

  • (Array<Hash>)

    all macbookairs in the jss



357
358
359
# File 'lib/jss/api_object/computer.rb', line 357

def self.all_macbookairs(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^macbookair\d/i  }
end

.all_macbookpros(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all macbookpros in the jss

Returns:

  • (Array<Hash>)

    all macbookpros in the jss



352
353
354
# File 'lib/jss/api_object/computer.rb', line 352

def self.all_macbookpros(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^macbookpro\d/i  }
end

.all_macbooks(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all macbooks in the jss

Returns:



347
348
349
# File 'lib/jss/api_object/computer.rb', line 347

def self.all_macbooks(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^macbook\d/i }
end

.all_macpros(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all macpros in the jss

Returns:



382
383
384
# File 'lib/jss/api_object/computer.rb', line 382

def self.all_macpros(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^macpro/i }
end

.all_managed(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all managed computers in the jss

Returns:

  • (Array<Hash>)

    all managed computers in the jss



332
333
334
# File 'lib/jss/api_object/computer.rb', line 332

def self.all_managed(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:managed] }
end

.all_minis(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all mac minis in the jss

Returns:



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

def self.all_minis(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /^macmini/i }
end

.all_serial_numbers(refresh = false, api: JSS.api) ⇒ Array<String>

Returns all computer serial numbers in the jss

Returns:

  • (Array<String>)

    all computer serial numbers in the jss



317
318
319
# File 'lib/jss/api_object/computer.rb', line 317

def self.all_serial_numbers(refresh = false, api: JSS.api)
  all(refresh, api: api).map { |i| i[:serial_number] }
end

.all_udids(refresh = false, api: JSS.api) ⇒ Array<String>

Returns all computer udids in the jss

Returns:



327
328
329
# File 'lib/jss/api_object/computer.rb', line 327

def self.all_udids(refresh = false, api: JSS.api)
  all(refresh, api: api).map { |i| i[:udid] }
end

.all_unmanaged(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all unmanaged computers in the jss

Returns:

  • (Array<Hash>)

    all unmanaged computers in the jss



337
338
339
# File 'lib/jss/api_object/computer.rb', line 337

def self.all_unmanaged(refresh = false, api: JSS.api)
  all(refresh, api: api).reject { |d| d[:managed] }
end

.all_xserves(refresh = false, api: JSS.api) ⇒ Array<Hash>

Returns all xserves in the jss

Returns:



362
363
364
# File 'lib/jss/api_object/computer.rb', line 362

def self.all_xserves(refresh = false, api: JSS.api)
  all(refresh, api: api).select { |d| d[:model] =~ /serve/i }
end

.application_installs(appname, fields: [], version: nil, ids_only: false, api: JSS.api) ⇒ Array<Integer>, ...

Query the JSS for computers with some app installed. An app name is required as the first parameter.

If no other parameters are given, returns a Hash, one key per version of the app. For each version there is an array of Hashes, one Hash for each computer with that version. The sub hashes contain keys for the computer's identifiers, i.e. :name, :id, :udid, :serial_number, :mac_address.

If one or more inventory fields are provided in the 'fields' parameter, each computer's hash also has keys and values for those fields if they exist in the JSS. These fields are those available in the display options for Advanced Computer Searches (including extention attribute names) and their names are case-sensitive, so 'Username', not 'username'

If a specific version is provided in the 'version' parameter, only computers containing that version of the app are returned as an Array of Hashes.

If the ids_only parameter is truthy, an Array of JSS id numbers for computers with this app is returned. In this case the 'fields' parameter is ignored, however the 'version' parameters is still valid and will restrict the list to those computer ids with that version installed.

This method implements the 'computerapplications' API endpoint.

NOTE: To see all the apps installed on a specific computer, fetch the JSS::Computer instance and call its #apps method.

Parameters:

  • appname (String)

    The name of the app to look for, e.g. 'Transmogrifier.app'

  • fields (String, Array<String>)

    Additional 'inventory fields' to return with each computer's data

  • version (String)

    Limit search to a specific version of the app

  • ids_only (Boolean)

    Just return an array of the id's of computers found with this query. Defaults to false

  • api (JSS::APIConnection)

    The API connection to use for the query. default: JSS.api

Returns:

  • (Array<Integer>)

    When ids_only == true, the ids of computers with the app installed (possibly limited to version)

  • (Array<Hash>)

    When version is provided, An Array of Hashes, one for each computer, with keys for identifiers plus any requested fields.

  • (Hash{String => Array<Hash>})

    When no version is provided, a Hash with keys for each version, pointing to an array of Hashes, one for each computer with that version. Each computer's Hash has keys for identifiers plus any requested fields.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/jss/api_object/computer/application_installs.rb', line 96

def self.application_installs(appname, fields: [], version: nil, ids_only: false, api: JSS.api)
  fields = [fields] unless fields.is_a? Array

  rsrc = "#{COMPUTER_APPLICATIONS_RSRC}/#{appname}"
  rsrc << "/version/#{version}" if version
  rsrc << "/inventory/#{fields.join ','}" unless ids_only || fields.empty?

  # get_rsrc will URI.encode the rsrc
  result = api.get_rsrc(rsrc)[:computer_applications]

  return result[:unique_computers].map { |c| c[:id] } if ids_only

  if version.nil?
    hash_by_version = {}
    result[:versions].each { |v| hash_by_version[v[:number]] = v[:computers] }
    return hash_by_version
  end

  result[:versions].first[:computers]
end

.application_usage(ident, start_date, end_date = nil, api: JSS.api) ⇒ Hash{Date=>Array<Hash>}

Retrieve Application Usage data for a computer by id, without instantiation.

Parameters:

  • ident (Integer, String)

    An identifier (id, name, serialnumber, macadress or udid) of the computer for which to retrieve Application Usage

  • start_date (Time, Date, DateTime, String)

    The earliest date to retrieve

  • end_date (String, Date, DateTime, Time) (defaults to: nil)

    Defaults to start_date

  • api (JSS::APIConnection)

    an API connection to use for the query. Defaults to the corrently active API. See APIConnection

Returns:

  • (Hash{Date=>Array<Hash>})

    A Hash with keys (Date instances) for each day in the range.

    Each hash value contains an Array of apps used on that day.

    Each item in the array is a hash of data about the app. Those hash keys are:

    :name => String, the name of the app
    :version => String ,the version of the app
    :foreground => Integer, the minutes it was in the foreground
    :open => Integer, the minutes it was running.
    

Raises:



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/jss/api_object/computer.rb', line 412

def self.application_usage(ident, start_date, end_date = nil, api: JSS.api)
  id = valid_id ident, api: api
  raise "No computer matches identifier: #{ident}" unless id
  end_date ||= start_date
  start_date = Time.parse start_date if start_date.is_a? String
  end_date = Time.parse end_date if end_date.is_a? String
  raise JSS::InvalidDataError, 'Invalid Start or End Date' unless ([start_date.class, end_date.class] - APPLICATION_USAGE_DATE_CLASSES).empty?
  start_date = start_date.strftime APPLICATION_USAGE_DATE_FMT
  end_date = end_date.strftime APPLICATION_USAGE_DATE_FMT
  data = api.get_rsrc(APPLICATION_USAGE_RSRC + "/id/#{id}/#{start_date}_#{end_date}")
  parsed_data = {}
  data[APPLICATION_USAGE_KEY].each do |day_hash|
    date = Date.parse day_hash[:date]
    parsed_data[date] = day_hash[:apps]
  end
  parsed_data
end

.checkin_settings(api: JSS.api) ⇒ Hash

Display the current Computer CheckIn settings in the JSS. Currently this is read-only in ruby-jss, even tho the API allows updating.

Parameters:

Returns:

  • (Hash)

    the Computer Checkin Settings from the currently connected JSS.



273
274
275
# File 'lib/jss/api_object/computer.rb', line 273

def self.checkin_settings(api: JSS.api)
  api.get_rsrc(CHECKIN_RSRC)[CHECKIN_KEY]
end

.inventory_collection_settings(api: JSS.api) ⇒ Hash

Display the current Computer Inventory Collection settings in the JSS. Currently this is read-only in ruby-jss, even tho the API allows updating.

Parameters:

Returns:

  • (Hash)

    the Computer Inventpry Collection Settings from the currently connected JSS.



287
288
289
# File 'lib/jss/api_object/computer.rb', line 287

def self.inventory_collection_settings(api: JSS.api)
  api.get_rsrc(INV_COLLECTION_RSRC)[INV_COLLECTION_KEY]
end

.management_data(ident, subset: nil, only: nil, api: JSS.api) ⇒ Hash, Array

The 'computer management' data for a given computer by id, looked up on the fly.

Without specifying a subset:, the entire dataset is returned as a hash of arrays, one per subset

If a subset is given then only that array is returned, and it contains hashes with data about each item (usually :name and :id)

If the only: param is provided with a subset, it is used as a hash-key to map the array to just those values, so subset: :smart_groups, only: :name will return an array of names of smartgroups that contain the computer.

Parameters:

  • ident (Integer, String)

    An identifier (id, name, serialnumber, macadress or udid) of the computer for which to retrieve Application Usage

  • subset (Symbol)

    Fetch only a subset of data, as an array. must be one of the symbols in MGMT_DATA_SUBSETS

  • only (Symbol)

    When fetching a subset, only return one value per item in the array. meaningless without a subset.

  • api (JSS::APIConnection)

    an API connection to use for the query. Defaults to the corrently active API. See APIConnection

Returns:

  • (Hash)

    Without a subset:, a hash of all subsets, each of which is an Array

  • (Array)

    With a subset:, an array of items in that subset, possibly limited to just certain values with only:



461
462
463
464
465
466
467
468
469
# File 'lib/jss/api_object/computer.rb', line 461

def self.management_data(ident, subset: nil, only: nil, api: JSS.api)
  id = valid_id ident, api: api
  raise "No computer matches identifier: #{ident}" unless id
  if subset
    management_data_subset id, subset: subset, only: only, api: api
  else
    full_management_data id, api: api
  end
end

.match(term, api: JSS.api) ⇒ Array<Hash> Originally defined in module Matchable

Perform a match, returning an Array of Hashes, one for each item matched

At the moment, it appears the search is an “exact match” search regardless of the prefs of the user connected to the API.

Parameters:

  • term (String)

    the term to match.

Returns:

Raises:

Instance Method Details

#app_store_app_history(status = nil) ⇒ Object Also known as: managed_app_history Originally defined in module ManagementHistory

Wrapper for app store history for both computers and mobile devices

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#app_store_apps(only: nil) ⇒ Object

A shortcut for 'management_data subset: :mac_app_store_apps'



934
935
936
# File 'lib/jss/api_object/computer.rb', line 934

def app_store_apps(only: nil)
  management_data subset: :mac_app_store_apps, only: only
end

#application_usage(start_date, end_date = nil) ⇒ Object

Get application usage data for this computer for a given date range. See application_usage for details



887
888
889
# File 'lib/jss/api_object/computer.rb', line 887

def application_usage(start_date, end_date = nil)
  JSS::Computer.application_usage @id, start_date, end_date, api: @api
end

#appsArray<Hash>

Returns all apps installed on this machine. Hash keys are :name, :path, and :version

Returns:

  • (Array<Hash>)

    all apps installed on this machine. Hash keys are :name, :path, and :version



872
873
874
# File 'lib/jss/api_object/computer.rb', line 872

def apps
  @software[:applications]
end

#audit_historyObject Also known as: audits Originally defined in module ManagementHistory

The audit_history for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#blank_pushvoid Also known as: send_blank_push, noop Originally defined in module MDM

This method returns an undefined value.

Send a blank push to this object

#boot_driveHash?

Returns The hardware hash of the boot drive

Returns:



858
859
860
# File 'lib/jss/api_object/computer.rb', line 858

def boot_drive
  drives.select { |d| d[:partition] && d[:partition][:type] == 'boot' }.first
end

#casper_imaging_logsObject Originally defined in module ManagementHistory

The casper_imaging_logs for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#casper_remote_logsObject Originally defined in module ManagementHistory

The casper_remote_logs for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#clear_locationvoid Originally defined in module Locatable

This method returns an undefined value.

Clear all location data

#clear_passcodeObject Originally defined in module MDM

Send an clear_passcode command to this object

#clear_restrictions_passwordObject Originally defined in module MDM

Send an clear_restrictions_password command to this object

#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)

    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:

#completed_mdm_commandsObject Also known as: completed_commands Originally defined in module ManagementHistory

The completed_mdm_commands for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#completed_policiesObject Originally defined in module ManagementHistory

The array from .policy_logs, limited to status = :completed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#computer_groupsArray

Returns the JSS groups to which thismachine belongs (smart and static)

Returns:

  • (Array)

    the JSS groups to which thismachine belongs (smart and static)



825
826
827
# File 'lib/jss/api_object/computer.rb', line 825

def computer_groups
  @groups_accounts[:computer_group_memberships]
end

#computer_usage_logsObject Also known as: usage_logs Originally defined in module ManagementHistory

The computer_usage_logs for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#create(api: nil) ⇒ Integer Originally defined in module Creatable

Create a new object in the JSS.

Parameters:

  • api (JSS::APIConnection)

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

Returns:

  • (Integer)

    the jss ID of the newly created object

Raises:

#deletevoid

This method returns an undefined value.

Delete this computer from the JSS



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'lib/jss/api_object/computer.rb', line 1053

def delete
  super
  @alt_mac_address = nil
  @asset_tag = nil
  @barcode1 = nil
  @barcode2 = nil
  @distribution_point = nil
  @initial_entry_date = nil
  @ip_address = nil
  @jamf_version = nil
  @last_contact_time = nil
  @macaddress = nil
  @managed = nil
  @management_username = nil
  @mdm_capable = nil
  @netboot_server = nil
  @platform = nil
  @report_date = nil
  @serial_number = nil
  @site = nil
  @sus = nil
  @udid = nil

  @building = nil
  @department = nil
  @email_address = nil
  @phone = nil
  @position = nil
  @real_name = nil
  @room = nil
  @username = nil

  @configuration_profiles = nil
  @extension_attributes = nil
  @groups_accounts = nil
  @hardware = nil
  @peripherals = nil
  @purchasing = nil
  @software = nil
end

#delete_user(user) ⇒ Object Originally defined in module MDM

Send a delete_user command to this computer or group

Parameters:

  • user (String)

    the username of the acct to delete

#device_lock(passcode_or_message = '') ⇒ Object Also known as: lock, lock_device Originally defined in module MDM

Send a dev lock to this object

Parameters:

  • passcode_or_message (String) (defaults to: '')

    a six-char passcode, required for computers & computergroups Or an optional message to display on mobiledevices & mobiledevicegroups

#device_name(name) ⇒ Object Also known as: set_name, set_device_name Originally defined in module MDM

Send a device_name command to this object

Parameters:

  • name (String)

    The new name

#disable_app_analyticsObject Originally defined in module MDM

Send a disable_app_analytics command to this object

#disable_data_roamingObject Originally defined in module MDM

Send a disable_data_roaming command to this object

#disable_diagnostic_submissionObject Originally defined in module MDM

Send a disable_diagnostic_submission command to this object

#disable_lost_modeObject Originally defined in module MDM

Send a disable_lost_mode command to this object

#disable_voice_roamingObject Originally defined in module MDM

Send a disable_voice_roaming command to this object

#drivesArray<Hash>

Returns each storage device

Returns:



852
853
854
# File 'lib/jss/api_object/computer.rb', line 852

def drives
  @hardware[:storage]
end

#ebook_history(status = nil) ⇒ Object Also known as: managed_ebook_history Originally defined in module ManagementHistory

The ebook_history for this mobile device

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#ebooks(only: nil) ⇒ Object

A shortcut for 'management_data subset: :ebooks'



928
929
930
# File 'lib/jss/api_object/computer.rb', line 928

def ebooks(only: nil)
  management_data subset: :ebooks, only: only, refresh: refresh
end

#enable_app_analyticsObject Originally defined in module MDM

Send an enable_app_analytics command to this object

#enable_data_roamingObject Originally defined in module MDM

Send an enable_data_roaming command to this object

#enable_diagnostic_submissionObject Originally defined in module MDM

Send an enable_diagnostic_submission command to this object

#enable_lost_mode(message: nil, phone_number: nil, footnote: nil, enforce_lost_mode: true, play_sound: false) ⇒ Object Originally defined in module MDM

Send a enable_lost_mode command to one or more targets

Either or both of message and phone number must be provided

Parameters:

  • message (String)

    The message to display on the lock screen

  • phone_number (String)

    The phone number to display on the lock screen

  • footnote (String)

    Optional footnote to display on the lock screen

  • play_sound (Boolean)

    Play a sound when entering lost mode

  • enforce_lost_mode (Boolean)

    Re-enabled lost mode when re-enrolled after wipe.

#enable_voice_roamingObject Originally defined in module MDM

Send an enable_voice_roaming command to this object

#erase_device(passcode = '', preserve_data_plan: false) ⇒ Object Also known as: wipe_device, wipe_computer, wipe, erase Originally defined in module MDM

Send an erase device command to this object

Parameters:

  • passcode (String) (defaults to: '')

    a six-char passcode, required for computers & computergroups

#ext_attr_xmlREXML::Element Originally defined in module Extendable

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.

TODO: make this (and all XML amending) method take the in-progress XML doc and add (or not) the EA xml to it. See how Sitable#add_site_to_xml works, as called from Computer.rest_xml

Returns:

  • (REXML::Element)

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

#failed_app_store_appsObject Also known as: failed_managed_apps Originally defined in module ManagementHistory

shortcut for app_store_app_history where status = :failed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#failed_ebooksObject Also known as: failed_managed_ebooks Originally defined in module ManagementHistory

shortcut for ebook_history where status = :failed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#failed_mdm_commandsObject Also known as: failed_commands Originally defined in module ManagementHistory

The failed_mdm_commands for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#failed_policiesObject Originally defined in module ManagementHistory

The array from .policy_logs, limited to status = :failed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#filevault1_accountsArray<Hash>

Returns The local_accounts Array that have Legacy FV enabled

Returns:

  • (Array<Hash>)

    The local_accounts Array that have Legacy FV enabled



845
846
847
848
# File 'lib/jss/api_object/computer.rb', line 845

def filevault1_accounts
  return [] if filevault2_enabled?
  local_accounts.select { |a| a[:filevault_enabled] }
end

#filevault2_enabled?Boolean

Returns is FileVault2 enabled?

Returns:

  • (Boolean)

    is FileVault2 enabled?



839
840
841
# File 'lib/jss/api_object/computer.rb', line 839

def filevault2_enabled?
  boot_drive[:partition][:filevault2_status] != 'Not Encrypted'
end

#flush_mdm_commands(status) ⇒ void Originally defined in module MDM

This method returns an undefined value.

flush pending and/or failed MDM commands for this object

Parameters:

  • status (String)

    a key from Commandable::FLUSHABLE_STATUSES

#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?

#installed_app_store_appsObject Also known as: installed_managed_apps Originally defined in module ManagementHistory

shortcut for app_store_app_history where status = :installed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#installed_ebooksObject Also known as: installed_managed_ebooks Originally defined in module ManagementHistory

shortcut for ebook_history where status = :installed

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#licensed_swArray<String>

Returns the JSS-defined “licensed software” titles installed on this machine.

Returns:

  • (Array<String>)

    the JSS-defined “licensed software” titles installed on this machine.



879
880
881
# File 'lib/jss/api_object/computer.rb', line 879

def licensed_sw
  @software[:licensed_software]
end

#local_accountsArray<Hash> Also known as: accounts, accts

Each item has keys :name, :realname, :uid, :home, :home_size, :administrator, :filevault_enabled

Returns:

  • (Array<Hash>)

    all the local accts on the machine.



833
834
835
# File 'lib/jss/api_object/computer.rb', line 833

def local_accounts
  @groups_accounts[:local_accounts]
end

#locationHash<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_xmlREXML::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)

#mac_app_store_app_history(status = nil) ⇒ Object Originally defined in module ManagementHistory

The mac_app_store_app_history for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#make_unmanagedvoid

This method returns an undefined value.

Make the machine unmanaged.

The same as

#set_management_to nil, nil

followed by

JSS::Computer.send_mdm_command @id, :unmanage_device

which currently isn't working



982
983
984
985
986
# File 'lib/jss/api_object/computer.rb', line 982

def make_unmanaged
  return nil unless managed?
  set_management_to(nil, nil)
  @unmange_at_update = true
end

#management_data(subset: nil, only: nil) ⇒ Object

The 'computer management' data for this computer

NOTE: the data isn't cached locally, and the API is queried every time

Raises:

See Also:

  • for details


897
898
899
900
# File 'lib/jss/api_object/computer.rb', line 897

def management_data(subset: nil, only: nil)
  raise JSS::NoSuchItemError, 'Computer not yet saved in the JSS' unless @in_jss
  JSS::Computer.management_data @id, subset: subset, only: only, api: @api
end

#management_history(subset = nil) ⇒ Object Also known as: history Originally defined in module ManagementHistory

The raw management history data for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#mdm_command_history(status = nil) ⇒ Object Also known as: commands, management_command_history Originally defined in module ManagementHistory

The mdm_command_history for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#mobile_device_app_history(status = nil) ⇒ Object Originally defined in module ManagementHistory

The mobile_device_app_history for this mobile device

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#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:

#parse_ext_attrsvoid Originally defined in module Extendable

This method returns an undefined value.

Populate @extension_attributes (the Array of Hashes that comes from the API) and @ext_attr_names, which is a Hash mapping the EA names to their values. This is called during initialization for all objects that mix in this module

#parse_locationvoid 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_purchasingObject 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

#passcode_lock_grace_period(secs) ⇒ Object Originally defined in module MDM

Send a passcode_lock_grace_period command to this object

Parameters:

  • secs (Integer)

    The numer of seconds for the grace period

#patch_titles(only: nil) ⇒ Object

A shortcut for 'management_data subset: :patch_reporting_software_titles'



946
947
948
# File 'lib/jss/api_object/computer.rb', line 946

def patch_titles(only: nil)
  management_data subset: :patch_reporting_software_titles, only: only
end

#pending_app_store_appsObject Also known as: pending_managed_apps Originally defined in module ManagementHistory

shortcut for app_store_app_history where status = :pending

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#pending_ebooksObject Also known as: pending_managed_ebooks Originally defined in module ManagementHistory

shortcut for ebook_history where status = :pending

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#pending_mdm_commandsObject Also known as: pending_commands Originally defined in module ManagementHistory

The pending_mdm_commands for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#play_lost_mode_soundObject Originally defined in module MDM

Send a play_lost_mode_sound command to this object

#policies(only: nil) ⇒ Object

A shortcut for 'management_data subset: :policies'



916
917
918
# File 'lib/jss/api_object/computer.rb', line 916

def policies(only: nil)
  management_data subset: :policies, only: only
end

#policy_logsObject Originally defined in module ManagementHistory

The policy_logs for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#printersArray<Hash>

Returns each printer on this computer Keys are :name, :uri, :type, :location

Returns:

  • (Array<Hash>)

    each printer on this computer Keys are :name, :uri, :type, :location



865
866
867
# File 'lib/jss/api_object/computer.rb', line 865

def printers
  @hardware[:mapped_printers]
end

#purchasingHash<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_xmlREXML::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.

#restart_deviceObject Also known as: restart Originally defined in module MDM

Send a restart_device command to this object

#restricted_software(only: nil) ⇒ Object

A shortcut for 'management_data subset: :restricted_software'



940
941
942
# File 'lib/jss/api_object/computer.rb', line 940

def restricted_software(only: nil)
  management_data subset: :restricted_software, only: only
end

#screen_sharing_logsObject Originally defined in module ManagementHistory

The screen_sharing_logs for this computer

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#set_ext_attr(name, value) ⇒ void Originally defined in module Extendable

This method returns an undefined value.

Set the value of an extension attribute

If the extension attribute is defined as a popup menu, the value must be one of the defined popup choices, or an empty string

If the ext. attrib. is defined with a data type of Integer, the value must be an Integer.

If the ext. attrib. is defined with a data type of Date, the value will be converted to a Time

Note that while the Jamf Pro Web interface does not allow editing the values of Extension Attributes populated by Scripts or LDAP, the API does allow it. Bear in mind however that those values will be reset again at the next recon.

Parameters:

  • name (String)

    the name of the extension attribute to set

  • value (String, Time, Time, Integer)

    the new value for the extension attribute for this user

#set_management_to(name, password) ⇒ void Also known as: make_managed

This method returns an undefined value.

Set or unset management acct and password for this computer

The changes will need to be pushed to the server with #update before they take effect.

CAUTION: this does nothing to confirm the name and password will work on the machine!

Parameters:

  • name (String)

    the name of the management acct.

  • password (String)

    the password of the management acct



964
965
966
967
968
969
970
# File 'lib/jss/api_object/computer.rb', line 964

def set_management_to(name, password)
  password = nil unless name
  @management_username = name
  @management_password = password
  @managed = name ? true : false
  @need_to_update = true
end

#shut_down_deviceObject Also known as: shutdown_device, shut_down, shutdown Originally defined in module MDM

Send a shut_down_device command to this object

#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_idInteger Originally defined in module Sitable

The id of the site for this object.

Returns:

  • (Integer)

    The id of the site for this object.

#site_nameString 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_objectJSS::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

#smart_groups(only: nil) ⇒ Object

A shortcut for 'management_data subset: :smart_groups'



904
905
906
# File 'lib/jss/api_object/computer.rb', line 904

def smart_groups(only: nil)
  management_data subset: :smart_groups, only: only
end

#static_groups(only: nil) ⇒ Object

A shortcut for 'management_data subset: :static_groups'



910
911
912
# File 'lib/jss/api_object/computer.rb', line 910

def static_groups(only: nil)
  management_data subset: :static_groups, only: only
end

#unlock_user_account(user) ⇒ Object Originally defined in module MDM

Send an unlock_user_account command to this computer or group

Parameters:

  • user (String)

    the username of the acct to unlock

#unmanage_deviceObject Also known as: remove_mdm_profile Originally defined in module MDM

Send an unmanage device command to this object

NOTE: when used with computers, the mdm profile will probably be re-installed immediately unless the computer is also no longer managed by Jamf Pro itself. To fully unmanage a computer, use the Computer#make_unmanaged instance method.

#unsaved_eas?Boolean Originally defined in module Extendable

are there any changes in the EAs needing to be saved?

Returns:

  • (Boolean)

#unset_sitevoid Originally defined in module Sitable

This method returns an undefined value.

Set the site to nothing

#updatevoid

This method returns an undefined value.

Send changes to the API



1043
1044
1045
1046
1047
# File 'lib/jss/api_object/computer.rb', line 1043

def update
  remove_mdm_profile if mdm_capable && @unmange_at_update
  @unmange_at_update = false
  super
end

#update_inventoryObject Also known as: recon Originally defined in module MDM

Send an update_inventory command to this object

#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_location_historyObject Originally defined in module ManagementHistory

The user_location_history for this object

See Also:

  • matching method in {JSS::ManagementHistory::ClassMethods}

#wallpaper(wallpaper_setting: nil, wallpaper_content: nil, wallpaper_id: nil) ⇒ Object Also known as: set_wallpaper Originally defined in module MDM

Send a wallpaper command to this object

Parameters:

  • wallpaper_setting (Symbol)

    :lock_screen, :home_screen, or :lock_and_home_screen

  • wallpaper_content (String, Pathname)

    The local path to a .png or .jpg to use as the walpaper image, required if no wallpaper_id

  • wallpaper_id (Symbol)

    The id of an Icon in Jamf Pro to use as the wallpaper image, required if no wallpaper_content