Remove-UMSDeviceDirectory
SYNOPSIS
Removes a device directory.
SYNTAX
Remove-UMSDeviceDirectory [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
[[-SecurityProtocol] <String[]>] [-WebSession] <Object> [-Id] <Int32> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Removes a device directory via API. The device directory is only removed if it is empty.
EXAMPLES
Example 1
Remove device directory with ID 688:
Remove-UMSDeviceDirectory -Computername 'igelrmserver' -WebSession $WebSession -Id 688
Bestätigung
Möchten Sie diese Aktion wirklich ausführen?
Ausführen des Vorgangs "Remove-UMSDeviceDirectory" für das Ziel "Id: 688".
[J] Ja [A] Ja, alle [N] Nein [K] Nein, keine [H] Anhalten [?] Help (default is "Ja"):
Message Id
------- --
Deletion successful. 688
Example 2
Remove device directories with name 1, 2, 3 and 4, disabling confirmation:
$PSDefaultParameterValues = @{
'*-UMS*:Credential' = (Get-Credential)
'*-UMS*:Computername' = 'igelrmserver'
'*-UMS*:Confirm' = $false
}
$PSDefaultParameterValues += @{
'*-UMS*:WebSession' = New-UMSAPICookie
}
(Get-UMSDeviceDirectory).where{$_.Name -match '^[1-4]$'} |
Remove-UMSDeviceDirectory
Message Id
------- --
Deletion successful. 684
Deletion successful. 685
Deletion successful. 686
Deletion successful. 687
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 directory
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.