Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 4.26 KB

Get-ServerComponentState.md

File metadata and controls

120 lines (89 loc) · 4.26 KB
Raw
external help file online version applicable title schema author ms.author ms.reviewer
Microsoft.Exchange.RemoteConnections-Help.xml
Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
Get-ServerComponentState
2.0.0
chrisda
chrisda

Get-ServerComponentState

SYNOPSIS

This cmdlet is available only in on-premises Exchange.

Use the Get-ServerComponentState cmdlet to retrieve configuration settings for Microsoft Exchange components and endpoints.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

SYNTAX

Get-ServerComponentState [-Identity] <ServerIdParameter>
 [-Component <String>]
 [-DomainController <Fqdn>]
 [<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-ServerComponentState -Identity Mailbox01

This example returns a summary list of all component and endpoint states on the server named Mailbox01.

Example 2

Get-ServerComponentState -Identity Mailbox01 -Component UnifiedMessaging | Format-List

This example returns detailed information for the component state of the Unified Messaging component on the server named Mailbox01.

PARAMETERS

-Identity

The Identity parameter specifies the Exchange server where you want to view the configuration settings. You can use the following values:

  • Name
  • Distinguished name (DN)
  • FQDN
Type: ServerIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: True
Position: 1
Default value: None
Accept pipeline input: True
Accept wildcard characters: False

-Component

The Component parameter specifies the component or endpoint for which you want to retrieve the state. To see the available values, run the following command: Get-ServerComponentState <ServerName>.

Type: String
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Type: Fqdn
Parameter Sets: (All)
Aliases:
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Input types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

OUTPUTS

Output types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data.

NOTES

RELATED LINKS