OfficeOnlineServerMachineConfig.adoc

DSC Resource 'OfficeOnlineServerMachineConfig'

OfficeOnlineServerMachineConfig manages Office Online Server membership in a farm (join or leave), and configures server roles.

When to use 'OfficeOnlineServerMachineConfig'

Use this resource when you need to add a server to an Office Online Server farm or create a new single-server farm. It controls the machine-level OOS configuration and farm membership. Use it together with OfficeOnlineServerSetup for installation and OfficeOnlineServerFarmConfig for farm-wide settings.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/OfficeOnlineServerMachineConfig
DSC Resource	OfficeOnlineServerDsc
Documentation	OfficeOnlineServerMachine

Table 1. Attributes of category 'OfficeOnlineServerMachineConfig'

Parameter	Attribute	DataType	Description	Allowed Values
Ensure		String	Specifies whether the server should be joined to or removed from the farm.	Present (default) Absent
Roles		String[]	Specifies one or more server roles to assign to the server.
MachineToJoin	Mandatory	String	Specifies the name of an existing server that is already a member of the Office Online Server farm.

Example

OfficeOnlineServerMachineConfig:
  MachineToJoin: Master

See also

• OfficeOnlineServerSetup

• OfficeOnlineServerFarmConfig