.png)
Set-SPIRMSettings
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Sets the Information Rights Management (IRM) settings.
Set-SPIRMSettings -IrmEnabled <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-CertificatePassword <SecureString>] [-Confirm [<SwitchParameter>]] [-ServiceAuthenticationCertificate <X509Certificate2>] [-SubscriptionScopeSettingsEnabled <SwitchParameter>] [-UseActiveDirectoryDiscovery <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-SPIRMSettings -CertificateServerUrl <Uri> -IrmEnabled <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-CertificatePassword <SecureString>] [-Confirm [<SwitchParameter>]] [-ServiceAuthenticationCertificate <X509Certificate2>] [-SubscriptionScopeSettingsEnabled <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Parameters
1| Parameter | Required | Type | Description | ||
| IrmEnabled | Required | System.Management.Automation.SwitchParameter | Specifies whether or not IRM is enabled in the tenant. The default value is false. | ||
| 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.
| ||
| CertificatePassword | Optional | System.Security.SecureString | Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store. | ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| ServiceAuthenticationCertificate | Optional | System.Security.Cryptography.X509Certificates.X509Certificate2 | Specifies the service authentication certificate. If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. If the parameter is not specified, the local farm connects to RMS server using integrated windows authentication. | ||
| SubscriptionScopeSettingsEnabled | Optional | System.Management.Automation.SwitchParameter | Specifies whether or not IRM can be configured at the site subscription scope. Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope. | ||
| UseActiveDirectoryDiscovery | Optional | System.Management.Automation.SwitchParameter | Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the domain. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Note: | Parameter | Required | Type | Description | ||
| CertificateServerUrl | Required | System.Uri | Specifies the address of the RMS certificate server to use for the tenant. | ||
| IrmEnabled | Required | System.Management.Automation.SwitchParameter | Specifies whether or not IRM is enabled in the tenant. The default value is false. | ||
| 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.
| ||
| CertificatePassword | Optional | System.Security.SecureString | Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store. | ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| ServiceAuthenticationCertificate | Optional | System.Security.Cryptography.X509Certificates.X509Certificate2 | Specifies the service authentication certificate. If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. If the parameter is not specified, the local farm connects to RMS server using integrated windows authentication. | ||
| SubscriptionScopeSettingsEnabled | Optional | System.Management.Automation.SwitchParameter | Specifies whether or not IRM can be configured at the site subscription scope. Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
Use the Set-SPIRMSettings cmdlet to set the Information Rights Management (IRM) settings for the tenant.
Input Types
Return Types
--------------EXAMPLE 1------------
Set-SPIRMSettings –RmsEnabled -UseActiveDirectoryDiscovery
This example enables IRM for the farm and configures it to use the default RMS server configured in Active Directory.
--------------EXAMPLE 2------------
Set-SPIRMSettings –RmsEnabled –CertificateServerUrl http://myrmsserver
This example enables IRM for the farm and specifies the URL of the RMS server to use.
--------------EXAMPLE 3------------
site = Get-SPSite http://myspserver
$subscription = $site.SiteSubscription
Set-SPIRMSettings –SiteSubscription $subscription –RmsEnabled –CertificateServerUrl http://myrmsserver
This example enables IRM for the specified tenant and specifies the URL of the RMS server to use.
--------------EXAMPLE 4------------
Set-SPIRMSettings –RmsEnabled:$false
This example disables IRM for the farm.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
