Set-SPIRMSettings

Sets the Information Rights Management (IRM) settings.

Syntax

Set-SPIRMSettings
   -CertificateServerUrl <Uri>
   [-IrmEnabled]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CertificatePassword <SecureString>]
   [-Confirm]
   [-ServiceAuthenticationCertificate <X509Certificate2>]
   [-SubscriptionScopeSettingsEnabled]
   [-WhatIf]
   [-UseOauth]
   [<CommonParameters>]
Set-SPIRMSettings
   [-IrmEnabled]
   [-AssignmentCollection <SPAssignmentCollection>]
   [-CertificatePassword <SecureString>]
   [-Confirm]
   [-ServiceAuthenticationCertificate <X509Certificate2>]
   [-SubscriptionScopeSettingsEnabled]
   [-UseActiveDirectoryDiscovery]
   [-WhatIf]
   [-UseOauth]
   [<CommonParameters>]

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 (http://go.microsoft.com/fwlink/?LinkID=187810).

Use the Set-SPIRMSettings cmdlet to set the Information Rights Management (IRM) settings for the tenant.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251831 (http://go.microsoft.com/fwlink/p/?LinkId=251831).

Examples

--------------EXAMPLE 1------------

C:\PS>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------------

C:\PS>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------------

C:\PS>site = Get-SPSite http://myspserver

C:\PS>$subscription = $site.SiteSubscription

C:\PS>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------------

C:\PS>Set-SPIRMSettings -RmsEnabled:$false

This example disables IRM for the farm.

Required Parameters

-CertificateServerUrl

Specifies the address of the RMS certificate server to use for the tenant.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-IrmEnabled

Specifies whether or not IRM is enabled in the tenant.

The default value is false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016

Optional Parameters

-AssignmentCollection

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.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-CertificatePassword

Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store.

Type:SecureString
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-ServiceAuthenticationCertificate

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.

Type:X509Certificate2
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-SubscriptionScopeSettingsEnabled

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-UseActiveDirectoryDiscovery

Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the domain.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016
-UseOauth

{{Fill UseOauth Description}}

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2016
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016