Product Documentation

Set-BrokerSiteMetadata

Oct 21, 2016

Creates/Updates metadata key-value pairs for Site

Syntax

Set-BrokerSiteMetadata -Map <PSObject> [[-InputObject] <Site[]>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerSiteMetadata -Name <String> -Value <String> [[-InputObject] <Site[]>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerSiteMetadata -Name <String> -Value <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerSiteMetadata -Name <String> -Value <String> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-BrokerSiteMetadata -Map <PSObject> [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Set-BrokerSiteMetadata cmdlet creates/updates metadata key-value pairs for Site. The Site can be specified by ImputObject or piping.

Related topics

Parameters

-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)

-InputObject<Site[]>

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

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-PassThru<SwitchParameter>

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 False
Accept Pipeline Input? 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 Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.BrokerSite You can pipe the Site to hold the new or updated metadata.

Return Values

None or Citrix.Broker.Admin.SDK.BrokerSite

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.BrokerSite object.

Examples

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

C:\PS> Set-BrokerSiteMetadata -Name "MyMetadataName" -Value "1234"

This command creates/updates the Metadata "MyMetadataName" key-value pair for the Site

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

C:\PS> Get-BrokerSite | Set-BrokerSiteMetadata -Name "MyMetadataName" -Value "1234"

This command creates/updates metadata key "MyMetadataName" with the value "1234"