Skip to content

Latest commit

 

History

History
217 lines (167 loc) · 4.03 KB

Reset-UMSDevice.md

File metadata and controls

217 lines (167 loc) · 4.03 KB
Raw
external help file Module Name online version schema
PSIGEL-help.xml
PSIGEL
2.0.0

Reset-UMSDevice

SYNOPSIS

Resets a device to factory defaults.

SYNTAX

Reset-UMSDevice [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
 [[-SecurityProtocol] <String[]>] [-WebSession] <Object> [-Id] <Int32> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Resets a device to factory defaults and removes it completely (without recycle bin) via API.

EXAMPLES

Example 1

Reset device with ID 195:

Reset-UMSDevice -Computername 'igelrmserver' -WebSession $WebSession -Id 195

Bestätigung
Möchten Sie diese Aktion wirklich ausführen?
Ausführen des Vorgangs "Reset-UMSDevice" für das Ziel "Id: 195".
[J] Ja [A] Ja, alle [N] Nein [K] Nein, keine [H] Anhalten [?] Help (default is "Ja"):



Message  : OK.
Id       : 195
ExecId   : ID-igelrmserver-52569-1552118590065-3-0
Mac      :
ExecTime : 1552119234364
State    : SUCCESS

Example 2

Reset all devices which are in a device directory which is in the device directory with the ID 71:

$PSDefaultParameterValues = @{
  '*-UMS*:Credential'   = (Get-Credential)
  '*-UMS*:Computername' = 'igelrmserver'
  '*-UMS*:Confirm'      = $false
}
$PSDefaultParameterValues += @{
  '*-UMS*:WebSession' = New-UMSAPICookie
}

(((Get-UMSDeviceDirectory -Filter children).where{$_.ParentId -eq 71}).DirectoryChildren).where{$_.ObjectType -eq 'tc'} |
  Reset-UMSDevice

Message  : OK.
Id       : 58
ExecId   : ID-igelrmserver-52884-1552119449589-3-0
Mac      :
ExecTime : 1552119887968
State    : SUCCESS

Message  : OK.
Id       : 195
ExecId   : ID-igelrmserver-52884-1552119449589-4-0
Mac      :
ExecTime : 1552119889327
State    : SUCCESS

PARAMETERS

-ApiVersion

API Version to use

Type: Int32
Parameter Sets: (All)
Aliases:
Accepted values: 3

Required: False
Position: 2
Default value: 3
Accept pipeline input: False
Accept wildcard characters: False

-Computername

Computername of the UMS Server

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

ID of the device

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SecurityProtocol

Set SSL/TLS protocol

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: Tls12, Tls11, Tls, Ssl3

Required: False
Position: 3
Default value: Tls12
Accept pipeline input: False
Accept wildcard characters: False

-TCPPort

TCP Port API

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 8443
Accept pipeline input: False
Accept wildcard characters: False

-WebSession

Websession Cookie

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Int32

OUTPUTS

System.Object

NOTES

RELATED LINKS