< Back
Get-DbaAgentOperator
Post
NAME Get-DbaAgentOperator
SYNOPSIS
Returns all SQL Agent operators on a SQL Server Agent.
SYNTAX
Get-DbaAgentOperator [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Operator] <System.Object[]>] [[-ExcludeOperator] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
This function returns SQL Agent operators.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeOperator [<System.Object[]>]
The operator(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Operator [<System.Object[]>]
The operator(s) to process - this list is auto-populated from the server. If unspecified, all operators will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Operator
Author: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaAgentOperator
SYNOPSIS
Returns all SQL Agent operators on a SQL Server Agent.
SYNTAX
Get-DbaAgentOperator [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Operator] <System.Object[]>] [[-ExcludeOperator] <System.Object[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
This function returns SQL Agent operators.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeOperator [<System.Object[]>]
The operator(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Operator [<System.Object[]>]
The operator(s) to process - this list is auto-populated from the server. If unspecified, all operators will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Operator
Author: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Get-DbaAgentOperator