Remove-Brokermachinecommandmetadata¶
Deletes MachineCommand Metadata from the MachineCommand objects
Syntax¶
Remove-BrokerMachineCommandMetadata [-InputObject] <MachineCommand[]> -Name <String> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
Detailed Description¶
The Remove-BrokerMachineCommandMetadata cmdlet deletes Metadata from the MachineCommand objects.
Related Commands¶
Parameters¶
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| InputObject | Specifies the MachineCommand object's instance whose Metadata is to be deleted. | true | true (ByValue) | |
| Name | Specifies the name of the Metadata to be deleted | true | 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. | false | false | |
| AdminAddress | Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address. | false | false | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| BearerToken | Specifies the bearer token assigned to the calling user | false | false |
Input Type¶
Citrix.Broker.Admin.Sdk.Brokermachinecommand¶
You can pipe the MachineCommand to delete the metadata.
Return Values¶
None¶
Examples¶
Example 1¶
C:\PS> Remove-BrokerMachineCommandMetadata -InputObject $obj-Uid -Name "MyMetadataName"
Description¶
This command deletes the Metadata "MyMetadataName" key-value pair for the MachineCommand whose instance is pointed by \$obj-Uid
Example 2¶
C:\PS> Get-BrokerMachineCommand | Remove-BrokerMachineCommandMetadata -Name "MyMetadataName"
Description¶
This command deletes the Metadata "MyMetadataName" key-value pair for all the MachineCommand in the site