XenApp and XenDesktop 7.6

Set-BrokerAccessPolicyRuleMetadata

Sep 10, 2014

Creates/Updates metadata key-value pairs for AccessPolicyRule

Syntax

Set-BrokerAccessPolicyRuleMetadata [-AccessPolicyRuleId] <Int32> -Map <PSObject> [-PassThru] [-LoggingId

<Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-AccessPolicyRuleId] <Int32> -Name <String> -Value <String> [-PassThru] [-

LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-AccessPolicyRuleId] <Int32> -Name <String> -Value <String> [-PassThru] [-

LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-InputObject] <AccessPolicyRule[]> -Name <String> -Value <String> [-

PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-InputObject] <AccessPolicyRule[]> -Map <PSObject> [-PassThru] [-LoggingId

<Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-AccessPolicyRuleName] <String> -Map <PSObject> [-PassThru] [-LoggingId

<Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerAccessPolicyRuleMetadata [-AccessPolicyRuleName] <String> -Name <String> -Value <String> [-

PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Set-BrokerAccessPolicyRuleMetadata cmdlet creates/updates metadata key-value pairs for AccessPolicyRule. The

AccessPolicyRule can be specified by InputObject or piping.

Related topics

Parameters

-AccessPolicyRuleId<Int32>

Specifies the AccessPolicyRule object whose Metadata is to be created/updated by ID.

Required?

true

Default Value

Accept Pipeline Input?

true (ByValue, ByPropertyName)

-InputObject<AccessPolicyRule[]>

Specifies the AccessPolicyRule objects whose Metadata is to be created/updated.

Required?

true

Default Value https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.1692

Accept Pipeline Input?

true (ByValue)

-AccessPolicyRuleName<String>

Specifies the AccessPolicyRule object whose Metadata is to be created/updated by name.

Required?

true

Default Value

Accept Pipeline Input?

true (ByValue, ByPropertyName)

-Map<PSObject>

Specifies a hashtable containing name/value pairs to be used to create or update Metadata members

Required?

true

Default Value

Accept Pipeline Input?

true (ByValue)

-Name<String>

Specifies the name of the Metadata member to be created/updated

Required?

true

Default Value

Accept Pipeline Input?

true (ByPropertyName)

-Value<String>

Specifies the value of the Metadata member to be created/updated

Required?

true

Default Value

Accept Pipeline Input?

true (ByPropertyName)

-PassThru<SwitchParameter> https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.1693

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

Required?

false

Default Value

Accept Pipeline Input?

False false

-LoggingId<Guid>

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.

Required?

false

Default Value

Accept Pipeline Input?

false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an

IP address.

Required?

false

Default Value

Accept Pipeline Input?

Localhost. Once a value is provided by any cmdlet, this value will become the default.

false

Input Type

Citrix.Broker.Admin.SDK.BrokerAccessPolicyRule You can pipe the AccessPolicyRule to hold the new or updated metadata.

Return Values

None or Citrix.Broker.Admin.SDK.BrokerAccessPolicyRule

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a

Citrix.Broker.Admin.SDK.BrokerAccessPolicyRule object.

Examples

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

C:\PS> Set-BrokerAccessPolicyRuleMetadata -InputObject $obj-Uid -Name "MyMetadataName" -Value "1234"

This command creates/updates the Metadata "MyMetadataName" key-value pair for the AccessPolicyRule whose instance is pointed by $obj-Uid https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.1694

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

C:\PS> Get-BrokerAccessPolicyRule | Set-BrokerAccessPolicyRuleMetadata -Name "MyMetadataName" -Value "1234"

This command creates/updates metadata key "MyMetadataName" with the value "1234" for all the AccessPolicyRule in the site

-------------------------- EXAMPLE 3 --------------------------

C:\PS> @{ 'name1' = 'value1'; 'name2' = 'value2' } | Set-BrokerAccessPolicyRuleMetadata 'objname'

This command creates/updates two metadata keys "name1" and "name2" with the values "value1" and "value2" respectively for the

AccessPolicyRule in the site whose name is 'objname' https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.1695