Set-BrokerCatalog
Sets the properties of a catalog.
Syntax
Set-BrokerCatalog
[-InputObject] <Catalog[]>
[-PassThru]
[-Description <String>]
[-HypervisorVMTagging <Boolean>]
[-IsRemotePC <Boolean>]
[-MinimumFunctionalLevel <FunctionalLevel>]
[-ProvisioningSchemeId <Guid>]
[-PvsAddress <String>]
[-PvsDomain <String>]
[-RemotePCHypervisorConnectionUid <Int32>]
[-TimeZone <String>]
[-ZoneUid <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-BrokerCatalog
[-Name] <String>
[-PassThru]
[-Description <String>]
[-HypervisorVMTagging <Boolean>]
[-IsRemotePC <Boolean>]
[-MinimumFunctionalLevel <FunctionalLevel>]
[-ProvisioningSchemeId <Guid>]
[-PvsAddress <String>]
[-PvsDomain <String>]
[-RemotePCHypervisorConnectionUid <Int32>]
[-TimeZone <String>]
[-ZoneUid <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-BrokerCatalog cmdlet sets properties of a catalog or set of catalogs. The catalog can be specified by name, in which case only one catalog can be specified, or one or more catalog instances can be passed to the command either by piping or by using the -InputObject parameter.
Examples
EXAMPLE 1
This example specifies a catalog by name and sets its description.
Set-BrokerCatalog -Name "MyCatalog" -Description "New Description"
EXAMPLE 2
This example sets the description for all catalogs with AllocationType 'Static'.
$permCatalogs = Get-BrokerCatalog -AllocationType Static
Set-BrokerCatalog -InputObject $permCatalogs -Description "Permanently assigned machines"
Parameters
-InputObject
Specifies the catalog objects to modify.
| Type: | Catalog[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Identifies the catalog 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 |
-Description
Supplies the new value of the Description property.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Disallowed characters: | All ASCII control characters |
-HypervisorVMTagging
Indicates that assigned VMs from this catalog will carry a hypervisor-level tag
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2503 |
-IsRemotePC
Supplies a new value for IsRemotePC.
IsRemotePC can only be enabled when:
-
SessionSupport is SingleSession
-
MachinesArePhysical is true.
IsRemotePC can only be set from true to false when no RemotePCAccount references this catalog, and when no Remote PC relationship exists between this catalog and a desktop group.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinimumFunctionalLevel
The new minimum FunctionalLevel required for machines to work successfully in the catalog. If this is higher than the FunctionalLevel of any machines already in the catalog, they will immediately cease to function.
Valid values are L5, L7, L7_6, L7_7, L7_8, L7_9, L7_20, L7_25, L7_30, L7_34
| Type: | FunctionalLevel |
| Accepted values: | L5, LMIN, L7, L7_6, L7_7, L7_8, L7_9, L7_20, L7_25, L7_30, L7_34, LMAX |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeId
Specifies the identity of the MCS provisioning scheme the catalog is associated with (can only be specified for new catalogs with a ProvisioningType of MCS; once set can never be changed).
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PvsAddress
Supplies the new value of the PvsAddress property. Can only be set if CatalogKind is Pvs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PvsDomain
Supplies the new value of the PvsDomain property. Can only be set if CatalogKind is Pvs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemotePCHypervisorConnectionUid
Supplies the new hypervisor connection to use for powering on remote PCs in this catalog (only allowed when IsRemotePC is true); this will affect all machines already in the catalog as well as those created later.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeZone
The time zone in which this catalog's machines reside.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2209 |
-ZoneUid
Supplies the Zone Uid associated with this catalog.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| 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.Catalog
You can pipe the catalogs to be modified to Set-BrokerCatalog.
Outputs
None or Citrix.Broker.Admin.SDK.Catalog
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.Catalog object.
Notes
A catalog's Name property cannot be changed by Set-BrokerCatalog. To rename a catalog use Rename-BrokerCatalog.