Resource Type: dsc_xexchjetstresscleanup

Defined in:

lib/puppet/type/dsc_xexchjetstresscleanup.rb

Providers:

powershell

Overview

The DSC xExchJetstressCleanup resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchJetstressCleanup/MSFT_xExchJetstressCleanup.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_configfilepath

  ConfigFilePath - Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. ConfigFilePath takes precedence. This is the full path to the JetstressConfig.xml file. If ConfigFilePath is specified, the config file will be used to determine the database and log folders that need to be removed

• dsc_databasepaths

  DatabasePaths - Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. DatabasePaths specifies the paths to database directories that should be cleaned up.

• dsc_deleteassociatedmountpoints

  DeleteAssociatedMountPoints - Defaults to $false. If specified, indicates that mount points associated with the Jetstress database and log paths should be removed

  Supported values:

  • true
  • false
• dsc_jetstresspath

  JetstressPath - The path to the folder where Jetstress is installed, and which contains JetstressCmd.exe

• dsc_logpaths

  LogPaths - Either ConfigFilePath, or DatabasePaths AND LogPaths MUST be specified. LogPaths specifies the paths to log directories that should be cleaned up.

• dsc_outputsavelocation

  OutputSaveLocation - If RemoveBinaries is set to $true and Jetstress output was saved to the default location (the installation path of Jetstress), specifies the folder path to copy the Jetstress output files to.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_removebinaries

  RemoveBinaries - Specifies that the files in the Jetstress installation directory should be removed

  Supported values:

  • true
  • false
• name (namevar)
• provider

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