New-FasCloudRegistration
SYNOPSIS
Registers FAS with the Citrix Cloud without requiring a registration code.
SYNTAX
KnownClouds
New-FasCloudRegistration -CloudId <String> [-Staging] -Rule <String> -ClientId <String> -ClientSecret <String>
-Customer <String> -ResourceLocationId <String> [-Address <String>] [<CommonParameters>]
<!--NeedCopy-->
NewCloud
New-FasCloudRegistration -CwsServiceUri <String> -GeoServiceUri <String> -Rule <String> -ClientId <String>
-ClientSecret <String> -Customer <String> -ResourceLocationId <String> [-Address <String>]
[<CommonParameters>]
<!--NeedCopy-->
UsernamePassword
New-FasCloudRegistration [-Address <String>] [-UserName <String>] [-Password <String>] [<CommonParameters>]
<!--NeedCopy-->
DESCRIPTION
Registers FAS with a Citrix Cloud without requiring a registration code. This command is used to register with a Citrix Cloud that does not support registration codes. This requires using a secure client to authenticate with Citrix Cloud. A secure client can be generated in the Citrix Cloud Admin Console.
EXAMPLES
Example 1
PS C:\> New-FasCloudRegistration -CloudId com -Rule Default -ClientId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ClientSecret xxxxxxxxxxxxxxxxxxxxxxxxxxxxx -Customer xxxxxxxxxxxx -ResourceLocationId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Address localhost
<!--NeedCopy-->
Registers FAS with Citrix cloud using an existing Citrix cloud, as identified by ‘com’, which represents the default Citrix commercial cloud. See Get-FasCloudRegistrationCloudInfo for list of supported clouds and their associated cloud identifiers.
Example 2
PS C:\> New-FasCloudRegistration -CwsServiceUri "https://service.example.net/" -GeoServiceUri "https://service-geo.ctxwsstgapi.net/" -Rule Default -ClientId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -ClientSecret xxxxxxxxxxxxxxxxxxxxxxxxxxxxx -Customer xxxxxxxxxxxx -ResourceLocationId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx -Address localhost
<!--NeedCopy-->
Registers FAS with Citrix Cloud using an explicit cloud referenced by https://service.example.net
PARAMETERS
-Address
Address of FAS Server (or $NULL to use $CitrixFasAddress)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-ClientSecret
Specified the secure client secret to use to authenticate with citrix cloud. This is the secret of the secure client, which can be generated in Citrix Cloud.
Type: String
Parameter Sets: KnownClouds, NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-ClientId
The secure client secret identifier to use to authenticate with citrix cloud. This is the identifier of the secure client generated in Citrix Cloud.
Type: String
Parameter Sets: KnownClouds, NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-GeoServiceUri
This is a specific geo-aware cloud endpoint
Type: String
Parameter Sets: NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-CloudId
This is the identifier of the Citrix cloud to register FAS with
Type: String
Parameter Sets: KnownClouds
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-CwsServiceUri
This is an explicit reference to a Citrix cloud endpoint to register FAS with
Type: String
Parameter Sets: NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Customer
This is the cloud customer that owns this FAS server
Type: String
Parameter Sets: KnownClouds, NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Password
Password for authentication to FAS server ($NULL for current user account)
Type: String
Parameter Sets: UsernamePassword
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-ResourceLocationId
The resource location Id, such that when desktops and apps (resources) are launched in this location, this FAS server will be used to SSO into those resources. The resource location id can be found in resource locations page in Citrix Cloud or using Get-FasCloudRegistrationStatus once the registration code is approved in Citrix Cloud
Type: String
Parameter Sets: KnownClouds, NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Rule
The rule name parameter specifies which rule is applied to identity assertions made by Citrix Cloud Workspace
Type: String
Parameter Sets: KnownClouds, NewCloud
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-UserName
The username that will be used to connect to the FAS server, which if unspecified, will use the current Windows network identity
Type: String
Parameter Sets: UsernamePassword
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Staging
Type: SwitchParameter
Parameter Sets: KnownClouds
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
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
OUTPUTS
Citrix.Authentication.FederatedAuthenticationService.ToggledPowerShell.Registration.Models.NewCloudRegistrationUserResponse
NOTES
RELATED LINKS
Get-FasCloudRegistrationCloudInfo