hostmgr.md

Protocol Documentation

Table of Contents

• hostmgr/proto/hostmgr_southbound.proto

  • AmtConfigInfo

  • BiosInfo

  • BmInfo

  • BmcInfo

  • CPUTopology

  • Config

  • CoreGroup

  • HWInfo

  • HostStatus

  • HostStatusResp

  • IPAddress

  • Interfaces

  • Metadata

  • OsInfo

  • OsKernel

  • OsRelease

  • RASInfo

  • Socket

  • Storage

  • SystemCPU

  • SystemDisk

  • SystemGPU

  • SystemInfo

  • SystemMemory

  • SystemNetwork

  • SystemPCI

  • SystemUSB

  • UpdateHostStatusByHostGuidRequest

  • UpdateHostSystemInfoByGUIDRequest

  • UpdateHostSystemInfoByGUIDResponse

  • UpdateInstanceStateStatusByHostGUIDRequest

  • UpdateInstanceStateStatusByHostGUIDResponse

  • BmInfo.Bm_type

  • ConfigMode

  • HostStatus.Host_status

  • HostStatusResp.Host_action

  • InstanceState

  • InstanceStatus

  • Hostmgr

• Scalar Value Types

Top

hostmgr/proto/hostmgr_southbound.proto

SPDX-FileCopyrightText: (C) 2026 Intel Corporation SPDX-License-Identifier: Apache-2.0

AmtConfigInfo

Field	Type	Label	Description
version	string
device_name	string
operational_state	string
build_number	string
sku	string
features	string
device_guid	string
control_mode	string
dns_suffix	string
ras_info	RASInfo

BiosInfo

Field	Type	Label	Description
version	string
release_date	string
vendor	string

BmInfo

Field	Type	Label	Description
bm_type	BmInfo.Bm_type
bmc_info	BmcInfo

BmcInfo

Field	Type	Label	Description
bm_ip	string
bm_username	string
bm_password	string

CPUTopology

Field	Type	Label	Description
sockets	Socket	repeated	a list of CPU socket descriptions

Config

Field	Type	Label	Description
key	string
value	string

CoreGroup

Field	Type	Label	Description
core_type	string		type of CPU cores (e.g., P-Core or E-Core)
core_list	uint32	repeated	a list of CPU cores in the group

HWInfo

Field	Type	Label	Description
serial_num	string
product_name	string
cpu	SystemCPU
gpu_deprecated	SystemGPU		Deprecated.
memory	SystemMemory
storage	Storage
network	SystemNetwork	repeated
pci	SystemPCI	repeated
usb	SystemUSB	repeated
gpu	SystemGPU	repeated

HostStatus

Field	Type	Label	Description
host_status	HostStatus.Host_status
details	string
human_readable_status	string

HostStatusResp

Field	Type	Label	Description
host_action	HostStatusResp.Host_action
details	string

IPAddress

Field	Type	Label	Description
ip_address	string		Just an IP Address of the interface (e.g., 192.168.1.12)
network_prefix_bits	int32
config_mode	ConfigMode		this is derived from the FLAG and lifetime associated with the IPAddress

Interfaces

Field	Type	Label	Description
class	string

Metadata

Field	Type	Label	Description
key	string
value	string

OsInfo

Field	Type	Label	Description
kernel	OsKernel
release	OsRelease

OsKernel

Field	Type	Label	Description
version	string
config	Config	repeated

OsRelease

Field	Type	Label	Description
id	string
version	string
metadata	Metadata	repeated

RASInfo

Field	Type	Label	Description
network_status	string
remote_status	string
remote_trigger	string
mps_hostname	string

Socket

Field	Type	Label	Description
socket_id	uint32
core_groups	CoreGroup	repeated	a list of CPU core groups, categorized by CPU core type

Storage

Field	Type	Label	Description
disk	SystemDisk	repeated
features	string	repeated

SystemCPU

Field	Type	Label	Description
arch	string
vendor	string
model	string
sockets	uint32
cores	uint32
threads	uint32
features	string	repeated
cpu_topology	CPUTopology

SystemDisk

Field	Type	Label	Description
serial_number	string
name	string
vendor	string
model	string
size	uint64
wwid	string

SystemGPU

Field	Type	Label	Description
pci_id	string
product	string
vendor	string
name	string
description	string		human-readable description of GPU
features	string	repeated

SystemInfo

Field	Type	Label	Description
hw_info	HWInfo
os_info	OsInfo
bm_ctl_info	BmInfo
bios_info	BiosInfo
amt_info	AmtConfigInfo

