Local Managebility Service D-Bus Interfaces

Version 2127.0.0.0

Table of Contents

com.intel.amt.lms — Intel(r) Local Manageability Service DBus interface.
com.intel.amt.lms.Manageability — Manageability DBus interface subsystem
com.intel.amt.lms.PTHI — PTHI DBus interface subsystem
com.intel.amt.lms.AT_Device — AT_Device DBus interface subsystem
com.intel.amt.lms.UNSAlert — UNSAlert DBus interface subsystem

Name

com.intel.amt.lms — Intel(r) Local Manageability Service DBus interface.

Signals

Alert (u Category,
       u ID,
       s Message,
       s MessageArgument,
       s MessageID,
       s DateTime);

Description

Interface for interaction with Intel(R) Local Manageability Service.

Signal Details

The "Alert" signal

Alert (u Category,
       u ID,
       s Message,
       s MessageArgument,
       s MessageID,
       s DateTime);

Emitted to inform clients about FW or service events.

u Category:

Alert category

u ID:

Alert ID

s Message:

Alert message.

s MessageArgument:

Aler message arguments string.

s MessageID:

Alert message type.

s DateTime:

Timestamp.

Name

com.intel.amt.lms.Manageability — Manageability DBus interface subsystem

Methods

GetTheFeatureState  (IN  u Feature,
                     OUT u State);
GetCustomerType     (OUT u CustomerType);
GetMenageabiltyMode (OUT u MenageabiltyMode);
GetFWInfo           (OUT s MEBxVersion,
                     OUT u BiosBootState,
                     OUT b CryptoFuseEnable,
                     OUT b LocalFWupdateEnable);
GetPMCVersion       (OUT s Version);
IsMeasuredBootState (OUT u State);

Description

Interface for interaction with Intel(R) Local Manageability Service, Manageability part.

Method Details

The GetTheFeatureState() method

GetTheFeatureState (IN  u Feature,
                    OUT u State);

Retrieves feature state by feature id. If Feat is unknown to server, a #org.freedesktop.DBus.Error.InvalidArgs error is returned.

IN u Feature:

0 = AMT, 1 = IRWT, 2 = QST, 3 = TDT, 4 = SOFTCREEK, 5 = VE, 7 = NAND, 9 = ICC_OVER_CLOCK_IN, 10 = PAV, 11 = SPK, 12 = RCA, 13 = RPAT, 14 = IPV6, 15 = KVM, 16 = OCH, 17 = DAL, 18 = TLS, 19 = CILA, 20 = LAKEHOUSTON

OUT u State:

0 = NOT_PRESENT, 1 = DISABLED, 2 = ENABLED, 3 = AVAILABLE

The GetCustomerType() method

GetCustomerType (OUT u CustomerType);

Retrieves customer type.

OUT u CustomerType:

0 = CORPORATE, 1 = CONSUMER, 2 = WRONG_CUSTOMER_TYPE

The GetMenageabiltyMode() method

GetMenageabiltyMode (OUT u MenageabiltyMode);

Retrieves manageability mode.

OUT u MenageabiltyMode:

0 = NONE, 1 = NOT_KNOWN, 2 = VPRO, 3 = STANDARD, 4 = L3, 5 = SBT

The GetFWInfo() method

GetFWInfo (OUT s MEBxVersion,
           OUT u BiosBootState,
           OUT b CryptoFuseEnable,
           OUT b LocalFWupdateEnable);

Retrieves basic FW info.

OUT s MEBxVersion:

MEBx version string

OUT u BiosBootState:

Bios boot state

OUT b CryptoFuseEnable:

Is crypto fuse enabled

OUT b LocalFWupdateEnable:

The GetPMCVersion() method

GetPMCVersion (OUT s Version);

Retrieves PMC version.

OUT s Version:

PMC version string

The IsMeasuredBootState() method

IsMeasuredBootState (OUT u State);

Checks if system is in a measured boot state.

OUT u State:

0 = Yes, 1 = No

Name

com.intel.amt.lms.PTHI — PTHI DBus interface subsystem

Methods

GetAMTVersion                            (OUT s         Version);
GetLMSVersion                            (OUT s         Version);
GetProvisioningState                     (OUT u         ProvisioningState);
GetNetworkConnectionStatus               (OUT u         Status,
                                          OUT u         ConnectionType,
                                          OUT u         ConnectionTrigger);
GetUserInitiatedEnabled                  (OUT u         Status);
GetPowerPolicy                           (OUT s         PowerPolicy);
GetLastResetReason                       (OUT u         LastResetReason);
GetRedirectionStatus                     (OUT u         SOL,
                                          OUT u         IDER);
