Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 2.64 KB

README.md

File metadata and controls

95 lines (65 loc) · 2.64 KB

PowerAMT

CI GitHub all releases PowerShell Gallery PowerShell Gallery Version

Overview

This PowerShell module is a simple wrapper for the Intel Open AMT Cloud Toolkit API. It serves to make the API interaction and automation with PowerShell simpler.

In the current build only MPS functions (device management) are supported. RPS functions will be implemented in a later stage.

Requirements

Quickstart

Installation

If you have the PowerShellGet module installed or PowerShell 5.1 or higher you can enter the following command:

C:\> Install-Module -Name PowerAMT

Basic usage

Import module:

C:\> Import-Module -Name PowerAMT

Create a session:

C:\> Connect-AMTManagement -AMTManagementAddress 192.168.1.100 -AMTUsername admin -AMTPassword P@ssw0rd

Token           Address
-----           -------
<JWT Token>     192.168.1.100

Retrieve all devices:

C:\> Get-AMTDevice

TenantID         :
Tags             : {Store1,London}
Hostname         : Client-01
MPSInstance      : mps
ConnectionStatus : True
MPSUsername      : admin
GUID             : 1ada9c84-780e-4ccc-831c-0edb26994b18

TenantID         :
Tags             : {Store2,NewYork}
Hostname         : Device-09
MPSInstance      :
ConnectionStatus : False
MPSUsername      : admin
GUID             : 39270bdb-9488-4695-8f8f-0d9e5366c54e
...

Start a specific device:

C:\> Start-AMTDevice -GUID 1ada9c84-780e-4ccc-831c-0edb26994b18

GUID                                 ReturnValue ReturnValueStr
----                                 ----------- --------------
1ada9c84-780e-4ccc-831c-0edb26994b18           0 SUCCESS

Documentation

The documentation is currently only available via the Get-Help command.

PS> Get-Help Get-AMTDevices

Maintainer

Todos:

  • Implement RPS functions