Share via

Set-OwaVirtualDirectory (RTM)

  • Article

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

Use the Set-OwaVirtualDirectory cmdlet to modify the properties of Outlook Web Access virtual directories on a computer that is running Microsoft Exchange 2007 that has the Client Access server role installed.

Syntax

Set-OwaVirtualDirectory -Identity <VirtualDirectoryIdParameter> [-ActionForUnknownFileAndMIMETypes <Nullable>] [-ActiveSyncIntegrationEnabled <Nullable>] [-AllAddressListsEnabled <Nullable>] [-AllowedFileTypes <MultiValuedProperty>] [-AllowedMimeTypes <MultiValuedProperty>] [-BasicAuthentication <$true | $false>] [-BlockedFileTypes <MultiValuedProperty>] [-BlockedMimeTypes <MultiValuedProperty>] [-CalendarEnabled <Nullable>] [-ChangePasswordEnabled <Nullable>] [-ClientAuthCleanupLevel <High | Low>] [-ContactsEnabled <Nullable>] [-DefaultClientLanguage <Nullable>] [-DefaultDomain <String>] [-DefaultTheme <String>] [-DigestAuthentication <$true | $false>] [-DirectFileAccessOnPrivateComputersEnabled <Nullable>] [-DirectFileAccessOnPublicComputersEnabled <Nullable>] [-DomainController <Fqdn>] [-ExchwebProxyDestination <Nullable>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-FilterWebBeaconsAndHtmlForms <Nullable>] [-ForceSaveFileTypes <MultiValuedProperty>] [-ForceSaveMimeTypes <MultiValuedProperty>] [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <Nullable>] [-ForceWebReadyDocumentViewingFirstOnPublicComputers <Nullable>] [-FormsAuthentication <$true | $false>] [-GzipLevel <Off | Low | High | Error>] [-InternalUrl <Uri>] [-JournalEnabled <Nullable>] [-JunkEmailEnabled <Nullable>] [-LogonAndErrorLanguage <Int32>] [-LogonFormat <FullDomain | PrincipalName | UserName>] [-NotesEnabled <Nullable>] [-NotificationInterval <Nullable>] [-OutboundCharset <Nullable>] [-PremiumClientEnabled <Nullable>] [-RedirectToOptimalOWAServer <Nullable>] [-RemindersAndNotificationsEnabled <Nullable>] [-RemoteDocumentsActionForUnknownServers <Nullable>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-SearchFoldersEnabled <Nullable>] [-SignaturesEnabled <Nullable>] [-SpellCheckerEnabled <Nullable>] [-TasksEnabled <Nullable>] [-ThemeSelectionEnabled <Nullable>] [-UMIntegrationEnabled <Nullable>] [-UNCAccessOnPrivateComputersEnabled <Nullable>] [-UNCAccessOnPublicComputersEnabled <Nullable>] [-UseGB18030 <Nullable>] [-UseISO885915 <Nullable>] [-UserContextTimeout <Nullable>] [-VirtualDirectoryType <Nullable>] [-WebReadyDocumentViewingForAllSupportedTypes <Nullable>] [-WebReadyDocumentViewingOnPrivateComputersEnabled <Nullable>] [-WebReadyDocumentViewingOnPublicComputersEnabled <Nullable>] [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] [-WebReadyFileTypes <MultiValuedProperty>] [-WebReadyMimeTypes <MultiValuedProperty>] [-WindowsAuthentication <$true | $false>] [-WSSAccessOnPrivateComputersEnabled <Nullable>] [-WSSAccessOnPublicComputersEnabled <Nullable>]

Set-OwaVirtualDirectory [-ActionForUnknownFileAndMIMETypes <Nullable>] [-ActiveSyncIntegrationEnabled <Nullable>] [-AllAddressListsEnabled <Nullable>] [-AllowedFileTypes <MultiValuedProperty>] [-AllowedMimeTypes <MultiValuedProperty>] [-BasicAuthentication <$true | $false>] [-BlockedFileTypes <MultiValuedProperty>] [-BlockedMimeTypes <MultiValuedProperty>] [-CalendarEnabled <Nullable>] [-ChangePasswordEnabled <Nullable>] [-ClientAuthCleanupLevel <High | Low>] [-ContactsEnabled <Nullable>] [-DefaultClientLanguage <Nullable>] [-DefaultDomain <String>] [-DefaultTheme <String>] [-DigestAuthentication <$true | $false>] [-DirectFileAccessOnPrivateComputersEnabled <Nullable>] [-DirectFileAccessOnPublicComputersEnabled <Nullable>] [-DomainController <Fqdn>] [-ExchwebProxyDestination <Nullable>] [-ExternalAuthenticationMethods <MultiValuedProperty>] [-ExternalUrl <Uri>] [-FilterWebBeaconsAndHtmlForms <Nullable>] [-ForceSaveFileTypes <MultiValuedProperty>] [-ForceSaveMimeTypes <MultiValuedProperty>] [-ForceWebReadyDocumentViewingFirstOnPrivateComputers <Nullable>] [-ForceWebReadyDocumentViewingFirstOnPublicComputers <Nullable>] [-FormsAuthentication <$true | $false>] [-GzipLevel <Off | Low | High | Error>] [-Instance <ADOwaVirtualDirectory>] [-InternalUrl <Uri>] [-JournalEnabled <Nullable>] [-JunkEmailEnabled <Nullable>] [-LogonAndErrorLanguage <Int32>] [-LogonFormat <FullDomain | PrincipalName | UserName>] [-NotesEnabled <Nullable>] [-NotificationInterval <Nullable>] [-OutboundCharset <Nullable>] [-PremiumClientEnabled <Nullable>] [-RedirectToOptimalOWAServer <Nullable>] [-RemindersAndNotificationsEnabled <Nullable>] [-RemoteDocumentsActionForUnknownServers <Nullable>] [-RemoteDocumentsAllowedServers <MultiValuedProperty>] [-RemoteDocumentsBlockedServers <MultiValuedProperty>] [-RemoteDocumentsInternalDomainSuffixList <MultiValuedProperty>] [-SearchFoldersEnabled <Nullable>] [-SignaturesEnabled <Nullable>] [-SpellCheckerEnabled <Nullable>] [-TasksEnabled <Nullable>] [-ThemeSelectionEnabled <Nullable>] [-UMIntegrationEnabled <Nullable>] [-UNCAccessOnPrivateComputersEnabled <Nullable>] [-UNCAccessOnPublicComputersEnabled <Nullable>] [-UseGB18030 <Nullable>] [-UseISO885915 <Nullable>] [-UserContextTimeout <Nullable>] [-VirtualDirectoryType <Nullable>] [-WebReadyDocumentViewingForAllSupportedTypes <Nullable>] [-WebReadyDocumentViewingOnPrivateComputersEnabled <Nullable>] [-WebReadyDocumentViewingOnPublicComputersEnabled <Nullable>] [-WebReadyDocumentViewingSupportedFileTypes <MultiValuedProperty>] [-WebReadyDocumentViewingSupportedMimeTypes <MultiValuedProperty>] [-WebReadyFileTypes <MultiValuedProperty>] [-WebReadyMimeTypes <MultiValuedProperty>] [-WindowsAuthentication <$true | $false>] [-WSSAccessOnPrivateComputersEnabled <Nullable>] [-WSSAccessOnPublicComputersEnabled <Nullable>]

Detailed Description

The Set-OwaVirtualDirectory cmdlet is used to modify the settings of Outlook Web Access virtual directories on a computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed. Running the Set-OwaVirtualDirectory cmdlet lets an administrator enable or disable features and manage security.

Note

The Identity parameter is required by the Set-OWAVirtualDirectory cmdlet.

Before you run the Set-OwaVirtualDirectory cmdlet:

  • You must have Write access to the virtual directory objects in the Active Directory directory service. If you do not have the necessary permissions and you try to run the Set-OwaVirtualDirectory cmdlet on the Active Directory virtual directory object, the cmdlet will fail.

  • You must have Write access to virtual directory objects in the metabase for some of the properties such as Authentication and GZip. If you do not have the necessary permissions to run the Set-OwaVirtualDirectory cmdlet on a metabase virtual directory object or on a parameter that writes to the metabase, the cmdlet will fail.

  • Before you run the Set-OwaVirtualDirectory cmdlet, verify that the data source can be read. Depending on the properties that you want to set on an Outlook Web Access virtual directory, you may want to run the cmdlet in a test environment on the Outlook Web Access virtual directory object in Active Directory, the metabase, or both.

