Add-CAAuthorityInformationAccess
Add-CAAuthorityInformationAccess
Configures the Authority Information Access (AIA) or Online Certificate Status Protocol (OCSP) for a certification authority (CA).
Syntax
Parameter Set: AddAsAIA
Add-CAAuthorityInformationAccess [-Uri] <String> -AddToCertificateAia [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddAsInputObject
Add-CAAuthorityInformationAccess [-InputObject] <AuthorityInformationAccess> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: AddAsOCSP
Add-CAAuthorityInformationAccess [-Uri] <String> -AddToCertificateOcsp [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-CAAuthorityInformationAccess cmdlet configures the uniform resource identifier (URI) for the AIA or Online Responder OCSP location for a CA. An AIA URI should specify either an AIA extension or an OCSP extension, but not both.
Parameters
-AddToCertificateAia
Specifies to add the URI to the AIA extension of the issued certificate.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AddToCertificateOcsp
Specifies to add the URI to the Online Responder OCSP extension of the issued certificate.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Suppresses all user prompts. By default, you are prompted to confirm each operation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<AuthorityInformationAccess>
The input object is meant to be used in a pipeline command.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Uri<String>
Specifies a URI for the AIA or Online Responder OCSP location.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.String
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.CertificateServices.Administration.Commands.CA.AuthorityInformationAccessResult
This output object has a single property named Restart of Boolean type, which by default is set to True.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Adds Authority Information Access (AIA) for the specified certification authority to http://ca1.corp.contoso.com/pki
PS C:\> Add-CAAuthorityInformationAccess –AddToCertificateAia -uri http://ca1.corp.contoso.com/pki
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Adds AIA for OCSP pointing to http://www.corp.contoso.com/ocsp
PS C:\> Add-CAAuthorityInformationAccess -AddToCertificateOcsp -uri http://www.corp.contoso.com/ocsp
-------------------------- EXAMPLE 3 --------------------------
These commands remove all AIA entries
PS C:\> $aia = Get-CAAuthorityInformationAccess
PS C:\> $aia | remove-CAAuthorityInformationAccess