Citrix Virtual Apps and Desktops SDK

New-MonitorNotificationPolicy

Returns a new MonitorNotificationPolicy object

Syntax

New-MonitorNotificationPolicy
   -Name <String>
   [-Description <String>]
   [-Webhook <String>]
   [-IsSnmpEnabled <Boolean>]
   [-Enabled <Boolean>]
   [-IsEmailAttachmentEnabled <Boolean>]
   [-IsWebhookAttachmentEnabled <Boolean>]
   [-WebhookProfileId <Int64>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns a new policy instance using the specified parameters

Examples

EXAMPLE 1

Creates session policy and persist the data into database

New-MonitorNotificationPolicy -Name "Policy1" -Description "Policy Description" -Enabled $true
<!--NeedCopy-->

EXAMPLE 2

Creates an enabled “Policy1” with a description and links it to a webhook profile with ID 1.

New-MonitorNotificationPolicy -Name "Policy1" -Description "Policy Description" -Enabled $true -WebhookProfileId 1
<!--NeedCopy-->

Parameters

-Name

Name of policy to create

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

-Description

Description of policy to create

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

-Webhook

Webhook URL of policy to create

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

-IsSnmpEnabled

boolean value representing if SNMP is enabled for new Policy

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

-Enabled

Boolean paramter indicating the enabled state of the policy. true - Enabled, false - Disabled

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

-IsEmailAttachmentEnabled

boolean value representing if email attachment is enabled for new Policy

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2407

-IsWebhookAttachmentEnabled

boolean value representing if webhook attachment is enabled for new Policy

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2407

-WebhookProfileId

Unique identifier for the webhook profile to be associated with the policy.

Type: Int64
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2411

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

None

You can’t pipe objects to this cmdlet.

Outputs

MonitorNotificationPolicy

Returns the collection of policy objects created

New-MonitorNotificationPolicy