< Back

New-DbaAgentAlertCategory

Mon Jan 13, 2020 12:35 pm

NAME New-DbaAgentAlertCategory



SYNOPSIS

New-DbaAgentAlertCategory creates a new alert category.





SYNTAX

New-DbaAgentAlertCategory [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>

[[-SqlCredential] <Pscredential>] [-Category] <System.String[]> [-Force <Switch>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

New-DbaAgentAlertCategory makes it possible to create a Agent Alert category that can be used with Alerts.



It returns an array of the alert categories created .





PARAMETERS

-Category [<System.String[]>]

The name of the category



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-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



-Force [<Switch>]

The force parameter will ignore some errors in the parameters and assume defaults.



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. You must have sysadmin access and server version must be SQL

Server version 2000 or greater.



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, Alert, AlertCategory

Author: Patrick Flynn (@sqllensman)



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>New-DbaAgentAlertCategory -SqlInstance sql1 -Category 'Category 1'



Creates a new alert category with the name 'Category 1'.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>'sql1' | New-DbaAgentAlertCategory -Category 'Category 2'



Creates a new alert category with the name 'Category 2'.



RELATED LINKS

https://dbatools.io/New-DbaAgentAlertCategory