Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Set-MonitorNotificationPolicy

March 11, 2024
Contributed by: 
C

Set/Modify MonitorNotificationPolicy object

Syntax


Set-MonitorNotificationPolicy -InputObject <MonitorNotificationPolicy> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-MonitorNotificationPolicy -Uid <Int64> [-Name <String>] [-Description <String>] [-Webhook <String>] [-IsSnmpEnabled <Boolean>] [-Enabled <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Returns a new policy instance using the specified parameters

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the new policy object to adjust. true false  
Uid Unique identifier for policy to bet set. true false  
Name New Name of the policy. false false  
Description String value representing the new Policy description false false  
Webhook String value representing the new Policy webhook false false  
IsSnmpEnabled boolean value representing if SNMP is enabled for new Policy false false  
Enabled Boolean paramter indicating the enabled state of the policy. true – Enabled, false – Disabled false false  
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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the Client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a Citrix Virtual Apps and Desktops 7 controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Monitornotificationpolicy

Returns the modified policy

Examples

Example 1 


Set-MonitorNotificationPolicy -Id 1 -Enable

<!--NeedCopy-->

Description

Enable the policy with the id 1

Example 2 


$policy = Get-MonitorNotificationPolicy -Uid 1

          $policy.EmailAddresses += "newemail@abc.com"

          Set-MonitorNotificationPolicy -InputObject $policy

<!--NeedCopy-->

Description

Update the policy with the id 1 to add new email address

Example 3 


$policy = Get-MonitorNotificationPolicy -Uid 1

          $policy.TargetIds += "766cde70-3c69-4481-a658-4e11247ac70c"

          $Policy = Set-MonitorNotificationPolicy -Id 1 -InputObject $policy

<!--NeedCopy-->

Description

Update the policy with the id 1 to add new target value

Set-MonitorNotificationPolicy
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.