Class: JSS::ComputerGroup

Inherits:
Group show all
Includes:
MDM
Defined in:
lib/jss/api_object/group/computer_group.rb,
lib/jss.rb

Overview

A computer group in the JSS

See also the parent class JSS::Group

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

"computergroups"
RSRC_LIST_KEY =

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

:computer_groups
RSRC_OBJECT_KEY =

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

:computer_group
VALID_DATA_KEYS =

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

[:is_smart, :computers ]
MEMBER_CLASS =

this allows the parent Group class to do things right

JSS::Computer
OBJECT_HISTORY_OBJECT_TYPE =

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

7
MDM_COMMAND_TARGET =

what kind of devices are these WRT MDM

:computergroups

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from JSS::Group

Instance Attribute Details

#criteriaJSS::Criteriable::Criteria Originally defined in module Criteriable

Returns the criteria for the instance into which we're mixed.

Returns:

#need_to_updateBoolean (readonly) Originally defined in module Updatable

Returns do we have unsaved changes?

Returns:

  • (Boolean)

    do we have unsaved changes?

Instance Method Details

#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

#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

#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

#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

#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

#member_mac_addressesArray<String>

Return an array of the mac_addrs of members in this group

Returns:


124
125
126
# File 'lib/jss/api_object/group/computer_group.rb', line 124

def member_mac_addresses
  @members.map{|m| m[:mac_address]} + @members.map{|m| m[:alt_mac_address]}
end

#member_serial_numbersArray<String>

The serial numbers of members in this group

Returns:


115
116
117
# File 'lib/jss/api_object/group/computer_group.rb', line 115

def member_serial_numbers
  @members.map{|m| m[:serial_number]}
end

#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

#play_lost_mode_soundObject Originally defined in module MDM

Send a play_lost_mode_sound command to this object

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

Send a restart_device command to this object

#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

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

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

Send an update_inventory command to this object

#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