GetSystemDefenseStatus                   (OUT u         SystemDefenseStatus);
GetNetworkSettings                       (IN  u         ConnectionType,
                                          OUT u         DhcpEnabled,
                                          OUT s         IpAddress,
                                          OUT s         MacAddress,
                                          OUT u         LinkStatus,
                                          OUT u         WirelessControl,
                                          OUT u         WirelessConfEnabled);
GetIPv6NetworkSettings                   (IN  u         ConnectionType,
                                          OUT s         IPv6DefaultRouter,
                                          OUT s         PrimaryDNS,
                                          OUT s         SecondaryDNS,
                                          OUT as        Response,
                                          OUT b         Ipv6Enable);
GetSystemUUID                            (OUT s         SystemUUID);
CloseUserInitiatedConnection             ();
GetKVMRedirectionState                   (OUT b         Enabled,
                                          OUT b         Connected);
SetSpriteLanguage                        (IN  u         SpriteLanguage);
SetSpriteZoom                            (IN  u         SpriteZoom);
GetSpriteParameters                      (OUT u         SpriteLanguage,
                                          OUT u         SpriteZoom);
GetConfigurationInfo                     (OUT u         ControlMode,
                                          OUT u         ProvisioningMethod,
                                          OUT s         CreationTimeStamp,
                                          OUT ay        CertHash);
TerminateRemedySessions                  ();
GetUserConsentState                      (OUT u         State,
                                          OUT u         Policy);
GetWLANLinkInfo                          (OUT u         Preference,
                                          OUT u         Control,
                                          OUT u         Protection);
SetLinkPreferenceToHost                  ();
InitiateUserConnection                   (OUT u         Status);
userInitiatedPolicyRuleExists            (OUT u         Exists);
userInitiatedPolicyRuleForLocalMpsExists (OUT u         Exists);
snmpEventSubscriberExists                (OUT u         Exists);
CILAFilterCollectionSubscriptionExists   (OUT u         Exists);
UpdateScreenSettings2                    (IN  a(biiuuu) DisplayParameters,
                                          IN  u         numOfDisplays);
GetRedirectionSessionLinkTechnology      (IN  u         sessionType,
                                          OUT u         LinkTechnology);

Description

Interface for interaction with Intel(R) Local Manageability Service, AMTHI (PTHI) part.

Method Details

The GetAMTVersion() method

GetAMTVersion (OUT s Version);

Retrieves AMT version.

OUT s Version:

AMT version string

The GetLMSVersion() method

GetLMSVersion (OUT s Version);

Retrieves Local Manageability Serice version.

OUT s Version:

LMS version string

The GetProvisioningState() method

GetProvisioningState (OUT u ProvisioningState);

Retrieves FW provisioning state.

OUT u ProvisioningState:

0 = PRE, 1 = IN, 2 = POST

The GetNetworkConnectionStatus() method

GetNetworkConnectionStatus (OUT u Status,
                            OUT u ConnectionType,
                            OUT u ConnectionTrigger);

Retrieves network connection status.

OUT u Status:

0 = NOT_CONNECTED, 1 = CONNECTING, 2 = CONNECTED

OUT u ConnectionType:

0 = DIRECT, 1 = VPN, 2 = OUTSIDE_ENTERPRISE, 3 = UNKNOWN

OUT u ConnectionTrigger:

0 = USER_INITIATED, 1 = ALERT, 2 = PROVISIONING, 3 = PERIODIC

The GetUserInitiatedEnabled() method

GetUserInitiatedEnabled (OUT u Status);

Retrieves status of user initiated connection enablement.

OUT u Status:

0 = DISABLED, 1 = ENABLED

The GetPowerPolicy() method

GetPowerPolicy (OUT s PowerPolicy);

Retrieves status of power policy.

OUT s PowerPolicy:

Power policy string

The GetLastResetReason() method

GetLastResetReason (OUT u LastResetReason);

Retrieves reason of last reset.

OUT u LastResetReason:

0 = NONE, 1 = ME, 2 = GLOBAL, 3 = EXCEPTION

The GetRedirectionStatus() method

GetRedirectionStatus (OUT u SOL,
                      OUT u IDER);

Retrieves status of redirection interfaces.

OUT u SOL:

0 = CLOSED, 1 = OPEN

OUT u IDER:

0 = CLOSED, 1 = OPEN

The GetSystemDefenseStatus() method

GetSystemDefenseStatus (OUT u SystemDefenseStatus);

Retrieves status of system defense.

OUT u SystemDefenseStatus:

0 = DISABLED, 1 = ENABLED

The GetNetworkSettings() method

