Skip to content

Latest commit

 

History

History
235 lines (181 loc) · 4.6 KB

Remove-UMSProfileAssignment.md

File metadata and controls

235 lines (181 loc) · 4.6 KB
external help file Module Name online version schema
PSIGEL-help.xml
PSIGEL
2.0.0

Remove-UMSProfileAssignment

SYNOPSIS

Removes a profile assignment from a device or device directory.

SYNTAX

Remove-UMSProfileAssignment [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
 [[-SecurityProtocol] <String[]>] [-WebSession] <Object> [-Id] <Int32> [-ReceiverId] <Int32>
 [-ReceiverType] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes a profile assignment from a device or device directory via API.

EXAMPLES

Example 1

Remove assignment of profile with ID 669 from device with ID 195:

Remove-UMSProfileAssignment -Computername 'igelrmserver' -WebSession $WebSession -Id 669 -ReceiverId 195 -ReceiverType tc

Message                      Id ReceiverId ReceiverType
-------                      -- ---------- ------------
deleted profile assignment. 669        195 tc

Example 2

Remove all profile assignments from device directory with name 'IGELOS':

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

$AssignmentColl = ((Get-UMSDeviceDirectory).where{$_.Name -eq 'IGELOS'}) | Get-UMSDeviceDirectoryAssignment 

foreach ($Assignment in $AssignmentColl)
{
  Remove-UMSProfileAssignment -Id $Assignment.AssigneeId -ReceiverId $Assignment.ReceiverId -ReceiverType $Assignment.ReceiverType
}

Message                      Id ReceiverId ReceiverType
-------                      -- ---------- ------------
deleted profile assignment. 390         71 tcdirectory
deleted profile assignment.  69         71 tcdirectory

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 profile

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ReceiverId

ID of the device or device directory

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ReceiverType

Type of the device or device directory

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: tc, tcdirectory

Required: True
Position: 7
Default value: None
Accept pipeline input: True (ByPropertyName)
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

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS