Get-PublicFolderDatabase (RTM)

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 Get-PublicFolderDatabase cmdlet to get public folder database settings.

Syntax

Get-PublicFolderDatabase [-Identity <DatabaseIdParameter>] [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Get-PublicFolderDatabase -Server <ServerIdParameter> [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Get-PublicFolderDatabase -StorageGroup <StorageGroupIdParameter> [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Detailed Description

  • The Get-PublicFolderDatabase cmdlet gets the settings for a public folder database.

  • Only one of the Server, StorageGroup, or Identity parameters can be included in a command.

Note

When you run the Get-PublicFolderDatabase cmdlet with no parameters, it will return attributes of all of the public folder databases in the Exchange organization. To return specific database properties (including backup and mount status information) where the Get-PublicFolderDatabase cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the –Status parameter.

To perform the following procedures, the account you use must be delegated the following:

  • Exchange View-Only Administrator role

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

Parameters

Parameter Required Type Description

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the name of a server that contains a public folder database. If specified, only the public folder database on the specified server is returned. This parameter cannot be used with the Identity or the StorageGroup parameter.

StorageGroup

Required

Microsoft.Exchange.Configuration.Tasks.StorageGroupIdParameter

The StorageGroup parameter specifies the name of a storage group that contains a folder database. If specified, the command returns only the public folder databases in the storage group. This parameter cannot be used with the Identity or the Server parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Identity parameter specifies a public folder database. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Server\storage group\database name

  • Server\database name

  • Storage groupname\database name

If you do not specify the server name, the cmdlet will search for databases on the local server. If you have multiple databases with the same name, the cmdlet will retrieve all databases with the same name in the specified scope.

IncludePreExchange2007

Optional

System.Management.Automation.SwitchParameter

If the IncludePreExchange2007 parameter is included in the command, information about all of the public folder databases in the organization is returned, including versions of Exchange prior to Microsoft Exchange Server 2007. This parameter is not necessary when the Server, StorageGroup, or Identity parameters are included in the command.

Status

Optional

System.Management.Automation.SwitchParameter

If the Status parameter is included, additional backup and mount status information is included for Exchange 2007 servers.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

In this example, the Get-PublicFolderDatabase command is piped to the Format-List command to return all of the attributes of all the public folder databases in the organization.

Note

The IncludePreExchange2007 parameter is used in the example only because no other parameters are included. If the Server, StorageGroup, or Identity parameters are included in the command, the IncludePreExchange2007 parameter is not necessary to retrieve information about versions of Exchange prior to Exchange 2007.

Get-PublicFolderDatabase -IncludePreExchange2007 | Format-List

Only the Identity, StorageGroup, and Server parameters can be piped.