Get-ExchangeSettings

This cmdlet is available only in on-premises Exchange.

Use the Get-ExchangeSettings cmdlet to view customized Exchange setting objects that are stored in Active Directory. Use the New-ExchangeSettings to create the settings object, and the Set-ExchangeSettings cmdlet to define the actual settings.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).

Syntax

Get-ExchangeSettings
   [[-Identity] <ExchangeSettingsIdParameter>]
   [-ConfigName <String>]
   [-Database <DatabaseIdParameter>]
   [-Diagnostic]
   [-DiagnosticArgument <String>]
   [-DomainController <Fqdn>]
   [-Force]
   [-GenericScopeName <String>]
   [-GenericScopes <String[]>]
   [-GenericScopeValue <String>]
   [-Organization <OrganizationIdParameter>]
   [-Process <String>]
   [-Server <ServerIdParameter>]
   [-User <Guid>]
   [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-ExchangeSettings

This example returns a summary list of all Exchange setting objects.

Example 2

Get-ExchangeSettings -Identity Audit | Format-List

This example returns a summary list of all Exchange setting objects.

Parameters

-ConfigName

The ConfigName parameter filter the results by the specified property name. The value you specify is visible in the EffectiveSetting property.

The available values are determined by the schema of the Exchange setting object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Database

The Database parameter filters the results by mailbox database. You can use any value that uniquely identifies the database. For example:

  • Name

  • Distinguished name (DN)

  • ExchangeLegacyDN

  • GUID

Type:DatabaseIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Diagnostic

The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems.

The detailed information is visible in the DiagnosticInfo property.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-DiagnosticArgument

The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-DomainController

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Force

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-GenericScopeName

The GenericScopeName parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-GenericScopeValue

The GenericScopeValue parameter filters the results by the value of the scope specified by the GenericScopeName parameter. The available values are determined by the schema of the Exchange setting object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-GenericScopes

The GenericScopes parameter filters the results by the scope. The available values are determined by the schema of the Exchange setting object. This parameter uses the syntax "<key1>=<value1>","<key2>=<value2>"...

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Identity

The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Type:ExchangeSettingsIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Organization

This parameter is reserved for internal Microsoft use.

Type:OrganizationIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Process

The Process parameter filters the results by the specified process. The available values are determined by the schema of the Exchange setting object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Server

The Server parameter filters the results by Exchange server. You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • ExchangeLegacyDN

  • GUID

Type:ServerIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-User

The User parameter filters the results by user. You identify the user by their GUID value (for example, 87246450-1b19-4c81-93dc-1a4200eff66c). To find the GUID for a user, run the following command: Get-User <UserIdentity> | Format-List Name,GUID.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

Inputs

Outputs