The Set-OwaVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed. To perform the following procedure, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Notes About Forms-Based Authentication

  • Any time forms-based authentication is turned on or off, you must use the IISReset /noforce command before the change will take effect.

  • To switch from forms-based authentication to Basic authentication, you must first turn off forms-based authentication, and then, as a separate task, turn on Basic authentication. You cannot turn off forms-based authentication and turn on Basic authentication in a single task.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.VirtualDirectoryIdParameter

This parameter specifies the name or GUID of an Outlook Web Access virtual directory. The Identity parameter is represented as: ServerName\VirtualDirectoryName (WebsiteName).

ActionForUnknownFileAndMIMETypes

Optional

System.Nullable

This parameter specifies how to handle files that are not included in other File Access Management lists.

The following values are valid for this parameter:

  • Allow

  • ForceSave

  • Block

ActiveSyncIntegrationEnabled

Optional

System.Nullable

This parameter disables Exchange ActiveSync in Outlook Web Access Options.

AllAddressListsEnabled

Optional

System.Nullable

This parameter specifies which address lists are exposed to the user.

The following values are valid for this parameter:

  • If set to $true, users can view all address lists.

  • If set to $false, users can view only the global address list (GAL).

AllowedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter sets the extensions of file types that the user is allowed to save locally and view from a Web browser. If the same extensions are in multiple settings lists, the most secure setting overrides the less secure settings.

AllowedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates extensions of MIME attachments that users can save locally and view from a Web browser. If the same extensions are in multiple settings lists, the most secure setting overrides the less secure settings.

BasicAuthentication

Optional

System.Boolean

This parameter specifies whether Basic authentication is enabled on the Outlook Web Access virtual directory. This parameter can be used with FormsAuthentication, or with DigestAuthentication and WindowsAuthentication.

BlockedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of extensions of attachments that are blocked. Attachments that contain these blocked extensions cannot be saved locally or viewed from a Web browser.

BlockedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of MIME extensions of attachments that are blocked. Attachments that contain these blocked MIME extensions cannot be saved locally or viewed from a Web browser.

CalendarEnabled

Optional

System.Nullable

This parameter enables or disables the calendar for users.

ChangePasswordEnabled

Optional

System.Nullable

This parameter determines whether users can change their password from within Outlook Web Access.

ClientAuthCleanupLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClientAuthCleanupLevels

This parameter specifies how much of the cache is cleared when the user logs off. This property has no effect on clients that are using Outlook Web Access Light.

ContactsEnabled

Optional

System.Nullable

This parameter specifies whether Contacts are enabled or disabled for users.

DefaultClientLanguage

Optional

System.Nullable

This parameter, if set to a value other than 0, specifies the Outlook Web Access language that is used when a user who has not selected a specific language on the Options page logs on to Outlook Web Access.

Note   $null is not a valid value for this parameter.

DefaultDomain

Optional

System.String

This parameter specifies which domain to use when the LogonFormat parameter is set to UserName.

DefaultTheme

Optional

System.String

This parameter specifies the default theme that will be used by all Outlook Web Access users.

DigestAuthentication

Optional

System.Boolean

This parameter specifies whether Digest authentication is enabled on the virtual directory. This parameter cannot be used with FormsAuthentication.

DirectFileAccessOnPrivateComputersEnabled

Optional

System.Nullable

This parameter affects the left-click options on attachments when the user has chosen to log on by using the "Private" option. If this parameter is set to $true, "Open" is an available option. If it is set to $false, the "Open" option is disabled.

DirectFileAccessOnPublicComputersEnabled

Optional

System.Nullable

This parameter affects the left-click options on attachments when the user has chosen to log on by using the "Public" option. If this parameter is set to $true, "Open" is an available option. If it is set to $false, the "Open" option is disabled.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the cmdlet.

ExchwebProxyDestination

Optional

System.Nullable

This parameter specifies whether the /exchweb virtual directory is sent to the user’s Mailbox server or public folder server. This parameter applies only to Exchange Server 2003 and Exchange 2000 Server Outlook Web Access virtual directories.

If a user's mailbox is located on an Exchange 2007 server, the /exchweb virtual directory connects the user to the Exchange Server 2003 or Exchange 2000 Server public folder stores.

ExternalAuthenticationMethods

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the authentication methods that are supported on the Exchange server from outside the firewall.

ExternalUrl

Optional

System.Uri

This parameter specifies the host name that will be used to connect to the Exchange server from outside the firewall. This setting is also important when Secure Sockets Layer (SSL) is used.

Note

