Set-XDSiteMetadata
Creates or updates metadata key-value pairs for a Site
Syntax
Set-XDSiteMetadata
-DataName <String>
-DataValue <String>
[-PassThru]
[-AdminAddress <String>]
[<CommonParameters>]
Description
Creates or updates metadata key-value pairs for a Site which has a Controller identified by AdminAddress.
Examples
EXAMPLE 1
Creates, or if it already exists, updates the metadata key "MyMetadataName" with the value "1234".
Set-XDSiteMetadata -DataName "MyMetadataName" -DataValue "1234"
Parameters
-DataName
The name of the metadata member that is to be created/updated.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-DataValue
The value of the metadata member that is to be created/updated.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-PassThru
Returns the affected record. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AdminAddress
Specifies the address of the Delivery Controller to which the PowerShell module will connect. This can be provided as a host name or an IP address.
| Type: | String |
| Position: | Named |
| Default value: | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
None
The DataName and DataValue parameters may be piped into this cmdlet by property name.
Outputs
None or Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.Site
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.Site object.