Remove-ProvServiceMetadata¶
Removes metadata from the given Machine Creation Service.
Syntax¶
Remove-ProvServiceMetadata [-ServiceHostId] <Guid> -Name <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvServiceMetadata [-ServiceHostId] <Guid> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvServiceMetadata [-InputObject] <Service[]> -Name <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>] Remove-ProvServiceMetadata [-InputObject] <Service[]> -Map <PSObject> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description¶
Provides the ability to remove metadata from the given Machine Creation Service.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ServiceHostId | Id of the Machine Creation Service | true | true (ByValue, ByPropertyName) | |
| InputObject | Machine Creation Service objects from which metadata is to be removed. | true | true (ByValue) | |
| Name | The metadata property to remove. | true | false | |
| Map | Specifies a dictionary of (name, value)-pairs for the properties. This can be either a hashtable (created with @{"name1" = "val1"; "name2" = "val2"}) or a string dictionary (created with new-object "System.Collections.Generic.Dictionary[string, string];"). The properties whose names match keys in the map will be removed. | true | true (ByValue) | |
| 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. | false | false | |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false | |
| AdminClientIP | Specifies the Client IP of the calling user | false | false | |
| TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | |
| TraceState | Specifies the trace state assigned for internal diagnostic tracing user | false | false | |
| VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | false | false | |
| AdminAddress | The address of a Citrix Virtual Apps and Desktops controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
Input Type¶
Citrix.Machinecreation.Sdk.Service¶
A Service object can be piped to the Remove-ProvServiceMetadata command.
System.Management.Automation.Psobject¶
A metadata map object can be piped to the Remove-ProvServiceMetadata command.
Return Values¶
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.
Examples¶
Example 1¶
c:\PS>Get-ProvService | % { Remove-ProvServiceMetadata -Map $_.MetadataMap }
Description¶
Remove all metadata from all Machine Creation Service objects.