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_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_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.