Skip to content

Release Notes

Feature Changes for 2.2

This section outlines key features changes between versions 2.1 and 2.2 for Open AMT Cloud Toolkit.

Noteworthy Features and Changes

Major Refactoring & WSMAN-MESSAGES Library: At the end of 2021, the team began refactoring parts of the toolkit source code to improve the communication method between the toolkit and Intel® AMT devices. Much of this code was inherited from another open source project also developed at Intel. While this inherited code was well-validated and stable, it was difficult to modify and maintain. Validation with automated testing posed a challenge, and code coverage metrics were lackluster. The new portable and testable design of WSMAN-MESSAGES addresses these issues with a library of wsman-based messages for communication with Intel® AMT devices. Both MPS and RPS use WSMAN-MESSAGES, available on NPM as @open-amt-cloud-toolkit/wsman-message. CODE COVERAGE NET RESULT: Both MPS and RPS code coverage improved dramatically, from 24% to 91% and 29% to 70% respectively. BOTTOM LINE: This reduces the overall technical debt of the project substantially and provides users with another reason to adopt the Open AMT Cloud Toolkit. As we move forward, we'll continue to push toward our goal of 80% code coverage across all repositories. Future improvements will happen through the course of our normal release cadence.

Device Migration: Several customers have requested a method to migrate an Intel® AMT device from a management console to the Open AMT Cloud Toolkit. Now with 2.2, perform this migration with RPC without deactivating and reactivating the device. Use the activate command and provide the desired profile. The prompt will ask for the AMT credential. RPS will use this credential to add the device to Open AMT Cloud Toolkit and apply the configuration profile.

Healthcheck API: This new API provides the ability to check the connection status of MPS and RPS with both the database and secret provider. This is particularly helpful when Open AMT Cloud Toolkit is deployed in Kubernetes or Docker Swarm so that you know they are up and ready to respond to requests.

RPC -json flag: The RPC-Go application sports a new -json flag. With this flag, convert application output to json format making it machine parsable. Big thanks to Portainer for this contribution!

Additions, Modifications, and Removals

Changes to /AMT routes

  • Method property is removed from wsman header in response and is now a property of the wsman body

    before: 

    "responses": {
    "Header": {
        "To": "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous",
        "RelatesTo": "1",
        "Action": "http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse",
        "MessageID": "uuid:00000000-8086-8086-8086-0000000000FA",
        "ResourceURI": "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystemPackage",
        "Method": "CIM_ComputerSystemPackage"
    },
    "Body": {
        "Antecedent": {
    after: 
    "responses": [
    {
        "Header": {
            "To": "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous",
            "RelatesTo": 0,
            "Action": "http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse",
            "MessageID": "uuid:00000000-8086-8086-8086-000000000002",
            "ResourceURI": "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystemPackage"
        },
        "Body": {
            "CIM_ComputerSystemPackage": {
                "Antecedent": {

  • SelectorSet values no longer includes @name and Value properties

  • While these technically constitute a breaking change, ultimately we decided to NOT rev the major version of the toolkit as we felt these changes have minimal impact. We will be revamping the /AMT routes in a future version and will rev to 3.x at that time

Open AMT Cloud Toolkit

  • deployment: update to use dockerhub imgs
  • dep: update k8s helm dependencies to support v1.22
  • healthcheck: adds healthcheck to docker-compose
  • see changelog for full list of changes

RPS

  • activation: add already activated device to toolkit (#476) (#ae11da5)
  • healthcheck: provides API Route for status of vault and db (#9572d85)
  • verifies amt password if device is already activated and exists in toolkit (#478) (#ecbdb96)
  • cira: randomly generate environment detection (#554) (#484a927)
  • activator: adds wmsan_messages and unit tests (#541) (#68f96a9)
  • activator: optimize code readability (#67e5950)
  • cira: adds wsman-messages and unit tests (#567) (#841bfb1)
  • validator.ts: handles ccm activation flow when device is already in ccm (#598) (#d8824d7)
  • activation: handle when too many auth failures (#fa566f4)
  • activator: optimize code readability (#67e5950)
  • activator: adds wmsan_messages and unit tests (#541) (#68f96a9)
  • cira: adds wsman-messages and unit tests (#567) (#841bfb1)
  • clientManager: simplify client manager (#563) (#05b7180)
  • deactivator: adds wmsan_messages and unit tests (#545) (#36f97d5)
  • dto: convert AMTdeviceDTO from class to interface type in /models (#a517218)
  • maintenance: adds wmsan_messages and unit tests (#559) (#9907289)
  • network: adds wsman-messages and unittests (#0f147f4)
  • node-forge: migrate base64 encode/decode to use Buffer instead of node forge (#555) (#4873f89)
  • randPass: removes '&' from server side random password generation (#dfc813a)
  • routes: rename route filenames and add test skeletons (#8715943)
  • rps: remove node-vault This PR replaces node-vault with standard REST calls to vault using got. (#0385eab)
  • test: move tests to live alongside file (#7005c38)
  • tls: removes use of js amt-libraries (#4c1074a)
  • wifi: ensures wifi configuration completes successfully (#5b8b51f)
  • see change log for full list of changes

MPS

  • healthcheck: adds API endpoint for healthcheck (#5085569)
  • CIRA race condition and add 30 sec keepalive time (#f84f6a2)
  • api: connection status query parameter now matches API docs for devices (#3091294)
  • api: removed common tag envelope from AMT responses (#481) (#eb8603f)
  • api: updated return value code with value type (#5124aa1)
  • api: reverts auditlog field names back to being capitalized (#ff15aa8)
  • cira: close cira channel after request (#6738d7b)
  • cira: clears the wsman response messages once parsed (#468) (#2187eeb)
  • cira: handle chunked http message (#2c44300)
  • test: added unit test for secret manager (#436) (#bed8025)
  • test: added unit test for db(pg) (#430) (#ecc42f7)
  • amt_models: matching case (#453) (#3071866)
  • api: updates audit log to leverage refactored device connection (#52044e7)
  • api: get version uses new amt libraries (#446) (#977ba3d)
  • api: general settings uses new amt library (#456) (#722975c)
  • api: updates audit log and adds unit tests for it to connected devices (#9adf30f)
  • api: get amt features was missing userConsent property (#c29cee4)
  • api: set amt features uses new CIRA connection (#7087eb3)
  • api: user consent (#458) (#04d9923)
  • api: update getAMTFeatures to use new CIRA connections (#019895e)
  • api: power actions leverage new connection libraries (#6806237)
  • api: updated event log (#463) (#2438bbd)
  • api: hardware information (#460) (#48f4576)
  • cira: fix cira channel distruption across multiple API Calls (#ef4fdb8)
  • cira: remove javascript libraries and leverage new refactored AMT libraries (#fa68566)
  • logging: centralizes logging and mqtt messages into messages.ts (#de32b04)
  • logging: fixes spelling mistakes (#d0f9a4b)
  • mps: remove node-vault (#9d4963e)
  • power: use new device handling (#27c5c28)
  • websockets: KVM and SOL now use new CIRA connection (#e075539)
  • wsman: use new dependency wsman-message (#2f0c65c)
  • see change log for full list of changes

RPC-Go

  • activate: prompts for password when device is activated
  • cli: Remove ControlModeRaw from json
  • cli: Add json flag to version command
  • log: adds -json option to all rpc commands
  • output: adds json output for amtinfo command
  • update password with user input
  • pthi: converts amt and pthi commands to go from C
  • see change log for full list of changes

Sample Web UI

  • add-dialog: uses rpc-go syntax (#c729709)
  • cypress: consolidate http codes (#0ebdb3f)
  • see change log for full list of changes

UI Toolkit

  • upgrade ws from 8.4.2 to 8.5.0 (#228166b)
  • npm: add job to publish to npm (#33bdf7e)
  • semantic-release: adds automated releases (#fde186b)
  • see change log for full list of changes

WSMAN-MESSAGES

Expect this set of libraries to version up very fast as we continue to enhance its capabilities to support the rest of the Open AMT Cloud Toolkit. Since this is new, adding the full set of changes since 1.0.0.

v2.1.0 - 2022-03-15:

  • amt: add wifiportconfiguration service PUT and GET calls (#b9767cf)

v2.0.1 - 2022-03-02:

  • AMT: update wifi_port naming convention (#86) (#4d2830d)

v2.0.0 - 2022-03-02:

  • tls-configuration: add support for TLS Connection type (#0bcddb6)
  • BREAKING CHANGE: messageID is no longer passed in to functions and is tracked internally

v1.7.0 - 2022-02-24

  • general-settings: adds PUT method for AMT_GeneralSettings (#f39c0df)

v1.6.0 - 2022-02-23

  • amt: adds WiFiPortConfigurationService to amt. (#d2a2f0e)

v1.5.0 - 2022-02-15

  • amt: adds delete method to ManagementPresenceRemoteSAP and PublicKeyCertificate (#919794e)

v1.4.1 - 2022-02-08

  • exports: align exports with expected types from breaking change in PR#29 (#99e1ea7)

v1.4.0 - 2022-02-07

  • amt: adds AMT Authorization and Time Synchronization services (#747988d)

v1.3.1 - 2022-02-03

  • ips: updates methods and actions for HostBasedService (#66) (#f777de0)

v1.3.0 - 2022-02-02

  • cim: adds WiFiPort method (#62) (#faf4aac)

v1.2.0 - 2022-01-31

  • ips: adds methods to HostbasedSetupService (#1f196f1)

v1.1.0 - 2022-01-25

  • amt: adds Unprovision and SetMEBXPassword methods to setup and configuration service (#8cff7c0)
  • codecov: sets acceptable range to 99-100 (#a95ffa3)

v1.0.0 - 2022-01-07

  • initialize workflow (#ede3a3d)
  • add cp step for package.json (#7223e97)
  • badge: adds badges (#20) (#dd036ca)
  • badge: adds snyk and codecov (#21) (#747b9df)
  • build: remove dist folder (#7bb6840)
  • release: remove step (#94ce849)
  • release: update release to build (#6dec446)
  • release: add step (#b1ba3e3)
  • semantic-release: adds automation for releasing (#114517e)
  • semantic-release: fixes workflow name (#817c9dc)
  • semantic-release: change pkgRoot to dist (#579e722)
  • semantic-release: updates comment (#ed4b16e)
  • workflow: optimizes node CI (#ae84187)
  • renames AMT, CIM, IPS classes to Messages (#4470042)
  • models and exports now under respective calls AMT, IPS, CIM (#a89ab8d)
  • wsman: initial migration (#94e261e)

Resolved Issues

RPS

MPS

RPC-Go

Open Issues and Requests

Open AMT Cloud Toolkit

RPS

MPS

RPC

Sample Web UI

UI Toolkit

Back to top