Public/Stop-AMTDevice.ps1
|
function Stop-AMTDevice { <# .SYNOPSIS Stops an AMT device. .DESCRIPTION Stops an AMT device. .PARAMETER GUID Specify a device GUID to stop. .PARAMETER Soft If this switch is set, AMT will try to send the signal to the OS to perform a soft shutdown. It can take a minute or two until the devices shuts down with the -Soft switch. .INPUTS You can pipe one or more device GUIDs into Stop-AMTDevice. .OUTPUTS System.Object GUID: Device GUID ReturnValue: Status number of command ReturnValueStr: Status message of command .EXAMPLE PS> Stop-AMTDevice -GUID 1ada9c84-780e-4ccc-831c-0edb26994b18 GUID ReturnValue ReturnValueStr ---- ----------- -------------- 1ada9c84-780e-4ccc-831c-0edb26994b18 0 SUCCESS .EXAMPLE PS> Get-AMTDevice | Stop-AMTDevice GUID ReturnValue ReturnValueStr ---- ----------- -------------- 1ada9c84-780e-4ccc-831c-0edb26994b18 0 SUCCESS 39270bdb-9488-4695-8f8f-0d9e5366c54e 0 SUCCESS .EXAMPLE PS> Get-AMTDevice | Stop-AMTDevice -Soft GUID ReturnValue ReturnValueStr ---- ----------- -------------- 1ada9c84-780e-4ccc-831c-0edb26994b18 0 SUCCESS 39270bdb-9488-4695-8f8f-0d9e5366c54e 0 SUCCESS .LINK Online version: https://github.com/netricsag/PowerAMT/tree/main/Docs #> param( [Parameter(Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName)][string[]] $GUID, [switch] $Soft ) begin { if($null -eq $Global:AMTSession){ throw "No active AMT session. Create a session first with Connect-AMTManagement" } } process { foreach($device in $GUID) { $headers=@{} $headers.Add("Authorization", "Bearer $($Global:AMTSession.Token)") $Body = @{ "action"=if ($soft) {12} else {8} "useSOL"=$false } | ConvertTo-Json if($null -ne $GUID -and $GUID -ne ""){ $Response = (Invoke-RestMethod -Uri ("https://" + $Global:AMTSession.Address + "/mps/api/v1/amt/power/action/$GUID") -Method POST ` -UseBasicParsing -ContentType 'application/json' -Headers $headers -body $body).body $ReturnObject = New-Object -TypeName PSObject -Property @{ GUID = $device ReturnValue = $Response.ReturnValue ReturnValueStr = $Response.ReturnValueStr } return $ReturnObject } } } } |