Export (0) Print
Expand All

Set-SPMetadataServiceApplication

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets the properties of a managed metadata service application.

Set-SPMetadataServiceApplication [-Identity] <SPMetadataServiceCmdletPipeBind> [-AdministratorAccount <String>] [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-CacheTimeCheckInterval <Int32>] [-Confirm [<SwitchParameter>]] [-DatabaseCredentials <PSCredential>] [-DatabaseName <String>] [-DatabaseServer <String>] [-DoNotUnpublishAllPackages <SwitchParameter>] [-FailoverDatabaseServer <String>] [-FullAccessAccount <String>] [-HubUri <String>] [-MaxChannelCache <Int32>] [-Name <String>] [-ReadAccessAccount <String>] [-RestrictedAccount <String>] [-SyndicationErrorReportEnabled <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.Taxonomy.Cmdlet.SPMetadataServiceCmdletPipeBind

Specifies the managed metadata service application to update.

The type must be a valid GUID or the name of a valid managed metadata service application.

AdministratorAccount

Optional

System.String

A comma-separated list of user accounts or service accounts in the format <domain>\<account> that may create and run the service application. The accounts must already exist.

If a value is set by using this parameter, any existing values for the FullAccessAccount, ReadAccessAccount, and RestrictedAccount parameters are removed. Consider setting all four parameters at the same time.

ApplicationPool

Optional

Microsoft.SharePoint.PowerShell.SPIisWebServiceApplicationPoolPipeBind

Specifies an existing IIS application pool in which to run the Web service for the managed metadata service application.

The value must be a GUID that is the identity of an SPServiceApplicationPool object; the name of an existing application pool; or an instance of a valid SPServiceApplicationPool 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.

noteNote:

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.

CacheTimeCheckInterval

Optional

System.Int32

Specifies the interval, in seconds, that a front-end Web server should wait before asking the application server for changes. This value is set per timer job, client application, or Web application.

The mininum value is 1, and there is no maximum value. The default value is 10.

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

DatabaseCredentials

Optional

System.Management.Automation.PSCredential

Specifies the PSCredential object that contains the user name and password to be used for database SQL authentication.

If SQL authentication is to be used, either the DatabaseCredentials parameter must be specified or both the DatabaseUserName and DatabasePassword parameters must be set.

The type must be a valid PSCredential object.

DatabaseName

Optional

System.String

Specifies the name of the database that contains the term store for the managed metadata service application.

The type must be a valid name of a SQL Server database; for example MeatadataDB1.

DatabaseServer

Optional

System.String

Specifies the name of the host server for the database specified in DatabaseName.

The type must be a valid name of a SQL Server database; for example SqlServerHost1.

DoNotUnpublishAllPackages

Optional

System.Management.Automation.SwitchParameter

If this flag is set, the packages will not be unpublished. If the HubUri parameter is changed, all content type packages will be unpublished by default.

If the HubUri parameter is not changed, this flag has no effect.

FailoverDatabaseServer

Optional

System.String

Specifies the name of the host server for the failover database server.

The type must be a valid SQL Server host name; for example, SQLServerHost1.

FullAccessAccount

Optional

System.String

Specifies a comma-separated set of application pool accounts in the format <domain>\<account> that will be given read/write permission to the managed metadata service's term store and content type gallery. The accounts must already exist.

If a value is set by using this parameter, any existing values for the AdministratorAccount, ReadAccessAccount, and RestrictedAccount parameters are removed. Consider setting all four parameters at the same time.

Name

Optional

System.String

Specifies the new name of the service application. The name can contain a maximum of 128 characters.

RestrictedAccount

Optional

System.String

Specifies a comma-separated set of application pool accounts in the format <domain>\<account> that will be given permission to read the managed metadata service's term store and content type gallery, and permission to write to open term sets and local term sets and to create new enterprise keywords. The accounts must already exist.

If a value is set by using this parameter, any previous values for the FullAccessAccount, ReadAccessAccount, and AdministratorAccount parameters are removed. Consider setting all four parameters at the same time.

SyndicationErrorReportEnabled

Optional

System.Management.Automation.SwitchParameter

Enables reporting of errors when content types are imported.

HubUri

Optional

System.String

Specifies the fully qualified URL of the site collection that contains the content type gallery that the service will provide access to.

MaxChannelCache

Optional

System.Int32

Specifies the maximum number of Windows Communication Foundation (WCF) channels that a front-end Web server holds open to the application server. This value is set per timer job, client application, or Web application.

The minimum value is 0, and there is no maximum value. The default value is 4.

ReadAccessAccount

Optional

System.String

Specifies a comma-separated set of application pool accounts in the format <domain>\<account> that will be given read-only permission to the managed metadata service's term store and content type gallery. The accounts must already exist.

If a value is set by using this parameter, any previous values for the FullAccessAccount, RestrictedAccount, and AdministratorAccount parameters are removed. Consider setting all four parameters at the same time.

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

Use the Set-SPMetadataServiceApplication cmdlet to set the properties of a managed metadata service application.

Input Types

Return Types

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

Set-SPMetadataServiceApplication -Identity "MetadataServiceApp1" -HubUri "http://sitename" -SyndicationErrorReportEnabled

This example adds a content type hub to an existing managed metadata service application. It also enables error reporting when content types are imported.

--------------------EXAMPLE 2---------------------

Set-SPMetadataServiceApplication -Identity "MetadataServiceApp1" -AdministratorAccount "contoso\username1" -FullAccessAccount "contoso\AppPoolAccount1,contoso\AppPoolAccount2" -RestrictedAccount "contoso\AppPoolAccount3,contoso\AppPoolAccount4,contoso\AppPoolAccount5" –ReadAccessAccount "contoso\AppPoolAccount6"

This example sets permissions on an existing managed metadata service application.

noteNote:

If you use Windows PowerShell to set any of the account values, you should set all of them. The Set-SPMetadataServiceApplication cmdlet first erases all accounts, then adds the accounts that you specified.

Change History

Date Description

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft