Set-ConfigEdgeServerMetadata
Adds or updates metadata on the given EdgeServer.
Syntax
Set-ConfigEdgeServerMetadata
[-EdgeServerUid] <Guid>
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ConfigEdgeServerMetadata
[-EdgeServerUid] <Guid>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ConfigEdgeServerMetadata
[-EdgeServerName] <String>
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ConfigEdgeServerMetadata
[-EdgeServerName] <String>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ConfigEdgeServerMetadata
[-InputObject] <EdgeServer[]>
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-ConfigEdgeServerMetadata
[-InputObject] <EdgeServer[]>
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability for additional custom data to be stored against given EdgeServer objects.
Examples
EXAMPLE 1
Add metadata with a name of 'property' and a value of 'value' to the EdgeServer with the identifier '4CECC26E-48E1-423F-A1F0-2A06DDD0805C'.
Set-ConfigEdgeServerMetadata -EdgeServerUid 4CECC26E-48E1-423F-A1F0-2A06DDD0805C -Name property -Value value
Key Value
--- -----
property value
Parameters
-EdgeServerUid
Id of the EdgeServer
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-EdgeServerName
Name of the EdgeServer
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | True |
-InputObject
Objects to which the metadata is to be added.
| Type: | EdgeServer[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Specifies the property name of the metadata to be added. The property must be unique for the EdgeServer specified. The property cannot contain any of the following characters \/;:#.*?=\<\>\|\[\]()"'
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Value
Specifies the value for the property.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Map
Specifies a dictionary of (name, value)-pairs for the properties. This can either be a hashtable (created with @{"name1" = "val1"; "name2" = "val2"}) or a string dictionary (created with new-object "System.Collections.Generic.Dictionary\[String,String\]").
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | 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.
| 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
None
You can't pipe objects to this cmdlet.
Outputs
System.Collections.Generic.Dictionary\[String,String\]
Set-ConfigEdgeServerMetadata returns a dictionary containing the new (name, value)-pairs.
-
Key \<string\>Specifies the name of the property.
-
Value \<string\>Specifies the value for the property.
Notes
If the command fails, the following errors can be returned.
Error Codes
InvalidParameterCombination
The cmdlet parameters are inconsistent.
UnknownObject
One of the specified objects was not found.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.