Set-FasCertificateDefinition
Synopsis
Modify an existing Certificate Definition object (recipe for issuing a certificate).
Syntax
Set-FasCertificateDefinition -Name <String> [-CertificateTemplate <String>]
[-AuthorizationCertificate <String>] [-CertificateAuthorities <String[]>] [-PolicyOids <String>]
[-InSession <Boolean>] [-Address <String>] [-UserName <String>] [-Password <String>] [<CommonParameters>]
<!--NeedCopy-->
Description
Change the configuration of an existing Certificate Definition object that FAS is using to generate user certificates.
When generating a certificate, FAS requires various pieces of information. Including: - The CertificateTemplate to request (see Get-FasMsTemplate) - A list of loadbalanced/failover Certificate Authority Addresses (see Get-FasMsCertificateAuthority) - The ID of the AuthorizationCertificate to use to Authorize the request (see Get-FasAuthorizationCertificate) - A list of additional Issuance Policy OIDs to add to the certificate request (see Get-FasPolicyOid) - A flag indicating if the certificate can be used as an in-session Virtual Smart Card, or only for the logon process.
Note that Certificate Definition objects can only be created and managed by the FAS Server administrator, although they can be referenced by “Rule” administrators.
Examples
Example 1
PS C:\>
C:\PS> $CitrixFasAddress=(Get-FasServer)[0].Address
C:\PS> $DefaultCA=(Get-FasMsCertificateAuthority -Default).Address
C:\PS> Set-FasCertificateDefinition -Name MyCertificateDefinition -CertificateAuthorities $DefaultCA
<!--NeedCopy-->
Description
Updates an existing certificate definition named “MyCertificateDefinition” to use the the default CA
Parameters
-Name
Specify the name of the certificate definition to modify
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: (required)
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-CertificateTemplate
Change the name of Certificate Template to use to issue this certificate
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (no change)
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-AuthorizationCertificate
Change a the Id of an AuthorizationCertificate object
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (no change)
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-CertificateAuthorities
Change the list of Addresses of Certificate Authorities that can issue these certificates
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (no change)
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-PolicyOids
Change the list of Issuance Policy OIDs to request in the certificate
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (no change)
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
<!--NeedCopy-->
-InSession
Change whether to only allow this certificate to be used for authentication
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (no change)
Accept pipeline input: True (ByPropertyName)
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: True (ByPropertyName)
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: True (ByPropertyName)
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: True (ByPropertyName)
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 does not return a value