@device-management-toolkit/wsman-messages 5.9.4

package/amt/messages.d.ts

@@ -0,0 +1,466 @@
+/*********************************************************************
+ * Copyright (c) Intel Corporation 2021
+ * SPDX-License-Identifier: Apache-2.0
+ **********************************************************************/
+import { CIM } from '../';
+import { Base, WSManMessageCreator } from '../WSMan';
+import { Classes } from './';
+import type { Models, Types } from './';
+import type { IPS } from '../';
+import type { Selector } from '../WSMan';
+declare class AlarmClockService extends Base {
+    className: Classes;
+    /**
+     * This method creates an alarm that would wake the system at a given time.The method receives as input an embedded instance of type IPS_AlarmClockOccurrence, with the following fields set: StartTime, Interval, InstanceID, DeleteOnCompletion. Upon success, the method creates an instance of IPS_AlarmClockOccurrence which is associated with AlarmClockService.The method would fail if 5 instances or more of IPS_AlarmClockOccurrence already exist in the system.
+     * @param alarmClockOccurrence IPS.Models.AlarmClockOccurrence Object
+     * @returns string
+     */
+    AddAlarm: (alarmClockOccurrence: IPS.Models.AlarmClockOccurrence) => string;
+    /**
+     * Changes properties of the selected instance
+     * @param alarmClockService An instance of AlarmClockService
+     * @returns string
+     */
+    Put: (alarmClockService: Models.AlarmClockService) => string;
+}
+declare class AuditLog extends Base {
+    className: Classes;
+    /**
+     * Returns a list of consecutive audit log records in chronological order: The first record in the returned array is the oldest record stored in the log. The record entries are returned as an array of base64Binary elements.
+     * @param startIndex Identifies the position of the first record to retrieve. An index of 1 indicates the first record in the log.  If startIndex isn't provided, defaults to 1.
+     * @returns string
+     */
+    ReadRecords: (startIndex?: number) => string;
+}
+declare class AuthorizationService extends Base {
+    className: Classes;
+    /**
+     * Adds a user entry to the Intel(R) AMT device.
+     * @param accessPermission Indicates whether the User is allowed to access Intel(R) AMT from the Network or Local Interfaces. Note: this definition is restricted by the Default Interface Access Permissions of each Realm.
+     * @param realms Array of interface names the ACL entry is allowed to access.
+     * @param digestUsername Username for access control. Contains 7-bit ASCII characters. String length is limited to 16 characters. Username cannot be an empty string.
+     * @param digestPassword An MD5 Hash of these parameters concatenated together (Username + ":" + DigestRealm + ":" + Password). The DigestRealm is a field in AMT_GeneralSettings
+     * @param kerberosUserSid Descriptor for user (SID) which is authenticated using the Kerberos Authentication. Byte array, specifying the Security Identifier (SID) according to the Kerberos specification. Current requirements imply that SID should be not smaller than 1 byte length and no longer than 28 bytes. SID length should also be a multiplicand of 4.
+     * @returns string
+     */
+    AddUserAclEntryEx: (accessPermission: Types.AuthorizationService.AccessPermission, realms: Types.AuthorizationService.Realms, digestUsername?: string, digestPassword?: string, kerberosUserSid?: string) => string;
+    /**
+     * Enumerates entries in the User Access Control List (ACL). Only 50 handles can be returned, so in order to get others startIndex should be bigger than 1.
+     * @param startIndex Indicates the first ACL entry to retrieve. if startIndex isn't provided, it will be set to 1
+     * @returns string
+     */
+    EnumerateUserAclEntries: (startIndex?: number) => string;
+    /**
+     * Gets the state of a user ACL entry (enabled/disabled)
+     * @param handle Specifies the ACL entry
+     * @returns string
+     */
+    GetAclEnabledState: (handle: number) => string;
+    /**
+     * Returns the username attribute of the Admin ACL.
+     * @returns string
+     */
+    GetAdminAclEntry: () => string;
+    /**
+     * Reads the Admin ACL Entry status from Intel(R) AMT. The return state changes as a function of the admin password.  TRUE if the admin ACL entry (admin password) was never changed by the user. Otherwise, the parameter is FALSE.
+     * @returns string
+     */
+    GetAdminAclEntryStatus: () => string;
+    /**
+     * Reads the remote Admin ACL Entry status from Intel(R) AMT. The return state changes as a function of the remote admin password.  TRUE if the admin ACL entry (admin password) was never changed by the user. Otherwise, the parameter is FALSE.
+     * @returns string
+     */
+    GetAdminNetAclEntryStatus: () => string;
+    /**
+     * Reads a user entry from the Intel(R) AMT device. Note: confidential information, such as password (hash) is omitted or zeroed in the response.
+     * @param handle Specifies the ACL entry to fetch.
+     * @returns string
+     */
+    GetUserAclEntryEx: (handle: number) => string;
+    /**
+     * Removes an entry from the User Access Control List (ACL), given a handle.
+     * @param handle Specifies the ACL entry to be removed.
+     * @returns string
+     */
+    RemoveUserAclEntry: (handle: number) => string;
+    /**
+     * Enables or disables a user ACL entry.Disabling ACL entries is useful when accounts that cannot be removed (system accounts - starting with $$) are required to be disabled.
+     * @param handle Specifies the ACL entry to update
+     * @param enabled Specifies the state of the ACL entry
+     * @returns string
+     */
+    SetAclEnabledState: (handle: number, enabled: boolean) => string;
+    /**
+     * Updates an Admin entry in the Intel(R) AMT device.
+     * @param username Username for access control. Contains 7-bit ASCII characters. String length is limited to 16 characters. Username cannot be an empty string.
+     * @param digestPassword An MD5 Hash of these parameters concatenated together (Username + ":" + DigestRealm + ":" + Password). The DigestRealm is a field in AMT_GeneralSettings.
+     * @returns string
+     */
+    SetAdminACLEntryEx: (username: string, digestPassword: string) => string;
+    /**
+     * Updates a user entry in the Intel(R) AMT device.
+     * @param handle Creation handle to a User ACL entry.
+     * @param accessPermission Indicates whether the User is allowed to access Intel(R) AMT from the Network or Local Interfaces. Note: this definition is restricted by the Default Interface Access Permissions of each Realm.
+     * @param realms Array of interface names the ACL entry is allowed to access.
+     * @param digestUsername Username for access control. Contains 7-bit ASCII characters. String length is limited to 16 characters. Username cannot be an empty string.
+     * @param digestPassword An MD5 Hash of these parameters concatenated together (Username + ":" + DigestRealm + ":" + Password). The DigestRealm is a field in AMT_GeneralSettings
+     * @param kerberosUserSid Descriptor for user (SID) which is authenticated using the Kerberos Authentication. Byte array, specifying the Security Identifier (SID) according to the Kerberos specification. Current requirements imply that SID should be not smaller than 1 byte length and no longer than 28 bytes. SID length should also be a multiplicand of 4.
+     * @returns string
+     */
+    UpdateUserAclEntryEx: (handle: number, accessPermission: Types.AuthorizationService.AccessPermission, realms: Types.AuthorizationService.Realms, digestUsername?: string, digestPassword?: string, kerberosUserSid?: string) => string;
+}
+declare class BootCapabilities extends Base {
+    className: Classes;
+}
+declare class BootSettingData extends Base {
+    className: Classes;
+    /**
+     * Changes properties of BootSettingData.
+     * @param bootSettingData BootSettingData Object.
+     * @returns string
+     */
+    Put: (bootSettingData: Models.BootSettingData) => string;
+}
+declare class EnvironmentDetectionSettingData extends Base {
+    className: Classes;
+    /**
+     * Changes properties of EnvironmentDetectionSettingData.
+     * @param environmentDetectionSettingData EnvironmentDetectionSettingData Object.
+     * @returns string
+     */
+    Put: (environmentDetectionSettingData: Models.EnvironmentDetectionSettingData) => string;
+}
+declare class EthernetPortSettings extends Base {
+    className: Classes;
+    /**
+     * Changes properties of the EthernetPortSettings.
+     * @param ethernetPortObject EthernetPortSettings Object.
+     * @returns string
+     */
+    Put: (ethernetPortObject: Models.EthernetPortSettings) => string;
+}
+declare class GeneralSettings extends Base {
+    className: Classes;
+    /**
+     * Changes properties of GeneralSettings.
+     * @param generalSettings GeneralSettings Object.
+     * @returns string
+     */
+    Put: (generalSettings: Models.GeneralSettings) => string;
+}
+declare class IEEE8021xCredentialContext extends Base {
+    className: Classes;
+}
+declare class IEEE8021xProfile extends Base {
+    className: Classes;
+    /**
+     * Changes properties of IEEE8021xProfile
+     * @param ieee8021xProfile IEEE8021xProfile Object
+     * @returns string
+     */
+    Put: (ieee8021xProfile: Models.IEEE8021xProfile) => string;
+}
+declare class KerberosSettingData extends Base {
+    className: Classes;
+    /**
+     * Gets the current state of the credential caching functionality
+     * @returns string
+     */
+    GetCredentialCacheState: () => string;
+    /**
+     * Enables/disables the credential caching functionality
+     * @param enabled New state of the functionality
+     * @returns string
+     */
+    SetCredentialCacheState: (enabled: boolean) => string;
+}
+declare class ManagementPresenceRemoteSAP extends Base {
+    className: Classes;
+    /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+}
+declare class MessageLog extends Base {
+    className: Classes;
+    /**
+     * Retrieves multiple records from MessageLog.
+     * @param identifier the IterationIdentifier input parameter is a numeric value (starting at 1) which is the position of the first record in the log that should be extracted.  If identifier isn't provided, defaults to 1.
+     * @returns string
+     */
+    GetRecords: (identifier?: number) => string;
+    /**
+     * Requests that an iteration of the MessageLog be established and that the iterator be set to the first entry in the Log. An identifier for the iterator is returned as an output parameter of the method.
+     * @returns string
+     */
+    PositionToFirstRecord: () => string;
+}
+declare class MPSUsernamePassword extends Base {
+    className: Classes;
+    /**
+     * Changes properties of MPSUsernamePassword.
+     * @param  mpsUsernamePassword MPSUsernamePassword Object.
+     * @returns string
+     */
+    Put: (mpsUsernamePassword: Models.MPSUsernamePassword) => string;
+}
+declare class PublicKeyCertificate extends Base {
+    className: Classes;
+    /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+    /**
+     * Changes properties of PublicKeyCertificate.
+     * @param publicKeyCertificate Public Key Certificate object
+     * @returns string
+     */
+    Put: (publicKeyCertificate: Models.PublicKeyCertificate) => string;
+}
+declare class PublicKeyManagementService extends Base {
+    className: Classes;
+    /**
+     * This method adds new certificate to the Intel(R) AMT CertStore. A certificate cannot be removed if it is referenced (for example, used by TLS, 802.1X or EAC).
+     * @param addCertificate AddCertificate Object
+     * @returns string
+     */
+    AddCertificate: (addCertificate: Models.AddCertificate) => string;
+    /**
+     * This function adds new certificate key to the Intel(R) AMT CertStore. A key cannot be removed if its corresponding certificate is referenced (for example, used by TLS or 802.1X).
+     * @param keyBlob RSA Key encoded as DES PKCS#1
+     * @returns string
+     */
+    AddKey: (keyBlob: string) => string;
+    /**
+     * This method adds new root certificate to the Intel(R) AMT CertStore. A certificate cannot be removed if it is referenced (for example, used by TLS, 802.1X or EAC).
+     * @param addCertificate AddCertificate Object
+     * @returns string
+     */
+    AddTrustedRootCertificate: (addCertificate: Models.AddCertificate) => string;
+    /**
+     * This method is used to generate a key in the FW.
+     * @param keyPairParameters KeyPairParameters Object
+     * @returns string
+     */
+    GenerateKeyPair: (keyPairParameters: Models.GenerateKeyPairParameters) => string;
+    /**
+     * This method is used to create a PKCS#10 certificate signing request based on a key from the key store.
+     * @param pkcs10Request PKCS10Request Object
+     * @returns string
+     */
+    GeneratePKCS10RequestEx: (pkcs10Request: Models.PKCS10Request) => string;
+}
+declare class PublicPrivateKeyPair extends Base {
+    className: Classes; /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+}
+declare class RedirectionService extends Base {
+    className: Classes;
+    /**
+     * Changes properties of RedirectionService.
+     * @param redirectionService RedirectionService Object.
+     * @returns string
+     */
+    Put: (redirectionService: Models.RedirectionService) => string;
+    /**
+     * Requests that the state of the element be changed to the value specified in the RequestedState parameter.  The supported values in requestedState are 32768-32771.
+     * @param requestedState The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
+     * @value_map 32768 = disable IDER and SOL, 32769 = enable IDER and disable SOL, 32770 = enable SOL and disable IDER, 32771 = enable IDER and SOL
+     * @returns string
+     */
+    RequestStateChange: (requestedState: Types.RedirectionService.RequestedState) => string;
+}
+declare class RemoteAccessPolicyAppliesToMPS extends Base {
+    className: Classes;
+    /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+    /**
+     * Creates an instance of RemoteAccessPolicyAppliesToMPS
+     * @param remoteAccessPolicyAppliesToMPS RemoteAccessPolicyAppliesToMPS Object
+     * @returns string
+     */
+    Create: (remoteAccessPolicyAppliesToMPS: Models.RemoteAccessPolicyAppliesToMPS) => string;
+    /**
+     * Changes properties of RemoteAccessPolicyAppliesToMPS.
+     * @param remoteAccessPolicyAppliesToMPS RemoteAccessPolicyAppliesToMPS Object.
+     * @returns string
+     */
+    Put: (remoteAccessPolicyAppliesToMPS: Models.RemoteAccessPolicyAppliesToMPS) => string;
+}
+declare class RemoteAccessPolicyRule extends Base {
+    className: Classes;
+    /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+    /**
+     * Changes properties of RemoteAccessPolicyRule
+     * @param remoteAccessPolicyRule Remote Access Policy Rule object
+     * @returns string
+     */
+    Put: (remoteAccessPolicyRule: Models.RemoteAccessPolicyRule) => string;
+}
+declare class RemoteAccessService extends Base {
+    className: Classes;
+    /**
+     * Requires mpServer.  Adds a Management Presence Server to the Intel(R) AMT subsystem. Creates an AMT_ManagementPresenceRemoteSAP instance and an AMT_RemoteAccessCredentialContext association to a credential. This credential may be an existing AMT_PublicKeyCertificate instance (if the created MPS is configured to use mutual authentication). If the created MpServer is configured to use username password authentication, an AMT_MPSUsernamePassword instance is created and used as the associated credential.
+     * @param mpServer MPServer Object.
+     * @returns string
+     */
+    AddMPS: (mpServer: Models.MPServer) => string;
+    /**
+     * Requires remoteAccessPolicyRule and selector.  Adds a Remote Access policy to the Intel(R) AMT subsystem. The policy defines an event that will trigger an establishment of a tunnel between AMT and a pre-configured MPS. Creates an AMT_RemoteAccessPolicyRule instance and associates it to a given list of AMT_ManagementPresenceRemoteSAP instances with AMT_PolicySetAppliesToElement association instances.
+     * @param remoteAccessPolicyRule RemoteAccessPolicyRule Object.
+     * @param selector Selector Object.
+     * @returns string
+     */
+    AddRemoteAccessPolicyRule: (remoteAccessPolicyRule: Models.RemoteAccessPolicyRule, selector: Selector) => string;
+}
+declare class SetupAndConfigurationService extends Base {
+    className: Classes;
+    /**
+     * Commits pending configuration commands made to the Intel(R) AMT device. Completes configuration when in "IN-provisioning" state.
+     * @returns string
+     */
+    CommitChanges: () => string;
+    /**
+     * Pulls instances of SetupAndConfigurationService, following an Enumerate operation.
+     * @param enumerationContext string returned from an Enumerate call.
+     * @returns string
+     */
+    GetUuid: () => string;
+    /**
+     * Requires password. This method sets the ME Bios extension password. It allows a remote caller to change the ME access password for the BIOS extension screen. This call succeeds depending on the password policy rule defined in MEBx (BIOS extension):"Default Password Only" - Method succeeds only when the current password is still the default value and only in PKI provisioning. "During Setup and Configuration" - Method succeeds only during provisioning, regardless of provisioning method or previous password value."ANYTIME" - Method will always succeed. (i.e. even when configured).
+     * @param password Password needs to be strong: Contain at least one of: upper-case, lower-case, digit and special character.
+     * @remarks Min Length = 8
+     * @remarks Max Length = 32
+     * @returns string
+     */
+    SetMEBXPassword: (password: string) => string;
+    /**
+     * Resets the Intel(R) AMT device to default factory settings. The device will need to be re-provisioned after this command.
+     * @param provisioningMode Indicates the provisioning mode (Enterprise , Small Business or Remote Connectivity) the device will enter following successful completion of the command. Starting from Release 6.0 only effective value is ProvisioningModeEnterprise
+     * @value_map 0 = ProvisioningModeCurrent, 1 = ProvisioningModeEnterprise, 2 = ProvisioningModeSmallBusiness, 3 = ProvisioningRemoteConnectivity
+     * @returns string
+     */
+    Unprovision: (provisioningMode?: Types.SetupAndConfigurationService.ProvisioningMode_Input) => string;
+    /**
+     * Changes properties of Setup and Configuration Service
+     * @param setupAndConfigurationService SetupAndConfigurationService object
+     * @returns string
+     */
+    Put: (setupAndConfigurationService: Models.SetupAndConfigurationService) => string;
+}
+declare class TimeSynchronizationService extends Base {
+    className: Classes;
+    /**
+     * Requires ta0, tm1, tm2.  This method is used to synchronize the Intel(R) AMT device's internal clock with an external clock.
+     * @param ta0 The time value received from invoking GetLowAccuracyTimeSynch().
+     * @param tm1 The remote client timestamp after getting a response from GetLowAccuracyTimeSynch().
+     * @param tm2 The remote client timestamp obtained immediately prior to invoking this method.
+     * @returns string
+     */
+    SetHighAccuracyTimeSynch: (ta0: number, tm1: number, tm2: number) => string;
+    /**
+     * This method is used for reading the Intel(R) AMT device's internal clock.
+     * @returns string
+     */
+    GetLowAccuracyTimeSynch: () => string;
+}
+declare class TLSCredentialContext extends Base {
+    className: Classes;
+    /**
+     * Deletes an instance
+     * @param selector indicates the instance
+     * @returns string
+     */
+    Delete: (selector: Selector) => string;
+    /**
+     * Requires tlsCredentialContext.  Creates a new instance of TLSCredentialContext.
+     * @param tlsCredentialContext TLSCredentialContext Object.
+     * @returns string
+     */
+    Create: (certHandle: string) => string;
+}
+declare class TLSSettingData extends Base {
+    className: Classes;
+    /**
+     * Changes properties of TLSSettingData.
+     * @param tlsSettingData TLSSettingData Object.
+     * @returns string
+     */
+    Put: (tlsSettingData: Models.TLSSettingData) => string;
+}
+declare class UserInitiatedConnectionService extends Base {
+    className: Classes;
+    /**
+     * Requires requestedState.  Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.  If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
+     * @param requestedState The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
+     * @value_map 32768 = All Interfaces disabled, 32769 = BIOS Interface enabled, 32770 = OS Interface enabled, 32771 = BIOS and OS Interfaces enabled
+     * @returns string
+     */
+    RequestStateChange: (requestedState: Types.UserInitiatedConnectionService.RequestedState) => string;
+}
+declare class WiFiPortConfigurationService extends Base {
+    className: Classes;
+    /**
+     * Atomically creates an instance of CIM_WifiEndpointSettings from the embedded instance parameter and optionally an instance of CIM_IEEE8021xSettings from the embedded instance parameter (if provided), associates the CIM_WiFiEndpointSettings instance with the referenced instance of CIM_WiFiEndpoint using an instance of CIM_ElementSettingData optionally associates the newly created or referenced by parameter instance of CIM_IEEE8021xSettings with the instance of CIM_WiFiEndpointSettings using an instance of CIM_ConcreteComponent and optionally associates the referenced instance of AMT_PublicKeyCertificate (if provided) with the instance of CIM_IEEE8021xSettings (if provided) using an instance of CIM_CredentialContext.
+     * @param wifiEndpointSettings WiFiEndpointSettings Object
+     * @param selector Selector Object.
+     * @returns string
+     */
+    AddWiFiSettings: (wifiEndpointSettings: CIM.Models.WiFiEndpointSettings, selector: Selector, ieee8021xSettingsInput?: CIM.Models.IEEE8021xSettings, clientCredential?: string, caCredential?: string) => string;
+    /**
+     * Changes properties of WiFiEndpointSettings
+     * @param wifiEndpointSettings WiFiEndpointSettings Object
+     * @param selector Selector Object.
+     * @returns string
+     */
+    Put: (wifiEndpointSettings: Models.WiFiPortConfigurationService, selector?: Selector) => string;
+}
+export declare class Messages {
+    readonly resourceUriBase: string;
+    wsmanMessageCreator: WSManMessageCreator;
+    AlarmClockService: AlarmClockService;
+    AuditLog: AuditLog;
+    AuthorizationService: AuthorizationService;
+    BootCapabilities: BootCapabilities;
+    BootSettingData: BootSettingData;
+    EnvironmentDetectionSettingData: EnvironmentDetectionSettingData;
+    EthernetPortSettings: EthernetPortSettings;
+    GeneralSettings: GeneralSettings;
+    IEEE8021xCredentialContext: IEEE8021xCredentialContext;
+    IEEE8021xProfile: IEEE8021xProfile;
+    KerberosSettingData: KerberosSettingData;
+    ManagementPresenceRemoteSAP: ManagementPresenceRemoteSAP;
+    MessageLog: MessageLog;
+    MPSUsernamePassword: MPSUsernamePassword;
+    PublicKeyCertificate: PublicKeyCertificate;
+    PublicKeyManagementService: PublicKeyManagementService;
+    PublicPrivateKeyPair: PublicPrivateKeyPair;
+    RedirectionService: RedirectionService;
+    RemoteAccessPolicyAppliesToMPS: RemoteAccessPolicyAppliesToMPS;
+    RemoteAccessPolicyRule: RemoteAccessPolicyRule;
+    RemoteAccessService: RemoteAccessService;
+    SetupAndConfigurationService: SetupAndConfigurationService;
+    TimeSynchronizationService: TimeSynchronizationService;
+    TLSCredentialContext: TLSCredentialContext;
+    TLSSettingData: TLSSettingData;
+    UserInitiatedConnectionService: UserInitiatedConnectionService;
+    WiFiPortConfigurationService: WiFiPortConfigurationService;
+}
+export {};