Remove-SPExcelFileLocation

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Banner stating end of support date for Office 2010 with link to more info

Removes a trusted file location from Excel Services Application.

Syntax

Remove-SPExcelFileLocation [-Identity] <SPExcelFileLocationPipeBind> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Remove-SPExcelFileLocation cmdlet removes a location from the list of trusted file locations. Excel Services Application loads only workbooks that are stored in a trusted file location. Properties of trusted file locations control how workbooks can be used when loaded on Excel Services Application. Excel Services Application always enforces the properties defined by the trusted file location from which a workbook was loaded. The properties used by the trusted file location are determined by comparing the file path for the workbook with the Address parameter of the trusted file location.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Excel.Server.Cmdlet.SPExcelFileLocationPipeBind

Specifies the FileLocation object to remove.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid string that identifies the file location, in the form http://myPortal/myTeam; a valid string that identifies the path, in the form C:\folder_name; or an instance of a valid SPExcelFileLocation object.

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication 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.

Note

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.

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

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

Input Types

Return Types

Example

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

Remove-SPExcelFileLocation -ExcelServiceApplication "My Excel Service" -Identity http://portal/badTeamSite

This example removes the http://portal/badTeamSite from the list of trusted file locations for the Excel Services Application Web service application named My Excel Service.

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

Get-SPExcelServiceApplication | Get-SPExcelFileLocation | where {$_.Address -ne "http://"} | Remove-SPExcelFileLocation

This example removes all nondefault trusted file locations from every Excel Services Application Web service application in the farm.