Remove-DbaAgentOperator

Want to see the source code for this command? Check out Remove-DbaAgentOperator on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaAgentOperator.

Synopsis

Removes an operator from an instance.

Description

Drop an operator from SQL Agent.

Syntax

Remove-DbaAgentOperator
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Operator <String[]>]
    [-ExcludeOperator <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-DbaAgentOperator
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Operator <String[]>]
    [-ExcludeOperator <String[]>]
    -InputObject <Operator[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS:>Remove-DbaAgentOperator -SqlInstance sql01 -Operator DBA
This removes an operator named DBA from the instance.

Example: 2

PS C:\> Get-DbaAgentOperator -SqlInstance SRV1 | Out-GridView -Title 'Select SQL Agent operator(s) to drop' -OutputMode Multiple | Remove-DbaAgentOperator

Using a pipeline this command gets all SQL Agent operator(s) on SRV1, lets the user select those to remove and then removes the selected SQL Agent alert category(-ies).

Required Parameters

-InputObject

Allows piping from Get-DbaAgentOperator.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Operator

Name of the operator in SQL Agent.

-ExcludeOperator

The operator(s) to exclude.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.