computer_hardware association

Available from 9.2.8. Use the computer_hardware association to retrieve detailed hardware information as part of other REST API requests.

Association

computer_hardware

Applicable REST APIs

You can use the computer_hardware association with the following REST APIs:

Syntax

<URL>?columns[]=computer_hardware.<column>&token=<token>
For example:
GET api/sam/v2/software_instances?columns[]=computer_hardware.computer_type
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623

9.2.10 Schema description

To retrieve the list of all columns that are returned by this association together with their descriptions, use the following request.
GET api/sam/schemas/associations/computer_hardware.json?token=<token>

Available columns

Table 1. Columns with information about computer hardware
Name on the Hardware Inventory report Description Type
computer_type Computer Type. Possible values are:
  • 0 - physical
  • 1- virtual
  • 2- computer running on a public cloud
Numeric
shared_pool_id Identifier of IBM POWER shared processor pool. String
system_model Name of the hardware system or virtualization technology that is discovered by the BigFix client. String
cluster_name Name of the cluster to which the computer belongs. String
cluster_cores_count Number of processor cores available within the cluster to which the computer belongs. Numeric
partition_cores Number of processor cores on the partition on which the BigFix client is installed. The number does not take into account hyper-threading on the x86 architecture. Numeric
status Status of the computer. Possible values are:
  • 1 - OK
  • 2 - No Scan Data
  • 3 - No Host Scan Data
  • 4 - No VM Manager Data
  • 9.2.10 5 - Outdated VM Manager Data
String
server_id Internal identifier of the physical server that hosts a computer. In case of a virtual machine that is not fully defined, the ID is a placeholder for a physical server and it changes when you complete defining the virtual machine. Numeric
server_name A unique system in the infrastructure. For a physical machine, it is the hardware manufacturer, type, and a machine serial number. For a virtual machine, it is the manufacturer and host name. For a virtual machine with an incomplete definition, it is a UUID that is prefixed with TLM_VM_.

You can specify the data that is returned by this property by configuring the following advanced server settings: managedServerTagTemplate and standaloneServerTagTemplate. For more information, see: Configuring advanced server settings.

String
9.2.16 server_serial_number A serial number of a physical server. In case of a virtual machine that is not fully defined, the Server Serial Number is a UUID that is prefixed with TLM_VM_. Numeric
9.2.16 server_type A type of a physical server. String
9.2.16 server_vendor A type of a physical server. String
9.2.16 server_model A type of a physical server. String
node_total_processors Number of active sockets on the physical server for placing CPU units. Numeric
server_cores Number of active physical processor cores on the physical server. Numeric
server_id Identifier of the server.
pvu_per_core Number of PVUs that are assigned to a processor core on the computer. By default, the value is taken from the PVU table. Numeric
default_pvu_value Indicates whether a default number of processor value units is assigned to the computer. Boolean
10.0.0 parent_hostname Hostname of the parent computer, if available. The value is null if the parent computer is not available. String
10.0.9 platform Hardware architecture. Possible values are:
  • x86 platforms that are available on Windows, Linux, and SUN:
    • IA32ONWIN64
    • AMD64
    • amd64
    • x86
    • i386
    • i586
    • i686
    • x86_64
  • Power platforms that are available on AIX, IBM i, and Linux:
    • ppc
    • ppc64
    • ppc64le
    • PowerPC
    • PowerPC64
  • PA-RISC platform that is available on HP-UX:
    • PA-RISC
  • IA-64 platform that is available on HP-UX:
    • ia64
  • IBM Z platforms that are available on Linux
    • s390
    • s390x
  • SPARC platform that is available on Solaris:
    • sparcv9

The list might change with time because the REST API stores the same value that is returned by the operating system.

String
The following properties identify the Current Physical Server Processor. In case of a virtual machine that is not fully defined, the information is gathered on VM level.
Table 2. Columns with properties that identify the Current Physical Server Processor
Property Name on the Hardware Inventory report Description Type
processor_brand_string Processor Brand String Full specification of the processor including its brand, model and speed as read from the computer operating system. String
processor_brand Brand Brand of the processor that was matched in the PVU table. If the brand is "Other", the processor is not listed in the PVU table. String
processor_model Model Model of the processor. String
processor_type Type Type of the processor according to the number of cores. String
processor_vendor Vendor Vendor of the processor. String