Resource Type: dsc_xexchmaintenancemode

Defined in:

lib/puppet/type/dsc_xexchmaintenancemode.rb

Providers:

powershell

Overview

The DSC xExchMaintenanceMode resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchMaintenanceMode/MSFT_xExchMaintenanceMode.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_additionalcomponentstoactivate

  AdditionalComponentsToActivate - When taking a server out of Maintenance Mode, the following components will be set to Active by default: ServerWideOffline, UMCallRouter, HighAvailability, Monitoring, RecoveryActionsEnabled. This parameter specifies an additional list of components to set to Active.

• dsc_credential

  Credential - Credentials used to establish a remote PowerShell session to Exchange

• dsc_domaincontroller

  DomainController - The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

• dsc_enabled

  Enabled - Whether the server should be put into Maintenance Mode. When Enabled is set to True, the server will be put in Maintenance Mode. If False, the server will be taken out of Maintenance Mode.

  Supported values:

  • true
  • false
• dsc_mountdialoverride

  MountDialOverride - Used when moving databases back to the server after taking the server out of maintenance mode. The MountDialOverride parameter is used to override the auto database mount dial (AutoDatabaseMountDial) setting for the target server and specify an alternate setting. Defaults to None. Valid values are None, Lossless, GoodAvailability, BestAvailability, BestEffort.

• dsc_movepreferreddatabasesback

  MovePreferredDatabasesBack - Whether to move back databases with an Activation Preference of one for this server after taking the server out of Maintenance Mode. Defaults to False.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_setinactivecomponentsfromanyrequestertoactive

  SetInactiveComponentsFromAnyRequesterToActive - Whether components that were set to Inactive by outside Requesters should also be set to Active when exiting Maintenance Mode. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipactivecopychecks

  SkipActiveCopyChecks - Used when moving databases back to the server after taking the server out of maintenance mode. The SkipActiveCopyChecks switch specifies whether to skip checking the current active copy to see if it’s currently a seeding source for any passive databases. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipallchecks

  SkipAllChecks - Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipAllChecks switch specifies whether to skip all checks. This switch is equivalent to specifying all of the individual skip parameters that are available on this cmdlet. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipclientexperiencechecks

  SkipClientExperienceChecks - Used when moving databases back to the server after taking the server out of maintenance mode. The SkipClientExperienceChecks switch specifies whether to skip the search catalog (content index) state check to see if the search catalog is healthy and up to date. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipcpuchecks

  SkipCpuChecks - Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipCpuChecks switch specifies whether to skip the high CPU utilization checks. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skiphealthchecks

  SkipHealthChecks - Used when moving databases back to the server after taking the server out of maintenance mode. The SkipHealthChecks switch specifies whether to bypass passive copy health checks. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skiplagchecks

  SkipLagChecks - Used when moving databases back to the server after taking the server out of maintenance mode. The SkipLagChecks switch specifies whether to allow a copy to be activated that has replay and copy queues outside of the configured criteria. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipmaximumactivedatabaseschecks

  SkipMaximumActiveDatabasesChecks - Used when moving databases back to the server after taking the server out of maintenance mode. The SkipMaximumActiveDatabasesChecks switch specifies whether to skip checking the value of MaximumPreferredActiveDatabases during the best copy and server selection (BCSS) process. Defaults to False.

  Supported values:

  • true
  • false
• dsc_skipmovesuppressionchecks

  SkipMoveSuppressionChecks - Exchange 2016 Only. Used when moving databases back to the server after taking the server out of maintenance mode. The SkipMoveSuppressionChecks switch specifies whether to skip the move suppression checks. Defaults to False.

  Supported values:

  • true
  • false
• dsc_upgradedserverversion

  UpgradedServerVersion - Optional string to specify what the server version will be after applying a Cumulative Update. If the server is already at this version, requests to put the server in Maintenance Mode will be ignored. Version should be in the format ##.#.####.#, as in 15.0.1104.5.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xexchmaintenancemode` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.