.png)
PowerShell and cmdlets
Applies to: Live@edu, Forefront Online Protection for Exchange
Topic Last Modified: 2009-06-01
The Windows PowerShell command line shell and scripting language helps IT professionals achieve greater control and productivity. Using a new administrator-focused scripting language, more than 130 standard command-line tools, and consistent syntax and utilities, Windows PowerShell allows IT professionals to control system administration and accelerate automation. For more information about Windows PowerShell, or to download the version for your local environment, see the Microsoft TechNet Technology Center for Windows PowerShell (http://go.microsoft.com/fwlink/?LinkID=102372).
Cmdlets resemble built-in commands in other shells, for example, the dir command found in cmd.exe. Like these familiar commands, cmdlets can be called directly from the command line in the Exchange Management Shell and run under the context of the shell, not as a separate process.
If you plan on scripting additional automation, you may want to consider using Windows PowerShell scripts. Before you run Windows PowerShell, configure the Administration Center to as outlined in Configuring Your Hosted Services. Managing the service (start, stop, restart) is accomplished with the Services MMC. The service must be stopped and restarted upon changing the proxy server.
| Cmdlet | Purpose | Parameters | Example |
|---|---|---|---|
|
Set-SyncCredentials |
Sets the credentials for the client to use when connecting. |
<username> <password> |
Set-SyncCredentials adminuser@contoso.com SecurePassword |
|
Set-SyncInterval |
Sets the interval at which the sync job will run. |
<interval-in-minutes> |
Set-SyncInterval 240 |
|
Set-SyncProxyServer |
Sets up the corporate proxy server to use when the client connects to the backend. |
{ [-Address <address>] | [-AutoDetect] | [-UseDefault] } |
Set-SyncProxyServer -Address http://proxy.contosoproxy.com
|
|
Get-SyncConfig |
Gets the current sync configuration and reports it to console. |
none |
Get-SyncConfig |
|
Get-SyncStatus |
Gets the current sync service (client) status and reports it to console. |
none |
Get-SyncStatus |
|
Start-Sync |
Starts a new sync job (out of schedule) if it's not already running. |
none |
Start-Sync |
|
Start-SyncSimulation |
Starts a new sync job in simulation mode if simulation mode is available. |
none |
Start-SyncSimulation |
|
Stop-Sync |
Stops current sync job if it's running. |
none |
Stop-Sync |
|
Clear-SyncCookies |
Clears stored cookies and forces next synchronization to be a full synchronization. |
none |
Clear-SyncCookies |
