.png)
Set-SPTrustedRootAuthority
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Creates a new trusted root authority.
Set-SPTrustedRootAuthority [-Identity] <SPTrustedRootAuthorityPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Certificate <X509Certificate2>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Set-SPTrustedRootAuthority [-Identity] <SPTrustedRootAuthorityPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-MetadataEndPoint <Uri>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| Identity | Required | Microsoft.SharePoint.PowerShell.SPTrustedRootAuthorityPipeBind | Specifies the trusted root authority to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Certificate | Optional | System.Security.Cryptography.X509Certificates.X509Certificate2 | Specifies the X.509 certificate of the trusted root authority. The type must be a name of a valid X.509 certificate; for example, Certificate1. |
Note: | Parameter | Required | Type | Description | ||
| Identity | Required | Microsoft.SharePoint.PowerShell.SPTrustedRootAuthorityPipeBind | Specifies the trusted root authority to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a trusted root authority (for example, WFEFarm1); or an instance of a valid SPTrustedRootAuthority object. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
|
Detailed Description
The Set-SPTrustedRootAuthority cmdlet creates a new trusted root authority. If a certificate file is used, the certificate must be an X509 certificate with private keys, otherwise an exception is raised.
Input Types
Return Types
------------------EXAMPLE------------------
$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfxGet – SPTrustedRootAuthority –Name "WFEFarm1" | Set– SPTrustedRootAuthority -Certificate $cert
This example updates the certificate of the trusted root authority WFEFarm1.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
