Set-BrokerMergeGroup
Introduced in: Citrix Virtual Apps and Desktop 7 2407
Sets the properties of a Merge Group
Syntax
Set-BrokerMergeGroup
[-InputObject] <MergeGroup[]>
[-PassThru]
[-DefaultResourceUid <Int32>]
[-Description <String>]
[-MergeGroupSetUid <Int32>]
[-PublishedName <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerMergeGroup
[-Name] <String>
[-PassThru]
[-DefaultResourceUid <Int32>]
[-Description <String>]
[-MergeGroupSetUid <Int32>]
[-PublishedName <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Can be used to set the Name, Description, and the DefaultResourceUid of a Merge Group
Examples
EXAMPLE 1
Sets the Default Resource of the Merge Group to a MergedResource with Uid = 7
$mergeGroup = Get-BrokerMergeGroup -Uid 1
Set-BrokerMergeGroup $mergeGroup -DefaultResourceUid 7
Parameters
-InputObject
Specifies one or more Merge Group objects.
| Type: | MergeGroup[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Identifies the Merge Group to modify.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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 |
-DefaultResourceUid
Supplies the new value for the Uid of the Merged Resource to be used as the Default Resource for the Merge Group
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
The updated description of the Merge Group
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 512 |
-MergeGroupSetUid
The Uid of the Merge Group Set this Merge Group belongs to
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-PublishedName
Published name of Merge Group as seen by end user. If not specified
value used defaults to the administrative name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 255 |
| Disallowed characters: | /;:#.*?=<>\|[]()"' and all ASCII control characters |
-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.MergeGroup
You can pipe in the Merge Groups whose properties you want to set.
Outputs
None or Citrix.Broker.Admin.SDK.MergeGroup
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.MergeGroup object.