Set-LogServiceMetadata

Last published : Oct 31, 2026
Adds or updates metadata on the given Service.
Related information
about_LogConfigurationLoggingSnapIn

Syntax

Set-LogServiceMetadata
   [-ServiceHostId] <Guid>
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-LogServiceMetadata
   [-ServiceHostId] <Guid>
   -Map <PSObject>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-LogServiceMetadata
   [-InputObject] <Service[]>
   -Name <String>
   -Value <String>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Set-LogServiceMetadata
   [-InputObject] <Service[]>
   -Map <PSObject>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Allows you to store additional custom data against given ConfigurationLogging Service objects.

Examples

EXAMPLE 1

Add metadata with a name of 'property' and a value of 'value' to the Service with the identifier '4CECC26E-48E1-423F-A1F0-2A06DDD0805C'.
Set-LogServiceMetadata -ServiceHostId 4CECC26E-48E1-423F-A1F0-2A06DDD0805C -Name property -Value value

Key                                       Value
---                                       -----
property                                  value

Parameters

-Name

Specifies the property name of the metadata to be added. The property must be unique for the Service 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
Length range: 1 to 64
Disallowed characters: \/;:#.*?=<>\|[]()"'

-Value

Specifies the value for the property.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False
Length range: 1 to 1000

-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

-ServiceHostId

Id of the Service
Type: Guid
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-InputObject

ConfigurationLogging service objects to which metadata is to be added.
Type: Service[]
Position: 2
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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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-LogServiceMetadata returns a dictionary containing the new (name, value)-pairs.
  • Key \&lt;string\>
    Specifies the name of the property.
  • Value \&lt;string\>
    Specifies the value for the property.

Notes

If the command fails, the following errors can be returned:
  • 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 Citrix Virtual Apps and Desktops logs.