Set-SmConfig

Detailed Description

The Simply Migrate Management Shell is governed by the configuration set on a global level per installation.
What this means is that you are able to configure each instance of the Simply Migrate Manage Shell to perform entirely disparate tasks base on the requirements and topology being used. The Set-SmConfig cmdlet is used to set these configuration settings.

Syntax

Set-SmConfig 
[[-TempFolder] <string>] 
[[-LogFolder] <string>] 
[[-SimplyMigrateDB] <string>] 
[[-SQLCommandTimeout] <int>] 
[[-UseAzureSqlStrategy] <bool>] 
[[-ReportLogging] {Detailed | Normal | Minimum}] 
[[-ConsoleLogging] {Trace | Debug | Info | Warn | Error | Fatal | Off}] 
[[-FileLogging] {Trace | Debug | Info | Warn | Error | Fatal | Off}]
[[-DatabaseLogging] {Trace | Debug | Info | Warn | Error | Fatal | Off}] 
[[-MaxProcesses] <int>] 
[[-MaxThreads] <int>] 
[[-DequeueCount] <int>] 
[[-PluginsPath] <string>] 
[[-UpdateStatisticsInterval] <int>] 
[[-LogProgressEvery] <int>] 
[[-MaxSingleFailuresPct] <int>] 
[[-MaxRetries] <int>] 
[[-RetryDelay] <int>] 
[[-IncludeMsgClass] <string[]>]
[[-LogDiscoverySeconds] <int>] 
[[-MaxDiscoveryRetries] <int>] 
[[-RetryOnHoldDiscoverySeconds] <int>]
[[-MaxDiscoveryEntryRetries] <int>] 
[[-RetryFailedDiscoveryEntrySeconds] <int>] 
[[-DiscoveryFileExtensions] <string[]>] 
[[-ExcludedPaths] <string[]>] 
[[-EVDirectoryDB] <string>] 
[[-EVStoreDBStub] <string>]
[[-EvDiscoveryMaxThreads] <int>] 
[[-EvDiscoveryLogSeconds] <int>] 
[[-ZantazConnectionString] <string>]
[[-EmailXtenderDatabaseServer] <string>] 
[[-EmailXtenderUnPackContainerPath] <string>] 
[[-MimecastAppId] <string>]
[[-MimecastBaseUrl] <string>] 
[[-ArchiveManagerConnectionString] <string>] 
[[-MetalogixConnectionString] <string>]
[[-MaxConcurrentEwsConnections] <int>] 
[-JobProcessExecutablePath <string>] 
[-PstClientExecutablePath <string>]
[<CommonParameters>]

