Citrix Virtual Apps and Desktops SDK

Set-XDLicensing

August 9, 2024

Contributed by:

Changes one or more of the licensing attributes of a Site

Syntax

Set-XDLicensing
   [-Force]
   [-LicenseServerAddress <String>]
   [-LicenseServerPort <String>]
   [-LicensingModel <String>]
   [-PassThru]
   [-ProductCode <String>]
   [-ProductEdition <String>]
   [-AdminAddress <String>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Changes one or more of the licensing attributes of the Site which has a Controller identified by AdminAddress. When the Citrix License Server address and/or port are specified and Force is not, the new server:port combination will be validated before being changed. Otherwise, no validation is performed.

Examples

EXAMPLE 1

For the Site managed by MyController, changes the License Server to MyLicenseServer:27001.

Set-XDLicensing -AdminAddress MyController -LicenseServerAddress MyLicenseServer -LicenseServerPort 27001
<!--NeedCopy-->

Parameters

-Force

Force the setting of the License Server address and/or port, i.e. do not check that the new server:port combination is valid. This can be used, for example, when the License Server needs to be set but is temporarily unavailable.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseServerAddress

The address of the License Server for this Site. If this parameter is not provided then the License Server address will not be altered.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseServerPort

The port on which the License Server for this Site is listening. If this parameter is not provided then the License Server port will not be altered.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicensingModel

The licensing model for this Site. If this parameter is not provided then the licensing model will not be altered. Use the ProductCode returned from Get-XDSite as input to Get-ConfigLicensingModel to determine the list of valid licensing models.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns the affected record. By default, this cmdlet does not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProductCode

The product code for this Site. If this parameter is not provided then the product code will not be altered. Find valid product codes by running Get-ConfigProduct.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProductEdition

The product edition for this Site. If this parameter is not provided then the product edition will not be altered. Use the ProductCode returned from Get-XDSite as input to Get-ConfigProductEdition to determine the list of valid product editions.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AdminAddress

Specifies the address of the Delivery Controller to which the PowerShell module will connect. This can be provided as a host name or an IP address.

Type:	String
Position:	Named
Default value:	Localhost. Once a value is provided by any cmdlet, this value will become the default.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

None

You cannot pipe input to this cmdlet.

Outputs

None or Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.LicenseInformation

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.LicenseInformation object.

Notes

The command can fail for the following reasons:

The supplied License Server does not support the requested product edition.
A License Server was not found at the supplied address.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-XDLicensing

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Set-XDLicensing

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Force

-LicenseServerAddress

-LicenseServerPort

-LicensingModel

-PassThru

-ProductCode

-ProductEdition

-AdminAddress

CommonParameters

Inputs

None

Outputs

None or Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.LicenseInformation

Notes

Related Links

In this article