.png)
New-SPUsageApplication
Published: July 16, 2012
Applies to: SharePoint Server 2013 Standard
Creates a new usage application.
New-SPUsageApplication [[-Name] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DatabaseName <String>] [-DatabasePassword <SecureString>] [-DatabaseServer <String>] [-DatabaseUsername <String>] [-FailoverDatabaseServer <String>] [-UsageService <SPUsageServicePipeBind>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Name | Optional | System.String | Specifies the friendly name of the new usage application. The type must be a valid name of a usage application; for example, UsageApplication1. | ||
| 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.
| ||
| 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 | ||
| DatabaseName | Optional | System.String | Specifies the name of the logging database. If the logging database does not exist, a logging database is automatically created. The type must be a valid name of a SQL Server database; for example, UsageLogDB1. | ||
| DatabasePassword | Optional | System.Security.SecureString | Specifies the password for the user specified in DatabaseUserName. Use this parameter only if SQL Server Authentication is used to access the logging database. The type must be a valid password. | ||
| DatabaseServer | Optional | Microsoft.SharePoint.PowerShell.SPServerPipeBind | Specifies the SPServer object where the logging database is created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; the IP address of a server computer, in the form 208.77.188.166; a valid name of a SQL Server host service (for example, SQLServerHost1); or an instance of a valid SPServer object. | ||
| DatabaseUsername | Optional | System.String | Specifies the user name to use for connecting to the logging database. Use this parameter only if SQL Server Authentication is used to access the logging database. The type must be a valid user name; for example, UserName1. | ||
| FailoverDatabaseServer | Optional | System.String | Specifies the name of the host SQL Server instance for the failover database server. The type must be a valid SQL Server instance name; for example, SQLServerHost1. | ||
| UsageService | Optional | Microsoft.SharePoint.PowerShell.SPUsageServicePipeBind | Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. | ||
| 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: Detailed Description
The New-SPUsageApplication cmdlet creates a new usage application in the local farm.
Input Types
Return Types
-------------------EXAMPLE-------------------------
New-SPUsageApplication -Name "Usage Application For Farm ABC"
This example creates a new usage application for the specified name.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
