BuildForge Help

Built-in Properties Reference

The Management Console collects built-in properties from servers and then assigns the values to the server manifest.

List of Built-in Properties

Built-in properties are used by several different data objects in the system:
  • Selectors can use built-in properties as selector variables, to match servers with certain values in those properties.
  • Collectors use built-in properties to collect data from servers.
  • Manifests store the values of built-in properties when they have been collected.
Built-in properties are not automatically added. You must add a built-in property to a collector for the property to display in the manifest.
Table 1. Built-in Properties for Collectors and Manifests

Property

Description

CPU_ARCH

The returned value is a label for an architecture name, as shown:
  • HP-PA: HP Precision Architecture
  • IA-64: Intel Itanium
  • MVS: IBM S/390
  • PPC: PowerPC
  • PPC-64: PowerPC 64
  • SPARC: Sun SPARC
  • X86: x86-compliant architecture used by Intel, AMD, Cyrix, and others.

CPU_LOAD (Windows only)

For Windows systems, the CPU load (or CPU usage) is expressed as a percentage of capacity (between 0 and 100).

CPU_LOAD1

(UNIX/Linux only)

For UNIX/Linux, the average number of processes (load average) running or waiting to run over the last minute.

CPU_LOAD1 is a measure of CPU activity. An idle computer has a load number of 0. Each process that is using CPU or waiting for CPU adds to the load number by 1.

CPU_LOAD5

(UNIX/Linux only)

For UNIX/Linux, the average number of processes (load average) waiting to run over the last 5 minutes as reported by the operating system.

CPU_LOAD5 is a measure of CPU activity. An idle computer has a load number of 0. Each process that is using CPU or waiting for CPU adds to the load number by 1.

CPU_LOAD15

(UNIX/Linux only)

For UNIX/Linux, the average number of processes (load average) waiting to run over the last 15 minutes as reported by the operating system.

CPU_LOAD15 is a measure of CPU activity. An idle computer has a load number of 0. Each process that is using CPU or waiting for CPU adds to the load number by 1.

CPU_MHZ Processor speed in Megahertz. Certain conditions have to be met for this property to be filled in successfully:
  • Linux: frequency scaling must be enabled.
  • Windows: the ~MHz registry entry must exist and be filled in.
  • x86 and x86-64 processors: inline assembly must work.
CPU_MANUFACTURER Company name of the processor manufacturer. The names are assumed based on architecture if the information is not directly available. No value is returned if there is insufficient processor information available. Supported values are:
  • AMD: for their x86 and AMD64 processors
  • Cyrix: for their x86-compliant processors
  • DEC: for Alpha and VAX
  • HP: Hewlett-Packard Precision Architecture
  • IBM: IBM S/390 and PowerPC G5
  • Intel: Intel x86 (including Intel64), IA-64 Itanium
  • Motorola: PowerPC G4
  • NexGen: x86-compliant processors
  • National: National Semiconductor x86-compliant processors
  • Rise: Rise x86-compliant processor
  • Sis: Sis x86-compliant processor
  • Sun: Sun Microsystems SPARC
  • TransMeta: TransMeta x86-compliant processor
  • UMC: UMC x86-compliant processor
  • VIA: VIA Technologies x86-compliant processor
CPU_MODEL Manufacturer-specific CPU model numbers. The following values are reported:
  • x86 architecture
    • 386
    • 486
    • 586
    • 686
    • X86_64
  • PPC architecture
    • 6xx
    • POWER
    • RS64
    • G3
    • G4
    • G5
    • Cell
CPU_SERIAL Serial number of the CPU or machine. Currently this functionality is limited to the following architectures:
  • x86: Intel or Transmeta serial numbers only. Note: most x86 processors will not report a serial number. No value is returned in those cases.
  • MacOS/X: the serial number assigned is retrieved from an I/O registry. Requires that CoreFoundation and IOKit frameworks be found.
DISK_FREE

For UNIX/Linux, the amount of free space (in MBs) on the file system specified by the server Path property.

For Windows, the free disk space (in MBs) on the drive specified by the server Path property.

For example, 4096 MB for systems with 4 GB of free disk space.

DISK_TOTAL Total free disk space available. This value is reported for the agent's base path, which may have a separate allocation that is smaller than the entire remaining disk or partition. Disk space management varies significantly between operating systems.

MEM_LOAD

(UNIX/Linux only)

For UNIX/Linux, the amount of RAM or system memory currently in use is expressed as a percentage of total real memory (between 0 and 100).

MEM_FREE

The amount of RAM or system memory (in MBs). For example, 1183 MB for systems with 2 GB of RAM.

MEM_PAGESIZE

The RAM or system memory page size (in MBs). The standard page size for the host system. For example, 4096 MB is a 4 KB page size.

MEM_TOTAL

The total RAM or system memory (in MBs).

For example, 2048 MB for a system with 2 GB of RAM.

NET_FQDN Fully Qualified Domain Name (FQDN) of the machine where the agent is running. It is reported based on the address that the agent is using to communicate. The address returned can be an IPv4 or IPv6, based on the address actually being used. See also NET_IPV, NET_IPV4, and NET_IPV6.
NET_HWADDR Hardware address for the interface reported in NET_IFACE.
NET_IFACE Name of the interface used by the agent.
  • Windows: the name as reported by the ipconfig command, for example Intel(R) PRO/100 VE Network Connection - Packet Scheduler Miniport
  • Other systems: the name as reported by ifconfig, for example en0 or eth0 or OSA1.
NET_IPV The type of IP connection used to communicate with the agent, either 4 for IPv4 or 6 for IPv6.
NET_IPV4 The IPv4 address used by the agent to communicate. On connections over IPv6, if the agent is able to identify an IPv4 address for the same interface, that address is reported.
NET_IPV6 The IPv6 address used by the agent to communicate.
NET_SPEED (Windows only) Windows: speed of the interface in Mb/sec, for example 1000 for Gigabit Ethernet.

NUM_CPU

The number of CPUs on the machine.

OS_HOSTID Result of the gethostid() system call. Normally this is not very informative unless a system administrator has set /etc/hostid to an informative value.

OS_SYSNAME

The operating system name of the server. For example, Windows XP, AIX, or Macintosh OS, and so on.

OS_RELEASE

The operating system release level of the server.

For example, if the server OS is Microsoft XP Version 5.1.2600, this number is 5.

OS_VERSION

The operating system version of the server.

For example, if the server OS is Microsoft XP Version 5.1.2600, this number is 1.

WIN_SERVICEPACK

(Windows only)

The number of the Windows service pack installed on the server. For example, 2 for Service Pack 2.

Related concepts
Manifests
Selectors
Special Manifest Properties
Special Set Value Properties
Creating a Selector
Collectors
Selecting the Server for a Project or Step