Set-BrokerLeaseMetadata
Creates/Updates metadata key-value pairs for Lease
Syntax
Set-BrokerLeaseMetadata
[-LeaseId] <Int64>
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-InputObject] <Lease[]>
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-InputObject] <Lease[]>
[-PassThru]
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-LeaseName] <String>
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-LeaseName] <String>
[-PassThru]
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-LeaseId] <Int64>
[-PassThru]
-Map <PSObject>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerLeaseMetadata
[-LeaseId] <Int64>
[-PassThru]
-Name <String>
-Value <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-BrokerLeaseMetadata cmdlet creates/updates metadata key-value
pairs for Lease. The Lease can be specified by InputObject or piping.
Examples
EXAMPLE 1
This command creates/updates the Metadata "MyMetadataName" key-value pair for the Lease whose instance is pointed by \$obj-Uid
Set-BrokerLeaseMetadata -InputObject $obj-Uid -Name "MyMetadataName" -Value "1234"
EXAMPLE 2
This command creates/updates metadata key "MyMetadataName" with the value "1234" for all the Lease in the site
Get-BrokerLease | Set-BrokerLeaseMetadata -Name "MyMetadataName" -Value "1234"
EXAMPLE 3
This command creates/updates two metadata keys "name1" and "name2" with the values "value1" and "value2" respectively for the Lease in the site whose name is 'objname'
@{ 'name1' = 'value1'; 'name2' = 'value2' } | Set-BrokerLeaseMetadata 'objname'
Parameters
-LeaseId
Specifies the Lease object whose Metadata is to be created/updated by ID.
| Type: | Int64 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
| Type: | Int64 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
| Type: | Int64 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-InputObject
Specifies the Lease objects whose Metadata is to be created/updated.
| Type: | Lease[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-LeaseName
Specifies the Lease object whose Metadata is to be created/updated by name.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | True |
-Name
Specifies the name of the Metadata member to be created/updated
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 0 to 64 |
| Disallowed characters: | \/;:#.*?=<>\|[]()"`' |
-Value
Specifies the value of the Metadata member to be created/updated
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 0 to 1000 |
-Map
Specifies a hashtable containing name/value pairs to be used to create or update Metadata members
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| 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
Citrix.Broker.Admin.SDK.BrokerLease
You can pipe the Lease to hold the new or updated metadata.
Outputs
None or Citrix.Broker.Admin.SDK.BrokerLease
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.BrokerLease object.