Class: JSS::ManagementHistory::MDMCommand

Inherits:
Object
  • Object
show all
Includes:
HashLike
Defined in:
lib/jss/api_object/management_history/mdm_command.rb

Overview

MDMCommand - an issued MDM command in a Jamf Object’s Management History

This should only be instantiated by the ManagementHistory.mdm_commands method when mixed in to Computers or Mobile devices.

That method will return an array of these objects.

NOTE: some attributes will be nil for some statuses (e.g. no error message if not failed, no completed time if not completed)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ MDMCommand

Returns a new instance of MDMCommand.



54
55
56
57
58
59
 
# File 'lib/jss/api_object/management_history/mdm_command.rb', line 54

def initialize(args = {})
  args[:completed_epoch] ||= args[:date_time_completed_epoch]
  args[:issued_epoch] ||= args[:date_time_issued_epoch]
  args[:failed_epoch] ||= args[:date_time_failed_epoch]
  super args
end

Instance Attribute Details

#completed_epoch ⇒ Integer (readonly)

a unix epoch timestamp with milliseconds

Returns:

  • (Integer) —

    When the command was completed, as




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 81

#error ⇒ String (readonly)

Returns The error message if status == :failed.

Returns:

  • (String) —

    The error message if status == :failed




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 70

#failed_epoch ⇒ Integer (readonly)

a unix epoch timestamp with milliseconds

Returns:

  • (Integer) —

    When the command failed, as




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 77

#issued_epoch ⇒ Integer (readonly)

Returns When the command was issued, as a unix epoch timestamp with milliseconds.

Returns:

  • (Integer) —

    When the command was issued, as a unix epoch timestamp with milliseconds




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 73

#last_push_epoch ⇒ Integer (readonly)

pending command, a unix epoch timestamp with milliseconds

Returns:

  • (Integer) —

    When the most recent attempt was made on a




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 85

#name ⇒ String (readonly)

Returns the name of the command.

Returns:

  • (String) —

    the name of the command.




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 61

#status ⇒ Symbol (readonly)

Returns :completed, :pending, or :failed.

Returns:

  • (Symbol) —

    :completed, :pending, or :failed




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 67

#username ⇒ String (readonly)

Returns the username of associated with the command.

Returns:

  • (String) —

    the username of associated with the command.




# File 'lib/jss/api_object/management_history/mdm_command.rb', line 64

Instance Method Details

#[](attr) ⇒ Object Originally defined in module HashLike

#completed ⇒ Time

Returns When the command completed, as a ruby Time object.

Returns:

  • (Time) —

    When the command completed, as a ruby Time object



106
107
108
 
# File 'lib/jss/api_object/management_history/mdm_command.rb', line 106

def completed
  JSS.epoch_to_time @completed_epoch if @completed_epoch
end

#failed ⇒ Time

Returns When the command failed, as a ruby Time object.

Returns:

  • (Time) —

    When the command failed, as a ruby Time object



99
100
101
 
# File 'lib/jss/api_object/management_history/mdm_command.rb', line 99

def failed
  JSS.epoch_to_time @failed_epoch if @failed_epoch
end

#issued ⇒ Time

Returns When the command was issued, as a ruby Time object.

Returns:

  • (Time) —

    When the command was issued, as a ruby Time object



92
93
94
 
# File 'lib/jss/api_object/management_history/mdm_command.rb', line 92

def issued
  JSS.epoch_to_time @issued_epoch if @issued_epoch
end

#last_push ⇒ Time

Returns When the most recent attempt was made on a pending command, as a ruby Time object.

Returns:

  • (Time) —

    When the most recent attempt was made on a pending command, as a ruby Time object



113
114
115
 
# File 'lib/jss/api_object/management_history/mdm_command.rb', line 113

def last_push
  JSS.epoch_to_time @last_push_epoch if @last_push_epoch
end