API Reference
Command
Test-ADXAdfs
Tests AD FS service, federation metadata, TLS certificate, and event telemetry.
Examples
Example 1: Check two AD FS servers without starting the monitoring service
Test-ADXAdfs -ComputerName 'adfs01.contoso.com','adfs02.contoso.com' -IncludeChildResults
Example 2: Check Web Application Proxy servers
Test-ADXAdfs -ComputerName 'wap01.contoso.com','wap02.contoso.com' -IncludeWebApplicationProxy -SkipFederationService
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Test-ADXAdfs -ComputerName <string[]> [-AllowedRecentErrorEvents <int>] [-AllowedRecentWarningEvents <int>] [-CertificateCriticalDays <int>] [-CertificateDegradedDays <int>] [-EventLogChannel <string[]>] [-EventLookbackHours <int>] [-EventProviderName <string[]>] [-FailureEventId <int[]>] [-FailureLookbackHours <int>] [-FederationMetadataPath <string>] [-FederationServiceHost <string>] [-HttpsPort <int>] [-IgnoreWarnings] [-IncludeChildResults] [-IncludeWebApplicationProxy] [-MaxConcurrency <int>] [-Name <string>] [-QueryTimeoutSeconds <int>] [-SkipCertificate] [-SkipFederationMetadata] [-SkipFederationService] [-TimeoutSeconds <int>] [<CommonParameters>]Parameters
- ComputerName string[]
- AD FS or Web Application Proxy server names to test.
- AllowedRecentErrorEvents int
- Recent AD FS error events tolerated before the result changes state.
- AllowedRecentWarningEvents int
- Recent AD FS warning events tolerated before the result changes state.
- CertificateCriticalDays int
- Certificate remaining-days threshold that marks the result down.
- CertificateDegradedDays int
- Certificate remaining-days threshold that marks the result degraded.
- EventLogChannel string[]
- Event log channels to query for AD FS telemetry.
- EventLookbackHours int
- Event lookback window in hours.
- EventProviderName string[]
- Optional event provider names. Empty means all providers in the channel.
- FailureEventId int[]
- Specific event IDs treated as failures. Empty means warning/error levels are used.
- FailureLookbackHours int
- Failure lookback window in hours.
- FederationMetadataPath string
- Relative AD FS federation metadata path.
- FederationServiceHost string
- Optional federation service host used for metadata and TLS certificate checks.
- HttpsPort int
- HTTPS port for federation metadata checks.
- IgnoreWarnings SwitchParameter
- Does not degrade the result for warning-level AD FS events.
- IncludeChildResults SwitchParameter
- Writes child per-server results when a multi-target aggregate is returned.
- IncludeWebApplicationProxy SwitchParameter
- Checks the Web Application Proxy service (appproxysvc).
- MaxConcurrency int
- Maximum concurrent server checks.
- Name string
- Probe name written to the result object.
- QueryTimeoutSeconds int
- Timeout in seconds for each WMI, event-log, and HTTPS metadata query.
- SkipCertificate SwitchParameter
- Skips TLS certificate policy and expiration evaluation.
- SkipFederationMetadata SwitchParameter
- Skips the federation metadata HTTPS endpoint check.
- SkipFederationService SwitchParameter
- Skips the AD FS federation service check (adfssrv).
- TimeoutSeconds int
- Overall per-target timeout in seconds.
Outputs
ADPlayground.Monitoring.Probes.ProbeResult