Citrix Virtual Apps and Desktops SDK

Set-Monitornotificationpolicy

August 3, 2023

Contributed by:

Set/Modify MonitorNotificationPolicy object

Syntax

Set-MonitorNotificationPolicy -InputObject <MonitorNotificationPolicy> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-MonitorNotificationPolicy -Uid <Int64> [-Name <String>] [-Description <String>] [-Webhook <String>] [-IsSnmpEnabled <Boolean>] [-Enabled <Boolean>] [-LoggingId <Guid>] [-BearerToken <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
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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-Monitornotificationpolicy

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-Monitornotificationpolicy

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Monitornotificationpolicy

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article