Stop-PASCPMTask

SYNOPSIS

Cancels a pending CPM task for one or more accounts.

SYNTAX

Stop-PASCPMTask [-Accountid] <String[]> [-dependentAccountid <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Cancels an in-progress or pending CPM operation (such as a change, verify or reconcile task) for a specific account.

Multiple accounts can be processed in a single bulk request by supplying more than one value for -Accountid.

Requires CyberArk Self-Hosted version 15.2 or higher.

EXAMPLES

Example 1

Stop-PASCPMTask -Accountid 123_4

Cancels the pending CPM task for account with id 123_4.

Example 2

Stop-PASCPMTask -Accountid 123_4, 567_8

Cancels the pending CPM tasks for accounts 123_4 and 567_8 in a single bulk request.

Example 3

Stop-PASCPMTask -Accountid 123_4 -dependentAccountid 123_5

Cancels the pending CPM task for dependent account 123_5 under parent account 123_4.

Example 4

Get-PASAccount -id 123_4 | Stop-PASCPMTask -WhatIf

Shows what would happen if the pending CPM task for account 123_4 were cancelled, but does not perform the cancellation. Uses pipeline input from Get-PASAccount for -Accountid.

PARAMETERS

-Accountid

The unique id of the account to cancel the pending CPM task for.

When more than one value is supplied, a bulk cancel request is sent.

Type: String[]
Parameter Sets: (All)
Aliases: id

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Required: False
Position: Named
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-dependentAccountid

The dependent account id to cancel the pending CPM task for.

Type: String
Parameter Sets: (All)
Aliases:

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

OUTPUTS

System.Object

NOTES

Bulk operations are sent when -Accountid contains more than one value.