Set-OfficeWebAppsMachine
Changes the settings of the current server that is in an Office Online Server farm.
Syntax
Default (Default)
Set-OfficeWebAppsMachine
[-Master <String>]
[-Roles <String[]>]
[-WhatIf]
[-Confirm]
Description
The Set-OfficeWebAppsMachine cmdlet changes the settings of the current server that is in an Office Online Server farm. The settings include the roles held by the current server and the designated master server for the farm.
Examples
------------------EXAMPLE 1---------------------
(Get-OfficeWebAppsFarm).Machines
This example shows the roles held by each server in the Office Online Server farm.
------------------EXAMPLE 2---------------------
Set-OfficeWebAppsMachine -Roles FrontEnd
This example configures the current server as a Front End server.
------------------EXAMPLE 3---------------------
Set-OfficeWebAppsMachine -Roles All
This example configures the current server to host all roles.
Parameters
-Confirm
Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Master
Specifies the server that stores the master farm configuration files.
If you set the local server as the master, you must run Set-OfficeWebAppsMachine -Master on all of the remaining servers in the Office Online Server farm to point them to the new master.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Roles
Specifies the list of server roles to assign to the local server, separated by commas.
The role types are as follows:
All
FrontEnd
WordBackEnd
ExcelBackEnd
PowerPointBackEnd
As a best practice, we recommend that all servers in an Office Online Server farm run all roles. Assigning roles is not useful until the Office Online Server farm contains approximately 50 servers.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |