Keapigetsystemstateamt, Keapisetsystemstateamt, Keapisetsystemstate – Kontron KEAPI User Manual

Page 9: 4 keapigetsystemstateamt, 5 keapisetsystemstateamt, 6 keapisetsystemstate

Advertising
background image

Software specification for Kontron EAPI

9

2.3.4 KEApiGetSystemStateAmt

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiGetSystemStateAmt (

KEAPI_PCHAR

pHostIp,

KEAPI_PCHAR

pUser,

KEAPI_PCHAR

pPassword,

KEAPI_PINT32

pSystemState

);

Description:

Uses Intel AMT to get information about state of remote board (turned on, turned off or hibernated).
The remote board must support Intel AMT and enable it in BIOS. AMT functionality can be tested via
web browser (fill in address http:// remote board’s IP:16992 and AMT web page should appear).

Parameters:

in/out

Parameter name

Description

in

pHostIp

IP address of the remote board

in

pUser

User name for host AMT

in

pPassword

Password for host AMT

out

pSystemState

Pointer to variable that will receive remote board's state

SYSTEM_STATE_TURN_ON, 0

SYSTEM_STATE_TURN_OFF, 1

SYSTEM_STATE_HIBERNATE, 2

2.3.5 KEApiSetSystemStateAmt

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiSetSystemStateAmt (

KEAPI_PCHAR

pHostIp,

KEAPI_PCHAR

pUser,

KEAPI_PCHAR

pPassword,

KEAPI_INT32

systemState

);

Description:

Uses Intel AMT to turn on, turn off or restart remote board. If the remote board

doesn’t support Intel

AMT, then the KEApiSetSystemState() function using OS call can be used instead.

Parameters:

in/out

Parameter name

Description

in

pHostIp

IP address of the remote board

in

pUser

User name for host AMT

in

pPassword

Password for host AMT

in

systemState

Desired system state

SYSTEM_STATE_TURN_ON, 0

SYSTEM_STATE_TURN_OFF, 1

SYSTEM_STATE_RESTART, 3

2.3.6 KEApiSetSystemState

KEAPI_CALLTYPE

KEAPI_UINT32

KEApiSetSystemState (

KEAPI_UINT32

boardHandle,

KEAPI_INT32

systemState

);

Description:

Uses

operating system’s command to turn on, turn off or restart remote board. There is no guarantee

that the command was performed correctly i.e. if the system hangs.

Advertising