HLAPI

This exception is thrown when an error is returned from AccessMonitor.

Initializes a new instance of the AccessMonitorManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user on how to solve the error. The status code that returns from the network call. Inner exception wrapped by this one.

Initializes a new instance of the AccessMonitorManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user on how to solve the error.

Initializes a new instance of the AccessMonitorManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user on how to solve the error. Inner exception wrapped by this one.

Access Monitor failure types.

Unknown error.

User does not have permission to perform any function.

The log is locked already.

Input Parameters are invalid.

Signature was not authenticated with the certificate.

Invalid log state, the log is disabled or there is no key.

The operation is not supported.

ACL failures.

The user does not have permissions to perform the action.

User name does not exist in the Intel AMT or in the active directory.

The inserted user name is invalid.

The inserted password is invalid.

The user entry already exists.

The max limit of users reached.

The realm is invalid.

The Audit log user already exists.

General error.

This exception is thrown when an error is returned from the ACL.

Constructor

Message string. The name of the function that causes the error. Inner exception wrapped by this one. The address of the machine that causes the error. The failure type. The status code that returns from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. The status code that returns from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that caused the error. The address of the machine that caused the error. The failure type. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that caused the error. The address of the machine that caused the error. The failure type. Counsel for the user how to solve the error. Inner exception wrapped by this one.

This exception is thrown when an error is returned from Agent Presence.

Initialize a new instance of the AgentPresenceManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error. The status code that return from the network call. Inner exception wrapped by this one.

Initialize a new instance of the AgentPresenceManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Initialize a new instance of the AgentPresenceManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error. Inner exception wrapped by this one.

Agent Presence failure types.

Unknown error.

Limit reached.

Not supported.

Agent does not exist.

Policy does not exist.

There has been such agent.

This exception is thrown when an error is returned from AlarmClock.

Initialize a new instance of the AlarmClockManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error. The status code returned by the network call. Inner exception wrapped by this one.

Initialize a new instance of the AlarmClockManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Initialize a new instance of the AlarmClockManageabilityException class.

Alarm Clock failure types.

Entry does not exist.

The operation was not supported by the Intel AMT Version.

The Input Parameters are invalid.

Unknown error.

Limit reached.

Certificate Management failures.

Cannot create a new private key - number of private keys is limited.

Invalid certificate.

Certificate does not exist in the Certificates store.

Operation is not supported by the current Intel AMT machine

Certificate cannot be removed if it is referenced.(for example: used by TLS, 802.1x or EAC).

General error.

This exception is thrown when an error is returned from CertificateManagement.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user on how to solve the error.

Constructor

This exception is thrown when an error is returned from the HBP use cases

Constructor

Message string. The name of the function that causes the error. Inner exception wrapped by this one. The address of the machine that causes the error. The failure type. The status code that return from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. The status code that return from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error. Inner exception wrapped by this one.

HBP Failures

Host based Setup not supported.

Unprovision failed.

EventLog failures

Success

Unspecified Error.

Timeout.

Not Supported

Flash Write Limit Exceeded.

Event Log Frozen.

When filter in use by subscribe, his value cannot be update.

Filter is not exist in the event log

Invalid Input.

This exception is thrown when an error is returned from EventLog.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error. The status code that return from the network call. Inner exception wrapped by this one.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error.

Constructor

Events failures.

There is already a same subscription.

The machine does not support IPv6 address.

Cannot create a new subscription - number of subscribers is limited.

