Skip to main content
Version: 2.1.1-preview

Get-MtADDomainState

SYNOPSIS

Collects Active Directory domain state information.

SYNTAX

Get-MtADDomainState [-Refresh] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Collects comprehensive domain state including domain info, forest info, computers, users, groups, domain controllers, replication sites, etc. Results are cached for the session to avoid repeated queries. Connect-Maester -Service ActiveDirectory must complete successfully before this command can collect or return data.

EXAMPLES

EXAMPLE 1

Get-MtADDomainState

Returns cached domain state or collects if not already cached. Returns no data unless Active Directory was explicitly connected through Connect-Maester.

EXAMPLE 2

Get-MtADDomainState -Refresh

Forces a fresh collection of domain state data from Active Directory.

PARAMETERS

-Refresh

Forces a refresh of the data from Active Directory, bypassing the cache.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

OUTPUTS

NOTES

https://maester.dev/docs/commands/Get-MtADDomainState