You can only configure this option on Exchange 2007 virtual directories. The default Exchange 2007 virtual directory is /owa.

FilterWebBeaconsAndHtmlForms

Optional

System.Nullable

This parameter specifies how Web beacons are handled. The possible values are UserFilterChoice, ForceFilter, and DisableFilter.

ForceSaveFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of extensions of attachments that can be opened only after the file is saved locally on the user's computer.

ForceSaveMIMETypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the MIME types of attachments that can be opened only after the file is saved locally on the user's computer.

ForceWebReadyDocumentViewingFirstOnPrivateComputers

Optional

System.Nullable

This parameter determines whether a user who has logged on by using the Private option can open a document directly without first viewing it as a Web page.

ForceWebReadyDocumentViewingFirstOnPublicComputers

Optional

System.Nullable

This parameter determines whether a user who has logged on by using the Public option can open a document directly without first viewing it as a Web page.

FormsAuthentication

Optional

System.Boolean

This parameter specifies whether forms-based authentication is enabled on the Outlook Web Access virtual directory.

If FormsAuthentication is set to $true, BasicAuthentication is set to $true and DigestAuthentication and WindowsAuthentication are set to $false.

GzipLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.GzipLevel

This parameter sets Gzip configuration information for the Outlook Web Access virtual directory.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ADOwaVirtualDirectory

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

InternalUrl

Optional

System.Uri

This parameter specifies the host name of the Exchange server for connection from within the firewall. This setting is also important when SSL is used.

Note

You can only configure this option on Exchange 2007 virtual directories. The default Exchange 2007 virtual directory is /owa.

JournalEnabled

Optional

System.Nullable

This parameter specifies whether the Journal folder is visible.

JunkEmailEnabled

Optional

System.Nullable

This parameter specifies whether the Junk E-mail management tools are enabled.

LogonAndErrorLanguage

Optional

System.Int32

This parameter specifies which language Outlook Web Access uses for forms-based authentication and for error messages that occur when a user’s current language setting cannot be read. A value of 0 on this parameter signifies that the language selection is undefined.

LogonFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.LogonFormats

This parameter specifies the type of logon format forms-based authentication must use on the Outlook Web Access logon page.

If you specify the UserName attribute, you must also specify the DefaultDomain attribute.

If you specify the PrincipalName attribute, the User name field on the Outlook Web Access logon page requires a UPN address. This logon method works only for users whose UPN name is the same as their e-mail address.

NotesEnabled

Optional

System.Nullable

This parameter specifies whether the Notes folder is visible in Outlook Web Access.

NotificationInterval

Optional

System.Nullable

This parameter specifies the polling frequency, in seconds, with which the client must poll the server for new item notifications, reminder updates, and session time-out information. This parameter applies only to Outlook Web Access Premium.

OutboundCharset

Optional

System.Nullable

This parameter specifies the character set that is used for messages that are sent by users on a specific Outlook Web Access virtual directory.

PremiumClientEnabled

Optional

System.Nullable

This parameter specifies whether a user can access the Premium Outlook Web Access client.

RedirectToOptimalOWAServer

Optional

System.Nullable

This parameter, when set to $true, causes Outlook Web Access to use service discovery to find the best Client Access server to use after a user authenticates. If redirection is disabled, Outlook Web Access will not redirect clients to the most optimal Client Access server.

RemindersAndNotificationsEnabled

Optional

System.Nullable

This parameter specifies whether notifications and reminders are enabled in Outlook Web Access Premium. This parameter does not apply to Outlook Web Access Light.

RemoteDocumentsActionForUnknownServers

Optional

System.Nullable

This parameter specifies whether to allow or prevent access to files on a server host name that is not included in Allow and Block lists.

RemoteDocumentsAllowedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of host names of servers that are allowed. Users can access files on these servers through Outlook Web Access only if the server is included in the Allow list and is not included in the Block list.

RemoteDocumentsBlockedServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of host names of servers that are blocked. Users will be unable to access files on these servers. The settings in the Block list override the Allow list.

RemoteDocumentsInternalDomainSuffixList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of Web sites that have fully qualified domain names (FQDNs) that are treated as internal Web sites.

SearchFoldersEnabled

Optional

System.Nullable

This parameter specifies whether a user can use the Search function on Outlook Web Access folders.

SignaturesEnabled

Optional

System.Nullable

This parameter specifies whether a user can use the Signature feature in Outlook Web Access.

SpellCheckerEnabled