Cannot update or delete the filter that was created automatically by Intel AMT (with filter that was created automatically by Intel AMT (with PolicyID 134).

General error.

Illegal value

WSEvents general error

PETEvent general error

This exception is thrown when an error is returned from PETEvents.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

PETEvents failures

There is already a same subscription.

The machine does not support IPv6 address.

Cannot create a new subscription - number of subscribers is limited.

Cannot create a new filter - number of filters is limited.

Filter with the inserted policyID, does not exist.

subscription with these parameters values does not exist.

Cannot update or delete the filter that was created automatically by Intel AMT (with filter that was created automatically by Intel AMT (with PolicyID 134).

Illegal input.

General error.

This exception is thrown when an error is returned from PETEvents.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

WSEvents failures.

General Error.

Input parameter is invalid (general error, in case schema validation was not used).

Feature not supported .

Profile name was not found.

This exception is thrown when an error is returned from WSEvents.

Constructor

Message string. The name of the function that caused the error. The address of the machine that caused the error. The failure type. Counsel for the user how to solve the error.

Constructor

General Info failures.

Unspecified Error.

Not Supported.

This exception is thrown when an error is returned from GeneralInfo.

Constructor

Message string. The name of the function that causes the error. Inner exception wrapped by this one. The address of the machine that causes the error. The failure type. The status code that return from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error.

Constructor

An exception occurred in the HLAPI. All other classes in the Exceptions namespace inherit from this class.

Constructor.

Message string.

Constructor

Message string. Inner exception wrapped by this one.

Constructor

Message string. The name of the application or the object that causes the error.

Constructor

Message string. Inner exception wrapped by this one. The name of the application or the object that causes the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

The address of the machine that causes the error.

The failure type.

The status code that return from the network call.

Tip for the user how to solve the error.

This exception is thrown when a feature is not supported by the Intel AMT system.

Constructor.

Message string.

Constructor

Message string. Inner exception wrapped by this one.

This exception is thrown when a user sets an invalid value.

Constructor.

Message string.

This exception is thrown when an error is returned from imrsdk.dll.

The error returned from the imrsdk.dll

Constructor

Message that describes the current exception Error returned from imrsdk.dll.

Constructor

Message that describes the current exception Error returned from imrsdk.dll. Inner exception wrapped by this one.

KVM failures

KVM Disabled in the MEBX

Failed to perform requested state change

RFB Password is empty

KVM general error

the Screen is unConnected in the AMT

NotSupported

Default Port Not Supported

This exception is thrown when an error is returned from KVM.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

NetworkAdmin failures.

This exception is thrown when an error is returned from NetworkAdmin.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

PowerPackages failures

This exception is thrown when an error is returned from PowerPackages.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

An enum of remote access failures.

There is aleady a same trigger type.

Cannot create a new MPS - number of MPSs is limited.

MPS with the inserted address or trigger type does not exist.

Certificate should be a client certificate.

Invalid parameters supplied.

General error.

This exception is thrown when an error is returned from RemoteAccess.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error. The status code that returns from the network call. Inner exception wrapped by this one.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Constructor

RPE failures.

General error.

The operation is not allowed in the current state.

The operation is not supported.

Represents the RPE exception.

Constructor

Message string. The name of the function that causes the error. Inner exception wrapped by this one. The address of the machine that causes the error. The failure type. The status code that return from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error.

Constructor

System Defense failures

A policy with the given name does not exist

Attempt to update a policy that wasn't changed

A policy with the given name appears more than once

The policy is already enabled

No policy is enabled

No policy is active

Attempted to use a network interface that is not enabled

Attempted to create or activate a policy or filter beyond the Intel AMT capabilities limit

Failed to perform an action. See the inner exception for more information about the WS-Mangement fault

Attempted to use class that is not supported

Internal error

This exception is thrown when an error is returned from SystemDefense.

The policy name (null when not relevant)

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user on how to solve the error. The policy name (null when not relevant).

Constructor

This exception is thrown when an error is returned from UserConsent.

Initializes a new instance of the UserConsentManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error. The status code that returns from the network call. Inner exception wrapped by this one.

Initializes a new instance of the UserConsentManageabilityException class.

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Tip for the user how to solve the error.

Initializes a new instance of the UserConsentManageabilityException class.

User Consent failure types.

Unknown error.

InvalidState failure will occur when: 1. Trying to start User Consent flow while User Consent State is Requested Code, Display Code, Received Code or In Session. 2. Trying to send Consent Code while User Consent State is Not Started, Requested Code, Received Code or In Session. 3. Trying to stop User Consent flow while User Consent State is Not Started or In Session.

The Start Consent Flow was started tree time without sending the consent code after it.

Input Parameters are invalid.

Consent Code is wrong.

If Intel AMT was set up locally and is in Client Control mode, cannot change User Consent policy.

The functiom is not supported on this Intel AMT Release.

Unknown\General error.

Invalid input parameter.

Not supported.

Connection error.

There is not enough free space in the storage.

Constructor

Message string. The name of the function that causes the error. Inner exception wrapped by this one. The address of the machine that causes the error. The failure type. The status code that return from the network call. Counsel for the user how to solve the error.

Constructor

Message string. The name of the function that causes the error. The address of the machine that causes the error. The failure type. Counsel for the user how to solve the error.

Constructor

Wireless failures

General Error.

Input parameter is invalid (general error, in case schema validation was not used).

Feature not supported .

Profile name was not found.

The wireless profile is active, therefore, update / delete operation is forbidden.

An error has occurred while adding the certificate.

Get OS Admin failed.

Number of created profiles has reached maximum limitation. For IT Profiles - 16. For User Profiles - 8.

This exception is thrown when an error is returned from Wireless.

Constructor

Message string. The name of the function that caused the error. The address of the machine that caused the error. The failure type. Counsel for the user how to solve the error.

Constructor

Lock log to stop logging any records to allow unprovisioning.

LogLockType, The locking type. The maximum number (in seconds) that the audit log will be locked, Max value is 5 minutes. int, lock handle used either to free the lock or to extend the lock time when the log has been locked.

Lock log to stop logging any records to allow unprovisioning.

LogLockType, The locking type. The maximum number (in seconds) that the audit log will be locked, Max value is 5 minutes. lock handle, This overload is useful to extend the lock time when the lock has been locked. int, new lock handle used either to free the lock or to extend the lock time when the log has been locked.

Stop logging any records to allow unprovisioning.

the lock handle returned from the lock operation.

Read the Audit log records. While reading the log it locks it from logging any records.

List of AuditRecord, all audit log records.

EventDetails, Describes Audited events properties.

eventsDetails, Describe Audited events properties. From Intel AMT versions 7.0 and later, there is an option to add multiple events at once. so in pre-7.0 releases set each event separately, and in later releases set all events at once.

Disable auditing of events.

string, events names.

Disable auditing of events.

From Intel AMT versions 7.0 and later, there is an option to add multiple events at once. so in pre-7.0 releases set each event separately, and in later releases set all events at once. Collection of strings, events names.

Get events definitions will be audited to the log.

EventDetails list, describing event definitions for each audited event.

Set storage policy that determines what happens when the audit log is full.

StoragePolicy, the storage policy.

Set storage policy that determines what happens when the audit log is full.

StoragePolicy, the storage policy. int, Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

Get audit log settings.

AuditLogSettings, contains all audit log settings.

Set the certificate and key used to generate an audit log signature when the Auditor requests an export of a signature. For Intel AMT pre-8.0 releases this action must be done before enabling auditing.

The certificate hex string The Private key to the certificate

The certificate with private key. this certificate will be returned when calling the function "ReadLogReliably" to assure reliability of the log.

The certificate hex string The Private key to the certificate

the certificate chain matching the private key. Up to 5 certificates (with a total length of 4100 bytes). These certificates will be returned when calling the function "ReadLogReliably" to assure reliability of the log.

Enable / Disable the auditing. For Intel AMT pre-8.0 releases required to set log signing before enabling auditing.

bool, flag indicates if the auditing will be enabled or not

Read the audit log and verify the digital signature to assure reliability of the log.

X509Chain, The chain of certificates are used to sign the audit log. string, UUID of the current system for identifying it in the audit repository. string, FQDN of the system. List of AuditRecord, all audit log records.

Read the audit log and verify the digital signature to assure reliability of the log.

X509Chain, The chain of certificates are used to sign the audit log. string, UUID of the current system for identifying it in the audit repository. string, FQDN of the system. Hash algorithm used to export the audit log signature. If the sent algorithm was not supported by the current AMT Release, Sha1 will be set. List of AuditRecord, all audit log records.

Read the audit log and verify the digital signature to assure reliability of the log.

X509Chain, Chain of certificates to verify the reliability of the certificates that are used to sign the audit log. string, UUID of the current system for identifying it in the audit repository. string, FQDN of the system. List of AuditRecord, all audit log records.

Read the audit log and verify the digital signature to assure reliability of the log.

Convert WS-Man events to HLAPI events.

list of WS-Man events. list of events details.

Convert external event object to WS-Man event. Gets the appropriate group id and event id for the event name.

HLAPI event details Flag indicates if the event will be enabled. Collection of WsmanEventDetails, event details to register the audit log.

Convert external event object to WS-Man event. Gets for event name the appropriate group id and event id.

Event Name Flag indicates if the event will be enabled. WsmanEventDetails, event details to register the audit log.

Get hash name by hash type.

hash type. hash name

Get hash length by hash type.

hash type. hash length

Log audit log.

lock type number frame time in seconds to lock the log

Clear log.

Read all records.

List of strings, all log records as collection of string

Set multiple events to register to audit log at once. NOTE: Support from AMT releases 7.0 and later.

List of events

Set event to register to log.

event details

Get events definitions will be registered to the log.

EventsDetails list, describing event definitions for each audited event.

Enable / Disable the auditing.

the state number to set the auditing.

Get access monitor settings.

AccessMonitorSettings, contains all access monitor settings.

Set the certificate and key used to generate an audit log signature when the Auditor requests an export of a signature.

certificates chain

Set storage policy that determines what happens when the audit log is full.

int, the storage policy flag. int, Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

Parse date string to DateTime object.

date string DateTime object.

Parse pt-status that returned from set events state operation, and throw appropriate exception.

pt-status from set events state operation. Name of the method which caused the error.

Parse pt-status that returned from lock log operation, and throw appropriate exception.

pt-status from lock log operation. uint?, handle returned from the locking call string, the operation name which was failed.

AccessMonitor Interface.

Clear the entire log.

Stop logging any records for allowing unprovisioning.

the lock handle returned from the lock opration.

Read the Audit log records. while reading the log it locks from logging any records.

string, UUID of the current system for identifying it in the audit repository. string, FQDN of the system. AuditLogRecord, Properties of one record in the log.

Enable auditing of events.

EventsDetails, Describe Audited events properties.

Enable auditing of events.

EventsDetails, Describe Audited events properties.

Disable auditing of events.

string, Specifies event name returns from EventsName struct.

Disable auditing of events.

Collection of strings, Specifies events name returns from EventsName struct.

Get events definitions will be audited to the log.

EventsDetails list, describing event definitions for each audited event.

Set storage policy that determines what happens when the audit log is full.

StoragePolicy, the storage policy.

Set storage policy that determines what happens when the audit log is full.

The Chosen policy. int, Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

Get the access monitor settings.

AccessMonitorSettings, the access monitor settings.

The certificate hex string The Private key to the certificate

The certificate with private key. this certificate will be returned when calling the function "ReadLogReliably" to assure reliability of the log.

The certificate chain includes private key for the leaf certificate. Up to 5 certificates (with a total length of 4100 bytes). these certificates will be returned when calling the function "ReadLogReliably" to assure reliability of the log.

Enable / Disable the auditing. For Intel AMT pre-8.0 releases required to set log signing before enabling auditing.

Read the audit log and verify the digital signature to assure reliability of the log.

Event specific data defined for each event in the Auditable Events table.

Initializes a new instance of the class.

The value as byte array format.

Friendly name for the value.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Describe Audited events properties.

Initializes a new instance of the struct.

Specifies event name.

A flag indicating the type of event policy, indicating if the policy is defined as critical or none.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Describes audit log settings.

Initializes a new instance of the struct.

LogState, state of log. bool, flag indicates if auditing is enabled. DateTime, time stamp of the most recent entry in the log if such an entry exists. int, indicates the percentage of free space in the storage dedicated to the audit log. int, current records number in the log. int, maximum number of auditors allowed. EventsStoragePolicy, determine what happens when the audit log is full. int, Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

State of log.

Flag indicates if auditing is enabled.

Time stamp of the most recent entry in the log if such an entry exists.

Indicates the percentage of free space in the storage dedicated to the audit log.

Current records number in the log.

Maximum number of auditors allowed.

Determine what happens when the audit log is full.

Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Describes record properties from the log.

Specifies event name.

Type of the event's trigger.

Contains the username of the Initiator if the AuditlogInitiator is equal to HttpDigest. Contains the SID of the Initiator if the AuditlogInitiator is equal to Kerberos.

Contains the domain of the Initiator if the AuditlogInitiator is equal to Kerberos.

Time when the event occurred.

Address of the machine that initiated the event.

Event specific data defined for each event in the Events table. For events that do not have extended data - this value will be equal to null.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal.

true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance. 2

Indicates whether one dictionary and a other dictionary object are equal.

Describes events that can be audited.

Describes the events of SecurityAdmin.

Describes the events of RemoteControl.

Describes the events of Redirection.

Describes the events of FirmwareUpdate.

Describes the events of SecurityAuditLog.

Describes the events of NetworkTime.

Describes the events of NetworkAdministration.

Describes the events of StorageAdministration.

Describes the events of EventManager.

Describes the events of SystemDefence.

Describes the events of AgentPresence.

Describes the events of WirelessConfiguration.

Describes the events of EAC.

Describes the events of KVM.

Describes the events of UserConsent.

Hash algorithm used to export the audit log signature.

Sha1

SHA2-256. Using this hash depends on both the Intel AMT Release and OS. AMT release supports this hash from 6.0 releases and later.

SHA2-384. Using this hash depends on both the Intel AMT Release and OS. AMT release supports this hash from 6.0 releases and later.

Defines the locking action

Standard lock log.

Lock for allowing unprovisioning of Intel AMT.

Indicates the type of policy. indicates if the policy is defined as critical.

Non-critical policy.

Critical events will not be executed when the event cannot be logged. This state will occur when the log is locked or full, and the StoragePolicy set to NoRollOver or to RestrictedRollOver.

Determines what happens when the audit log is full.

The oldest events in the log cannot be ovewritten. Thus, Intel AMT prevents critical events from completing, since they cannot be logged.

Intel AMT writes over the oldest event in the log when a new event occurs.

Intel AMT writes over the oldest event in the log when a new event occurs, as long as that event has been in the log longer than a minimum period, specified in the KeepDays property.

EventsStoragePolicy property is not supported on this Intel AMT release.

State of log - can be used as bitmap.

The log is enabled.

The log is diabled.

The log is locked.

The storage area dedicated for the audit log reached 85% full, and non-critical events will not be logged.

The storage area dedicated for the audit log is completely full. No events will be logged and critical events in policy will not be executed

No key and certificate were set for the signing of the audit log. Feature cannot be enabled

The initiator factors the event.

Digest user.

Kerberos user.

Local event.

KVM Default Port.

Log audit log.

lock type number frame time in seconds to lock the log

Clear log.

Read all records.

string[], all log records as string array

Set event to register to log.

events details

Set event to register to log.

events details

Get events definitions will be audited to the log.

EventsDetails list, describing event definitions for each audited event.

Enable / Disable the auditing.

the state number to set the auditing.

Set events storage policy.

int, policy type int, Restriction days to keep records in the AuditLog. Relevant only if "storagePolicy" is set to RestrictedRollOver.

Get access monitor settings.

AccessMonitorSettings, all access monitor settings

Set the certificate and key used to generate an audit log signature when the Auditor requests an export of a signature.

certificates chain

Event as a template to be sent to the Intel AMT.

Initializes a new instance of the WsmanEventDetails class.

Application ID Event ID Policy ID string indicates if the event will be enabled .

The application id and the event id are linked.

Application ID

Event ID

Policy ID

Flag indicates if the event will be enabled.

Certificate as a template to be sent to the Intel AMT.

Private key as SecureString.

Certificate as base64 string

The length of the certificate.

Audit log is supported only from AMT 4.1 - validate it

Make sure the user name is valid (this is additonal validation, depend on the FW version (hence it cannot be delted in the user name property)

Parse the return value and throw appropriate exception

Return user entry parameters

The handle of the entry to find Out params - the user name Out params - the password, as byte[] Out params - the kerberos SID Out params - the access permission Out params - list of realms

Return a digest entry object from the specified handle

Return a kerberos entry object from the specified handle

Indicates whether the User is allowed to access Intel(R) AMT from the Network or Local Interfaces.

Represent the Local interface.

Represent the Network (Remote) interface.

Represent both Local and Network interfaces.

Interface names that the ACL entry is allowed to access.

Represent the redirection realm

Represent the administrator realm

Represent the Hardware Asset realm

Represent the Remote Control realm

Represent the Storage realm

Represent the Event Manager realm

Represent the Storage Administration realm

Represent the Agent Presence (Local) realm

Represent the Agent Presence (Remote) realm

Represent the Circuit Breaker realm

Represent the Network Time realm

Represent the General Info realm

Represent the Firmware Update realm

Represent the EIT realm

Represent the Local UN realm

Represent the Endpoint Access Control realm

Represent the Endpoint Access Control (Admin) realm

Represent the Event Log Reader realm

Represent the Audit Log realm

Represent the User Access Control realm

Represent the Local System realm

Digest User entry struct

Digest User Name. A username must contains 7-bit ASCII characters, in the range of 33-126, excluding ‘:’, ‘,’, ‘<’, ‘>’, ‘&’, and ‘”’ characters. The string length is limited to 16 characters. It cannot be an empty string. The strings "Administrator" (Release3.2 only) and "Admin" (Release 4.0 and later releases) and strings that start with "$$" are invalid.

The password to the user, this property is private since when getting a user name the password is always null or empty, so no need this property when retrieving a user.

List of realms for the user

The user access permission

The only constructor, that get all the required parameters.

Provide an easy way to copy the Digest entry object.

Provide an easy way to compare between two the Digest entries.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal. true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to.

Represent a Kerberos user entry

Kerberos user name (domain\user) or SID string in base64 format

List of realms for the user

The user access permission

Full constructor.

Provide an easy way to copy the Kerberos entry object.

Provide an easy way to compare between two entries.

Indicates whether the current object is equal to another object of the same type.

true if the current object is equal to the parameter; otherwise, false. An object to compare with this object.

Indicates whether this instance and a specified object are equal. true if and this instance are the same type and represent the same value; otherwise, false. Another object to compare to.

Validate the kerberos user name entry

This class presents a user entry functionality

Update a user entry

Create a user entry

Delete a user entry

Retrieve a list of user entries

Get a user entry

Provide an API for the ACL configuration feature

Add a new Digest user, given a username and password.

Digest user entry - username and password for user identification.

Retrieve a digest user entry of a given username.

The Digest entry according to the given user name

Remove a digest user.

The user name to remove

Retrieve an array of ACL digest user entries.

List of Digest entries

Add a new Kerberos user to the system, given the SID of an Active Directory User or Group or the user name (domain\user).

User entry - Active Directory SID to identify a user or group of users.

Retrieve a kerberos user entry of a given username or SID.

The Kerberos entry acording to the given user name \ SID

Remove a kerberos user.

The user name (should be in domain\user format), or SID

Retrieve an array of ACL kerberos user entries.

List of the Kerberos entries

Update the admin username and password.

Username for access control. String length is limited to 16 characters. Username cannot be an empty string. Include if the Password is to be changed

Retrieve the admin parameters.

Represent a digest user funtionality

Represent a kerberos user funtionality

Update the admin parameters

Retrieve the admin user name

Retrieve the user entry digest realm

Get kerberos user by his handle, if the handle handles digest user return empty KerberosEntry.

uint, specifies the user entry to get. KerberosEntry, a kerberos user descriptor.

Get digest user by his handle, if the handle handles kerberos user return empty DigestEntry.

uint, specifies the user entry to get. DigestEntry, a digest user descriptor.

Get UserName or Sid of specific handle.

uint, specifies the user entry to get. string, UserName or Sid.

Get all handles of ACL users.

uint[], handles of all the users.

Update a kerberos user entry

The entry to update Should be null, since this parameter is not required for kerberos

Create a new kerberos user entry

The entry to add Should be null, since this parameter is not required for kerberos

Delete a kerberos entry by its name

Return a list of the kerberos entries

Get a kerberos user entry from a given user name

Update a digest user entry

The digest password

Create new digest user

The user entry with the parameters The digest password

Return list of all digest entries

Return a digest user entry

Represents the kerberos user WS-Man functionality implementation

Update a kerberos user entry

The entry to update Should be null, since this parameter is not required for kerberos

Create a new kerberos user entry

The entry to add Should be null, since this parameter is not required for kerberos

Delete a kerberos entry by its name

Return a list of the kerberos entries

Get a kerberos user entry from a given user name

Represents the digest user WS-Man functionality implementation

Update a digest user entry

The digest password

Create new digest user

The user entry with the parameters The digest password

Delete a given ACL entry

Return list of all digest entries

Return a digest user entry

Provides interface for Agent Presence functionality.

Include the remote interface.

Include the local interface.

Include the remote interface.

Create or Update an Agent Presence agent.

Agent, represents the agent properties.

Delete an agent.

string, The monitored application name.

Delete all agents.

Get a selected agent.

string, The monitored application name. Agent

Return all the agents.

Agent, Collection of agents.

Query the Agent Presence feature capabilities.

AgentPresenceCapabilities, struct of capabilities.

Set an Agent Watchdog’s System Defense Policy.

string, The policy name (to create a System Defense policy, see the System Defense feature). NetworkInterface, An identifier for the System Defense network interface.

Get the System Defense policy associated with a watchdog

NetworkInterface, An identifier for the System Defense network interface.

Remove an Agent Watchdog’s System Defense Policy.

NetworkInterface, An identifier for the System Defense network interface.

Set the expiration action.

WatchDogExpirationAction, the expiration action to be set.

Get the expiration action.

WatchDogExpirationAction, the properties of Expiration Action feature.

Apply expiration action on agent.

string, the name of the agent to apply action on. bool, determine if action should be applied or not on the agent.

Include the local Interface.

string, The monitored application name.

Shutdown an agent.

Expire an agent.

Cancel Reboot operation following WD expiration, can be applied during the timeout period.

Describe the properties of one action.

Initialize a new instance of the AgentAction class.

AgentState enum, The last state of the application. AgentState enum, The current state of the application. Bool, Specifies whether an Event should be created by the Event Manager. ActionSystemDefense, Specifies whether to activate or deactivate a System Defense policy. Bool, Specifies whether agent status should be included in EAC postures.

Initialize a new instance of the AgentAction class.

AgentState enum, The last state of the application. AgentState enum, The current state of the application. Bool, Specifies whether an Event should be created by the Event Manager. Bool, Specifies whether agent status should be included in EAC postures.

Initialize a new instance of the AgentAction class.

AgentState enum, The last state of the application. AgentState enum, The current state of the application. Bool, Specifies whether an Event should be created by the Event Manager.

The old state of the application.

The new state of the application

Specifies whether an Event should be created in the Event Manager.

Specifies whether the System Defense policy should be activated or deactivated.

Specifies whether agent status should be included in EAC postures, This is an internal property. It was added after the initial release of Agent Presence API. It is used for Intel AMT versions greater than Release 4.0 that do not support actionEAC (for example, the Intel SBT SKU) that should set actionEac to null.

Specifies whether agent status should be included in EAC postures.

Compares two AgentAction objects.

An Action instance to compare. An Action instance to compare. true if the two actions are equal; otherwise, false

Compares two AgentAction objects.

An Action instance to compare. An Action instance to compare. false if the two actions are equal; otherwise, true

Compares two AgentAction objects.

An Action instance to compare to the current instance. true if the two actions are equal; otherwise, false

Compares two AgentAction objects.

An Action instance to compare to the current instance. true if the two actions are equal; otherwise, false

Returns a hash value for an Action.

An integer hash value.

Describe the properties of one agent.

Initialize a new instance of the Agent class.

string, The monitored application name. List of AgentAction, Collection of actions. int, A seconds timer value that specifies the maximum time allowed for an application to start up. int, A seconds timer value that specifies the maximum time allowed between application heartbeat calls.

string, The monitored application name.

List of AgentAction.

ushort, seconds timer value that specifies the maximum time allowed for an application to start up.

ushort, seconds timer value that specifies the maximum time allowed between application heartbeat calls.

AgentState, the current state of the agent.

string, the AgentID's GUID for the monitored application.

int, resolution of the timer. For example, if this value is 100, then the timer can expire anytime between (TimeoutInterval- 100) microseconds or (TimeoutInterval+100) microseconds. not supported in all Intel AMT versions.

int, enabledState is an integer enumeration that indicates the enabled and disabled states of an element. not supported in all Intel AMT versions.

int, the entity that is currently being monitored by the Watchdog. not supported in all Intel AMT versions.

Compares two Agents

An Agent instance to compare. An Agent instance to compare. true if the two agents are equal; otherwise, false

Compares two Agents

An Agent instance to compare. An Agent instance to compare. false if the two agents are equal; otherwise, true

Compares two Agents

An Agent instance to compare to the current instance. true if the two agents are equal; otherwise, false

Compares two Agents

An Agent instance to compare to the current instance. true if the two agents are equal; otherwise, false

Returns a hash value for a Agent.

An integer hash value.

Describe the Agent Presence capabilities.

Initialize a new instance of the AgentPresenceCapabilities class.

int, the maximum number of agents that can be registered on the Intel AMT device. int, the maximum number of actions that can be defined (altogether) on the Intel AMT device. int, the minimum number of actions that is guaranteed for every Agent on the Intel AMT device. int, the maximum number of Agent Presence's agents that are configured to support EAC action.

Initialize a new instance of the AgentPresenceCapabilities class.

The maximum number of agents that can be registered on the Intel AMT device.

The maximum number of actions that can be defined (altogether) on the Intel AMT device.

The minimum number of actions that are guaranteed for every Agent on the Intel AMT device.

The maximum number of Agent Presence's agents that are configured to support EAC action.

Describe the WatchDog expiration action.

Initialize a new instance of the WatchDogExpirationAction class.

ExpirationAction, the action to invoke upon OS Watch dog expiration. ExpirationAction, the action to invoke upon Agent Presence Watch dog expiration. ushort, how long to wait (in seconds) before applying HeciWatchDogExpirationAction or AgentPresenceWatchDogExpirationAction. bool, the action to enable next reset. Allows to the manageability to perform reset again.

Initialize a new instance of the WatchDogExpirationAction class.

ExpirationAction, the action to invoke upon OS Watch dog expiration. ExpirationAction, the action to invoke upon Agent Presence Watch dog expiration. bool, the action to enable next reset. Allows to the manageability to perform reset again.

Initialize a new instance of the WatchDogExpirationAction class.

ExpirationAction, the action to invoke upon OS Watch dog expiration. ExpirationAction, the action to invoke upon Agent Presence Watch dog expiration.

The action to invoke upon OS Watch dog expiration.

The action to invoke upon Agent Presence Watch dog expiration.

How long to wait (in seconds) before applying HeciWatchDogExpirationAction or AgentPresenceWatchDogExpirationAction. Default value is 30 seconds.

The action to enable next reset. Allows to the manageability to perform reset again.

The state of the agent - can be used as a bitmap.

Any state

The associated application was not started.

The associated application is stopped.

The associated application is running.

The associated application failed to reset the watchdog expiration timer.

The host platform running the application is in an Sx state.

A System Defense Action that may be applied.

Specifies that a System Defense policy should be activated

Specifies that a System Defense policy should be deactivated.

Network interface.

Wired interface

Wireless interface

The action to invoke on expiration.

Stands for no action

Sands for reset of the machine

Provide access to AlarmClock operations.

Constructor

An AMT instance

Configure a single wake on

Next alarm time, UTC format. Note: The furthest time that can be represented is 03:14:07 UTC on Tuesday, 19 January 2038.

Configure a single wake on

Alarm time, UTC format. Note: The furthest time that can be represented is 03:14:07 UTC on Tuesday, 19 January 2038.

Configure a recurring wake on.

Setting the recurring wake on. Note: The furthest time that can be represented is 03:14:07 UTC on Tuesday, 19 January 2038. Interval string in format PnYnMnDTnHnMnS

Configure a recurring wake on

DateTime, Setting for a recurring wake on. Note: The furthest time that can be represented is 03:14:07 UTC on Tuesday, 19 January 2038. AlarmInterval, setting for the interval

Disable the Alarm Clock (by reset both NextAlarm time and Interval)

Get the setting for the next wake on and next interval. Note that if settings do not exist in the target system, NextAlarmTime will return DateTime.MinValue, and Interval will return null.

Time and interval settings for the next wake up.

Connect to this event to receive status on the redirection connection.

Connect to this event to receive status on the SOL/IDER connection.

Describes an Intel AMT machine and provides properties and methods for managing the system, for COM interface.

AMTInstance constructor

A delegate for SOL event

The sender SOL event arguments

Connect to this event to receive status on the SOL connection.

A delegate for IDER event

The sender IDER event arguments

Connect to this event to receive status on the IDER connection.

Represents the Intel AMT system being operated upon.

The WS-Management communications client, available so that users of the library can do low-level WS-Management operations on the same connection if they so desire.

Provides features supported by this Intel AMT system.

the major version of the AMT

the minor version of the AMT

Provides control over the power state, including shutdown and reboot.

Provides access to the General Info features.

Provides access to the Hardware Inventory features.

Provides access to the Storage Administration operations (usually requires separate permissions from the Storage operations).

Provide using the storage as file system.

Provides access to the AccessMonitor operations

Provides access to the AccessMonitor operations.

Provides access to the Remote Platform Erase operations.

Provides access to the Storage operations.

Provides access to the RedirectionSOL operations.

Provides access to the RedirectionIDER operations.

Provides access to the Boot control operations.

Provide access for KVM operations.

Provide access for AlarmClock operations.

Provides access to the System Defense operations.

SupportsFeatures has been deprecated. Please use SupportedFeatures. Returns true if the features listed are supported by the Intel AMT system.

The list of features (as bit flags) to be checked if they are supported or not. True if all the features are supported, false otherwise.

This is the default way to create an AMT Instance object, where all that is passed is the connection information and the library chooses the transport mechanism.

Connection information for the host.

Create a connection that uses a specified transport.

Connection information for the host. The transport to use. Currently only ManagedSystem.TRANSPORT_WS_MAN is supported.

Create a connection using the specified transport and the specified certificate password.

Connection information for the host. The password to use with the certificate. The transport to use. Currently only ManagedSystem.TRANSPORT_WS_MAN is supported.

This provides KVM control

Constructor

AMT instance

Change KVM state to the value in the state parameter.

KVM port states: Default KVM port only (5900) - no longer supported, see remarks, Redirection ports only (16994 and 16995), all ports, or KVM disabled OK if the KVM state was succesfully changed NOTE:KVM Default port (5900) is no longer supported, starting from the following releases. KabyLake: 11.8.94 CannonLake: 12.0.93 CometLake: 14.1.70 TigerLake: 15.0.45 AlderLake, RaptorLake: 16.1.25 Attempting to configure a RFB password or enabling the port via IPS_KVMRedirectionSettingData.PUT will return unsupported message.

Set the RFB password

The password must be 8 characters long and contain at least 1capital letter, regular letter, digit and special character NOTE:KVM Default port (5900) is no longer supported, starting from the following releases. KabyLake: 11.8.94 CannonLake: 12.0.93 CometLake: 14.1.70 TigerLake: 15.0.45 AlderLake, RaptorLake: 16.1.25 Attempting to configure a RFB password or enabling the port via IPS_KVMRedirectionSettingData.PUT will return unsupported message.

Set the opt in timeout

The valid range is 10 to 4095 seconds - default is 300 seconds

Set the TCP session timeout

Maximum value is 255 minutes

Set the default visible monitor

The screen to set

Set the opt in policy

Indicate whether to enable or disable the Opt-In

Retrieve KVM capabilities values

KVM capabilities

True if the KVM interface is enabled on the Intel AMT system. This field will not check whether the KVM is enabled in the MeBX

Enable \ disable the KVM interface.

Indicates whether there is an open session. Note: This data is used the KVM interface state. if the state is EnabledButOffline - indicates there is no open session, if the state is Enable - indicates the interface is enable but no open session.

Open - if KVM has open session, Close - if there is not open session

Provides control over the power state, including shutdown and reboot.

Constructor

AMT instance

Retrieve the current system power state. Note: GetSystemPowerState Method has been deprecated. Please use GetOSPowerState.

Retrieve the current OS power state (Real power state + Power saving state).

Power up the system.

Shut down the system.

Causes a reset of the system. This includes resetting Intel AMT.

Shut down the system and then reboot.

Put the system to sleep.

Hibernate the system.

Gracefully shut down the system.

Cause a graceful reset of the system. This includes resetting Intel AMT.

Cause a blue screen of death.

Retreive a set of transitions that are allowed in currentState.

The state we are assumed to be in. The states which we are allowed to transition to.

Retrieve a set of transitions that are allowed in the Intel AMT system's current state. This retieves the state from the Intel AMT system first.

The states which we are allowed to transtion to.

Retreive a set of transitions that are allowed in currentState.

The state we are assumed to be in. The states which we are allowed to transition to.

Retrieve a set of transitions that are allowed in the Intel AMT system's current state. This retieves the state from the Intel AMT system first.

The states which we are allowed to transtion to.

Serial Over LAN (SOL) redirection control.

costructor

Redirection instance

SOL event

The sender The SOL event arguments

Start the SOL session. Throws an exception if a session is active already.

The timeout parameters to use for this connection.

Start the SOL session. Throws an exception if a session is active already.

The timeout parameters to use for this connection.

Start the SOL session. Throws an exception if a session is active already. Will use the default parameters for timeout

Stop the SOL session. Does nothing if no session is active.

Write a text in the SOL session

The test to send to the SOL session

Write a text in the SOL session

The test to send to the SOL session

Retrieve current state of the session from the library - does not connect to Intel AMT.

Retrieve the current timeout settings.

Connect to this event to receive status on the SOL connection.

True if the SOL/Storage Redirection (IDE-R\USB-R) interface is enabled on the Intel AMT system. This field will not check whether the SOL/Storage Redirection is enabled in the MeBX

Enable/ disable the SOL/Storage Redirection (IDE-R \ USB-R) interface.

Releases resources used by the SOL object.

Storage Redirection (IDE-R\USB-R) control.

constructor

Redirection instance

Starts storage redirection (IDE-R \ USB-R). Saves and restores the current state of the Intel AMT redirection listener. The listener will be enabled automatically if it is not already. This method throws an exception if a session is already active.

Device or image file for CD image. Device or image file for floppy image. Timeout that will be used for the storage redirection session

Device or image file for CD image. Device or image file for floppy image. Timeout that will be used for the storage redirection session State that will be used for storage (IDE\USB) devices

Device or image file for CD image. Device or image file for floppy image. State that will be used for storage (IDE\USB) devices

Device or image file for CD image. Timeout that will be used for the storage redirection session

Device or image file for CD image. Timeout that will be used for the storage redirection session State that will be used for storage (IDE\USB) devices

Device or image file for CD image. State that will be used for storage (IDE\USB) devices

Device or image file for floppy image. Timeout that will be used for the storage redirection session

Device or image file for floppy image. Timeout that will be used for the storage redirection session State that will be used for storage (IDE\USB) devices

Device or image file for floppy image. State that will be used for storage (IDE\USB) devices

Device or image file for CD image. Device or image file for floppy image.

Device or image file for CD image.

Device or image file for floppy image.