Install-MMExAgent
Installs an agent on the selected host.
Detailed Description
The Install-MMExAgent cmdlet installs the agent specified by type on the selected host.
Syntax
Install-MMExAgent
-Type PublicFolder
-AgentHost <hostname>
-AgentHostAccount <PSCredential>
[-InstallPath <full path>]
[<CommonParameters>]
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
| Required? | true |
| Position? | 1 |
| Default value | PublicFolder |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AgentHost
Specifies host name to install specified agent.
|
|
TIP: If this parameter is not specified, the agent will be installed on the local server (localhost).. |
| Required? | false |
| Position? | 2 |
| Default value | localhost |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AgentHostAccount
Specifies credentials of service account required to install the agent on the specified host.
| Required? | true |
| Position? | 3 |
| Default value | none |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-InstallPath
Specifies full path to the agent installation folder.
| Required? | false |
| Position? | 4 |
| Default value | $Env:ProgramW6432*\Quest Software\Migration Manager\Migration Agent for Exchange |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Examples
Install-MMExAgent -Type PublicFolder -InstallPath "c:\QuestAgentPath
This command installs the public folder synchronization agent to the QuestAgentPath folder on the disc C.
Start-MMExAgent
Starts an agent on the selected host.
Detailed Description
The Start-MMExAgent cmdlet starts Migration Agent for Exchange (MAgE) installed on the selected host.
Syntax
Start-MMExAgent
-Type PublicFolder
[-AgentHost <agent host name>]
[<CommonParameters>]
Examples
Start-MMExAgent -Type PublicFolder
This command starts the agent installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
| Required? | true |
| Position? | 2 |
| Default value | PublicFolder |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AgentHost
Specifies host name where specified agent is installed to start the agent.
|
|
TIP: If this parameter is not specified, the agent will be started on the local server (localhost).. |
| Required? | false |
| Position? | 1 |
| Default value | <localhost> |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Stop-MMExAgent
Stops an agent on the selected host.
Detailed Description
The Start-MMExAgent cmdlet stops the Migration Agent for Exchange (MAgE) running on the selected host.
Syntax
Stop-MMExAgent
-Type PublicFolder
[-AgentHost <agent host name>]
[<CommonParameters>]
Examples
Stop-MMExAgent -Type PublicFolder
This command stops the agent running on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
| Required? | true |
| Position? | 4 |
| Default value | PublicFolder |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AgentHost
Specifies host name where specified agent is running on to stop the agent.
|
|
TIP: If this parameter is not specified, the agent will be stopped on the local server (localhost).. |
| Required? | false |
| Position? | 1 |
| Default value | localhost |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Repair-MMExAgent
Repairs an agent instance on the selected host.
Detailed Description
The Repair-MMExAgent cmdlet repairs an Migration Agent for Exchange (MAgE) instance installed on the selected host. This operation is used to update agents on a host after Public Update installation. During the Repair operation for an instance of MAgE agent or for the certain agent role, this update will be installed on all instances of all MAgE agent roles that reside on the agent host.
Syntax
Repair-MMExAgent
-Type PublicFolder
[-AgentHost <agent host name>]
[<CommonParameters>]
Examples
Repair-MMExAgent -Type PublicFolder
This command repairs the agent instance installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
| Required? | true |
| Position? | 2 |
| Default value | PublicFolder |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-AgentHost
Specifies host name where specified agent is installed to repair the agent instance.
|
|
TIP: If this parameter is not specified, the agent instance will be repaired or updated on the local server (localhost). |
| Required? | false |
| Position? | 1 |
| Default value | <localhost> |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.