Get-MtADDomainState
SYNOPSIS
Collects Active Directory domain state information.
SYNTAX
Get-MtADDomainState [-Refresh] [[-ComputerName] <String>] [-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.
EXAMPLE 3
Get-MtADDomainState -ComputerName dc01.contoso.com
Collects domain state data by targeting dc01.contoso.com for supported Active Directory and DNS queries.
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
-ComputerName
Specifies an Active Directory domain controller or AD DS server to target for data collection. When provided, Active Directory queries and the LDAP searcher are directed to this server. DNS collection also targets this host when it supports the required DNS management access. If not specified, commands use the implicit serverless behavior of the Active Directory module and the DNS root from the collected domain object is used for DNS queries.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
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.