GetNetworkSettings (IN  u ConnectionType,
                    OUT u DhcpEnabled,
                    OUT s IpAddress,
                    OUT s MacAddress,
                    OUT u LinkStatus,
                    OUT u WirelessControl,
                    OUT u WirelessConfEnabled);

Retrieves network interface settings.

IN u ConnectionType:

0 = WIRED, 1 = WIRELESS

OUT u DhcpEnabled:

0 = DISABLED, 1 = ENABLED

OUT s IpAddress:

IP address string

OUT s MacAddress:

MAC address string

OUT u LinkStatus:

0 = DOWN, 1 = UP

OUT u WirelessControl:

Wireless only 1 = ACTIVE, 2 = PASSIVE, 5 = NOT_APPLICABLE

OUT u WirelessConfEnabled:

Wireless only 0 = DISABLED, 1 = ENABLED, 5 = NOT_APPLICABLE

The GetIPv6NetworkSettings() method

GetIPv6NetworkSettings (IN  u  ConnectionType,
                        OUT s  IPv6DefaultRouter,
                        OUT s  PrimaryDNS,
                        OUT s  SecondaryDNS,
                        OUT as Response,
                        OUT b  Ipv6Enable);

Retrieves network interface IPv6 settings.

IN u ConnectionType:

0 = WIRED, 1 = WIRELESS

OUT s IPv6DefaultRouter:

Default router IP address string

OUT s PrimaryDNS:

Primary DNS IP address string

OUT s SecondaryDNS:

Secondary DNS IP address string

OUT as Response:

Interface IPv6 addresses string array

OUT b Ipv6Enable:

0 = DISABLED, 1 = ENABLED

The GetSystemUUID() method

GetSystemUUID (OUT s SystemUUID);

Retrieves the system UUID.

OUT s SystemUUID:

UUID as string

The CloseUserInitiatedConnection() method

CloseUserInitiatedConnection ();

Send command to close a previously open connection.

The GetKVMRedirectionState() method

GetKVMRedirectionState (OUT b Enabled,
                        OUT b Connected);

Retrieve KVM redirection state.

OUT b Enabled:

0 = DISABLED, 1 = ENABLED

OUT b Connected:

0 = DISCONNECTED, 1 = CONNECTED

The SetSpriteLanguage() method

SetSpriteLanguage (IN  u SpriteLanguage);

Set current sprite language.

IN u SpriteLanguage:

0 = English, 1 = French, 2 = German, 3 = Chinese_Traditional, 4 = Japanese, 5 = Russian, 6 = Italian, 7 = Spanish, 8 = Portuguese_Brazil, 9 = Korean, 10 = Chinese_Simplified, 11 = Arabic, 12 = Czech, 13 = Danish, 14 = Greek, 15 = Finnish, 16 = Hebrew, 17 = Hungarian, 18 = Dutch, 19 = Norwegian, 20 = Polish, 21 = Portuguese_Portugal, 22 = Slovak, 23 = Slovenian, 24 = Swedish, 25 = Thai, 26 = Turkish, 65535 = DefaultEnglish

The SetSpriteZoom() method

SetSpriteZoom (IN  u SpriteZoom);

Set current sprite zoom level.

IN u SpriteZoom:

1 = NO_ZOOM, 2 = ZOOM_X2, 65535 = AUTO

The GetSpriteParameters() method

GetSpriteParameters (OUT u SpriteLanguage,
                     OUT u SpriteZoom);

Retrieve current sprite language and zoom.

OUT u SpriteLanguage:

0 = English, 1 = French, 2 = German, 3 = Chinese_Traditional, 4 = Japanese, 5 = Russian, 6 = Italian, 7 = Spanish, 8 = Portuguese_Brazil, 9 = Korean, 10 = Chinese_Simplified, 11 = Arabic, 12 = Czech, 13 = Danish, 14 = Greek, 15 = Finnish, 16 = Hebrew, 17 = Hungarian, 18 = Dutch, 19 = Norwegian, 20 = Polish, 21 = Portuguese_Portugal, 22 = Slovak, 23 = Slovenian, 24 = Swedish, 25 = Thai, 26 = Turkish, 100 = NotSet, 65535 = DefaultEnglish

OUT u SpriteZoom:

1 = NO_ZOOM, 2 = ZOOM_X2, 65535 = AUTO

The GetConfigurationInfo() method

GetConfigurationInfo (OUT u  ControlMode,
                      OUT u  ProvisioningMethod,
                      OUT s  CreationTimeStamp,
                      OUT ay CertHash);

Retrieve AMT configuration parameters.

OUT u ControlMode:

