Skip to main content

Exchange Domain Settings

Synopsis​

Configure the Active Directory domain settings required by Microsoft Exchange Server.

Description​

When Exchange Server is deployed into an Active Directory domain, it extends the directory schema and modifies specific container objects to reflect the installed version. This component allows you to define which Exchange version the domain's AD settings should reflect, so ADMF can verify and enforce the correct state.

The Domain-level Component only affects the Domain-local and can only be applied after applying the Forest level settings.

The version is tracked via the objectVersion attribute on the Microsoft Exchange System Objects container in the domain. When ADMF detects a mismatch between the configured version and the current value, it can update the domain settings by invoking the Exchange installer from a locally accessible ISO file.

Applying this setting requires Enterprise Admin permissions, and the update can only be performed through the installer contained in the Exchange ISO file — there is no way to apply it directly via AD tooling.

This component stores a single configuration value. Registering a second entry - e.g. through a second Context - replaces the first.

Example Configuration​

Configure the domain for Exchange 2019 CU6 using the named version:

{
    "LocalImagePath": "C:\\ISO\\exchange-2019-cu6.iso",
    "ExchangeVersion": "2019CU6"
}

The same configuration in psd1 format:

@{
    LocalImagePath = 'C:\ISO\exchange-2019-cu6.iso'
    ExchangeVersion = '2019CU6'
}

If your Exchange version is not yet known to ADMF, you can specify the raw object version number instead of the named version:

{
    "LocalImagePath": "C:\\ISO\\exchange-2019-cu12.iso",
    "ObjectVersion": 17003
}

Properties​

LocalImagePath​

Optional: No | Default: None

The local path — on the remote server being configured — to the Exchange ISO file. Updating Exchange AD settings is only supported by running the installer directly from this ISO; no alternative method is available.

ExchangeVersion​

Optional: No | Default: None | ParameterSet: ByName

The named version of Exchange to apply, for example 2016CU6 or 2019CU6. ADMF maps these names to the corresponding objectVersion value used in AD.

Use tab-completion to browse the list of known versions. If your version is not listed, use ObjectVersion instead.

ObjectVersion​

Optional: No | Default: None | ParameterSet: ByVersion

The raw integer value of the objectVersion attribute on the Microsoft Exchange System Objects container. Use this when the named ExchangeVersion does not yet cover your specific CU.