Windows PowerShell for Office Online Server

Summary: Find articles about Office Online Server Microsoft PowerShell cmdlets.

Audience: IT Professionals

The following table lists and describes the articles for each OfficeWebApps Microsoft PowerShell cmdlet for Office Online Server.

Tip

If Microsoft PowerShell doesn't recognize these cmdlets when you run them, you may need to import the OfficeWebApps module. Use this command: Import-Module -Name OfficeWebApps

Article Description
Get-OfficeWebAppsExcelBIServer
Returns the instance of Analysis Services that has been configured as a data model server in Office Online Server.
Get-OfficeWebAppsExcelUserDefinedFunction
Returns a list of currently configured UDF definitions.
Get-OfficeWebAppsFarm
Returns details about the OfficeWebAppsFarm object that the current server is a member of.
Get-OfficeWebAppsHost
Returns the list of host domains that are on the Allow List for an Office Online Server farm.
Get-OfficeWebAppsMachine
Returns details about the current server that is in an Office Online Server farm.
New-OfficeWebAppsExcelBIServer
Configures Analysis Services servers to work with Excel Online.
New-OfficeWebAppsExcelUserDefinedFunction
Creates a definition for a UDF binary.
New-OfficeWebAppsFarm
Creates a new Office Online Server farm on the local computer.
New-OfficeWebAppsHost
Adds a host domain to the Allow List for an Office Online Server farm.
New-OfficeWebAppsMachine
Adds the current server to an existing Office Online Server farm.
Remove-OfficeWebAppsExcelBIServer
Removes an instance of Analysis Services from the Allow List of BI servers to be used with Excel Online.
Remove-OfficeWebAppsExcelUserDefinedFunction
Removes an existing UDF definition.
Remove-OfficeWebAppsHost
Removes a host domain from the Allow List for an Office Online Server farm.
Remove-OfficeWebAppsMachine
Removes the current server from the Office Online Server farm.
Repair-OfficeWebAppsFarm
Removes all servers flagged as unhealthy from an Office Online Server farm.
Set-OfficeWebAppsExcelUserDefinedFunction
Sets properties on existing UDF definitions.
Set-OfficeWebAppsFarm
Configures the settings of an existing Office Online Server farm.
Set-OfficeWebAppsMachine
Changes the settings of the current server that is in an Office Online Server farm.