Optional

System.Nullable

This parameter specifies whether a user can check spelling in Outlook Web Access. This parameter does not apply to Outlook Web Access Light.

TasksEnabled

Optional

System.Nullable

This parameter specifies whether a user can use the Tasks feature in Outlook Web Access. This parameter does not apply to Outlook Web Access Light.

ThemeSelectionEnabled

Optional

System.Nullable

This parameter specifies whether users can choose the theme for their Outlook Web Access client from the Options page. This parameter does not apply to Outlook Web Access Light.

UMIntegrationEnabled

Optional

System.Nullable

This parameter specifies whether Unified Messaging is enabled on Outlook Web Access. This setting applies only if Unified Messaging has been enabled for a user by using the Enable-UMMailbox cmdlet. This parameter does not apply to Outlook Web Access Light.

UNCAccessOnPrivateComputersEnabled

Optional

System.Nullable

This parameter specifies whether a user has Windows file share (also known as UNC) access when they choose the This is a private computer option on the Outlook Web Access logon page.

UNCAccessOnPublicComputersEnabled

Optional

System.Nullable

This parameter specifies whether a user has Windows file share (also known as UNC) access when they choose the This is a public or shared computer on the Outlook Web Access logon page.

UseGB18030

Optional

System.Nullable

This parameter specifies when to use the character set GB18030. This parameter is a character-handling registry key that works in coordination with the OutboundCharset registry key. When the UseGB18030 parameter is set to 1, the character set GB18030 is used wherever the GB2312 would have been used.

UseISO885915

Optional

System.Nullable

This parameter specifies when to use the character set ISO8859-15. This parameter is a character-handling registry key that works in coordination with the OutboundCharset registry key. When the UseISO885915 parameter is set to 1, the character set ISO8859-15 is used wherever the ISO8859-1 would have been used.

UserContextTimeout

Optional

System.Nullable

This parameter specifies the time-out setting, in minutes, for a user context object. This parameter does not limit public and private forms-based authentication time-out settings.

VirtualDirectoryType

Optional

System.Nullable

This parameter specifies whether the Outlook Web Access virtual directory points to mailboxes, public folders, or exchweb. This parameter is required if the Outlook Web Access virtual directory is on an Exchange Server 2003 or Exchange 2000 Server server. If the Outlook Web Access virtual directory is on an Exchange 2007 server, this parameter is ignored.

WebReadyDocumentViewingForAllSupportedTypes

Optional

System.Nullable

This parameter turns on WebReady Document Viewing for all supported file and MIME types. If this parameter is set to $false, use the WebReadyFileTypes and WebReadyMimeTypes parameters to set which file and MIME types to convert.

WebReadyDocumentViewingOnPrivateComputersEnabled

Optional

System.Nullable

This parameter specifies whether WebReady Document Viewing is enabled when the user selects This is a private computer on the Outlook Web Access logon page.

WebReadyDocumentViewingOnPublicComputersEnabled

Optional

System.Nullable

This parameter specifies whether WebReady Document Viewing is enabled when the user selects This is a public or shared computer on the Outlook Web Access logon page.

WebReadyDocumentViewingSupportedFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This read-only parameter lists the file types that are supported by the conversion engine.

WebReadyDocumentViewingSupportedMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This read-only parameter lists the MIME types supported by the conversion engine

WebReadyFileTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of file types on which WebReady Document Viewing is performed.

WebReadyMimeTypes

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter creates a list of MIME types on which WebReady Document Viewing is performed.

WindowsAuthentication

Optional

System.Boolean

This parameter specifies whether Integrated Windows authentication is permitted on the Outlook Web Access virtual directory.

WSSAccessOnPrivateComputersEnabled

Optional

System.Nullable

This parameter specifies whether a user has Windows SharePoint Services access when they select This is a private computer on the Outlook Web Access logon page, or when forms-based authentication is not used.

WSSAccessOnPublicComputersEnabled

Optional

System.Nullable

This parameter specifies whether a user has Windows SharePoint Services access when they select This is a public or shared computer on the Outlook Web Access logon page.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code example sets the FileAccessControlOnPublicComputers parameter to BlockAll on the Outlook Web Access virtual directory named "owa" on the default Internet Information Services (IIS) Web site on an Exchange server named "Contoso."

Set-OWAVirtualDirectory -Identity "Contoso\owa (default web site)" -FileAccessControlOnPublicComputers BlockAll