Enable‑SqlDscAgentOperator - dsccommunity/SqlServerDsc GitHub Wiki

SYNOPSIS

Enables a SQL Agent Operator.

SYNTAX

ServerObject

Enable-SqlDscAgentOperator -ServerObject <Server> -Name <String> [-Force] [-Refresh]
 [-WhatIf] [-Confirm] [<CommonParameters>]

OperatorObject

Enable-SqlDscAgentOperator -OperatorObject <Operator> [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

This command enables a SQL Agent Operator on a SQL Server Database Engine instance.

EXAMPLES

EXAMPLE 1

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$operatorObject = $serverObject | Get-SqlDscAgentOperator -Name 'MyOperator'
$operatorObject | Enable-SqlDscAgentOperator

Enables the operator named MyOperator.

EXAMPLE 2

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$serverObject | Enable-SqlDscAgentOperator -Name 'MyOperator'

Enables the operator named MyOperator.

PARAMETERS

-Force

Specifies that the operator should be enabled without any confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the SQL Agent Operator to be enabled.

Type: String
Parameter Sets: ServerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OperatorObject

Specifies a SQL Agent Operator object to enable.

Type: Operator
Parameter Sets: OperatorObject
Aliases:

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

-Refresh

Specifies that the ServerObject's operators should be refreshed before trying to enable the operator object. This is helpful when operators could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of operators it might be better to make sure the ServerObject is recent enough, or pass in OperatorObject.

Type: SwitchParameter
Parameter Sets: ServerObject
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ServerObject

Specifies current server connection object.

Type: Server
Parameter Sets: ServerObject
Aliases:

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

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

Microsoft.SqlServer.Management.Smo.Server

When using the ServerObject parameter set, a Server object can be piped in.

Microsoft.SqlServer.Management.Smo.Agent.Operator

When using the OperatorObject parameter set, an Operator object can be piped in.

OUTPUTS

None.

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️