Set-BrokerSiteMetadata
Creates/Updates metadata key-value pairs for Site
Syntax
Set-BrokerSiteMetadata
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerSiteMetadata
[[-InputObject] <Site[]>]
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerSiteMetadata
[[-InputObject] <Site[]>]
[-PassThru]
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerSiteMetadata
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerSiteMetadata
[-PassThru]
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-BrokerSiteMetadata cmdlet creates/updates metadata key-value
pairs for Site. The Site can be specified by InputObject or piping.
Examples
EXAMPLE 1
This command creates/updates the Metadata "MyMetadataName" key-value pair for the Site
Set-BrokerSiteMetadata -Name "MyMetadataName" -Value "1234"
EXAMPLE 2
This command creates/updates metadata key "MyMetadataName" with the value "1234"
Get-BrokerSite | Set-BrokerSiteMetadata -Name "MyMetadataName" -Value "1234"
Parameters
-Name
Specifies the name of the Metadata member to be created/updated
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Value
Specifies the value of the Metadata member to be created/updated
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Map
Specifies a hashtable containing name/value pairs to be used to create or update Metadata members
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-InputObject
Specifies the Site objects whose Metadata is to be created/updated.
| Type: | Site[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
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.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
Citrix.Broker.Admin.SDK.BrokerSite
You can pipe the Site to hold the new or updated metadata.
Outputs
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.