Chat now with support
Chat with Support

Migrator for Notes to Exchange 4.16 - Administration Guide

About the Migrator for Notes to Exchange documentation Notes Migration Manager NABS Discovery Wizard Internet Domains Discovery Wizard Directory Export Wizard Collection Wizard Groups Provisioning Wizard Notes Data Locator Wizard Provisioning Wizard Send PAB Replicator Wizard Data Migration Wizard SSDM Statistics Collection Wizard The Log Viewer Using the Qsched.exe task-scheduling utility SSDM Scheduling Administration utility Office 365 Admin Account Pool utility PowerShell cmdlets for Migrator for Notes to Exchange Appendix A: How do I ...?
Post-installation configuration Pre-migration preparations Batch-migration process Other features

Before you use the Admin Account Pool for the first time

These steps are mandatory before you can use the Admin Account Pooling utility the first time.

Verify that all system requirements for an Migrator for Notes to Exchange admin migration server, and for the Account Pooling Utility in particular, are satisfied. System requirements are documented in the most recent RTM Release Notes that accompany every release. Note that the requirements for migration to Office 365 specify additional requirements for Migrator for Notes to Exchange’s Account Pooling feature.

Admin pool accounts are granted administration rights by assigning a set of administration roles to the accounts. Roles are assigned by creating an admin role group and adding the pool accounts to the admin role group. The name of the admin role group can be customized with the following parameter:

For example (value shown is the default group name):

If the role group specified does not already exist, the Admin Account Pool utility creates it. The role group is assigned the following roles:

Accounts created for the pool are assigned a numeric suffix. The suffix is incremented as each account is added to the pool. The starting value for the numeric suffix can be customized with the following parameter:

For example (value shown is the default sequence number):

Migrator for Notes to Exchange’s Account Pool Utility helps you manage account pool membership, but it does not tell the other Migrator for Notes to Exchange applications to make use of its pool of accounts. To make use of the account pool, you must tell Migrator for Notes to Exchange on either of two screens:

In the Data Migration Wizard, on the Select Destination Exchange Server screen.

These screens both contain the same Admin Account Pool controls, so you can enable the pool and/or run the Admin Account Pool Utility from either place:

Use admin account pool (checkbox, available only when migrating to Office 365): Mark this checkbox to tell Migrator for Notes to Exchange to use your Admin Account Pool to migrate data. Next to this checkbox are two buttons that will run the Admin Account Pool Utility by either of two options:
Manage button: Launches Migrator for Notes to Exchange’s Admin Account Pool utility (see Managing the Admin Account Pool below).
Reset button: Used to reset the pool, this button launches Migrator for Notes to Exchange’s Admin Account Pool utility, and then automatically deletes all admin accounts from the pool and exits.

The Admin Account Pool utility clashes with Microsoft's AD sync utility in federated environments. To preempt this conflict:

1
Swap the Admin Pool accounts to tenant.onmicrosoft.com, and set the TargetAddress to user@[FederatedDomain].com.
2
Make sure to set Set-ExecutionPolicy Unrestricted in the x86 PowerShell.

For each Migrator for Notes to Exchange task you want to schedule

Migrator for Notes to Exchange's qsched.exe task-scheduling utility is compatible with Migrator for Notes to Exchange's Admin Account Pool for migrations to Office 365, but only with an additional step added to the process. For other migration scenarios (to an on-premises Exchange, or to Office 365 without the Admin Account Pool) the qsched.exe utility regularly checks Migrator for Notes to Exchange's SQL database to see whether any tasks have been scheduled to run since the last check, and then executes any such tasks it finds (as explained in Migrator for Notes to Exchange's Admin Guide, chapter 13). But Office 365 access restrictions require an intermediate scheduling mechanism to accommodate the Admin Account Pool.

When migrating to Office 365 with Migrator for Notes to Exchange's Admin Account Pool, use Windows' Task Scheduler to run Migrator for Notes to Exchange's qsched.exe for each Migrator for Notes to Exchange task you want to run:

1
Add a Windows scheduled task to run Migrator for Notes to Exchange's qsched.exe (in the Migrator for Notes to Exchange installation directory) at the task's scheduled execution time, and to "Run only when user is logged on."

Managing the Admin Account Pool

Use the Admin Account Pool Utility to manage your account pool. The utility lets you view the accounts in the pool, change the common password for all admin accounts in the pool, and/or change the number of accounts in the pool.

To start the Admin Account Pool Utility:

Click the Manage button on either of the Migrator for Notes to Exchange screens that offer it:
Notes Migration Manager Exchange Server Configuration screen.
Data Migration Wizard Select Destination Exchange Server screen.
Run the program file (AdminAcctPoolManager.exe) independently.

The Admin Account Pool Utility contains just a single screen, featuring a table of all admin pool accounts that are registered in the Migrator for Notes to Exchange database. Every time the program is started, it automatically uses remote PowerShell to scan Office 365, to synchronize Migrator for Notes to Exchange’s list of accounts with O365’s list.

Within the Admin Account Pool Utility you can:

Refresh the Current Owner, Allocate Time and Use Count values in the displayed table: Click the Refresh button. These values change as migrations allocate, use and release admin pool accounts, but you can always get the current values by clicking Refresh.
Re-sync the utility’s list of accounts with Exchange, to view the current list of O365 accounts registered in the Migrator for Notes to Exchange database: Click Synchronize. This is the same synchronization feature the utility performs each time you start the program, as noted above.
Password: Enter a new Password in the text box. The same Password is assigned to all pooled admin accounts.
New pool size: Change the number of accounts in the pool by setting a new number in the New pool size field.
NOTE: If you set the New pool size to 0, or otherwise reduce the size of the pool, any licenses associated with accounts no longer in the pool will become available for other accounts. Microsoft Office 365 licenses are transferable, so they can be reassigned after they are disassociated from these accounts. Note that this dissociation also deletes any O365 mailbox that may have been created for the account, but admin accounts created for this purpose typically do not need or use O365 mailboxes.
License Admin Pool Accounts: Mark the checkbox if you want Migrator for Notes to Exchange to assign O365 licenses to these accounts, or unmark the checkbox to dissociate O365 licenses from these accounts.
When you have entered all the changes you want to make, click Apply. (The Apply button applies any changes made in either or both fields, and then automatically Synchronizes with O365 and Refreshes the table display.)

While any of these operations are in progress, the status bar (bottom of the screen) displays progress information, and the Close button temporarily changes to a Cancel button (to cancel the current process).

 

PowerShell cmdlets for Migrator for Notes to Exchange

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:

To view a list of the available Migrator for Notes to Exchange cmdlets, enter the following command:

In addition to the cmdlet-specific parameters documented below, all of 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.

Examples

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>]

Description

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.

Add-MNEMailboxAdminPermission

Synopsis

Add the MNE admin user Full Access permission to mailboxes in the user collection for Office 365. If Admin Account Pool is used, the Office365 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 Office 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

-MaxHops <Integer>

Specifies the value for maximum number of redirects or hops when performing autodiscover. The default value is

10.

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

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 regar