Integration Guides › BFC API Reference Guide › Server Records

Server Records

This section contains the following topics:

Server Record

Server Selection Record

Network Interface Record

Disk Record

Power Controller Record

The following section describes Server records.

Server Record

A server record contains information about a currently available server, or information about a server allocated to a grid in the system. The server_record contains a server_info record and an inventory_record. The inventory_record contains a list of network_interface records and a list of power_controller records that contain information about the network interfaces and associated onboard power controllers with this server, respectively.

A server record contains the following fields:

Field	Type	Description
comp_id	integer	Read-only field that contains the resource component ID for the server resource.
server_info	server_info record	Read-only field that contains a server_info record with additional information about the server. The data contained in this record is the same data that the BFC GUI uses to display badging information for servers
mac_address	string	Read-only field that contains the MAC address for this server.
grid_info	grid_info record	Read-only field that contains a grid_info record that holds information about the grid to which this server belongs. This field is null if the server is not currently in a grid.
grid_os_info	grid_os_info record	Read-only field that contains a grid_os_info record that holds information about the grid operating system that runs on the grid server. This field is null if the server is not currently in a grid.
power_mode	string	Read-only field that contains the power mode of the server: controlled, degraded, manual.
power_status	string	Read-only field that contains one of the following power statuses of the server: on, off, unknown
power_ip_address	string	Read-only field that contains the power IP address of the server.
ignore_power_ controllers_ during_inventory	boolean	Specifies if you want to ignore power controllers during inventory. This attribute supports write only in manual power_mode.
description	string	Specifies a description of the server.
discovery_time	integer	Read-only field that contains the time this server was discovered. This time is expressed in milliseconds from the epoch and represents midnight (UTC) of the day on which the server was discovered.
inventorying	boolean	Read-only boolean value which indicates whether the server is currently being inventoried.
inventory	inventory record	Read-only field that contains an inventory record with information about the server. This field is null if the server has not yet been inventoried.
tags	[tag name]	Contains a list of tag names, one for each tag associated with this server.

Server Selection Record

A server selection record is used in calls to matchingServerCount. It can contain information about the CA AppLogic version that will be used in grid creation so that any system tags associated with that version will be included in the selection criteria. It can also contain user-specified selection criteria in CNF format.

A server selection record contains the following fields:

Field	Type	Description
version	string	The name of a CA AppLogic version. Any system tags associated with the version are applied during the call to matchingServerCount.
selection_criteria	string	User-specified server selection criteria specified in Conjunctive Normal Form (CNF).

Server Info Record

The server_info record contains additional state information about a server. It contains category and message information (English only) that a GUI may use to provide badging information about the state of a server.

A server_info record contains the following fields:

Field	Type	Description
state	string	Read-only field that contains the resource state of the server. For example, resource_allocated_state, resource_running_state, resource_stopped_state.
uri	string	Read-only field that contains the REST URI for this server resource. For example, BFC/servers/FA:00:DE:01:01:00
category	string	Read-only field that contains the badge information for this server.
message	string	Read-only field that contains the badge information message for this server.

Grid Info Record

The grid info record contains information about the grid that contains this server.

A grid_info_record contains the following fields:

Field	Type	Description
comp_id	integer	Read-only field that contains the resource component ID for the grid resource.
name	string	Read-only field that contains the grid name.
state	string	Read-only field that contains the resource state of the grid. For example, resource_allocated_state, resource_running_state, resource_stopped_state.
uri	string	Read-only field that contains the REST URI for this grid resource. For example, BFC/grids/test_grid
category	string	Read-only field that contains the badge information category for this grid.
message	string	Read-only field that contains the badge information message for this grid.

Grid OS Info Record

The grid_os_info record contains information about the grid operating system component that is associated with a server.

A grid_os_info record contains the following fields:

Field	Type	Description
comp_id	integer	Read-only field that contains the resource component ID for the grid OS resource.
state	string	Read-only field that contains the resource state of the grid OS. For example, resource_allocated_state, resource_running_state, resource_stopped_state.
applogic_server_name	string	Read-only field that contains the name of the CA AppLogic grid server associated with this BFC server component.
applogic_server_state	string	Read-only field that contains the state of the CA AppLogic server state.
applogic_server_enabled	boolean	Read-only field that indicates whether the associated CA AppLogic server is enabled (true) or disabled (false).
has_grid_controller	boolean	Read-only field that indicates whether this BFC server is currently running the CA AppLogic Grid Controller.
hypervisor_type	string	Read-only field that contains the type of hypervisor running on this grid OS. The supported hypervisor types are ESX or Xen.
category	string	Read-only field that contains the badge information category for this grid OS.
message	string	Read-only field that contains the badge information message for this grid OS.

Inventory Record

The inventory record contains inventory information about this server.

An inventory record contains the following fields:

Field	Type	Description
inventory_time	integer	Read-only field that contains the time on which the server inventoried. The format of the date is in milliseconds since the epoch.
cpu_cores	integer	Read-only fields that contain the number of CPU cores that the server contains.
cpu_speed	float	Read-only field that contains the CPU speed of this server; expressed in gigahertz (GHz).
memory_size	integer	Read-only field that contains the amount of core memory that this server contains; expressed in gigabytes (Gbytes).
disk_count	integer	Read-only field that contains the number of disk drives associated with this server.
total_disk_space	integer	Read-only field that contains the total amount of disk drive storage associated with this server; expressed in gigabytes (Gbytes).
network_interfaces	[network_interface]	Read-only field that contains a list of network_interface records, one for each network interface associated with the server.
disks	[disk]	Read-only field that contains a list of disk records, one for each disk associated with the server.
power_controllers	[power_controller]	Read-only field that contains a list of power_controller records, one for each onboard controller associated with the server.

Network Interface Record

A network interface record contains information about one of the network interfaces (NIC) associated with this server.

A network_interface record contains the following fields:

Field	Type	Description
connectivity	[string]	Read-only field that contains a list of strings which represent the network connectivity for this interface. The following values are valid: unknown, not_connected, external, backbone
ip_address	string	Read-only field that specifies the IP address of this network interface.
is_boot	boolean	Read-only field that indicates whether this was the network interface from which we PXE booted.
mac_address	string	Read-only field that contains the MAC address for this network interface.
name	string	Read-only Field that contains the name of the interface. For example, eth0 or eth1.
speed	integer	Read-only field that contains the speed of the network interface; expressed in megabits per second (Mbps).

Disk Record

The disk record contains information about one of the disks associated with this server.

A disk record contains the following fields:

Field	Type	Description
name	string	Read-only field that contains the name of the disk: sda, sdb, and so on.
size	integer	Read-only field that contains the size of the disk in gigabytes (Gbytes).

Power Controller Record

A power_controller record contains information about one of the onboard power controllers associated with this server.

A power_controller record contains the following fields:

Field	Type	Description
comp_id	integer	Read-only field that contains the resource component ID for the power controller resource.
ip_address	string	Read-only field that contains the power IP address for this power controller.
mac_address	string	Read-only field that contains the MAC address for this power controller.
type	string	Read-only field that indicates the type of power controller. The Valid values include controlled and manual.
username	string	Username for login to this power controller.
credential_set_time	integer	Read-only field that contains milliseconds from the epoch representing the date and time that the user login credential were last set for this power controller.
power_status	string	Read-only field that contains the power status for this power controller. Valid values include on or off.
credential_mode	string	Read-only field that contains the credential mode for the power controller. Valid values include system_configured, system_preset, or user_preset.