Set-MonitorNotificationPolicy
Set/Modify MonitorNotificationPolicy object
Syntax
Set-MonitorNotificationPolicy
[-WebhookProfileId <Int64>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-MonitorNotificationPolicy
-InputObject <MonitorNotificationPolicy>
[-WebhookProfileId <Int64>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-MonitorNotificationPolicy
-Uid <Int64>
[-Name <String>]
[-Description <String>]
[-Webhook <String>]
[-IsSnmpEnabled <Boolean>]
[-Enabled <Boolean>]
[-WebhookProfileId <Int64>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Returns a new policy instance using the specified parameters
Examples
EXAMPLE 1
Enable the policy with the id 1
Set-MonitorNotificationPolicy -Id 1 -Enable
EXAMPLE 2
Update the policy with the id 1 to add new email address
$policy = Get-MonitorNotificationPolicy -Uid 1
$policy.EmailAddresses += "newemail@abc.com"
Set-MonitorNotificationPolicy -InputObject $policy
EXAMPLE 3
Update the policy with the id 1 to add new target value
$policy = Get-MonitorNotificationPolicy -Uid 1
$policy.TargetIds += "766cde70-3c69-4481-a658-4e11247ac70c"
$Policy = Set-MonitorNotificationPolicy -Id 1 -InputObject $policy
EXAMPLE 4
Update the policy with the id 1 to add/update Webhook Profile
$Policy = Set-MonitorNotificationPolicy -Uid 1 -WebhookProfileId 1
EXAMPLE 5
Update the policy with the id 1 to remove Webhook Profile
$Policy = Set-MonitorNotificationPolicy -Uid 1 -WebhookProfileId 0
Parameters
-InputObject
Specifies the new policy object to adjust.
| Type: | MonitorNotificationPolicy |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Uid
Unique identifier for policy to bet set.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
New Name of the policy.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
String value representing the new Policy description
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Webhook
String value representing the new Policy webhook
| 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 |
-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 modified policy