0 = NOT_PROVISIONED, 1 = CLIENT, 2 = ADMIN, 3 = RESERVED

OUT u ProvisioningMethod:

0 = UNKNOWNPROV, 1 = RESERVED1, 2 = UNPROVISIONED, 3 = REMOTE, 4 = REMOTE_TLSPKI, 5 = HOST, 6 = MANUAL, 7 = RESERVED2, 100 = NOTSUPPORTED

OUT s CreationTimeStamp:

Provison time stamp string

OUT ay CertHash:

Certificate hash string array

The TerminateRemedySessions() method

TerminateRemedySessions ();

Request to all remedy sessions (SOL, IDER, KVM, etc.) to terminate.

The GetUserConsentState() method

GetUserConsentState (OUT u State,
                     OUT u Policy);

State:0 = NOT STARTED, 1 = REQUESTED, 2 = DISPLAYED, 3 = RECEIVED, 4 = IN_SESSION, 5 = RESERVED Policy: 0 = NOT_REQUIRED, 1 = KVM_ONLY, 4294967295 = ALL_SESSIONS

Retrieve user consent status.

OUT u State:

OUT u Policy:

The GetWLANLinkInfo() method

GetWLANLinkInfo (OUT u Preference,
                 OUT u Control,
                 OUT u Protection);

Retrieve WLAN link information.

OUT u Preference:

1 = ME, 2 = HOST, 3 = Reserved

OUT u Control:

1 = ME, 2 = HOST, 3 = Reserved

OUT u Protection:

0 = OVERRIDE, 1 = NONE, 2 = PASSIVE, 3 = HIGH, 4 = RESERVED

The SetLinkPreferenceToHost() method

SetLinkPreferenceToHost ();

Request to set the link preferred owner entity to host.

The InitiateUserConnection() method

InitiateUserConnection (OUT u Status);

Send command to initiate a user request for helpdesk services.

OUT u Status:

Operation result status

The userInitiatedPolicyRuleExists() method

userInitiatedPolicyRuleExists (OUT u Exists);

Checks if user initiated policy rule exists in the FW.

OUT u Exists:

0 = NOT_EXISTS, 1 = EXISTS

The userInitiatedPolicyRuleForLocalMpsExists() method

userInitiatedPolicyRuleForLocalMpsExists (OUT u Exists);

Checks if user initiated policy rule for local MPS exists in the FW.

OUT u Exists:

0 = NOT_EXISTS, 1 = EXISTS

The snmpEventSubscriberExists() method

snmpEventSubscriberExists (OUT u Exists);

Checks if event subscriber exists in the FW.

OUT u Exists:

0 = NOT_EXISTS, 1 = EXISTS

The CILAFilterCollectionSubscriptionExists() method

CILAFilterCollectionSubscriptionExists (OUT u Exists);

Checks if CILA filter collection subscription exists in the FW.

OUT u Exists:

0 = NOT_EXISTS, 1 = EXISTS

The UpdateScreenSettings2() method

UpdateScreenSettings2 (IN  a(biiuuu) DisplayParameters,
                       IN  u         numOfDisplays);

Put new screen topology to FW.

IN a(biiuuu) DisplayParameters:

array of (IsActive: screen is present, UpperLeftX: Upper left X coordinate of screen, UpperLeftY: Upper left Y coordinate of screen, SizeX: X resolution of screen, SizeY: Y resolution of screen, Pipe: Display index)

IN u numOfDisplays:

Number of displays in array (1-4)

The GetRedirectionSessionLinkTechnology() method

GetRedirectionSessionLinkTechnology (IN  u sessionType,
                                     OUT u LinkTechnology);

Retrieves underlining link technology for given session type.

IN u sessionType:

0 = SOL, 1 = IDER, 2 = KVM

OUT u LinkTechnology:

0 = WIRED, 1 = WIRELESS

Name

com.intel.amt.lms.AT_Device — AT_Device DBus interface subsystem

Methods

GetAuditLogs (OUT s AuditLogs);

Description

Interface for interaction with Intel(R) Local Manageability Service, AT_Device part.

Method Details

The GetAuditLogs() method

GetAuditLogs (OUT s AuditLogs);

Retrieves audit logs from the FW.

OUT s AuditLogs:

logs as XML string

Name

com.intel.amt.lms.UNSAlert — UNSAlert DBus interface subsystem

Methods

GetIMSSEventHistory (OUT s EventHistory);

Description

Interface for interaction with Intel(R) Local Manageability Service, UNSAlert part.

Method Details

The GetIMSSEventHistory() method

GetIMSSEventHistory (OUT s EventHistory);

Retrieves IMSS event history from LMS.

OUT s EventHistory:

event history string