commands

^

Get-DbaAgentOperator

Author Klaas Vandenberghe (@PowerDBAKlaas)
Availability Windows, Linux, macOS

 

Synopsis

Returns all SQL Agent operators on a SQL Server Agent.

Description

This function returns SQL Agent operators.

Syntax

Get-DbaAgentOperator
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Operator] <Object[]>]
    [[-ExcludeOperator] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaAgentOperator -SqlInstance ServerA,ServerB\instanceB

Returns any SQL Agent operators on serverA and serverB\instanceB

Example: 2
PS C:\> 'ServerA','ServerB\instanceB' | Get-DbaAgentOperator

Returns all SQL Agent operators on serverA and serverB\instanceB

Example: 3
PS C:\> Get-DbaAgentOperator -SqlInstance ServerA -Operator Dba1,Dba2

Returns only the SQL Agent Operators Dba1 and Dba2 on ServerA.

Example: 4
PS C:\> Get-DbaAgentOperator -SqlInstance ServerA,ServerB -ExcludeOperator Dba3

Returns all the SQL Agent operators on ServerA and ServerB, except the Dba3 operator.

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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.

Alias
Required False
Pipeline false
Default Value
-Operator

The operator(s) to process - this list is auto-populated from the server. If unspecified, all operators will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeOperator

The operator(s) to exclude - this list is auto-populated from the server

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

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