Get-UMVirtualDirectory
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Get-UMVirtualDirectory cmdlet retrieves the configuration settings for a Unified Messaging virtual directory on a computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Syntax
Get-UMVirtualDirectory [-Identity <VirtualDirectoryIdParameter>] [-DomainController <Fqdn>]
Get-UMVirtualDirectory -Server <ServerIdParameter> [-DomainController <Fqdn>]
Detailed Description
The Get-UMVirtualDirectory cmdlet retrieves the configuration settings for a Unified Messaging virtual directory on an Exchange 2007 Client Access server.
The Get-UMVirtualDirectory cmdlet can be run on a local server, or run remotely if the server name is specified in the Identity or Server parameters. It can also be run without parameters to retrieve the configuration settings from all Outlook Web Access virtual directories on all Internet Information Services (IIS) Web sites that are located on the Client Access servers in the organization.
The Get-UMVirtualDirectory cmdlet can be run on any server that has the Exchange administration tools installed. The account you use must be delegated the Exchange View-Only Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Server |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
Use this parameter to specify the name or GUID of the server that hosts the virtual directories that you want to display. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
Use this parameter to specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. Include the DomainController parameter in the cmdlet. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter |
Use this parameter to specify either the GUID of the server, the name of the Web site, or the name of the virtual directory that you want to display. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first code example returns the settings for the virtual directory named UnifiedMessaging under the default Web site in IIS.
The second code example retrieves all settings for the UnifiedMessaging virtual directories on a server named CAS01.
Get-UMVirtualDirectory
Get-UMVirtualDirectory -Identity CAS01