SystemMemory

Field	Type	Label	Description
size	uint64

SystemNetwork

Field	Type	Label	Description
name	string
pci_id	string
mac	string
link_state	bool
current_speed	uint64
current_duplex	string
supported_link_mode	string	repeated
advertising_link_mode	string	repeated
features	string	repeated
sriovenabled	bool
sriovnumvfs	uint32
sriov_vfs_total	uint32
peer_name	string
peer_description	string
peer_mac	string
peer_mgmt_ip	string
peer_port	string
ip_addresses	IPAddress	repeated	NIC can report multiple IP addresses for each NIC
mtu	uint32		units are bytes
bmc_net	bool		whether or not this is a bmc NIC

SystemPCI

Field	Type	Label	Description
dev_class	string

SystemUSB

Field	Type	Label	Description
class	string
idvendor	string
idproduct	string
bus	uint32
addr	uint32
description	string
serial	string
interfaces	Interfaces	repeated

UpdateHostStatusByHostGuidRequest

UpdateHostStatusByHostGuidParameters holds parameters to UpdateHostStatusByHostGuid

Field	Type	Label	Description
host_guid	string
host_status	HostStatus

UpdateHostSystemInfoByGUIDRequest

Field	Type	Label	Description
host_guid	string
system_info	SystemInfo

UpdateHostSystemInfoByGUIDResponse

UpdateInstanceStateStatusByHostGUIDRequest

Field	Type	Label	Description
host_guid	string		Host GUID
instance_status	InstanceStatus		Instance's Status
instance_state	InstanceState		Instance's last State as seen by the PS/ENA
provider_status_detail	string		Details of the current status of the Instance

UpdateInstanceStateStatusByHostGUIDResponse

BmInfo.Bm_type

buf:lint:ignore ENUM_VALUE_PREFIX buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_PASCAL_CASE

Name	Number	Description
IPMI	0
REDFISH	1
PDU	2
VPRO	3
FDO	4
NONE	5

ConfigMode

Name	Number	Description
CONFIG_MODE_UNSPECIFIED	0
CONFIG_MODE_STATIC	1
CONFIG_MODE_DYNAMIC	2

HostStatus.Host_status

buf:lint:ignore ENUM_VALUE_PREFIX buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_PASCAL_CASE

Name	Number	Description
UNSPECIFIED	0
REGISTERING	1
BOOTING	2
BOOTFAILED	3
PROVISIONING	4
PROVISIONED	5
PROVISIONFAILED	6
RUNNING	7
UPDATING	8
UPDATEFAILED	9
ERROR	10

HostStatusResp.Host_action

buf:lint:ignore ENUM_VALUE_PREFIX buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX buf:lint:ignore ENUM_PASCAL_CASE

Name	Number	Description
NONE	0
SHUTDOWN	1
RESTART	2
UPDATING	3
RUNNING	4

InstanceState

Name	Number	Description
INSTANCE_STATE_UNSPECIFIED	0	unconfigured
INSTANCE_STATE_INSTALLED	2	OS is installed, but hasn't been started
INSTANCE_STATE_RUNNING	3	OS is Running
INSTANCE_STATE_STOPPED	4	OS is Stopped
INSTANCE_STATE_DELETED	5	OS should be Deleted

InstanceStatus

Name	Number	Description
INSTANCE_STATUS_UNSPECIFIED	0
INSTANCE_STATUS_BOOTING	1
INSTANCE_STATUS_BOOT_FAILED	2
INSTANCE_STATUS_PROVISIONING	3
INSTANCE_STATUS_PROVISIONED	4
INSTANCE_STATUS_PROVISION_FAILED	5
INSTANCE_STATUS_RUNNING	6
INSTANCE_STATUS_ERROR	7
INSTANCE_STATUS_UPDATING	9
INSTANCE_STATUS_UPDATE_FAILED	10
INSTANCE_STATUS_INITIALIZING	11

Hostmgr

buf:lint:ignore SERVICE_SUFFIX

Method Name	Request Type	Response Type	Description
UpdateHostStatusByHostGuid	UpdateHostStatusByHostGuidRequest	HostStatusResp	buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
UpdateInstanceStateStatusByHostGUID	UpdateInstanceStateStatusByHostGUIDRequest	UpdateInstanceStateStatusByHostGUIDResponse	This call is dedicated to updating of an Instance's Current State AND Instance's Status.
UpdateHostSystemInfoByGUID	UpdateHostSystemInfoByGUIDRequest	UpdateHostSystemInfoByGUIDResponse	This call will update the Host System info

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)