Skip to main content

Register-FMExchangeSchema

SYNOPSIS​

Registers an exchange version to apply to the forest's schema and configuration.

SYNTAX​

Version​

Register-FMExchangeSchema -LocalImagePath <string> -ExchangeVersion <string>
 [-OrganizationName <string>] [-SchemaOnly] [-SplitPermission <bool>] [-AllDomains]
 [-ContextName <string>] [<CommonParameters>]

Details​

Register-FMExchangeSchema -LocalImagePath <string> -RangeUpper <int> [-ObjectVersion <int>]
 [-OrganizationName <string>] [-SchemaOnly] [-SplitPermission <bool>] [-AllDomains]
 [-ContextName <string>] [<CommonParameters>]

DESCRIPTION​

Registers an exchange version to apply to the forest's schema and configuration. Updating both requires both Schema Admin and Enterprise Admin permissions.

Domain-Level changes to Exchange are handled by the DomainManagement module.

EXAMPLES​

EXAMPLE 1​

Register-FMExchangeSchema -LocalImagePath 'C:\ISO\exchange-2019-cu6.iso' -ExchangeVersion '2019CU6'

Registers the Exchange 2019 CU6 exchange version as exchange forest settings to be applied.

PARAMETERS​

-AllDomains​

Whether the domain content changes to the root domain should be applied to ALL domains. Only applies to the SplitPermission change.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ContextName​

The name of the context defining the setting. This allows determining the configuration set that provided this setting. Used by the ADMF, available to any other configuration management solution.

Type: System.String
DefaultValue: <Undefined>
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ExchangeVersion​

The version of the Exchange server to apply. E.g. 2016CU6 We map Exchange versions to their respective identifiers in AD: RangeUpper in schema and ObjectVersion in configuration. This parameter is to help avoiding to have to look up those values. If your version is not supported by us yet, look up those numbers and explicitly bind it to -RangeUpper and -ObjectVersion isntead.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Version
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-LocalImagePath​

The path where to find the Exchange ISO file Must be local on the remote server connected to! Updating the Exchange AD settings is only supported when executed through the installer contained in that ISO file without exceptions.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ObjectVersion​

The object version on the msExchOrganizationContainer type object in the configuration. Do NOT confuse that with the ObjectVersion of the exchange object in the default Naming Context (regular domain space).

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Details
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OrganizationName​

The name of the Exchange Organization. Only used for CREATING a new Exchange deployment. Make sure to customize this if you are picky about names like that.

Type: System.String
DefaultValue: Exchange Organization
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-RangeUpper​

The explicit RangeUpper schema attribute property, found on the ms-Exch-Schema-Version-Pt class in schema.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Details
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SchemaOnly​

Whether to only apply the schema updates. Enabling this will mean no configuration scope changes are applied and the root domain also will not be pre-configured for Exchange.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SplitPermission​

Whether the exchange installation should implement Active Directory Split Permissions. With Split Permissions, Exchange Administrators will be less able to affect Active Directory. This provides more security, but imposes more administrative effort.

For more details on Split Permissions, see this documentation: https://docs.microsoft.com/en-us/exchange/permissions/split-permissions/configure-exchange-for-split-permissions?view=exchserver-2019

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.