Parameters

    -ArchiveManagerConnectionString <string>
        Set the Archive Manager Connection String

        Required?                    false
        Position?                    35
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -ConsoleLogging <LoggingLevel>
        Set the Console logging level

        Required?                    false
        Position?                    6
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -DatabaseLogging <LoggingLevel>
        Set the Database logging level

        Required?                    false
        Position?                    8
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -DequeueCount <int>
        Set the number of items that are queued in each processing loop for a Job

        Required?                    false
        Position?                    11
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -DiscoveryFileExtensions <string[]>
        Set the Discovery file extensions

        Required?                    false
        Position?                    24
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EVDirectoryDB <string>
        Provide the EV Directory database connection string

        Required?                    false
        Position?                    26
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EVStoreDBStub <string>
        Provide the EV Store database connection string format

        Required?                    false
        Position?                    27
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EmailXtenderDatabaseServer <string>
        Provide the EmailXtender database connection string

        Required?                    false
        Position?                    31
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EmailXtenderUnPackContainerPath <string>
        Provide the path to the EmailXtender UnPack Container

        Required?                    false
        Position?                    32
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EvDiscoveryLogSeconds <int>
        Provide how often a EV Discovery logs progress

        Required?                    false
        Position?                    29
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -EvDiscoveryMaxThreads <int>
        Provide the number of threads used to query EV during Discovery

        Required?                    false
        Position?                    28
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -ExcludedPaths <string[]>
        Set the path excluded from Discovery

        Required?                    false
        Position?                    25
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -FileLogging <LoggingLevel>
        Set the File logging level

        Required?                    false
        Position?                    7
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -IncludeMsgClass <string[]>
        Set the included Message Classes

        Required?                    false
        Position?                    18
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -JobProcessExecutablePath <string>

        Required?                    false
        Position?                    Named
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -LogDiscoverySeconds <int>
        Set the number of seconds that Discovery progress is logged

        Required?                    false
        Position?                    19
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -LogFolder <string>
        Specify the location of the Log folder

        Required?                    false
        Position?                    1
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -LogProgressEvery <int>
        Set the number of seconds that progress is logged

        Required?                    false
        Position?                    14
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxConcurrentEwsConnections <int>
        Set the maximum number of concurrent EWS connections per a Job

        Required?                    false
        Position?                    37
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxDiscoveryEntryRetries <int>
        Set the maximum number of retry attempts for Discovery items

        Required?                    false
        Position?                    22
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxDiscoveryRetries <int>
        Set the number of Discovery retry attempts for failed items

        Required?                    false
        Position?                    20
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxProcesses <int>
        Set the maximum number of Jobs per a Batch controller

        Required?                    false
        Position?                    9
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxRetries <int>
        Set the number of retry attempts for failed items

        Required?                    false
        Position?                    16
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxSingleFailuresPct <int>
        Set the maximum failure percentage per a Job Queue after which the Job is failed

        Required?                    false
        Position?                    15
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MaxThreads <int>
        Set the maximum number of Threads per a Job

        Required?                    false
        Position?                    10
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MetalogixConnectionString <string>
        Set the Metalogix Connection String

        Required?                    false
        Position?                    36
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MimecastAppId <string>
        Set the Mimecast App Id

        Required?                    false
        Position?                    33
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -MimecastBaseUrl <string>
        Set the Mimecast Base Url for all API requests

        Required?                    false
        Position?                    34
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -PluginsPath <string>
        Set the path to the plugins

        Required?                    false
        Position?                    12
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -PstClientExecutablePath <string>

        Required?                    false
        Position?                    Named
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -ReportLogging <ReportingDetail>
        Set the Report detail level

        Required?                    false
        Position?                    5
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -RetryDelay <int>
        Set the minimum time in seconds between item retry attempts

        Required?                    false
        Position?                    17
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -RetryFailedDiscoveryEntrySeconds <int>
        Set the minimum time in seconds between retry attempts for Discovery items

        Required?                    false
        Position?                    23
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -RetryOnHoldDiscoverySeconds <int>
        Set the minimum number of seconds that a Discovery Job is On Hold before retrying

        Required?                    false
        Position?                    21
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -SQLCommandTimeout <int>
        Set the SQL timeout value in seconds

        Required?                    false
        Position?                    3
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -SimplyMigrateDB <string>
        Provide the connection string to the Simply Migrate database

        Required?                    false
        Position?                    2
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -TempFolder <string>
        Specify the location of the Temp folder

        Required?                    false
        Position?                    0
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -UpdateStatisticsInterval <int>
        Set how often statistics are updated in seconds

        Required?                    false
        Position?                    13
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -UseAzureSqlStrategy <bool>
        Set to true if using an Azure SQL database

        Required?                    false
        Position?                    4
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    -ZantazConnectionString <string>
        Provide the Zantaz database connection string

        Required?                    false
        Position?                    30
        Accept pipeline input?       false
        Parameter set name           (All)
        Aliases                      None
        Dynamic?                     false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

Examples

Set-SmConfig is used to change the configuration settings of Simply Migrate.
An example of how to set the Temp file and Logging directories;

PS C:\Simply Migrate>Set-SmConfig -TempFolder 'C:\Temp' -LogFolder 'C:\Temp\Logs'

Version                          : 4.4.X.X
LicenseKey                       : ABCD-ABCD-ABCD-ABCD-ABCD-ABCD-ABCD
TempFolder                       : C:\Temp
LogFolder                        : C:\Temp\Logs
SimplyMigrateDB                  : Server=SqlServerName;Database=SimplyMigrate;Trusted_Connection=True
SQLCommandTimeout                : 360
UseAzureSqlStrategy              : False
ReportLogging                    : Normal
ConsoleLogging                   : Info
FileLogging                      : Trace
DatabaseLogging                  : Debug
MaxProcesses                     : 4
MaxThreads                       : 12
DequeueCount                     : 1000
PluginsPath                      : C:\Program Files (x86)\Simply Migrate\Plugins
UpdateStatisticsInterval         : 14400
LogProgressEvery                 : 30
MaxSingleFailuresPct             : 90
MaxRetries                       : 4
RetryDelay                       : 30
IncludeMsgClass                  : {IPM.*}
LogDiscoverySeconds              : 30
MaxDiscoveryRetries              : 30
RetryOnHoldDiscoverySeconds      : 900
MaxDiscoveryEntryRetries         : 24
RetryFailedDiscoveryEntrySeconds : 3600
DiscoveryFileExtensions          : {msg}
ExcludedPaths                    : {{0}$Recycle.Bin\, {0}Program Files\, {0}Program Files (x86)\, {0}Windows\...}
EVDirectoryDB                    : Server=simplymigrate02;Database=EnterpriseVaultDirectory;Trusted_Connection=True
EVStoreDBStub                    : Server={0};Database={1};Trusted_Connection=True;
EvDiscoveryMaxThreads            : 16
EvDiscoveryLogSeconds            : 60
ArchiveManagerConnectionString   :
MetalogixConnectionString        :
ZantazConnectionString           :
EmailXtenderDatabaseServer       :
EmailXtenderUnPackContainerPath  :
MimecastAppId                    :
MimecastBaseUrl                  :
MaxConcurrentEwsConnections      : 10