Module: Ohai::Common::DMI

Defined in:
lib/ohai/common/dmi.rb

Constant Summary collapse

ID_TO_DESCRIPTION = 
{
  0 => "bios",
  1 => "system",
  2 => "base_board",
  3 => "chassis",
  4 => "processor",
  5 => "memory_controller",
  6 => "memory_module",
  7 => "cache",
  8 => "port_connector",
  9 => "system_slots",
  10 => "on_board_devices",
  11 => "oem_strings",
  12 => "system_configuration_options",
  13 => "bios_language",
  14 => "group_associations",
  15 => "system_event_log",
  16 => "physical_memory_array",
  17 => "memory_device",
  18 => "32_bit_memory_error",
  19 => "memory_array_mapped_address",
  20 => "memory_device_mapped_address",
  21 => "built_in_pointing_device",
  22 => "portable_battery",
  23 => "system_reset",
  24 => "hardware_security",
  25 => "system_power_controls",
  26 => "voltage_probe",
  27 => "cooling_device",
  28 => "temperature_probe",
  29 => "electrical_current_probe",
  30 => "out_of_band_remote_access",
  31 => "boot_integrity_services",
  32 => "system_boot",
  33 => "64_bit_memory_error",
  34 => "management_device",
  35 => "management_device_component",
  36 => "management_device_threshold_data",
  37 => "memory_channel",
  38 => "ipmi_device",
  39 => "power_supply",
  40 => "additional_information",
  41 => "onboard_devices_extended_information",
  42 => "management_controller_host_interfaces",
  126 => "disabled_entries",
  127 => "end_of_table_marker",
}.freeze
ID_TO_CAPTURE =

list of IDs to collect from config or default to a sane list that prunes away some of the less useful IDs

[ 0, 1, 2, 3, 4, 6, 11 ].freeze
SKIPPED_CONVENIENCE_KEYS = 
%w{
  application_identifier
  caption
  creation_class_name
  size
  system_creation_class_name
  record_id
}.freeze

Class Method Summary collapse

Class Method Details

.allowlisted_ids ⇒ Array

the allowlisted DMI IDs. This is combination of the defaults + any additional IDs defined in the :additional_dmi_ids config

Returns:

  • (Array) —

    the list of DMI IDs to capture



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ohai/common/dmi.rb', line 86

def allowlisted_ids
  if Ohai.config[:additional_dmi_ids]
    if [ Integer, Array ].include?(Ohai.config[:additional_dmi_ids].class)
      return ID_TO_CAPTURE + Array(Ohai.config[:additional_dmi_ids])
    else
      Ohai::Log.warn("The DMI plugin additional_dmi_ids config must be an array of IDs!")
    end
  end
  ID_TO_CAPTURE
end

.convenience_keys(dmi) ⇒ Object

create simplified convenience access keys for each record type for single occurrences of one type, copy to top level all fields and values for multiple occurrences of same type, copy to top level all fields and values that are common to all records



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/ohai/common/dmi.rb', line 135

def convenience_keys(dmi)
  dmi.each do |type, records|
    in_common = Mash.new
    next unless records.is_a?(Mash)
    next unless records.key?("all_records")

    records[:all_records].each do |record|
      record.each do |field, value|
        next unless value.is_a?(String)

        translated = field.downcase.gsub(/[^a-z0-9]/, "_")
        next if SKIPPED_CONVENIENCE_KEYS.include?(translated.to_s)

        value = value.strip
        if in_common.key?(translated)
          in_common[translated] = nil unless in_common[translated] == value
        else
          in_common[translated] = value
        end
      end
    end
    in_common.each do |field, value|
      next if value.nil?

      dmi[type][field] = value.strip
    end
  end
end

.id_lookup(id) ⇒ String

the human readable description from a DMI ID

Parameters:

  • id (String, Integer) —

    the ID to lookup

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/ohai/common/dmi.rb', line 106

def id_lookup(id)
  id = id.to_i
  if (id >= 128) && (id <= 255)
    id = "oem_data_#{id}"
  elsif DMI::ID_TO_DESCRIPTION.key?(id)
    id = DMI::ID_TO_DESCRIPTION[id]
  else
    Ohai::Log.debug("unrecognized header id; falling back to 'unknown'")
    id = "unknown_dmi_id_#{id}"
  end
rescue
  Ohai::Log.debug("failed to look up id #{id}, returning unchanged")
  id
end

.whitelisted_ids ⇒ Array

Deprecated.

Use the ‘allowlisted_ids` method instead.

the allowlisted DMI IDs. This is combination of the defaults + any additional IDs defined in the :additional_dmi_ids config

Returns:

  • (Array) —

    the list of DMI IDs to capture



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ohai/common/dmi.rb', line 99

def allowlisted_ids
  if Ohai.config[:additional_dmi_ids]
    if [ Integer, Array ].include?(Ohai.config[:additional_dmi_ids].class)
      return ID_TO_CAPTURE + Array(Ohai.config[:additional_dmi_ids])
    else
      Ohai::Log.warn("The DMI plugin additional_dmi_ids config must be an array of IDs!")
    end
  end
  ID_TO_CAPTURE
end