PowerShell cmdlets for Migrator for Notes to Exchange
Using PowerShell Cmdlets
You may use these PowerShell cmdlets to configure and troubleshoot various wizards and other components of Quest’s Migrator for Notes to Exchange.
To import the PowerShell module so you can use the Migrator for Notes to Exchange cmdlets, enter the following command in a PowerShell console:
Import-Module Quest.MNE.Powershell
To view a list of the available Migrator for Notes to Exchange cmdlets, enter the following command: Get-Command -Module Quest.MNE.Powershell
Common Parameters
In addition to the cmdlet-specific parameters documented following, all these cmdlets support the common parameters that Microsoft builds into all PowerShell cmdlets, as described in the Microsoft article about_CommonParameters.
Cmdlets in Quest.MNE.Powershell
Add-MNECollectionMember
Synopsis
Adds a member object to the specifies collection.
Syntax
Add-MNECollectionMember [-CollectionGuid] <Guid> [-ObjectSmtpAddress] <string> [<CommonParameters>]
Add-MNECollectionMember [-CollectionGuid] <Guid> -ObjectGuid <Guid> [<CommonParameters>]
Description
Adds a specified object (either selected by GUID or SMTP address) to the specified collection (by GUID). Validates whether there is an object GUID or SMTP address given in the input.
Parameters
-CollectionGuid <Guid>
The Guid of the collection to add the member to.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ObjectSmtpAddress <string>
The SMTP address of the object to be added to the collection.
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ObjectGuid <Guid>
The Guid of the object to be added to the collection.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
Accepts pipeline input for the collection guid.
Outputs
QuestSoftware.NMEAPI.Controllers.NMECollection
Outputs the collection that was added to, if there are no errors.
PS C:\>Add-MNECollectionMember -CollectionGuid 455E1829-45D1-4485-8467-80A463DA5227
-ObjectGuid DA096D83-A07D-44F6-A0D2-35B88A10F6A5
Adds the object with the given Guid to the collection with the given Guid.
PS C:\>Add-MNECollectionMember -CollectionGuid 455E1829-45D1-4485-8467-80A463DA5227
-ObjectSmtpAddress Admin@Sample.test.com
Adds the object with the given Smtp address to the collection with the given Guid.
Add-MNEDesignClass
Synopsis
Adds a design class to the database.
Syntax
Add-MNEDesignClass [-DesignClassName] <string> -Authoritative <Boolean> - DataStoreTypeMask <DataStoreTypeMaskEnum> [<CommonParameters>]
Description
Adds a design class to the database, per specified parameters.
Parameters
-DesignClassName <string>
Name of the design class to add.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Authoritative <Boolean>
Whether or not the design class to add has authoritative status.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DataStoreTypeMask <DataStoreTypeMaskEnum>
Data store type mask of the design class to add.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
Pipeline input for the DesignClassName.
Outputs
NMEDesignClass
Design class that was added, if there are no errors.
Examples
PS C:\>Add-MNEDesignClass -DesignClassName "TestName" -Authoritative $true - DataStoreTypeMask All
Adds a design class with the given parameters to the database.
Add-MNEGroupCollection
Synopsis
Adds a group collection.
Syntax
Add-MNEGroupCollection [-Name] <string> [-Label <string>] [-Description <string>] [- Query <string>] [-QueryType <NmeCollectionQueryType>] [-Disabled] [<CommonParameters>]
Adds a specified new group collection.
Parameters
-Name <string>
The name of the group collection to add.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
The label to add to the group collection.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
The description of the group collection to add.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
The query of the group collection to add.
Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <NmeCollectionQueryType>
The query type of the group collection to add.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Disabled [<SwitchParameter>]
The collection should be disabled after adding.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Returns the collection that was added, if there are no errors.
Examples
PS C:\>Add-MNEGroupCollection -Name "GroupCollection" -Label "SampleGroup" - Description "This is a test" -Query "This is a query"
Adds the group collection with the given values into the database.
PS C:\>Add-MNEGroupCollection -Name "GroupCollection" -Label "SampleGroup" - Description "This is a test" -QueryType Dynamic -Query "This is a query"
Adds the group collection with the given values into the database and sets the group collection to use dyanmic query to populate members.
Add-MNEInetDomain
Synopsis
Adds specified InetDomain to the database by specific name or an existing object.
Syntax
Add-MNEInetDomain [-DomainName] <string> [-Disabled] [-IsDefault] [<CommonParameters>]
Add-MNEInetDomain [-AsObject] <InetDomain> [-Disabled] [-IsDefault] [<CommonParameters>]
Description
Adds specified InetDomain to the database by specific name or an existing object. By default, the domain is marked as active and does not change the default.
Throws errors if domain already exist in database or has incorrect syntax.
Parameters
-DomainName <string>
The name of the domain. Must have a period and only consist of Letters, Numbers, and Hyphens. The cmdlet throws an error if domain is already present in database or have incorrect syntax.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-AsObject <InetDomain>
Create and add a new domain to database from existing object. All same rules for domainName, and IsDefault apply.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Disabled [<SwitchParameter>]
Sets the Domain to be disabled, not active.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-IsDefault [<SwitchParameter>]
Sets domain to be the default domain. Changes all other domain defaults to be false.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
Add new domain by domain name from pipeline input.
InetDomain
Add new domain by InetDomain object from pipeline input.
Outputs
InetDomain
Returns the InetDomain object that was added to the database.
Examples
PS C:\>Add-MNEInetDomain "test.domain.com"
Adds the domain "test.domain.com" to the database. Enabled is "true". This domain is not the default.
PS C:\>Add-MNEInetDomain "test.domain.com" -Disabled
Adds the domain "test.domain.com" to the database. Enabled is "false". This domain is not the default.
PS C:\>Add-MNEInetDomain "test.domain.com" -IsDefault
Adds the domain "test.domain.com" to the database. Enabled is "false". This domain is the default.
PS C:\>Add-MNEInetDomain -AsObject $domain
Adds the domain name from $domain to the database with the same GUID, DomainName, Enabled value, and IsDefault status.
Synopsis
Add the MNE admin user Full Access permission to mailboxes in the user collection for Microsoft 365. If Admin Account Pool is used, the Microsoft 365 admin role specified by the configuration will be used instead of the MNE admin user.
Syntax
Add-MNEMailboxAdminPermission [-CollectionName] <string> [<CommonParameters>]
Add-MNEMailboxAdminPermission [-CollectionName] <string> -ConfigurationId <string> [<CommonParameters>]
Add-MNEMailboxAdminPermission [-CollectionName] <string> -ConfigurationFileName
<string> [<CommonParameters>]
Description
Prior to migrating the Notes mail database to Exchange Online, you must grant the migration admin user Full Access permission to the mailboxes in the user collection. This cmdlet takes the MNE user collection name and grants the migration admin user Full Access to the mailboxes in the user collection. Use the cmdlet Remove- MNEMailboxAdminPermission to remove the Full Access permission granted to the admin user once the migration is complete.
Parameters
-CollectionName <string>
Name of the user collection containing the mailboxes where the Exchange admin user will be granted Full Access
permission.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to use.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFilename <string>
File name of a configuration settings .ini file to use as the configuration.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
QuestSoftware.NME.PSModule.Utils.ManageMailboxPermissionResult
Returns a ManageMailboxPermissionResult object that contains information regarding the result of this cmdlet.
Examples
PS C:\>Add-MNEMailboxAdminPermission "All Users"
Grants MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration setting and returns the results.
PS C:\>Add-MNEMailboxAdminPermission -CollectionName "All Users"
Grants the MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration settings and returns the results.
PS C:\>Add-MNEMailboxAdminPermission "All Users" -ConfigurationId "CDB86C40-49E2- 43E1-8DE5-E1B2F4A55B51"
Grants the MNE admin user Full Access permission to mailboxes in the "All Users" collection using configuration settings by the given configuration id and returns the results.
PS C:\>Add-MNEMailboxAdminPermission "All Users" -ConfigurationId "Default Settings" Grants the MNE admin user Full Access permission to mailboxes in "All Users" collection using configuration by the given name and returns the results.
PS C:\>Add-MNEMailboxAdminPermission -CollectionName "All Users" - ConfigurationFilename "C:\defaultconfig.ini"
Grants MNE admin user Full Access permission to mailboxes in the "All Users" collection using the configuration settings specified in the file C:\defaultconfig.ini.
PS C:\>Add-MNEMailboxAdminPermission "All Users" | ForEach-Object -MemberName "Mailboxes"
Grants the MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration settings and returns a list of mailboxes that were processed.
Add-MNENotesDomain
Synopsis
Adds a NotesDomain to the database using a domain name and type or NotesDomain object
Syntax
Add-MNENotesDomain [-DomainName] <string> [[-DomainType] <DomainTypeEnum>] [<CommonParameters>]
Add-MNENotesDomain [-AsObject] <NotesDomain> [<CommonParameters>]
Description Parameters
-DomainName <string>
The name of the domain. Follows URI DNS syntax.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-DomainType <DomainTypeEnum>
The type of domain. The default type is None if not specified. The valid type are None, Domain, and GlobalDomain.
Required: false
Position: 1
Default value:"None"
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-AsObject <NotesDomain>
Add a NotesDomain from the properties of another NotesDomain object.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
The name of the domain. Follows URI DNS syntax.
DomainTypeEnum
The type of domain. The valid type are None, Domain, and GlobalDomain.
NotesDomain
Add a NotesDomain from the properties of another NotesDomain object.
Outputs
NotesDomain
Returns the NotesDomain object that was added to the database.
Examples
PS C:\>Add-MNENotesDomain "test.domain.com"
Adds the domain "test.domain.com" to the database. DomainType defaults to "None".
PS C:\>Add-MNENotesDomain "test.domain.com" GlobalDomain
Adds the domain "test.domain.com" to the database. DomainType is set to "GlobalDomain".
PS C:\>Add-MNENotesDomain -AsObject $domain
Adds the domain name from $domain to the database with the same GUID, DomainName, and DomainType.
Add-MNENotesNab
Synopsis
Adds the Nab specified by the given path. The Nab is either from a local file or from the domino server.
Syntax
Add-MNENotesNab [-FilePath] <string> [-NotesPassword <string>] [-Title <string>] [<CommonParameters>]
Description
The Add-MNENotesNab cmdlet add the Nab (Notes Address Book) that is given by the filepath. The title is automatically added from the Nab if not specified by the user.
Displays warnings if the path is not found, it is of the incorrect file type, or the NAB already exists in the database. Throws an exception if trying to access Notes Server on non-32 bit PowerShell.
Parameters
-FilePath <string>
The location of the Notes Address Book to add. The path may be a local path or a path to the Notes Server formatted as it is in the NME program.
The cmdlet confirms whether the file is the correct extension, whether the FilePath already exists in the database, and whether the FilePath is valid.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByPropertyName) Accept wildcard characters:false
-NotesPassword <string>
The password for the Domino server if needed. Must have ID file already selected for Notes. Can be left as empty if the NAB is on a local (non-Notes) path.
Required: false
Position: Named Default value:
Accept pipeline input:true (ByPropertyName) Accept wildcard characters:false
-Title <string>
Allows the user to specify a title for the NAB.
If left null, the title will be retrieved from the NAB.
Required: false
Position: Named Default value:
Accept pipeline input:true (ByPropertyName) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
This cmdlet accepts FilePath, NotesPassword, Title from pipeline input.
Outputs
This cmdlet either returns a warning if incorrect or returns nothing and simply adds the NAB to the SQL database.
Examples
PS C:\>Add-MNENotesNab -Filepath "C:\Example.nsf" -Title "Test"
Retrieves the NAB located at "C:\Example.nsf" from the local files. Sets the title as "Test".
PS C:\>Add-MNENotesNab -Filepath "!!names.nsf"
Retrieves the NAB located in the local Notes server named names.nsf.
PS C:\>Add-MNENotesNab -Filepath "NotesServer/Example!!names.nsf" -NotesPassword "pa55w0rd"
Retrieves the NAB located in the Notes server "NotesServer/Example" named names.nsf. Gives the password to initialize the notes server rather than prompting.
PS C:\>Import-Csv .\test.csv | Add-MNENotesNab
Retrieves the NAB(s) in the specified .csv file.
Add-MNEUserCollection
Synopsis
Adds a user collection.
Syntax
Add-MNEUserCollection [-Name] <string> [-Label <string>] [-Description <string>] [- Query <string>] [-QueryType <NmeCollectionQueryType>] [-Disabled] [<CommonParameters>]
Description
Adds a specified new user collection.
Parameters
-Name <string>
The name of the user collection to add.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
The label of the user collection to add.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
The description of the user collection to add.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
The query of the user collection to add.
Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <NmeCollectionQueryType>
The query type of the user collection to add.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Disabled [<SwitchParameter>]
The collection should be disabled after adding.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Outputs the collection that was added, if there are no errors.
Examples
PS C:\>Add-MNEUserCollection -Name "UserCollection" -Label "SampleGroup" - Description "This is a test" -Query "This is a query"
Adds the user collection with the given values into the database.
PS C:\>Add-MNEUserCollection -Name "UserCollection" -Label "SampleGroup" - Description "This is a test" -QueryType Dynamic -Query "This is a query"
Adds the user collection with the given values into the database and sets the user collection to use dyanmic query to populate members.
Add-MNEWorkstation
Synopsis
Adds a new workstation to the database.
Syntax
Add-MNEWorkstation -WorkstationName <string> -TcpipAddress <string> [<CommonParameters>]
Description
Adds a new workstation to the SQL database with the given workstation name and TCP/IP address.
Parameters
-WorkstationName <string>
Name of the workstation to add.
Required: true
Position: named Default value:
Accept pipeline input:true (ByPropertyName) Accept wildcard characters:false
-TcpipAddress <string>
TCPaddress of the workstation to add.
Required: true
Position: named Default value:
Accept pipeline input:true (ByPropertyName) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
Both the WorkstationName and TCPIPAddress parameters accept pipeline input by property value.
Outputs
QuestSoftware.NMEAPI.Controllers.Workstation
Returns the workstation that was added to the database.
Examples
PS C:\>Add-MNEWorkstation -WorkstationName "MyComputer" -TCPIPAddress "000.000.00.000"
Add the workstation to the database with name "MyComputer" and IP address "000.000.00.000"
Convert-MNEConfiguration
Synopsis
Converts a configuration between a Task and Template Config.
Syntax
Convert-MNEConfiguration [-ConfigurationFromPipeline] <NMEConfiguration> - ConvertToTask [<CommonParameters>]
Convert-MNEConfiguration [-ConfigurationFromPipeline] <NMEConfiguration> - ConvertToTemplate [-TemplateType <TemplateTypeEnum>] [<CommonParameters>]
Description
Converts a configuration from a task to a template or vise versa, then saves it to the database.
Parameters
-ConfigurationFromPipeline <NMEConfiguration>
Configuration to convert.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ConvertToTask [<SwitchParameter>]
Convert the Configuration to a Task Config.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConvertToTemplate [<SwitchParameter>]
Convert the Configuration to a Template Config.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TemplateType <TemplateTypeEnum>
Convert the Template Configuration to Full Template or Differential Template. If the configuration is already a Template configuration, no conversion will be done if the TemplateType parameter is not specified.
Required: false
Position: Named Default value:.Full
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
Configuration
The Configuration parameter accepts pipeline input.
Outputs
Configuration
Returns the converted configuration.
Examples
PS C:\>$config | Convert-MNEConfiguration -ConvertToTemplate
Converts the config piped in to a Template
Copy-MNEGroupCollection
Synopsis
Copies a group collection.
Syntax
Copy-MNEGroupCollection [-CollectionName] <string> [-Name] <string> [-Label
<string>] [-Description <string>] [-Query <string>] [-QueryType
<NmeCollectionQueryType>] [<CommonParameters>]
Description
This cmdlet copies a specified group collection.
Parameters
-CollectionName <string>
Name of the group collection to copy.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Name <string>
Name of the group collection to copy to.
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
Label of the group collection to copy to.
If not specified, the label of the copy collection is set to that of the original. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
Description of the group collection to copy to.
If not specified, the description of the copy collection is set to that of the original.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
Query of the group collection to copy to.
If not specified, the query of the copy collection is set to that of the original. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <NmeCollectionQueryType>
Query type of the group collection to copy to.
If not specified, the query type of the copy collection is set to that of the original. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Returns the collection that was copied to, if there are no errors.
Examples
PS C:\>Copy-MNEGroupCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -Query "This is a query"
Copies the group collection with the given values into the database.
PS C:\>Copy-MNEGroupCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -QueryType Dynamic -Query "This is a query"
Copies the group collection with the given values into the database and sets the group collection to use dyanmic query to populate members.
Copy-MNEUserCollection
Synopsis
Copies a user collection.
Syntax
Copy-MNEUserCollection [-CollectionName] <string> [-Name] <string> [-Label <string>] [-Description <string>] [-Query <string>] [-QueryType <NmeCollectionQueryType>] [<CommonParameters>]
Description
Copies a specified user collection.
Parameters
-CollectionName <string>
Name of the user collection to copy.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Name <string>
Name of the user collection to copy to.
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
Label of the user collection to copy to.
If not specified, the label of the copy collection is set to that of the original. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
Description of the user collection to copy to.
If not specified, the description of the copy collection is set to that of the original.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
Query of the user collection to copy to.
If not specified, the query of the copy collection is set to that of the original. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <NmeCollectionQueryType>
Query type of the user collection to copy to.
If not specified, the query type of the copy collection is set to that of the original. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Outputs the collection that was copied to, if there are no errors.
Examples
PS C:\>Copy-MNEUserCollection -CollectionName "OriginalCollection" -Name "UserCollection" -Label "SampleGroup" -Description "This is a test" -Query "This is a query"
Copies the user collection with the given values into the database.
PS C:\>Copy-MNEUserCollection -CollectionName "OriginalCollection" -Name "UserCollection" -Label "SampleGroup" -Description "This is a test" -QueryType Dynamic -Query "This is a query"
Copies the user collection with the given values into the database and sets the user collection to use dyanmic query to populate members.
Export-MNECollections
Synopsis
Exports collections of a specific type to a .tsv file.
Syntax
Export-MNECollections [-Path] <string> [-CollectionType] <CollectionTypeEnum> [- Autodefined <Boolean>] [-LogFile <string>] [<CommonParameters>]
Description
This cmdlet exports the collections of a specific type to a file specified by the user. Exports all non-autodefined collections in the database by default.
Parameters
-Path <string>
The file to export the group collection to.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-CollectionType <CollectionTypeEnum>
The type of collection to export. Valid collection types are None, User, Group or Scheduling.
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Autodefined <Boolean> Include autodefined collections Required: false
Position: Named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-LogFile <string>
Location of the Logfile to create/append to.
Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
The file to export the group collection to.
Boolean
Include autodefined collections.
Outputs
PSObject
Returns the stats of the export.
Examples
PS C:\>Export-MNECollections -Path "C:\Path.tsv" -CollectionType Group
Exports the group collections to the file at "C:\Path.tsv".
Export-MNEConfiguration
Synopsis
Export a configuration to a file.
Syntax
Export-MNEConfiguration [-ConfigurationGuid] <Guid> [[-FileName] <string>] [-Force] [-RawConfiguration] [<CommonParameters>]
Description
Exports a configuration to the specified file.
Updates the file with the configuration represented by the configuration Guid.
Parameters
-ConfigurationGuid <Guid>
Guid of the configuration to export to the file.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-FileName <string>
File to export the configuration to.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Force [<SwitchParameter>]
Overwrite an existing file without prompting the user for confirmation.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RawConfiguration [<SwitchParameter>]
Export configuration settings from database without merging with default settings.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
Configuration Guid accepts input from the pipeline.
Outputs
This cmdlet returns the directory path of the exported file upon a successful run.
Examples
PS C:\>Export-MNEConfiguration -ConfigurationGuid 69F764C9-D209-4C4D-BCCB- 6E59F615CD9D -FileName "TestName"
Exports the configuration from the specified Guid to the file named "TestName" with the default file extension ".ini" in the current directory.
PS C:\>Export-MNEConfiguration -ConfigurationGuid 69F764C9-D209-4C4D-BCCB- 6E59F615CD9D -FileName "C:\Temp.ini"
Exports the configuration from the specified Guid to the file of the given file path.
PS C:\>Export-MNEConfiguration -ConfigurationGuid 69F764C9-D209-4C4D-BCCB- 6E59F615CD9D
Exports the configuration from the specified Guid to the file with the name of the given Guid and file extension ".ini" in the current directory.
Export-MNEConfigurationData
Synopsis
Export configuration data to a file.
Syntax
Export-MNEConfigurationData [-ConfigurationData] <ConfigurationData> [[-FileName]
<string>] [-Force] [<CommonParameters>]
Description
Exports configuration data to the specified file. Updates the file with the configuration data.
Parameters
-ConfigurationData <ConfigurationData>
Configuration data to export to the file.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-FileName <string>
File to export the configuration data to.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Force [<SwitchParameter>]
Overwrite an existing file without prompting the user for confirmation.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
ConfigurationData
The ConfigurationData parameter accepts input from the pipeline.
Outputs
This cmdlet returns the directory path of the exported file upon a successful run.
Examples
PS C:\>Export-MNEConfigurationData -ConfigurationData $data -FileName "TestName"
Exports the configuration data object to the specified file with the default file extension ".ini" in the current directory.
PS C:\>Export-MNEConfigurationData -ConfigurationData $data -FileName "c:\temp.ini"
Exports the configuration data object to the file specified in the directory path.
PS C:\>Export-MNEConfigurationData -ConfigurationData $data
Exports the given configuraiton data object to a file specified in the configuration data object or to the default file name "ConfigurationData.ini" in the current directory.
Export-MNESummary
Synopsis
Exports data from the specified summary to the designated tsv (tab-delimited file).
Syntax
Export-MNESummary [-FilePath] <string> [-Summary] <ViewSummary> [<CommonParameters>]
Description
Exports data from the specified summary to the designated tsv (tab-delimited file). The path specified will automatically overwrite any existing file.
The Summary is chosen by a ViewSummary enum value
Parameters
-FilePath <string>
The designated export location and filename for the summary.
The cmdlet will confirm if the file is the correct extension and overwrite any existing file. Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Summary <ViewSummary>
The chosen summary to be exported.
Valid summary type are UserAndResources, DistributionList, InetDomains, NotesDomains, DatastoreDesign, UserMigrationStatus, DistributionListProvisioning and DatastoreStatus.
Uses a ViewSummary enum for ease of use. Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
This cmdlet returns no values on a successful run.
Examples
PS C:\>Export-MNESummary -Filepath "C:\summary.tsv" -Summary UserAndResources
Exports the user and resurces summary to a tsv file called "summary" in the root of the c drive.
Format-MNEDatabaseExport
Synopsis
Removes certain lines in the NME Database Export that are expected to change.
For this cmdlet to work properly, the export must be exported with high width, so that the file was not cut off by the window size.
Syntax
Format-MNEDatabaseExport -InputFile <string> [-IgnoreFile <string>] [<CommonParameters>]
Description Parameters
-InputFile <string>
File that will be formatted.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-IgnoreFile <string>
Path to a file containing all the lines of text to ignore in it.
If not specified, the text to ignore will default to "ComputerName :", "TcpipAddress :", "LogDir=", "EndUserDir=", "SMTPTranslationTable=", "CentralLogDir=", "~AdminPassword=", "UserIdFile=", "~Password=", "LastProvisionUserCollectionsCollection=", "LastLocateNotesDataStoresCollection=", "ATGenerated=", "LastManageUserCollectionsLabel=", "LastManageGroupsLabel=", "LastProvisionUserCollectionsLabel=", "LastSendPabReplicatorLabel=", "LastSendPabReplicatorCollection=", "DefaultAdminIniStatus=", "DefaultDesktopIniStatus=", "LastProvisionGroupsLabel=", "LastProvisionGroupsCollection=", "LastLocateNotesDataStoresLabel=", "LastMigrateUserDataLabel=", "LastMigrateUserDataCollection=".
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
System.String
Returns the formatted output.
Examples
PS C:\>Format-MNEDatabaseExport -InputFile C:\exampleexport.txt
Formats the database export at C:\exampleexport.txt using the default ignore lines and outputs it to the console.
PS C:\>Format-MNEDatabaseExport -InputFile C:\exampleexport.txt -IgnoreFile C:\ignore.txt
Formats the database export at C:\exampleexport.txt using the ignore lines from C:\ignore.txt and outputs it to the console.
PS C:\>Format-MNEDatabaseExport -InputFile C:\exampleexport.txt | Out-File C:\formattedexport.txt -Width 9001
Formats the database export at C:\exampleexport.txt using the default ignore lines and outputs it to C:\formattedexport.txt.
Format-MNEGroupCollection
Synopsis
Formats a group collection.
Syntax
Format-MNEGroupCollection [-CollectionName] <string> [-Name <string>] [-Label
<string>] [-Description <string>] [-Query <string>] [-QueryType
<NmeCollectionQueryType>] [<CommonParameters>]
Description
Formats the indicated group collection with the values of the other parameters.
Parameters
-CollectionName <string>
Name of the group collection to format.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Name <string>
Name to change the group collection name to.
If not specified, the name of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
Label to change the group collection label to.
If not specified, the label of the collection will remain the same. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
Description to change the group collection description to.
If not specified, the description of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
Query to change the group collection query to.
If not specified, the query of the collection will remain the same. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <string>
Query type to change the group collection query to.
If not specified, the query type of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Outputs the collection that was updated to, if there are no errors.
Examples
PS C:\>Format-MNEGroupCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -Query "This is a query"
Updates the group collection with the given values into the database.
PS C:\>Format-MNEGroupCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -QueryType Dynamic -Query "This is a query"
Updates the group collection with the given values into the database and sets the group collection to use dyanmic query to populate members.
Format-MNEUserCollection
Synopsis
Formats a user collection.
Syntax
Format-MNEUserCollection [-CollectionName] <string> [-Name <string>] [-Label
<string>] [-Description <string>] [-Query <string>] [-QueryType
<NmeCollectionQueryType>] [<CommonParameters>]
Description
This cmdlet formats the indicated user collection with the values of the other parameters.
Parameters
-CollectionName <string>
Name of the user collection to format.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Name <string>
Name to change the user collection name to.
If not specified, the name of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Label <string>
Label to change the user collection label to.
If not specified, the label of the collection will remain the same. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Description <string>
Description to change the user collection description to.
If not specified, the description of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Query <string>
Query to change the user collection query to.
If not specified, the query of the collection will remain the same. Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-QueryType <NmeCollectionQueryType>
Query type to change the user collection query to.
If not specified, the query type of the collection will remain the same. Required: false
Position: Named
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Collection
Outputs the collection that was updated to, if there are no errors.
Examples
PS C:\>Format-MNEUserCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -Query "This is a query"
Updates the user collection with the given values into the database.
PS C:\>Format-MNEUserCollection -CollectionName "OriginalCollection" -Name "GroupCollection" -Label "SampleGroup" -Description "This is a test" -QueryType Dynamic -Query "This is a query"
Updates the user collection with the given values into the database and sets the user collection to use dyanmic query to populate members.
Get-MNEAutodiscoverUserSettings
Synopsis
Returns the user settings obtained from the Plain Old XML (POX) Autodiscover service.
Syntax
Get-MNEAutodiscoverUserSettings [-UserSmtpAddress] <string> [-AutodiscoverUrl
<string>] [-Credential <PSCredential>] [-WebProxyCredential <PSCredential>] [- AllowSelfSignedCertificates] [-EnableScpLookup] [-DisableMapiHttp] [-MaxHops
<Integer>] [<CommonParameters>]
Description
Returns the user settings obtained from the Plain Old XML (POX) Autodiscover service.
Parameters
-UserSmtpAddress <string>
Specifies the user SMTP address used to perform autodiscover.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-AutodiscoverUrl <string>
Specifies the Autodiscover Url endpoint.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Credential <PSCredential>
Specifies the credentials that are used to authenticate with the Autodiscover service.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WebProxyCredential <PSCredential>
Specifies the HTTP proxy credential settings.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AllowSelfSignedCertificates [<SwitchParameter>]
Validate the certificate for the server responding to the Autodiscover request. By default only certificates signed by a trusted root authority are considered valid. Self-signed certificates are only considered valid if this is set to True.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-EnableScpLookup [<SwitchParameter>]
Indicates whether MNE should perform a service connection point (SCP) lookup when it is determining the service URL.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DisableMapiHttp [<SwitchParameter>]
Determines whether or not MNE requests MAPI/HTTP protocol information from the Autodiscover service.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
is 10.
-MaxHops <Integer>
Specifies the value for maximum number of redirects or hops when performing autodiscover. The default value
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
The UserSmtpAddress parameter accepts values from the pipeline.
Outputs
QuestSoftware.EwsMe.IPoxUserSettings
Returns user settings from the Plain old XML (POX) Autodiscover service response.
Examples
PS C:\>Get-MNEAutodiscoverUserSettings -UserSmtpAddress test@domain.com
Returns user settings such as UserDisplayName, UserDN, ExternalMailboxServer, etc. from the Autodiscover service response.
PS C:\>$cred = Get-CredentialGet-MNEAutodiscoverUserSettings -UserSmtpAddress test@company.onmicrosoft.de -Credential $cred
Returns user settings by supplying user credential obtained from Get-Credential cmdlet.
PS C:\>Get-MNEAutodiscoverUserSettings -UserSmtpAddress test@company.onmicrosoft.de
-AutodiscoverUrl https://outlook.office.de/autodiscover/autodiscover.svc
Returns user settings by supplying AutodiscoverUrl. This eliminates the need for MNE to have to resolve the Autodiscover URL.
Get-MNECollection
Synopsis
Gets all of the collections or the indicated collection from the database.
Syntax
Get-MNECollection [-CollectionType <NmeCollectionType>] [<CommonParameters>] Get-MNECollection [-CollectionGuid] <Guid> [<CommonParameters>]
Description
This cmdlet returns either all collections in the database, or the collection for the specified GUID.
Parameters
-CollectionType <NmeCollectionType>
The collection type to search for. The default type is User. Valid collection type must be either User or Group.
Required: false
Position: named Default value:.User
Accept pipeline input:false Accept wildcard characters:false
-CollectionGuid <Guid>
Guid of the collection to get from the database.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
Guid
The CollectionGuid parameter accepts input from the pipeline.
Outputs
Collection
Returns either a single specified collection, or all collections in the database of the specified type.
Examples
PS C:\>Get-MNECollection -CollectionGuid 455E1829-45D1-4485-8467-80A463DA5227
Returns the user or group collection associated with the given Guid.
PS C:\>Get-MNECollection
Returns all user collections in the database.
PS C:\>Get-MNECollection -CollectionType Group
Returns all group collections in the database.
Get-MNECollectionMember
Synopsis
Returns all members in a collection.
Syntax
Get-MNECollectionMember [-CollectionGuid] <Guid> [<CommonParameters>]
Description
Returns all members in a collection that is specified by the Guid given by the user.
Parameters
-CollectionGuid <Guid>
Guid of collection to retrieve the collection members from.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
The CollectionGuid parameter accepts values from the pipeline.
Outputs
CollectionMember
Returns all members of the given collection.
Examples
PS C:\>Get-MNECollectionMember -CollectionGuid 69F764C9-D209-4C4D-BCCB-6E59F615CD9D
Returns all members in the collection with the specified Guid.
Get-MNEConfiguration
Synopsis
Returns either a single or multiple configurations.
Syntax
Get-MNEConfiguration [[-ConfigurationGuid] <Guid>] [-RawConfiguration
<SwitchParameter>] [<CommonParameters>]
Get-MNEConfiguration -Name <string> [-ConfigurationType <ConfigurationTypeEnum>] [- RawConfiguration <SwitchParameter>] [<CommonParameters>]
Get-MNEConfiguration -ConfigurationType <ConfigurationTypeEnum> [-RawConfiguration
<SwitchParameter>] [<CommonParameters>]
Description
Returns either a single or multiple configurations based on the user input.
The inputs are given priority, with GUID being the highest, then name and configuration type enum (Optional), then configuration type enum, then none.
Giving a GUID returns a single configuration with that Guid. Name and configuration type enum (Optional) returns a single configuration with that name. The enum returns all configurations of that type. None returns all configurations in the database.
Parameters
-ConfigurationGuid <Guid>
Can be used to retrieve the configuration of the specified Guid.
Required: false
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Name <string>
Can be used to retrieve the configuration of the specified name.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ConfigurationType <ConfigurationTypeEnum>
Can be used to retrieve the configuration of the specified name and the specified type based on the
ConfigurationTypeEnum.
Can be used to retrieve all configurations of the specified type based on the ConfigurationTypeEnum. The valid configuration types are Default, DiscoverNabs, DiscoverDomains, DirExport, MergeContacts,
DiscoverData, ProvisionGroups, SendPabReplicator, MigrateWithSSDM, MigrateWithAdmin and
GatherUserStats.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RawConfiguration [<SwitchParameter>]
Get raw configuration settings without merging with default settings.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
The Name of the configuration to retrieve.
System.Guid
The Guid of the configuration to retrieve.
Outputs
Configuration
Returns either a single or multiple configurations based on the user given input.
Examples
PS C:\>Get-MNEConfiguration -ConfigurationGuid 69F764C9-D209-4C4D-BCCB-6E59F615CD9D
Returns the configuration with the specified Guid.
PS C:\>Get-MNEConfiguration -Name "Migration Configuration"
Returns the configuration with the specified name.
PS C:\>Get-MNEConfiguration -Name "Migration Configuration" -ConfigurationType MigrateWithAdmin
Returns the configuration with the specified name and configuration type.
PS C:\>Get-MNEConfiguration -ConfigurationType DiscoverNabs
Returns all configurations with the specified configuration type.
PS C:\>Get-MNEConfiguration
Returns all configurations in the database.
Get-MNEDatabaseConnectionString
Synopsis
Gets the database connection string for the SQL database.
Syntax
Get-MNEDatabaseConnectionString [<CommonParameters>]
Description
Builds the connection string using SqlConnectionStringBuilder.
Then writes the connection after getting the connection string from the NME database connection.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet does not have any parameters that accept pipeline input.
Outputs
System.Data.SqlClient.SqlConnectionStringBuilder Returns the database connection string object.
Examples
PS C:\>Get-MNEDatabaseConnectionString
Retrieves the connection to the SQL database for Notes Migrator for Exchange.
Get-MNEDatabaseExport
Synopsis
Accesses the NME Database and exports it.
Quest recommendeds you pipe the output to Out-File.
Syntax
Get-MNEDatabaseExport [<CommonParameters>]
Description
Accesses the NME Database and exports it to console output. Quest recommendeds you pipe the output to Out-File.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
System.String
Outputs the full NME database. Quest recommendeds you to output this to a file.
Examples
PS C:\>Get-MNEDatabaseExport
Exports the NME Database directly to the console.
PS C:\>Get-MNEDatabaseExport | Out-File C:\exampleexport.txt -Width 9001
Exports the NME Database to the file C:\exampleexport.txt with a high width, so that the text does not get cut off by the size of the window.
Get-MNEDatabaseVersion
Synopsis
Gets the database version.
Syntax
Get-MNEDatabaseVersion [<CommonParameters>]
Description
This cmdlet returns the database version.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Version
Returns the current database version.
Examples
PS C:\>Get-MNEDatabaseVersion
Returns the current database version.
Get-MNEGlobalDefaultSettings
Syntax
Get-MNEGlobalDefaultSettings [<CommonParameters>]
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
None
Outputs
System.ObjectALIASES NoneREMARKS
None
Get-MNELicense
Synopsis
Gets the currently installed license information from MNE.
Syntax
Get-MNELicense [<CommonParameters>]
Description
Gets the currently installed license information from MNE.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
LicenseInfo
PSObject that contains license Type, ExpirationDate, Status, IsValid, Number, MigratedUsers, and SeatsUsed.
Examples
Get-MNEMigrationResult
Synopsis
Returns all relevant data from the migration for the specified objects. You can input an SMTP address, object Guid, or collection Guid to get the information.
Syntax
Get-MNEMigrationResult [-SmtpAddress] <string> [<CommonParameters>] Get-MNEMigrationResult -ObjectGuid <Guid> [<CommonParameters>]
Get-MNEMigrationResult -CollectionGuid <Guid> [<CommonParameters>]
Description
This cmdlet returns all relevant data from the migration for the specfied objects. You can input an SMTP address, object Guid, or collection Guid to get the information.
Parameters
-SmtpAddress <string>
The SMTP address of the object to check the migration results for.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ObjectGuid <Guid>
The Guid of the object to check the migration results for.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CollectionGuid <Guid>
The Guid of the collection to check the migration results for.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
The cmdlet parameter SmtpAddress accepts input from the pipeline.
Outputs
MigrationUserResult, MigrationResourceResult
Returns all relevant data from the migration for the specified objects.
Examples
PS C:\>Get-MNEMigrationResult -SmtpAddress sample@test.nme.com
Returns the migration information for the user(s) or resource(s) with the given smtp address.
PS C:\>Get-MNEMigrationResult -ObjectGuid 555B8BB5-7AE0-4CBF-A7FF-9B11163CD9B1
Returns the migration information for the object with the given Guid.
PS C:\>Get-MNEMigrationResult -CollectionGuid 54899105-83EC-4009-B763-E54CA8C8B302
Returns the migration information for the collection members in the collection with the given Guid.
Get-MNEMigrationTask
Synopsis
Gets either a single migration task (by task Guid) or multiple tasks (by Configuration type enum).
Syntax
Get-MNEMigrationTask -TaskGuid <Guid> [<CommonParameters>]
Get-MNEMigrationTask -ConfigurationType <ConfigurationTypeEnum> [<CommonParameters>]
Description
Gets either a single migration task (by task Guid) or multiple tasks (by Configuration type enum).
Parameters
-TaskGuid <Guid>
Guid of the migration task to retrieve.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationType <ConfigurationTypeEnum>
Configuration type of the migration task(s) to retrieve.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept input from pipeline.
Outputs
Task
Returns the task(s) based on the given input.
Examples
PS C:\>Get-MNEMigrationTask -TaskGuid 555B8BB5-7AE0-4CBF-A7FF-9B11163CD9B1
Returns the migration task with the given Guid.
PS C:\>Get-MNEMigrationTask -ConfigurationType Default
Returns the migration task(s) with the given configuration type.
Get-MNEMigrationTimeWindow
Synopsis
Gets the migration time window.
Syntax
Get-MNEMigrationTimeWindow [[-CollectionName] <string>] [<CommonParameters>]
Description
Gets the migration time window.
Returns the migration schedule for a given collection if the collection name is specified or for all scheduled collections.
Parameters
-CollectionName <string>
Name of the collection to retrieve the schedule for if specfied.
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept input from pipeline.
Outputs
SingleCollectionSchedule
Returns the schedule for a given collection if the collection name is specified.
Examples
PS C:\>Get-MNEMigrationTimeWindow -CollectionName "Test"
Returns the migration time information for the collection named "Test".
PS C:\>Get-MNEMigrationTimeWindow
Returns the migration time information for all scheduled collections.
Get-MNEResource
Synopsis
Gets the specified resource.
Syntax
Get-MNEResource [-SmtpEmailAddress] <string> [<CommonParameters>] Get-MNEResource -ObjectGuid <Guid> [<CommonParameters>]
Description
This cmdlet returns the specified mail-in database or resource based on the specified smtp address or object Guid.
Parameters
-SmtpEmailAddress <string>
SMTP address of the resource to retrieve.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ObjectGuid <Guid>
Guid of the object associated with the resource to retrieve.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
SMTP address of the resource to retrieve.
System.Guid
Guid of the object associated with the resource to retrieve.
Outputs
Resource
Returns the specified resource information (either by SMTP address or object Guid).
Examples
PS C:\>Get-MNEResource -SmtpEmailAddress sample@test.nme.com
Returns the resource associated with the given smtp address.
PS C:\>Get-MNEResource -ObjectGuid 335B8BB5-7AE0-4CBF-A7FF-9B11122CD9B1
Returns the resource associated with the given object Guid.
Get-MNESchedulingConfigFile
Synopsis
Gets the list of scheduling configuration files and returns them.
Syntax
Get-MNESchedulingConfigFile [<CommonParameters>]
Description
Gets the list of scheduling configuration files and returns them.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
ConfigNames
Returns the names of the scheduling config files.
Examples
PS C:\>Get-MNESchedulingConfigFile
Gets and returns the names of the configuration files for the SSDM Scheduling Administration tool.
Get-MNESchedulingSetting
Synopsis
Gets and returns the list of global scheduling settings for the SSDM Scheduling Administration tool.
Syntax
Get-MNESchedulingSetting [<CommonParameters>]
Description
Gets the list of global scheduling settings for the SSDM Scheduling Administration tool and returns them.
Parameters
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
SchedulingGlobalSettings
Return the global settings for scheduling in SSDM Scheduling Administration tool.
Examples
PS C:\>Get-MNESchedulingSetting
Gets and returns the list of global scheduling settings for the SSDM Scheduling Administration tool.
Get-MNETaskError
Synopsis
Gets the Task Errors for a specified given task or run.
Syntax
Get-MNETaskError [-TaskRunGuid] <Guid> [<CommonParameters>] Get-MNETaskError -TaskGuid <Guid> [<CommonParameters>]
Description
This cmdlet outputs the errors for a specified task and/or task run.
Parameters
-TaskRunGuid <Guid>
Guid of the task run to retrieve the errors from if retrieving by task run.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-TaskGuid <Guid>
Guid of the task to retrieve the errors from if retrieving by task.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
Guid
Guid of the task run to retrieve the errors from.
Outputs
string
Returns the errors for the task and/or task run as strings.
Examples
PS C:\>Get-MNETaskError -TaskGuid 555B8BB5-7AE0-4CBF-A7FF-9B11163CD9B1
Returns the task error information for the specified task.
PS C:\>Get-MNETaskError -TaskRunGuid 335B8BB5-7AE0-4CBF-A7FF-9B11122CD9B1
Returns the task error information for the specified task(s) from the run.
Get-MNETaskRun
Synopsis
Gets the specified task run.
Syntax
Get-MNETaskRun [-TaskRunGuid] <Guid> [<CommonParameters>] Get-MNETaskRun -TaskName <string> [<CommonParameters>] Get-MNETaskRun -TaskGuid <Guid> [<CommonParameters>]
Get-MNETaskRun -ConfigurationType <ConfigurationTypeEnum> [<CommonParameters>]
Description
This cmdlet retrieves information for a specified task run.
Parameters
-TaskRunGuid <Guid>
Guid of a task run, if looking for a task run by its own Guid.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-TaskName <string>
Task Name, if finding all task runs associated with a particular task.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-TaskGuid <Guid>
Guid of the task, if finding the task runs associated with that task.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationType <ConfigurationTypeEnum>
Configuration Type, if finding all task runs associated with a particular configuration.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
Guid of a task run, if looking for a task run by its own Guid.
System.String
Task Name, if finding all task runs associated with a particular task.
Outputs
TaskRun
Outputs information on the specified task run.
Examples
PS C:\>Get-MNETaskRun -TaskGuid 555B8BB5-7AE0-4CBF-A7FF-9B11163CD9B1
Returns the task run associated with the task with the given Guid.
PS C:\>Get-MNETaskRun -TaskRunGuid 335B8BB5-7AE0-4CBF-A7FF-9B11122CD9B1
Returns the task run associated given task run Guid.
Get-MNETaskSchedule
Synopsis
Gets the specified task schedule.
Syntax
Get-MNETaskSchedule [-TaskGuid <Guid>] [<CommonParameters>]
Description
Retrieves information for a specific task schedule.
If no Guid is specified, this cmdlet returns all scheduled tasks. Using verbose will output the name and Guid prior to the schedule.
Parameters
-TaskGuid <Guid>
Guid of the task specified to get the schedule for.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Schedule
Returns the schedule of the specified task, or the schedules of all scheduled tasks.
Examples
PS C:\>Get-MNETaskSchedule -TaskGuid 555B8BB5-7AE0-4CBF-A7FF-9B11163CD9B1
Returns the task schedule associated with specified task Guid.
PS C:\>Get-MNETaskSchedule
Returns all schedules of scheduled tasks.
Get-MNEUser
Synopsis
Gets the specified user.
Syntax
Get-MNEUser [[-SmtpEmailAddress] <string>] [<CommonParameters>] Get-MNEUser -ObjectGuid <Guid> [<CommonParameters>]
Description
This cmdlet returns the specified user based on the defined smtp address or object Guid.
Parameters
-SmtpEmailAddress <string>
SMTP address of the user to retrieve.
Required: false
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ObjectGuid <Guid>
Guid of the object associated with the user to retrieve.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
SMTP address of the user to retrieve.
System.Guid
Guid of the object associated with the user to retrieve.
Outputs
User
Outputs the specified user information (either by SMTP address or object Guid).
Examples
PS C:\>Get-MNEUser -SmtpEmailAddress sample@test.nme.com
Returns the user associated with the given smtp address.
PS C:\>Get-MNEUser -ObjectGuid 335B8BB5-7AE0-4CBF-A7FF-9B11122CD9B1
Returns the user associated with the given object Guid.
Get-MNEWorkstation
Synopsis
Gets the workstation specified or all workstations.
Syntax
Get-MNEWorkstation [-WorkstationGuid <Guid>] [<CommonParameters>]
Description
This cmdlet returns the workstation specified by the given Guid or all workstation if no Guid is given.
Parameters
-WorkstationGuid <Guid>
Guid of the workstation to retrieve.
Required: false
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
WorkstationGuid parameter accepts pipeline input.
Outputs
Workstation
Outputs the workstation specified by user, or all workstations if no Guid is given.
Examples
PS C:\>Get-MNEWorkstation -WorkstationGuid 69F764C9-D209-4C4D-BCCB-6E59F615CD9D
Returns the workstation with the specified Guid.
PS C:\>Get-MNEWorkstation
Returns all workstations in the database.
Hide-MNECollection
Synopsis
Sets a Collection to be "invisible" in the UI.
Syntax
Hide-MNECollection [-Collection] <NmeCollection> [<CommonParameters>]
Description
Sets a Collection to be "invisible" in the UI. The collection is added/updated in the database upon completion. Collections that are "invisible" are essentially disabled and will not be included during migrations.
Parameters
-Collection <NmeCollection>
The collection object to be hidden.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
NmeCollection
The Collection parameter accepts object input from the pipeline.
Outputs
None if successful
Examples
Get-MNECollection -CollectionGuid "e50d5123-2ec8-4096-816e-8e0e458d12e7" | Hide- MNECollection
A collection is retrieved from the database and its visiblity is set to hidden.
Import-MNECollections
Synopsis
Import collections of any kind from a specified file.
Syntax
Import-MNECollections [-Path] <string> [-LogFile <string>] [<CommonParameters>]
Description
Import collections of any kind from a specified file.
Parameters
-Path <string>
Path to the file from which the collections will be imported.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-LogFile <string>
Path to which the log will be written.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
This cmdlet accepts file path input from the pipeline.
Outputs
PSObject
Import statistics information.
Examples
PS C:\>Import-MNECollections -Path "C:\Collections.tsv"
Imports the collections from the file at "C:\Collections.tsv".
Import-MNEConfiguration
Synopsis
Import a configuration from file.
Syntax
Import-MNEConfiguration [-ConfigurationGuid] <Guid> [-FileName] <string> [- RawConfiguration] [<CommonParameters>]
Description
Imports configurations from the given file.
Updates the configuration represented from the configuration Guid with the settings from the file.
Parameters
-ConfigurationGuid <Guid>
Guid of the configuration to which the settings from the file will be imported.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-FileName <string>
The name of the file that has the configuration settings to import.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-RawConfiguration [<SwitchParameter>]
Import configuration settings from file without comparing with default settings.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
The ConfigurationGuid parameter accepts input from the pipeline.
Outputs
This cmdlet returns no values upon a successful run.
Examples
PS C:\>Import-MNEConfiguration -ConfigurationGuid 69F764C9-D209-4C4D-BCCB- 6E59F615CD9D -FileName "TestName"
Imports the configuration from the file named "TestName" and updates the configuration with the given Guid with those settings.
Import-MNEConfigurationData
Synopsis
Import configuration data from file.
Syntax
Import-MNEConfigurationData [-FileName] <string> [<CommonParameters>]
Description
Imports configuration data from the given file.
Parameters
-FileName <string>
Name of the file to import the configuration data from.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
ConfigurationData
Returns the configuration data from the file.
Examples
PS C:\>Import-MNEConfigurationData -FileName "TestName"
Imports the configuration data from the file named "TestName".
Initialize-MNEOneDriveUserCollection
Synopsis
Preprovision mailbox user's OneDrive store in the user collection for Microsoft 365. It is required for the user's OneDrive store to be ready if the feature for MNE to migrate oversized attachments to OneDrive is enabled..
Syntax
Initialize-MNEOneDriveUserCollection [-CollectionName] <string> [<CommonParameters>]
Initialize-MNEOneDriveUserCollection [-CollectionName] <string> -ConfigurationId <string> [<CommonParameters>]
Initialize-MNEOneDriveUserCollection [-CollectionName] <string> -ConfigurationFileName <string> [<CommonParameters>]
Description
Prior to migrating the Notes mail database to Exchange Online, if you enable oversized attachments migration to OneDrive store, all users in the user collection should have their OneDrive stores provisioned. This cmdlet takes the MNE user collection name and initializes OneDrive store for each user in the user collection.
Parameters
-CollectionName <string>
Name of the user collection containing the mailbox users that have licensed OneDrive store to be preprovisioned by the Exchange admin user.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to use.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFilename <string>
File name of a configuration settings .ini file to use as the configuration.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
None if successful.
Examples
PS C:\>Initialize-MNEOneDriveUserCollection "All Users"
Preprovision OneDrive store for all mailbox users in the "All Users" collection using default configuration setting.
PS C:\>Initialize-MNEOneDriveUserCollection -CollectionName "All Users" - ConfigurationId "CDB86C40-49E2-43E1-8DE5-E1B2F4A55B51"
Preprovision OneDrive store for all mailbox users in the "All Users" collection using configuration settings by the given configuration id.
PS C:\>Initialize-MNEOneDriveUserCollection "All Users" -ConfigurationId "Default Settings"
Preprovision OneDrive store for all mailbox users in the "All Users" collection using configuration by the given name.
PS C:\>Initialize-MNEOneDriveUserCollection -CollectionName "All Users" - ConfigurationFilename "C:\defaultconfig.ini"
Preprovision OneDrive store for all mailbox users in the "All Users" collection using the configuration settings specified in the file C:\defaultconfig.ini.
Install-MNELicense
Synopsis
Installs a license file for MNE using the given file path.
Syntax
Install-MNELicense [-Path] <string> [<CommonParameters>]
Description
Installs a license file for MNE using the given file path.
Parameters
-Path <string>
File path for the license to install.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
LicenseInfo
PSObject that contains license Type, ExpirationDate, Status, IsValid, Number, MigratedUsers, and SeatsUsed.
Examples
Invoke-MNEExportObjectsToTsv
Synopsis
Exports the Directory Exporter objects in MNE to a tsv file.
Syntax
Invoke-MNEExportObjectsToTsv [-TsvFilePath] <string> [<CommonParameters>]
Description
Exports the directory exporter objects in NME to a tsv file.
Parameters
-TsvFilePath <string>
The UNC path of the tsv file to export to.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
This cmdlet accepts file path input from the pipeline.
Outputs
Nothing is returned from this cmdlet.
Examples
PS C:\>Invoke-MNEExportObjectsToTsv -TsvFilePath "C:\exampletsv.tsv"
Exports all objects to the tsv specified if it exists, otherwise creates a new tsv file.
Invoke-MNEFindNotesDomain
Synopsis
Runs the Enumerate Notes Domains executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNEFindNotesDomain [[-DominoServer] <string>] [[-UserIdFile] <string>] [[- Password] <string>] [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the get notes domains executable with the configuration in the database or user defined values.
Parameters
-DominoServer <string>
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserIdFile <string>
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Password <string>
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEFindNotesDomain
Runs the NME Enumerate Notes Domain task and returns the process results.
PS C:\>Invoke-MNEFindNotesDomain -DominoServer "Domino/Server"
Runs the NME Enumerate Notes Domain task with default configuration except DominoServer is set to "Domino/Server".
PS C:\>Invoke-MNEFindNotesDomain -UserIdFile "C:\Admin-id.id"
Runs the NME Enumerate Notes Domain task with default configuration except UserIdFile is set to "C:\Admin- id.id".
PS C:\>Invoke-MNEFindNotesDomain -Password "password"
Runs the NME Enumerate Notes Domain task with default configuration except Password is set to "password".
Invoke-MNEFindNotesNab
Synopsis
Runs the Enumerate Notes NABs executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNEFindNotesNab [[-DominoServer] <string>] [[-UserIdFile] <string>] [[- Password] <string>] [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the Enumerate Notes NABs executable with the configuration in the database or user-defined values.
Parameters
-DominoServer <string>
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserIdFile <string>
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Password <string>
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation this task should be ran on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEFindNotesNab
Runs the NME Enumerate Notes Nabs task and returns the process results.
PS C:\>Invoke-MNEFindNotesNab -DominoServer "Domino/Server"
Runs the NME Enumerate Notes Nabs task with default configuration except DominoServer is set to "Domino/Server".
PS C:\>Invoke-MNEFindNotesNab -UserIdFile "C:\Admin-id.id"
Runs the NME Enumerate Notes Nabs task with default configuration except UserIdFile is set to "C:\Admin-id.id".
PS C:\>Invoke-MNEFindNotesNab -Password "password"
Runs the NME Enumerate Notes Nabs task with default configuration except Password is set to "password".
Invoke-MNEGatherDesktopStatistics
Synopsis
Runs the Gather Desktop Statistics executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNEGatherDesktopStatistics [[-StatisticsDirectory] <string>] [-WorkStation
<WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the Gather Desktop Statistics executable with the configuration in the database or user-defined values.
Parameters
-StatisticsDirectory <string>
The UNC path of the directory containing the SSDM statistics.
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
The full path of the file the application should log to. If no path is provided, log files will be created in the Log Directory as defined in the default NME configuration.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEGatherDesktopStatistics
Runs the NME Gather Desktop Statistics enumerable.
PS C:\>Invoke-MNEGatherDesktopStatistics -StatisticsDirectory "\\elmo\C$\ssdm\" - LogFile "C:\testlog.wlog"
Runs the NME Gather Desktop Statistics executable, looking for statistics in the "\\elmo\C$\ssdm\" folder and creating a log file at C:\testlog.wlog.
Invoke-MNEImportObjectsFromTsv
Synopsis
Imports the Directory Exporter objects from a tsv file.
Syntax
Invoke-MNEImportObjectsFromTsv [-TsvFilePath] <string> [<CommonParameters>]
Description
Imports the directory exporter objects from a tsv file.
Parameters
-TsvFilePath <string>
UNC path of the tsv file from which to import.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
string
This cmdlet accepts file path input from the pipeline.
Outputs
Returns done or job failed status at the end of the run.
Examples
PS C:\>Invoke-MNEImportObjectsFromTsv -TsvFilePath "C:\exampletsv.tsv"
Imports all objects from the tsv file.
Invoke-MNELocateNotesDataStore
Synopsis
Runs the Enumerate Data executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNELocateNotesDataStore [-UserCollection] <string> [[-UserIdFile] <string>] [[-Password] <string>] -ConfigurationId <string> [-WorkStation <WorkStation>] [- LogFile <string>] [<CommonParameters>]
Invoke-MNELocateNotesDataStore [-UserCollection] <string> [[-UserIdFile] <string>] [[-Password] <string>] [-LocateNew <NotesUpdateModeTypeEnum>] [-LocateMailFiles
<LocateDatastoresFindByEnum>] [-LocatePabs <LocateDatastoresFindByEnum>] [- LocateArchives <LocateDatastoresFindByEnum>] [-MailFileDir <string>] [-PabDir
<string>] [-PabReplicaServer <string>] [-ArchiveDir <string>] [-ArchiveReplicaServer
<string>] [-AclIgnoreList <string>] [-OwnerByAcl] [-WorkStation <WorkStation>] [- LogFile <string>] [<CommonParameters>]
Description
Scans the Notes environment for all data stores associated with a designated user collection.
Parameters
-UserCollection <string>
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserIdFile <string>
Required: false
Position: 1
Default value:in default settings Accept pipeline input:false Accept wildcard characters:false
-Password <string>
Required: false
Position: 2
Default value:in default settings Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocateNew <NotesUpdateModeTypeEnum>
Required: false
Position: Named Default value:.Append
Accept pipeline input:false Accept wildcard characters:false
-LocateMailFiles <LocateDatastoresFindByEnum>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocatePabs <LocateDatastoresFindByEnum>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocateArchives <LocateDatastoresFindByEnum>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailFileDir <string>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabDir <string>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicaServer <string>
Required: false
Position: Named Default value:in default config Accept pipeline input:false Accept wildcard characters:false
-ArchiveDir <string>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveReplicaServer <string>
Required: false
Position: Named Default value:in default config Accept pipeline input:false Accept wildcard characters:false
-AclIgnoreList <string>
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-OwnerByAcl [<SwitchParameter>]
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
The full path of the file the application should log to. If no path is provided, log files will be created in the Log Directory as defined in the default MNE configuration.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNELocateNotesDataStore "All Users" -ConfigurationId "8846d710-03df- 4c51-ab51-4fe738526a78"
Creates and runs the NME Locate Notes Datastores Task and returns the process results on collection "All Users" with settings from Configuration with guid "8846d710-03df-4c51-ab51-4fe738526a78".
PS C:\>Invoke-MNELocateNotesDataStore "All Users" "C:\admin.id" "pa55w0rd" - LocateMailFiles Nab
Creates and runs a NME Locate Notes Datastores Task and returns the process results on collection "All Users" and logging in with UserIdFile "C:\admin.id" and password "pa55w0rd" that updates the mail files with thoes located on the domino server.
PS C:\>Invoke-MNELocateNotesDataStore "All Users" -LocateNew Append -LocatePabs Replica -PabReplicaServer "Domino/Server" -PabDir "Pab"
Creates and runs a NME Locate Notes Datastores Task and returns the process results on collection "All Users" that finds new Pabs on server "Domino/Server" in directory "Pab" and adds them to the database.
PS C:\>Invoke-MNELocateNotesDataStore "All Users" -LocateNew ReplaceAll - LocateArchives Scan -ArchiveDir "Domino/Server!!Archives" -OwnerByAcl -AclIgnoreList "admin,owner"
Creates and runs a NME Locate Notes Datastores Task and returns the process results on collection "All Users" that finds new Archivess on server "Domino/Server" in directory "Archives" and Replaces all in database with the located files.
Also attempts to find owners for all data without an owner and Ignoring users "admin" and "owner."
Invoke-MNEMigrateUserData
Synopsis
Runs the Migrate User Data application with a specified configuration.
Syntax
Invoke-MNEMigrateUserData [-UserCollectionId] <string> -ConfigurationId <string> [- MaxMigrationThreads <Integer>] [-WorkStation <WorkStation>] [-LogFile <string>] [- ShowProgressDialog] [-ProgressDialogIsTopmost] [-ManuallyCloseProgressDialog] [<CommonParameters>]
Invoke-MNEMigrateUserData [-UserCollectionId] <string> -ConfigurationFilename
<string> [-RawConfiguration] [-MaxMigrationThreads <Integer>] [-WorkStation
<WorkStation>] [-LogFile <string>] [-ShowProgressDialog] [-ProgressDialogIsTopmost] [-ManuallyCloseProgressDialog] [<CommonParameters>]
Description
Runs the Migrate User Data application with a specified configuration.
Parameters
-UserCollectionId <string>
Name or GUID of the user collection to migrate data from.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to use for this migration.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFilename <string>
Filename of a configuration settings .ini file to use as the configuration for this migration.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RawConfiguration [<SwitchParameter>]
Switch parameter that, if used with FileName, means this is a differential file and will save it to database as differential file.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxMigrationThreads <Integer>
Maximum amount of migration threads to run at once.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
File to log the results to. If specified, this is used, otherwise a default value is used.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ShowProgressDialog [<SwitchParameter>]
Switch parameter that, if used, will display the task progress along with key migration statistics within a pop-up dialog.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ProgressDialogIsTopmost [<SwitchParameter>]
Switch parameter that, when used with the ShowProgressDialog parameter, will cause the progress dialog to be displayed on top of all other windows that are not topmost windows.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ManuallyCloseProgressDialog [<SwitchParameter>]
Switch parameter that, when used with the ShowProgressDialog parameter, will cause the progress dialog to remain open after the migration task has completed until the progress dialog is manually closed. The invoke cmdlet will not terminate until the progress dialog has been closed.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" -ConfigurationId "CDB86C40-49E2-43E1-8DE5-E1B2F4A55B51"
Runs the MNE User Data Migrator with the "All Users" collection and the configuration with the GUID identifier "CDB86C40-49E2-43E1-8DE5-E1B2F4A55B51". Returns the process results.
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" -ConfigurationId "User Migration Template"
Runs the MNE User Data Migrator with the "All Users" collection and the configuration with the name "User Migration Template". Returns the process results.
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" -ConfigurationId "User Migration Template" -MaxMigrationThreads 4
Runs the MNE User Data Migrator with the specified user collection and configuration using 4 migration threads. Returns the process results.
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" -ConfigurationId "User Migration Template" -LogFile "C:\Log.wlog"
Runs the MNE User Data Migrator with the specified user collection and configuration, and logs the task to the specified log file. Returns the process results.
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" -
ConfigurationFilename "C:\defaultconfig.ini"
Runs the MNE User Data Migrator with "All Users" collection and uses the configuration settings specified in C:\defaultconfig.ini. Returns the process results.
PS C:\>Invoke-MNEMigrateUserData -UserCollectionId "All Users" - ConfigurationFilename "C:\defaultconfig.ini" -ShowProgressDialog - ProgressDialogIsTopmost -ManuallyCloseProgressDialog
Runs the MNE User Data Migrator with "All Users" collection and uses the configuration settings specified in C:\defaultconfig.ini. Returns the process results.
While the migration task is running, a progress dialog will be displayed indicating the task progress along with key migration statistics. The progress dialog will be displayed on top of other windows and will remain open after the task has completed until the progress dialog is manually closed.
Invoke-MNENotesDirectoryExport
Synopsis
Runs the Directory Exporter executable with the configuration in the database or user defined values.
Syntax
Invoke-MNENotesDirectoryExport [[-DominoServer] <string>] [[-UserIdFile] <string>] [[-Password] <string>] [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the get notes directory exporter executable with the configuration in the database or user defined values.
Parameters
-DominoServer <string>
Name of the Domino server to export directory from.
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserIdFile <string>
Location of the user ID file to log into the domino server.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Password <string>
The password to access the Domino server.
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
File to log the results to. If specified, this is used, otherwise a default value is used.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNENotesDirectoryExport
Runs the MNE Directory Exporter task and returns the process results.
PS C:\>Invoke-MNENotesDirectoryExport -DominoServer "Domino/Server"
Runs the MNE Directory Exporter task with default configuration except DominoServer is set to "Domino/Server".
PS C:\>Invoke-MNENotesDirectoryExport -UserIdFile "C:\Admin-id.id"
Runs the MNE Directory Exporter task with default configuration except UserIdFile is set to "C:\Admin-id.id".
PS C:\>Invoke-MNENotesDirectoryExport -Password "password"
Runs the MNE Directory Exporter task with default configuration except Password is set to "password".
Invoke-MNEProvisionGroupCollection
Synopsis
Runs the Provision Group Collection executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNEProvisionGroupCollection [-GroupCollection] <string> [-GroupContainer
<string>] [-ContactContainer <string>] [-AddNotFoundContacts] [-KeepGroupsInSync] [-SwitchToSecurityGroup] [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Invoke-MNEProvisionGroupCollection [-GroupCollection] <string> -ConfigurationId
<string> [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Invoke-MNEProvisionGroupCollection [-GroupCollection] <string> - ConfigurationFilename <string> [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the provision group collection application with a specified configuration or user defined values.
Parameters
-GroupCollection <string>
Guid or name of the group collection to provision.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to be used for this task.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFilename <string>
Path to the configuration settings .ini file to be used for this task.
Required: true
Position: named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-GroupContainer <string>
Path to existing organizational unit for distribution groups.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ContactContainer <string>
Path to existing organizational unit for creating external members for distribution groups.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AddNotFoundContacts [<SwitchParameter>]
Switch parameter that, if used, will add contacts not found in Active Directory to AD.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-KeepGroupsInSync [<SwitchParameter>]
Switch parameter that, if used, will keep the provisioned group in sync with the Notes group.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
list.
-SwitchToSecurityGroup [<SwitchParameter>]
Switch parameter that, if used, will provision the new group as a security group instead of a distribution
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
Logfile to which the results will be logged. Uses a default file if parameter is not specified.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEProvisionGroupCollection -GroupCollection "All Groups" -LogFile "C:\Log.txt"
Runs the NME Provision Group Collection task, logs to Log.txt on the C: drive, and returns the status.
PS C:\>Invoke-MNEProvisionGroupCollection -GroupCollection "All Groups" - ConfigurationId "Default Settings" -LogFile "C:\Log.txt"
Runs the MNE Provision Group Collection task with "All Groups" collection and the specified configuration name or GUID, and returns the status.
PS C:\>Invoke-MNEProvisionGroupCollection -GroupCollection "All Groups" - ConfigurationFilename "C:\defaultconfig.ini" -LogFile "C:\Log.txt"
Runs the MNE Provision Group Collection task with "All Groups" collection and the configuration settings specified in C:\defaultconfig.ini.
Invoke-MNEProvisionUserCollection
Synopsis
Runs the Provision User Collection application with a specified configuration or user-defined values.
Syntax
Invoke-MNEProvisionUserCollection [-UserCollection] <string> -DatabaseColumn
<DbColumn> -AdAttribute <ActiveDirectoryAttribute> [- CreateNonExistingUsersFromContacts] [-UserContainer <string>] [-WorkStation
<WorkStation>] [-LogFile <string>] [<CommonParameters>]
Invoke-MNEProvisionUserCollection [-UserCollection] <string> -ConfigurationId
<string> [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Invoke-MNEProvisionUserCollection [-UserCollection] <string> -ConfigurationFilename
<string> [-WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Runs the Provision User Collection application with a specified configuration or user-defined values.
Parameters
-UserCollection <string>
GUID or name of the user collection to provision.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-DatabaseColumn <string>
Database colummn to match to the selected active directory attribute (AdAttribute). Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdAttribute <string>
Active Directory attribute to match to the selected database colummn (DatabaseColumn). Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to be used for this task.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFilename <string>
Path to the configuration settings .ini file to be used for this task.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CreateNonExistingUsersFromContacts [<SwitchParameter>]
Switch parameter that, if used, will add users not currently in Active Directory to the AD.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserContainer <string>
Relative domain name path to an existing organizational unit for creating user object, must be specified if CreateNonExistingUsers switch is on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
The file to which results will be logged. Uses a default value if parameter is not specified.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNEProvisionUserCollection -UserCollection "All Users" -DatabaseColumn "GivenName" -AdAttribute "mailNickname" -LogFile "C:\Log.txt"
Runs the MNE Provision User Collection task with user-defined values and returns the status.
PS C:\>Invoke-MNEProvisionUserCollection -UserCollection "All Users" -DatabaseColumn "GivenName" -AdAttribute "mailNickname" -CreateNonExistingUsers -UserContainer "OU=Target Organization" -LogFile "C:\Log.txt"
Runs the MNE Provision User Collection task with user-defined values and create users in specified organizational unit (relative domain name path to an existing organizational unit) if not exist and returns the status.
PS C:\>Invoke-MNEProvisionUserCollection -UserCollection "All Users" - ConfigurationId "Default Settings" -LogFile "C:\Log.txt"
Runs the MNE Provision User Collection task with "All Users" collection and the specified configuration name or GUID, and returns the status.
PS C:\>Invoke-MNEProvisionUserCollection -UserCollection "All Users" - ConfigurationFilename "C:\defaultconfig.ini" -LogFile "C:\Log.txt"
Runs the MNE Provision User Collection task with "All Users" collection and the configuration settings specified in C:\defaultconfig.ini.
Invoke-MNESendPabReplicator
Synopsis
Sends PABs to all collection members
Syntax
Invoke-MNESendPabReplicator -CollectionName <string> -ConfigurationGuid <Guid> [- WorkStation <WorkStation>] [-LogFile <string>] [<CommonParameters>]
Invoke-MNESendPabReplicator [[-DominoServer] <string>] [[-UserIdFile] <string>] [[- Password] <string>] -CollectionName <string> [-TargetServer <string>] [-TargetDir
<string>] [-MessageSubject <string>] [-MessageFrom <string>] [-WorkStation
<WorkStation>] [-LogFile <string>] [<CommonParameters>]
Description
Sends Pabs to all collection members.
Parameters
-DominoServer <string>
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserIdFile <string>
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Password <string>
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-CollectionName <string>
Name of the collection to send the Pabs to.
Required: true
Position: Named Default value:
Accept pipeline input:false
Accept wildcard characters:false
-ConfigurationGuid <Guid>
Guid of the configuration for the cmdlet.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetServer <string>
Target Domino Server.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetDir <string>
Target Destination Directory.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MessageSubject <string>
Subject for the message.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MessageFrom <string>
Mark the message as sent from this user.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WorkStation <WorkStation>
The WorkStation to run this task on.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
TaskRunInfo
Returns a TaskRunInfo object that contains information regarding the invoked task.
Examples
PS C:\>Invoke-MNESendPabReplicator -CollectionName "All Users" -ConfigurationGuid e6a70f5e-e0d3-4692-a5ad-08b541ace006
Sends the PABs using all the settings from the configuration.
Invoke-MNESSDM
Synopsis
Runs the Self Service Desktop Migrator (SSDM) executable with the configuration in the database or user-defined values.
Syntax
Invoke-MNESSDM -TargetProfile <string> [-NotesUserIdPath <string>] [-NotesPassword
<string>] [-TargetPassword <string>] [-TargetUser <string>] [-TargetServer
<string>] [-TargetDomain <string>] [-DontMigrateMailFile] [-DontMigrateArchive] [- DontMigrateAddressBook] [-AddressBookFilePath <string>] [-MailFilePath <string>] [- MailArchivePath <string>] [<CommonParameters>]
Description
Runs the self service desktop manager executable with the configuration in the database or user defined values.
Parameters
-TargetProfile <string>
Name of the outlook profile to migrate to.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesUserIdPath <string>
Full path to the Notes user id file.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesPassword <string>
Password for the notes user.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetPassword <string>
Password for the outlook profile.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetUser <string>
Username of the AD user to attach to.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetServer <string>
Active Directory server to attach to.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetDomain <string>
Active Directory Domain to attach to.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DontMigrateMailFile [<SwitchParameter>]
Changes the ini to exclude the migration of mail files.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DontMigrateArchive [<SwitchParameter>]
Changes the ini to exclude the migration of mail archives.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DontMigrateAddressBook [<SwitchParameter>]
Changes the ini to exclude the migration of address books.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AddressBookFilePath <string>
Full path to the address book file.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailFilePath <string>
Full path to the mail file.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailArchivePath <string>
Full path to the mail archive file.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Returns done or job failed status at the end of the run.
Examples
PS C:\>Invoke-MNESSDM -TargetProfile "Outlook"
Runs the MNE SSDM and returns the status.
PS C:\>Invoke-MNESSDM -TargetProfile "Outlook" -DontMigrateMailFile
Runs the MNE SSDM without migrating the mail file, and returns the status.
PS C:\>Invoke-MNESSDM -TargetProfile "Outlook" -NotesUserIdPath "C:\oscar.id" - NotesPassword "password"
Sets the id file, then runs the MNE SSDM and returns the status.
PS C:\>Invoke-MNESSDM -TargetProfile "Outlook" -TargetPassword "Alt0ids" -Targetuser "migadmin"
Sets the target user's name and password then runs the MNE SSDM and returns the status.
New-MNEConfiguration
Synopsis
Creates and saves a new configuration to the database.
Syntax
New-MNEConfiguration [-Name] <string> [[-Type] <ConfigurationTypeEnum>] [[- Description] <string>] [<CommonParameters>]
New-MNEConfiguration [-Name] <string> [[-Type] <ConfigurationTypeEnum>] [[- Description] <string>] -MakeTemplate [-TemplateType] [<CommonParameters>]
Description
Creates a new configuration or configuration template with a user-specified name, type, and description, and/or and saves it to the database.
Parameters
-Name <string>
Name of the new configuration to create. Name automatically appends the current date/time to the end.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Type <ConfigurationTypeEnum>
Type of configuration to create.
Required: false
Position: 1
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Description <string>
Description for the configuration.
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MakeTemplate [<SwitchParameter>]
Converts configuration into a template configuration.
Required: false
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TemplateType <TemplateTypeEnum>
Convert the Template Configuation to Full Template or Differential Template.
Required: false
Position: Named Default value:.Full
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.String
Name of the new configuration to create.
ConfigurationTypeEnum
Type of configuration to create.
Outputs
NMEConfiguration
Outputs the created configuration.
Examples
PS C:\>New-MNEConfiguration -Name "NewConfiguration"
Creates a new configuration with the name "NewConfiguration" plus the current date/time.
New-MNEDirectoryExportConfiguration
Synopsis
Creates a new configuration of the type for Directory Export.
Syntax
New-MNEDirectoryExportConfiguration -Name <string> [<CommonParameters>]
Description
Creates and saves a new configuration of type ConfigurationTypeEnum.DirExport, with name specified by the user.
Outputs the created configuration.
Parameters
-Name <string>
Name of the configuration to create.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
Configuration
Outputs the newly created configuration.
Examples
PS C:\>New-MNEDirectoryExportConfiguration -Name "NewConfiguration"
Creates a new configuration with the given name and of type ConfigurationTypeEnum.DirExport.
Remove-MNECollectionMember
Synopsis
Removes a member object to the specifies collection.
Syntax
Remove-MNECollectionMember [-CollectionGuid] <Guid> [-ObjectSmtpAddress] <string> [<CommonParameters>]
Remove-MNECollectionMember [-CollectionGuid] <Guid> -ObjectGuid <Guid> [<CommonParameters>]
Remove-MNECollectionMember [-CollectionGuid] <Guid> -CollectionMember
<CollectionMember> [<CommonParameters>]
Description
Removes a specified object (either selected by GUID, SMTP address, or passed in) to the specified collection (by GUID).
Validates whether there is an object GUID, SMTP address, or a CollectionMember are given in the input.
Parameters
-CollectionGuid <Guid>
The Guid of the collection to removed the member from.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-ObjectSmtpAddress <string>
The SMTP address of the object to be removed from the collection.
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ObjectGuid <Guid>
The Guid of the object to be removed from the collection.
Required: true
Position: Named Default value:
Accept pipeline input:false
Accept wildcard characters:false
-CollectionMember <CollectionMember>
The CollectionMember to be removed from the collection.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
The parameter CollectionGuid accepts pipeline input.
Outputs
QuestSoftware.NMEAPI.Controllers.NMECollection
Returns the collection that was removed from, if there are no errors.
Examples
PS C:\>Remove-MNECollectionMember -CollectionGuid 455E1829-45D1-4485-8467- 80A463DA5227 -ObjectGuid DA096D83-A07D-44F6-A0D2-35B88A10F6A5
Removes the object with the given Guid from the collection with the given Guid.
PS C:\>Remove-MNECollectionMember -CollectionGuid 455E1829-45D1-4485-8467- 80A463DA5227 -ObjectSmtpAddress Admin@Sample.test.com
Removes the object with the given Smtp address from the collection with the given Guid.
PS C:\>$members = Get-MNECollectionMember -CollectionGuid 789E1829-45D1-4485-8467- 80A463DA5227Remove-MNECollectionMember -CollectionGuid 455E1829-45D1-4485-8467- 80A463DA5227 -CollectionMember $members
Adds all the members from the first collection to the second collection.
Remove-MNEMailboxAdminPermission
Synopsis
Remove the MNE admin user Full Access permission to mailboxes in the user collection for Microsoft 365. If Admin Account Pool is used, the Microsoft 365 admin role specified by the configuration will be used instead of the MNE admin user.
Syntax
Remove-MNEMailboxAdminPermission [-CollectionName] <string> [<CommonParameters>]
Remove-MNEMailboxAdminPermission [-CollectionName] <string> -ConfigurationId
<string> [<CommonParameters>]
Remove-MNEMailboxAdminPermission [-CollectionName] <string> -ConfigurationFileName
<string> [<CommonParameters>]
Description
The admin user must be granted Full Access permission to mailboxes in the user collection prior to migration. After completion of the migration, use this cmdlet to revoke admin user Full Access permission to the mailboxes in the user collection. This cmdlet takes the user collection name and revokes the Full Access permission of the admin user.
Parameters
-CollectionName <string>
Name of the user collection containing the mailboxes granted Full Access permission to Exchange admin user.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationId <string>
Name or Guid of the existing configuration to use.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConfigurationFileName <string>
File name of a configuration settings .ini file to use as the configuration.
Required: true
Position: Named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
QuestSoftware.NME.PSModule.Utils.ManageMailboxPermissionResult
Returns a ManageMailboxPermissionResult object that contains information regarding the result of this cmdlet.
Examples
PS C:\>Remove-MNEMailboxAdminPermission "All Users"
Revokes the MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration setting and returns the results.
PS C:\>Remove-MNEMailboxAdminPermission -CollectionName "All Users"
Revokes the MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration settings and returns the results.
PS C:\>Remove-MNEMailboxAdminPermission "All Users" -ConfigurationId "CDB86C40-49E2- 43E1-8DE5-E1B2F4A55B51"
Revokes the MNE admin user Full Access permission to mailboxes in the "All Users" collection using configuration settings by the given configuration id and returns the results.
PS C:\>Remove-MNEMailboxAdminPermission "All Users" -ConfigurationId "Default Settings"
Revokes the MNE admin user Full Access permission to mailboxes in the "All Users" collection using configuration by the given name and returns the results.
PS C:\>Remove-MNEMailboxAdminPermission -CollectionName "All Users" - ConfigurationFilename "C:\defaultconfig.ini"
Revokes MNE admin user Full Access permission to mailboxes in the "All Users" collection using the configuration settings specified in the file C:\defaultconfig.ini.
PS C:\>Remove-MNEMailboxAdminPermission "All Users" | ForEach-Object -MemberName "Mailboxes"
Removes MNE admin user Full Access permission to mailboxes in the "All Users" collection using default configuration settings and returns a list of mailboxes that were processed.
Set-MNEConfiguration
Synopsis
Allows you to set absolutely everything in the configuration.
Syntax
Set-MNEConfiguration [-ConfigurationFromPipeline] <Configuration> [-Section]
<string> [-Key] <string> [[-Value] <string>] [<CommonParameters>]
Set-MNEConfiguration [-ConfigurationFromPipeline] <Configuration> [-AclIgnore
<string>] [-AclIgnoreCount <Int32>] [-AclRootVisibleOnly <Boolean>] [-Acls
<Boolean>] [-ActiveDirectoryAlwaysUseDefaults <Boolean>] [-ActiveDirectoryGroupType
<ActiveDirectoryGroupTypeEnum>] [-ActiveDirectoryHost <string>] [- ActiveDirectoryPassword <string>] [-ActiveDirectoryUserId <string>] [-Ad2AdAttribute
<string>] [-Ad2OpenFlags <AuthenticationTypes>] [-Ad2UserFilter <string>] [- AdAttribute <string>] [-AddFullAccessPermission <Boolean>] [-AddressListName
<string>] [-AddressPolicyName <string>] [-AdjustTaskReminderToMidnight <Boolean>] [- AdminDomain <string>] [-AdminMailbox <string>] [-AdminPassword <string>] [- AdminProfile <string>] [-AdminUsername <string>] [-AllowForwardToNotesConnector
<Boolean>] [-AllowHtmlCalendarBodies <Boolean>] [-AllowNotesForeignDirSync
<Boolean>] [-AllowSelfSignedCerts <Boolean>] [-AltAddressAttribute <string>] [- AlwaysDoForwarding <Int32>] [-AlwaysRmvForwarding <Boolean>] [-AlwaysUseDefaults
<Boolean>] [-AlwaysUseOldAlias <Boolean>] [-AlwaysUseOldExchDn <Boolean>] [- AppDoesArch <Boolean>] [-AppDoesEncrypted <Boolean>] [-AppDoesMail <Boolean>] [- AppDoesPabs <Boolean>] [-AppendSmtpAddressToContactsDisplayName <Boolean>] [- AppointmentForms <string>] [-AppointmentLocationSource <Int16>] [- ArchiveDesignClass <string>] [-ArchiveDest <GeneralDestinationTypeEnum>] [- ArchiveDestServerArchive <Boolean>] [-ArchiveDir <string>] [-ArchiveReplicaDir
<string>] [-ArchiveReplicaServer <string>] [-ArchiveResolveAttendees <Boolean>] [- AskArchiveDest <Boolean>] [-AskFilter <Boolean>] [-AskPabDest <Boolean>] [- AskServerMailDest <Boolean>] [-AttachmentFilteredBySizeMsg <string>] [- AttachmentLostDueToEncryptionMsg <string>] [-Attribute <string>] [-AuthMechanismType
<AuthenticationMechanismTypeEnum>] [-AutodiscoverDisableMapiHttp <Boolean>] [- AutodiscoverEnableScpLookup <Boolean>] [-AutodiscoverMaxHops <Integer>] [- AutodiscoverPreferInternalRpcHttpUrl <Boolean>] [-AutodiscoverPreferInternalUrl
<Nullable<Boolean>>] [-AutodiscoverUrl <string>] [-BodyLostDueToEncryptionMsg
<string>] [-CalMaxRecurrenceFixType <CalMaxRecurrenceFixTypeEnum>] [- CanAddGroupMembers <Boolean>] [-CanDeleteGroupMembers <Boolean>] [-CentralLogDir
<string>] [-CentralLogLevel <Int32>] [-CmnExcludeFromDirSync <string>] [- CompressLogFile <Boolean>] [-ContactFilter <string>] [-ContactsName <string>] [- CreateFwdAddrInAd <Boolean>] [-CreateGroupDelay <Int32>] [-CreateMailBox <Boolean>] [-CreateMailboxDelay <Int32>] [-CurArchiveDir <string>] [-CurMailFileDir <string>] [-DateFilterUsingFormula <Boolean>] [-DeclineFolderCheck <Boolean>] [- DeleteAutoCompleteMessages <Boolean>] [-DeleteMailDomain <Boolean>] [- DisableCredentialScanner <Boolean>] [-DisableDialogScanner <Boolean>] [- DisableModernAuthentication <Boolean>] [-DisableDirSync <Boolean>] [-DoAuditLog
<Boolean>] [-DocLinksDefaultServer <string>] [-DocLinksFastLookupOnly <Boolean>] [- DocLinksHttpPort <Int32>] [-DoHtmlBody <Boolean>] [-DoMailRouting <Boolean>] [- Domain <string>] [-DomainController <string>] [-DominoDomain <string>] [-DoNeedAdsi
<Boolean>] [-DoNeedCdoexm <Boolean>] [-DoNotesMailRouting <Boolean>] [-
DoRmvForwarding <Boolean>] [-DoSetCalDomain <Boolean>] [-DoSetExcalconServer
<Boolean>] [-DoSetForwarding <Boolean>] [-DoSetMailDomain <Boolean>] [- DoSetMailSystem <Boolean>] [-DoSetNotesFormatPreference <Boolean>] [- DoShowRmvForwarding <Boolean>] [-DoShowSetForwarding <Boolean>] [-DoSourceAdmin
<Boolean>] [-DoTargetAdmin <Boolean>] [-DoVisibility <Boolean>] [-DoX500Proxy
<Boolean>] [-EmailAddressPolicyEnabled <Boolean>] [-EnableArchiveMailbox <Boolean>] [-EnableUsers <Boolean>] [-EncryptedMailOnly <Boolean>] [-EndUserDir <string>] [- EndUserStatsDir <string>] [-ExcalconServer <string>] [-ExchangeServer <string>] [- ExcludeDominoDomainFromFwdAddrInAD <Boolean>] [-FileAsFormat <string>] [- FindArchivesBy <string>] [-FindMailFilesBy <string>] [-FindPabsBy <string>] [- ForceAddrBooks <Boolean>] [-ForceAddress <Boolean>] [-ForceOldNxRtfDll <Boolean>] [-ForceTargetAdmin <Boolean>] [-ForwardingAddress <string>] [-ForwardingDomain
<string>] [-ForwardingMethod <Int32>] [-FwdAddrDelim <string>] [-FwdAttrField
<string>] [-FwdCalDomain <string>] [-FwdMailDomain <string>] [- GroupContactsContainer <string>] [-GroupFilter <string>] [-GroupsContainer <string>] [-GroupsSearchFilter <string>] [-HomeMailBoxStore <string>] [-HomeServer <string>] [-HtmlDocLinks <Int32>] [-IgnoreAcls <string>] [-IgnoreForms <IList`1[String]>] [- IncludeServerMailFile <Boolean>] [-JournalEntryMessageType
<NotesJournalEntryMessageTypeEnum>] [-LoadMethod <string>] [-LocateArchives
<Boolean>] [-LocateMailFiles <Boolean>] [-LocateNew <Boolean>] [-LocatePabs
<Boolean>] [-LogDir <string>] [-LogLevel <Int32>] [-LookupDisplayNames <Boolean>] [-MailDesignClass <string>] [-MailEnableAttempts <Int32>] [- MailEnableRetryWaitSeconds <Int32>] [-MailFileDir <string>] [-MailSystem
<MailSystemTypeEnum>] [-MailTarget <MailTargetTypeEnum>] [-MapiAdminProfile
<string>] [-MapiRecipient <MapiRecipientActionEnum>] [-MapiRetryCount <Int32>] [- MapiUseSharedProfile <Boolean>] [-MapPrivateAsPublic <Boolean>] [- MaxExceptionsPerMessage <Int32>] [-MaxExtractedImageArea <Int32>] [-MaxFolderCache
<Int32>] [-MaxLargePstSize <Int32>] [-MaxMailboxConnectionRetryWaitTime <Int32>] [- MaxPstSize <Int32>] [-MaxSessionReconnectCount <Int32>] [-MBoxFromContact
<Boolean>] [-MemoForms <string>] [-MergeAddressBookFolder <string>] [- MergeAddressBooks <Boolean>] [-MergeContactAttribWins <Boolean>] [- MergeContactIsAuthoritative <Boolean>] [-MergeCrossCheckObjs <Boolean>] [- MergeFindBySmtp <Boolean>] [-MergeGrpMembership <Boolean>] [-MergeReqImportedFrom
<Boolean>] [-MergeReqProxyAddress <Boolean>] [-MergeSyncObjRequired <Boolean>] [- MergeX500 <Boolean>] [-MessageRetryCount <Int32>] [-MessageRetryWait <Int32>] [- Migrate <Boolean>] [-MigrateAppointmentResponses <Boolean>] [-MigrateArchives
<Boolean>] [-MigrateConflictDocs <Boolean>] [-MigrateEmptyFolders <Boolean>] [- MigrateMailOrCalendar <Boolean>] [-MigrateMailUsingServer <Boolean>] [- MigrateOrphanedDocs <Boolean>] [-MigratePab <Boolean>] [- MigrateRecurringBeforeRange <Boolean>] [-MigrateReservationsAlways <Boolean>] [- MigrateServerMail <Boolean>] [-MigForwarding <Boolean>] [- MimeIgnoreBoundaryWhitespace <Boolean>] [-MinSpace <Int32>] [-MsgRequireAnyFeature
<MsgRequireAnyFeatureTypeEnum>] [-NabCount <Int32>] [-NabReaderGroup <string>] [- NeedLoginInfo <Boolean>] [-NoServer <Boolean>] [-NotesAlwaysDoForwarding <Int16>] [- NotesAlwaysRmvForwarding <Boolean>] [-NotesAlwaysUseDefaults <Boolean>] [- NotesDoRmvForwarding <Boolean>] [-NotesDoSetForwarding <Boolean>] [- NotesDoShowRmvForwarding <Boolean>] [-NotesDoShowSetForwarding <Boolean>] [- NotesEncryptedMailOnly <Boolean>] [-NotesFormatPreference
<NotesFormatPreferenceTypeEnum>] [-NotesForwardingDomain <string>] [- NotesFwdAddrDelim <string>] [-NotesFwdAttrField <string>] [-NotesIniPath <string>] [-NotesPassword <string>] [-NotesPreferredNab <string>] [-NotesServer <string>] [- NotesUserIdFile <string>] [-NoticeForms <string>] [-O365Environment <string>] [- O365MaxMailboxConnectionWaitTime <Int32>] [-O365PSConnectionUri <string>] [-Offline
<Boolean>] [-OpenFlags <AuthenticationTypes>] [-OrphanedDocsFolder <string>] [- OwnerByAcl <Boolean>] [-PabDesignClass <string>] [-PabDest
<GeneralDestinationTypeEnum>] [-PabDestServerArchive <Boolean>] [-PabDir <string>] [-PabGroupForms <string>] [-PabPersonForm <string>] [-PabReplicaDir <string>] [- PabReplicaServer <string>] [-PabReplicatorFrom <string>] [-PabReplicatorSign
<Boolean>] [-PabReplicatorSubject <string>] [-PabReplicatorTargetDir <string>] [- PabReplicatorTargetServer <string>] [-PabRequiredAttrs <IList`1[String]>] [- PabsInMailFile <Boolean>] [-Pass2Delay <Int32>] [-PostLogs <Boolean>] [- PowerShellXmlErrorFile <string>] [-ProvisionUsers <Boolean>] [-PsRetryAttempts
<Int32>] [-PsRetryWait <Int32>] [-PstDirMode <OutlookPstDirectoryModeEnum>] [- PstFileName <string>] [-PstFileNameFormat <OutlookPstFileNameFormatEnum>] [- PstRootDir <string>] [-PublicDelegates <Boolean>] [-PurgePabs <Boolean>] [- QuotaMode <NotesQuotaModeTypeEnum>] [-QuoteNonAsciiCharsInRtf <Boolean>] [- RemigrateMode <Int32>] [-RemoveDirSyncAttribute <Boolean>] [-RemoveSrcAddresses
<Boolean>] [-ReportErrors <Boolean>] [-ReportMofN <Boolean>] [-ReportPct <Boolean>] [-ReservationForms <string>] [-ReplaceForwardAddressInUserName <Boolean>] [- RewriteRtf <Int32>] [-RmvForwarding <Boolean>] [-RootFolderAclMode
<RootFolderAclModeEnum>] [-RpcProxyServerCertificationUrl <Uri>] [- RPCProxyServerUrl <Uri>] [-RpcUseAuthType <OutlookLogonNetworkSecurityEnum>] [- RPCUseFastHttp <Boolean>] [-RPCUseHttp <Boolean>] [-RPCUseProxyCertification
<Boolean>] [-RPCUseSlowHttp <Boolean>] [-RPCUseSsl <Boolean>] [-RunAsService
<Boolean>] [-RunUpdateAddressList <Boolean>] [-RunUpdateEmailAddressPolicy
<Boolean>] [-SelectedMailFile <string>] [-SelectedProfile <string>] [- SelectedPstDir <string>] [-SendStatus <Boolean>] [-ServerMailDest
<GeneralDestinationTypeEnum>] [-ServerMailDestServerArchive <Boolean>] [- ServerMailResolveAttendees <Boolean>] [-SetManagedByToUserForest <Boolean>] [- SetPersonDocCustom <Boolean>] [-SetUserAccountControl <Boolean>] [- SkipDisabledGroupMembers <Boolean>] [-SharePointServerName <string>] [- ShowSetMailDomain <Boolean>] [-SkipCompletedTasks <Boolean>] [-SkipConflictDocs
<Boolean>] [-SkipNotes <IList`1[String]>] [-SkipOutOfRangeException <Boolean>] [- SmtpForwardingAddress <Boolean>] [-SmtpTranslationTable <string>] [- SourceAdminDirSync <Boolean>] [-SqlColumn <string>] [-SqlCredentials <string>] [- StationaryFolder <string>] [-StationaryForms <string>] [-TargetType <string>] [- TargetTypeTested <Int32>] [-TaskForms <string>] [-TaskNoticeForms <string>] [- ThreadCount <Int32>] [-TotalSelAddrBooks <Int64>] [-TotalSelArchives <Int64>] [- TotalSelMailFiles <Int64>] [-UpdateMode <NotesUpdateModeTypeEnum>] [-UpdateRtfFonts
<Boolean>] [-UseAdminAcctPool <Boolean>] [-UseAppNxRtfDll <Boolean>] [- UseAutodiscoverCreateProfile <Boolean>] [-UseFilteredAttachmentMsg <Boolean>] [- UseFilteredBodyMsg <Boolean>] [-UseImapFlags <Boolean>] [-UseLargePsts <Boolean>] [-UseMailFileOnly <Boolean>] [-UseMailFileOwner <Boolean>] [-UserAccountControl
<Int32>] [-UserContainer <string>] [-UserFilter <string>] [-UserFolderPrefix
<string>] [-UserForestHost <string>] [-UserForestPassword <string>] [- UserForestUserId <string>] [-UsePseudoRoot <Boolean>] [-UseSeparatePsts <Boolean>] [-UseSpecialArchiveFolder <Boolean>] [-UseUserForest <Boolean>] [-VisibilityMode
<NotesVisibilityModeEnum>] [-WatchDogMinutes <Int32>] [-WriteCpidForRichText
<Boolean>] [<CommonParameters>]
Description
The cmdlet allows you to set every part of the configuration through parameters. Warning: parameters do not have descriptions.
Parameters
-ConfigurationFromPipeline <Configuration>
The configuration from the pipeline to set.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Section <string>
Required: true
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Key <string>
Required: true
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-Value <string>
Required: false
Position: 3
Default value:
Accept pipeline input:false Accept wildcard characters:false
-AclIgnore <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AclIgnoreCount <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AclRootVisibleOnly <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Acls <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ActiveDirectoryAlwaysUseDefaults <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ActiveDirectoryGroupType <ActiveDirectoryGroupTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ActiveDirectoryHost <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ActiveDirectoryPassword <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ActiveDirectoryUserId <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Ad2AdAttribute <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Ad2OpenFlags <AuthenticationTypes>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdAttribute <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AddFullAccessPermission <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AddressListName <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AddressPolicyName <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdjustTaskReminderToMidnight <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdminDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdminMailbox <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdminPassword <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdminProfile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AdminUsername <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AllowForwardToNotesConnector <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AllowHtmlCalendarBodies <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AllowNotesForeignDirSync <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AllowSelfSignedCerts <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AltAddressAttribute <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AlwaysDoForwarding <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AlwaysRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AlwaysUseDefaults <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AlwaysUseOldAlias <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AlwaysUseOldExchDn <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppDoesArch <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppDoesEncrypted <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppDoesMail <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppDoesPabs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppendSmtpAddressToContactsDisplayName <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppointmentForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AppointmentLocationSource <Int16>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveDesignClass <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveDest <GeneralDestinationTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveDestServerArchive <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveReplicaDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveReplicaServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ArchiveResolveAttendees <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AskArchiveDest <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AskFilter <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AskPabDest <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AskServerMailDest <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-AttachmentLostDueToEncryptionMsg <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Attribute <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AuthMechanismType <AuthenticationMechanismTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AutodiscoverDisableMapiHttp <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AutodiscoverEnableScpLookup <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AutodiscoverMaxHops <Integer>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-AutodiscoverPreferInternalRpcHttpUrl <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept pipeline input:false Accept wildcard characters:false
-AutodiscoverUrl <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-BodyLostDueToEncryptionMsg <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CalMaxRecurrenceFixType <CalMaxRecurrenceFixTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CanAddGroupMembers <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CanDeleteGroupMembers <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CentralLogDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CentralLogLevel <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-CompressLogFile <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ContactFilter <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ContactsName <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CreateFwdAddrInAd <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CreateGroupDelay <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CreateMailBox <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CreateMailboxDelay <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CurArchiveDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-CurMailFileDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DateFilterUsingFormula <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DeclineFolderCheck <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DeleteAutoCompleteMessages <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DeleteMailDomain <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DisableCredentialScanner <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DisableDialogScanner <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DisableModernAuthentication <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DisableDirSync <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoAuditLog <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DocLinksDefaultServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DocLinksFastLookupOnly <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DocLinksHttpPort <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoHtmlBody <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoMailRouting <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Domain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DomainController <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DominoDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoNeedAdsi <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoNeedCdoexm <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoNotesMailRouting <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetCalDomain <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetExcalconServer <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetMailDomain <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetMailSystem <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoSetNotesFormatPreference <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoShowRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoShowSetForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-DoTargetAdmin <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoVisibility <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DoX500Proxy <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-EmailAddressPolicyEnabled <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-EnableArchiveMailbox <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-EnableUsers <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-EncryptedMailOnly <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept pipeline input:false Accept wildcard characters:false
-EndUserStatsDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ExcalconServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ExchangeServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ExcludeDominoDomainFromFwdAddrInAD <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FileAsFormat <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FindArchivesBy <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FindMailFilesBy <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForceAddrBooks <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForceAddress <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForceOldNxRtfDll <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForceTargetAdmin <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForwardingAddress <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForwardingDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ForwardingMethod <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FwdAddrDelim <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FwdAttrField <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FwdCalDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-FwdMailDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-GroupContactsContainer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-GroupFilter <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-GroupsContainer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-GroupsSearchFilter <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-HomeMailBoxStore <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-HomeServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-HtmlDocLinks <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-IgnoreAcls <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-IgnoreForms <IList`1[String]>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-IncludeServerMailFile <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-JournalEntryMessageType <NotesJournalEntryMessageTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LoadMethod <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocateArchives <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocateMailFiles <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocateNew <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LocatePabs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LogLevel <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-LookupDisplayNames <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailDesignClass <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailEnableAttempts <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailEnableRetryWaitSeconds <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailFileDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailSystem <MailSystemTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MailTarget <MailTargetTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MapiAdminProfile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MapiRecipient <MapiRecipientActionEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-MapiUseSharedProfile <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MapPrivateAsPublic <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxExceptionsPerMessage <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxExtractedImageArea <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxFolderCache <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxLargePstSize <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MaxMailboxConnectionRetryWaitTime <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept pipeline input:false Accept wildcard characters:false
-MaxSessionReconnectCount <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MBoxFromContact <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MemoForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeAddressBookFolder <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeAddressBooks <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeContactAttribWins <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeContactIsAuthoritative <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeFindBySmtp <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeGrpMembership <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeReqImportedFrom <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeReqProxyAddress <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeSyncObjRequired <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MergeX500 <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MessageRetryCount <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MessageRetryWait <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Migrate <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateAppointmentResponses <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateArchives <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateConflictDocs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateEmptyFolders <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateMailOrCalendar <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateMailUsingServer <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateOrphanedDocs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigratePab <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateRecurringBeforeRange <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateReservationsAlways <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrateServerMail <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MimeIgnoreBoundaryWhitespace <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MinSpace <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-MsgRequireAnyFeature <MsgRequireAnyFeatureTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NabCount <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NabReaderGroup <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NeedLoginInfo <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NoServer <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesAlwaysDoForwarding <Int16>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesAlwaysRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesAlwaysUseDefaults <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesDoRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesDoSetForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesDoShowRmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesDoShowSetForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesEncryptedMailOnly <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesFormatPreference <NotesFormatPreferenceTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesForwardingDomain <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-NotesFwdAttrField <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesIniPath <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesPassword <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesPreferredNab <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotesUserIdFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-NoticeForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept pipeline input:false Accept wildcard characters:false
-O365MaxMailboxConnectionWaitTime <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-O365PSConnectionUri <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Offline <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-OpenFlags <AuthenticationTypes>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-OrphanedDocsFolder <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-OwnerByAcl <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabDesignClass <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabDestServerArchive <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabGroupForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabPersonForm <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicaDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicaServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicatorFrom <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicatorSign <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicatorSubject <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicatorTargetDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabReplicatorTargetServer <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabRequiredAttrs <IList`1[String]>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PabsInMailFile <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-Pass2Delay <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PostLogs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PowerShellXmlErrorFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ProvisionUsers <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PsRetryAttempts <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PsRetryWait <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PstDirMode <OutlookPstDirectoryModeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PstFileName <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PstFileNameFormat <OutlookPstFileNameFormatEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PstRootDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PublicDelegates <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-PurgePabs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-QuotaMode <NotesQuotaModeTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-QuoteNonAsciiCharsInRtf <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RemigrateMode <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RemoveDirSyncAttribute <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RemoveSrcAddresses <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ReplaceForwardAddressInUserName <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ReportErrors <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ReportMofN <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ReportPct <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ReservationForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RewriteRtf <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RmvForwarding <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RootFolderAclMode <RootFolderAclModeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-RPCProxyServerUrl <Uri>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RpcUseAuthType <OutlookLogonNetworkSecurityEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RPCUseFastHttp <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RPCUseHttp <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RPCUseProxyCertification <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RPCUseSlowHttp <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RPCUseSsl <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept pipeline input:false Accept wildcard characters:false
-RunUpdateAddressList <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-RunUpdateEmailAddressPolicy <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SelectedMailFile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SelectedProfile <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SelectedPstDir <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SendStatus <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ServerMailDest <GeneralDestinationTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ServerMailResolveAttendees <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SetManagedByToUserForest <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SetPersonDocCustom <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SetUserAccountControl <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SkipDisabledGroupMembers <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SharePointServerName <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ShowSetMailDomain <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SkipCompletedTasks <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SkipConflictDocs <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SkipNotes <IList`1[String]>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SkipOutOfRangeException <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SmtpForwardingAddress <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SmtpTranslationTable <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SourceAdminDirSync <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SqlColumn <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-SqlCredentials <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-StationaryFolder <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-StationaryForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetType <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TargetTypeTested <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TaskForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TaskNoticeForms <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-ThreadCount <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TotalSelAddrBooks <Int64>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TotalSelArchives <Int64>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-TotalSelMailFiles <Int64>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UpdateMode <NotesUpdateModeTypeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UpdateRtfFonts <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseAdminAcctPool <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseAppNxRtfDll <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseAutodiscoverCreateProfile <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseFilteredAttachmentMsg <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseFilteredBodyMsg <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseImapFlags <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseLargePsts <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseMailFileOnly <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseMailFileOwner <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserAccountControl <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
Accept wildcard characters:false
-UserFilter <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserFolderPrefix <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserForestHost <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserForestPassword <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UserForestUserId <string>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UsePseudoRoot <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseSeparatePsts <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseSpecialArchiveFolder <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseUserForest <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-VisibilityMode <NotesVisibilityModeEnum>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WatchDogMinutes <Int32>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-WriteCpidForRichText <Boolean>
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
Configuration
The configuration object to update. This parameter accepts input from the pipeline.
Outputs
None if successful.
Examples
PS C:\>Set-MNEConfiguration -ConfigurationFromPipeline $Config -Acls $true - AllowForwardToNotesConnector $false
Sets the specified values.
Set-MNEDatabaseConnectionString
Synopsis
Sets the database connection string for Notes Migrator for Exchange.
Syntax
Set-MNEDatabaseConnectionString [-IntegratedSecurity <Boolean>] [-DbUser <string>] [-DbPassword <string>] -DbServer <string> -DbSharedDir <string> [<CommonParameters>]
Description
Sets the database connection string.
There are two parameter sets, based on whether you are accessing the database using Windows Authentication or SQL Authentication.
The database name and database provider are constant for MNE.
Parameters
-IntegratedSecurity [<Boolean>]
Used if the database is accessed using Windows Authentication.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DbUser <string>
Used if the database is accessed by SQL Server Authentication. This is the username for accessing the database.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DbPassword <string>
Used if the database is accessed by SQL Server Authentication. This is the password for accessing the database.
Required: false
Position: named
Default value:
Accept pipeline input:false Accept wildcard characters:false
-DbServer <string>
Server of the database being accessed.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DbSharedDir <string>
Shared directory of the database being accessed.
Required: true
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
This cmdlet returns no value or output upon success.
Examples
PS C:\>Set-MNEDatabaseConnectionString -IntegratedSecurity $true -DbServer "(local)"
-DbSharedDir "\\Computer\C$\NME Stuff\"
Uses Windows Authentication to connect to the server and set the database connection string.
PS C:\>Set-MNEDatabaseConnectionString -DbUser "username" -DbPassword "password" - DbServer "(local)" -DbSharedDir "\\Computer\C$\NME Stuff\"
Uses SQL Authentication to connect to the server and set the database connection string.
Set-MNEDesignClass
Synopsis
Sets a design class in the database.
Syntax
Set-MNEDesignClass -DesignClassGuid <Guid> [-Authoritative <Boolean>] [- DataStoreTypeMask <DataStoreTypeMaskEnum>] [<CommonParameters>]
Set-MNEDesignClass -DesignClassName <string> [-Authoritative <Boolean>] [- DataStoreTypeMask <DataStoreTypeMaskEnum>] [<CommonParameters>]
Description
Sets the Authoritative status and/or the DataStoreTypeMask for a design class in the database, selected either by name or Guid.
Parameters
-DesignClassGuid <Guid>
Guid of the design class to set.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-DesignClassName <string>
Name of the design class to set.
Required: true
Position: named Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
-Authoritative <Boolean>
Whether the design class to set has authoritative status.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
-DataStoreTypeMask <DataStoreTypeMaskEnum>
Data store type mask of the design class to set.
Required: false
Position: named Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
System.Guid
Guid of the design class to set.
System.String
Name of the design class to set.
Outputs
NMEDesignClass
Outputs the design class that was set if there are no errors.
Examples
PS C:\>Set-MNEDesignClass -DesignClassName "TestName" -Authoritative $true - DataStoreTypeMask All
Sets the specified design class in the database to the parameters given.
Set-MNEMigrationTimeWindow
Synopsis
Sets the migration windows used in the SSDM Scheduling Administration tool.
Syntax
Set-MNEMigrationTimeWindow [-CollectionName] <string> [[-ConcurrentUsers] <Integer>] [[-MigrationDateFrom] <string>] [[-MigrationDateTo] <string>] [[-EnableTimeWindow]
<Boolean>] [[-MigrationTimeFrom] <string>] [[-MigrationTimeTo] <string>] [<CommonParameters>]
Description
Sets the migration windows used in the SSDM Scheduling Administration tool.
Parameters
-CollectionName <string>
Name of the collection to set the window for. The collection cannot be auto-defined.
Required: true
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-ConcurrentUsers <Integer>
Number of users that can migrate at one time.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrationDateFrom <string>
Date when users can start migrating.
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrationDateTo <string>
Date when users must stop migrating.
Required: false
Position: 3
Default value:
Accept pipeline input:false Accept wildcard characters:false
-EnableTimeWindow <Boolean>
Whether the users are limited to a certain time to migrate each day.
Required: false
Position: 4
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrationTimeFrom <string>
Time of day when users can start migrating.
Required: false
Position: 5
Default value:
Accept pipeline input:false Accept wildcard characters:false
-MigrationTimeTo <string>
Time when users must stop migrating.
Required: false
Position: 6
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
This cmdlet returns nothing.
Examples
PS C:\>Set-MNEMigrationTimeWindow -CollectionName "some users" -ConcurrentUsers 5 - MigrationDateFrom "8/15/2013 8:45:00 AM" -MigrationDateTo "8/31/2013 4:00:00 PM" - EnableTimeWindow $false
Sets the migration window for the collection "some users" to 8/15/2013 at 8:45:00 AM to 8/31/2013 at 4:00:00 PM,
with a max of 5 concurrent users, and no specific time window.
PS C:\>Set-MNEMigrationTimeWindow -CollectionName "other users" -ConcurrentUsers 2 - MigrationDateFrom "8/15/2013 8:45:00 AM" -MigrationDateTo "8/31/2013 4:00:00 PM" - EnableTimeWindow $true -MigrationTimeFrom "5:00:00 PM" -MigrationTimeTo "11:00:00 PM"
Sets the migration window for the collection "other users" to 8/15/2013 at 8:45:00 AM to 8/31/2013 at 4:00:00 PM, with a max of 2 concurrent users, and a specific time window between 5:00 PM and 11:00 PM.
Set-MNESchedulingConfigFile
Synopsis
Sets the configuration files used in the SSDM Scheduling Administration tool.
Syntax
Set-MNESchedulingConfigFile [[-XmlConfigPath] <string>] [[-CollWizPath] <string>] [[-WebServiceLocation] <string>] [<CommonParameters>]
Description
Sets the configuration files used in the SSDM Scheduling Administration tool.
Parameters
-XmlConfigPath <string>
Path to the Xml Config File.
Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-CollWizPath <string>
Path to the MNE Collection Wizard.
Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-WebServiceLocation <string>
URI to the SSDM Web Service.
Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
This cmdlet returns nothing.
Examples
PS C:\>Set-MNESchedulingConfigFile -XmlConfigPath "c:\conf.xml" -CollWizPath "c:\collwiz.exe" -WebServiceLocation "http://localhost/SSDMSchedulingWebService/SSDMSchedulingWebService.asmx" Sets XmlConfigFile to c:\conf.xml, CollWizPath to c:\collwiz.exe, and WebServiceLocation to http://localhost/SSDMSchedulingWebService/SSDMSchedulingWebService.asmx.
PS C:\>Set-MNESchedulingConfigFile -XmlConfigPath "c:\conf2.xml"
Sets XmlConfigFile to c:\conf2.xml and leaves the rest of the parameters alone.
PS C:\>Set-MNESchedulingConfigFile
Doesn't change the parameters, unless the file doesn't exist or is invalid. In that case, it creates the file with empty parameters.
Set-MNESchedulingSetting
Synopsis
Sets the settings used in the SSDM Scheduling Administration tool.
Syntax
Set-MNESchedulingSetting [[-UseSsdmSched] <Boolean>] [[-TimeOut] <Integer>] [[- FileProc] <Integer>] [[-IsEmail] <Boolean>] [[-EmailAddresses] <String[]>] [[- EmailSubject] <string>] [[-EmailBody] <string>] [[-EmailAutoSend] <Boolean>] [[- SchedReminder] <Boolean>] [[-NotScheduled] <string>] [[-BeforeMigrationDate]
<string>] [[-AfterMigrationDate] <string>] [[-BeforeMigrationTime] <string>] [[- AfterMigrationTime] <string>] [[-TooManyConnections] <string>] [[-RetryAttempt]
<Integer>] [[-RetryWaitMinute] <Integer>] [[-UseLimitedRetry] <Boolean>] [<CommonParameters>]
Description
Sets the settings used in the SSDM Scheduling Administration tool.
Parameters
-UseSsdmSched <Boolean> Whether or not to use SSDM Scheduling Required: false
Position: 0
Default value:
Accept pipeline input:false Accept wildcard characters:false
-TimeOut <Integer> Session timeout in minutes Required: false
Position: 1
Default value:
Accept pipeline input:false Accept wildcard characters:false
-FileProc <Integer> Update progress in minutes Required: false
Position: 2
Default value:
Accept pipeline input:false Accept wildcard characters:false
-IsEmail <Boolean>
Whether to email the migration team on problems.
Required: false
Position: 3
Default value:
Accept pipeline input:false Accept wildcard characters:false
-EmailAddresses <string[]>
The email addresses to send to when problems occur.
Required: false
Position: 4
Default value:
Accept pipeline input:false Accept wildcard characters:false
-EmailSubject <string>
The subject of the email dispatched when problems occur.
Required: false
Position: 5
Default value:
Accept pipeline input:false Accept wildcard characters:false
-EmailBody <string>
The body of the email dispatched when problems occur.
Required: false
Position: 6
Default value:
Accept pipeline input:false Accept wildcard characters:false
-EmailAutoSend <Boolean>
Whether the user automatically sends email if problems occur.
Required: false
Position: 7
Default value:
Accept pipeline input:false Accept wildcard characters:false
-SchedReminder <Boolean>
Lets users add a scheduled task if before window.
Required: false
Position: 8
Default value:
Accept pipeline input:false Accept wildcard characters:false
-NotScheduled <string>
Text the user sees if not scheduled to migrate.
Required: false
Position: 9
Default value:
Accept pipeline input:false Accept wildcard characters:false
-BeforeMigrationDate <string>
Text the user sees if before migration date window.
Required: false
Position: 10
Default value:
Accept pipeline input:false Accept wildcard characters:false
-AfterMigrationDate <string>
Text the user sees if after migration date window.
Required: false
Position: 11
Default value:
Accept pipeline input:false Accept wildcard characters:false
-BeforeMigrationTime <string>
Text the user sees if before migration time window.
Required: false
Position: 12
Default value:
Accept pipeline input:false Accept wildcard characters:false
-AfterMigrationTime <string>
Text the user sees if after migration time window.
Required: false
Position: 13
Default value:
Accept pipeline input:false Accept wildcard characters:false
-TooManyConnections <string>
Text the user sees if too many users simulataneously migrating.
Required: false
Position: 14
Default value:
Accept pipeline input:false Accept wildcard characters:false
-RetryAttempt <Integer>
Number of SSDM retry migration attempts. Required: false
Position: 15
Default value:
Accept pipeline input:false Accept wildcard characters:false
-RetryWaitMinute <Integer>
Time to (in minutes) before retrying.
Required: false
Position: 16
Default value:
Accept pipeline input:false Accept wildcard characters:false
-UseLimitedRetry <Boolean>
Whether to limit the number of retries.
Required: false
Position: 17
Default value:
Accept pipeline input:false Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
This cmdlet has no parameters that accept pipeline input.
Outputs
This cmdlet returns nothing.
Examples
PS C:\>Set-MNESchedulingSetting -UseSsdmSched $true -TimeOut 10 -FileProc 1000 - IsEmail $false
Sets UseSsdmSched to true, the timeout to 10 minutes, the file proc to 1000 minutes, and IsEmail to false. The rest of the parameters are left alone.
PS C:\>Set-MNESchedulingSetting
Doesn't change any of the parameters, unless the file doesn't exist or is invalid. In that case, it creates the file with empty parameters.
Show-MNECollection
Synopsis
Sets a Collection to be "visible" in the UI.
Syntax
Show-MNECollection [-Collection] <NmeCollection> [<CommonParameters>]
Description
Sets a Collection to be "visible" in the UI. The collection is added/updated in the database upon completion.
Parameters
-Collection <NmeCollection>
The collection object to be set visible.
Required: true
Position: 0
Default value:
Accept pipeline input:true (ByValue) Accept wildcard characters:false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
Inputs
NmeCollection
The collection to be set visible.
Outputs
None if successful.
Examples
Get-MNECollection -CollectionGuid "e50d5123-2ec8-4096-816e-8e0e458d12e7" | Show- MNECollection
A collection is retrieved from the database and its visiblity is set to visible.