Built-in properties

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

Built-in properties

Built-in properties are used by several different data objects in the build 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 if 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 be displayed in the manifest. This table lists and describes the built-in properties.
Note: The availability of a property varies from platform to platform.
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) The CPU load, or CPU usage, is expressed as a percentage of capacity (between 0 and 100).
CPU_LOAD1 The returned value reports the average number of processes (load average) that were 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 the CPU or waiting for the CPU adds to the load number by 1.

Note: On Windows, every process adds to the load number, active or not. Also, this information is gathered by the bfdispatch process and published to the agent using a shared memory segment. If the user credentials that are used for connecting to the agent are unprivileged, these statistics will not be available.
CPU_LOAD5 The returned value reports the average number of processes (load average) that were waiting to run over the last 5 minutes.

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.

Note: On Windows, every process adds to the load number, active or not. Also, this information is gathered by the bfdispatch process and published to the agent using a shared memory segment. If the user credentials that are used for connecting to the agent are unprivileged, these statistics will not be available.
CPU_LOAD15 The average number of processes (load average) that were waiting to run over the last 15 minutes.

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.

Note: On Windows, every process adds to the load number, active or not. Also, this information is gathered by the bfdispatch process and published to the agent using a shared memory segment. If the user credentials that are used for connecting to the agent are unprivileged, these statistics will not be available.
CPU_MHZ This property reports the processor speed in megahertz. Certain conditions are required for this property to be filled in successfully:
  • In Linux: frequency scaling must be enabled.
  • In Windows: the ~MHz registry entry must exist and be filled in.
  • For x86 and x86-64 processors inline assembly must work.
CPU_MANUFACTURER This property returns the company name of the processor manufacturer. If the information is not directly available, the names are assumed based on architecture. No value is returned if there is insufficient processor information available. These values are supported:
  • 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 This property returns the manufacturer-specific CPU model numbers. These values are reported as follows:
  • x86 architecture
    • 386
    • 486
    • 586
    • 686
    • X86_64
  • PowerPC architecture
    • 6xx
    • POWER
    • RS64
    • G3
    • G4
    • G5
    • Cell
CPU_SERIAL This property returns the serial number of the CPU or computer. Currently, this functionality is limited to these architectures:
  • x86: Intel or Transmeta serial numbers only. Note: Most x86 processors will not report a serial number. No value is returned in such cases.
  • MacOS/X: The serial number assigned is retrieved from an I/O registry. To report the property, it must able to find the CoreFoundation and IOKit frameworks.
DISK_FREE

For UNIX and Linux, this property returns the amount of free space (in MB) on the file system that the server Path specifies.

For Windows, the free disk space (in MBs) on the drive that the server Path specifies.

For example, a disk with 4 GB of free space is reported as 4096 MB.

DISK_TOTAL This property returns the total free disk space available. This value is reported for the base path of the agent, which might 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 and Linux, the amount of RAM or system memory that is currently in use expressed as a percentage of total real memory (between 0 and 100).
MEM_FREE This property returns the amount of RAM or system memory (in MB). For example, 2 GB of free RAM is reported as 2048 MB.
MEM_PAGESIZE This property returns the RAM or system memory page size (in MB). This figure represents the standard page size for the host system. For example, a host system with a page size of 4 KB is reported as 4096 MB.
MEM_TOTAL This property reports total RAM, or system memory (in MB).

For example, a computer with 2 GB of RAM would be reported as 2048 MB.

NET_FQDN This property returns the fully qualified domain name (FQDN) of the computer that is running the agent. The FQDN is reported based on the address that the agent is using to communicate. The returned address can be based on IPv4 or IPv6, depending on the address actually being used. See also NET_IPV, NET_IPV4, and NET_IPV6.
NET_HWADDR This property returns the hardware address for the interface reported in NET_IFACE.
NET_IFACE This property returns the name of the interface that the agent uses to communicate.
  • In Windows, the reported name is the name that ipconfig command returns, for example, Intel(R) PRO/100 VE Network Connection - Packet Scheduler Miniport
  • In other operating systems, the reported name is the name that ifconfig returns, for example, en0 or eth0 or OSA1.
NET_IPV This property returns the type of IP connection that is used to communicate with the agent, either 4 for IPv4 or 6 for IPv6.
NET_IPV4 This property returns the IPv4 address that the agent uses 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 This property returns the IPv6 address that the agent uses to communicate.
NET_SPEED (Windows only) This property returns the speed of the interface in Mb/sec, for example, 1000 for Gigabit Ethernet.
NUM_CPU This property returns the number of CPUs on the computer.
OS_HOSTID This property returns the result of the gethostid() system call. Typically, this result is not informative unless a system administrator has set /etc/hostid to an informative value.
OS_SYSNAME This property returns the operating system name of the server. Examples: Microsoft Windows XP, AIX, Macintosh OS.
OS_RELEASE This property returns the operating system release level of the server.

For example, if the server operating system is Microsoft XP Version 5.1.2600, this returned value is 5.

OS_VERSION This property returns the operating system version of the server.

For example, if the server operating system is Microsoft XP Version 5.1.2600, this returned value is 1.

WIN_SERVICEPACK (Windows only) This property returns the version number of the Windows service pack installed on the server. For example, for Service Pack 2, this value is 2.

Feedback