New-FasUserCertificate

SYNOPSIS

Generate and cache a certificate for a user on the Federated Authentication Service.

SYNTAX

New-FasUserCertificate -UserPrincipalName <String> -Rule <String> -CertificateDefinition <String>
 [-SecurityContext <String>] [-Address <String>] [-UserName <String>] [-Password <String>] [<CommonParameters>]
<!--NeedCopy-->

DESCRIPTION

This command creates a certificate for a user on the Federated Authentication Service. This can be used for testing purposes, or run at “off-peak” times to spread the load of certificate generation that would otherwise happen at user logon.

A new certificate is not generated if a cached certificate for the user already exists.

EXAMPLES

EXAMPLE 1

PS C:\>

C:\PS> $CitrixFasAddress=(Get-FasServer)[0].Address
C:\PS> New-FasUserCertificate -UserPrincipalName "fred@citrixtest.net" -Rule "default" -CertificateDefinition "default_Definition"
<!--NeedCopy-->

Description


This code generates and caches a certificate for fred@citrixtest.net.

PARAMETERS

-UserPrincipalName

Specify the UPN of the user for whom this certificate is being generated.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: (required)
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-Rule

Specify the Rule name (Federated Authentication Service configuration) this certificate is associated with.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: (required)
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-CertificateDefinition

Specify the Certificate Definition to use when generating the certificate.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: (required)
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-SecurityContext

Specify the Security Context to use when generating the certificate.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $NULL
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-Address

Address of FAS Server (or $NULL to use $CitrixFasAddress)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $CitrixFasAddress
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-UserName

User name to use for authentication to FAS server ($NULL for current user account)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $NULL
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: (All)
Aliases:

Required: False
Position: Named
Default value: $NULL
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

Variable, based on property name.

This cmdlet does accept input from the pipeline but only by property name.

OUTPUTS

void

This cmdlet returns the user certificate if successful

NOTES

Get-FasUserCertificate

Remove-FasUserCertificate

New-FasUserCertificate