API Reference
Class
CmdletGetCertificateInventoryCtHealth
Builds CT diagnostics health timeline from persisted certificate inventory snapshots.
Inheritance
- PSCmdlet
- CmdletGetCertificateInventoryCtHealth
Examples
Get CT health for the last 30 days
Get-DDCertificateInventoryCtHealth -SinceUtc (Get-Date).ToUniversalTime().AddDays(-30) -MaxSnapshots 60
Apply thresholds and fail when latest snapshot is breached
Get-DDCertificateInventoryCtHealth -LatestOnly -MaxFailed 0 -MaxCircuitOpen 0 -MaxLagAfter 5000 -FailOnThresholdBreach
Fail when any returned snapshot is breached
Get-DDCertificateInventoryCtHealth -SinceUtc (Get-Date).ToUniversalTime().AddDays(-7) -FailOnAnyBreach -MaxFailed 0 -FailOnThresholdBreach
Constructors
public CmdletGetCertificateInventoryCtHealth() #Methods
ProcessRecord() #Executes the cmdlet.
Inherited Methods
public PathInfo CurrentProviderLocation(String providerId) #Returns:
PathInfoInherited from PSCmdlet
Parameters
- providerId String
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Collection<String> GetResolvedProviderPathFromPSPath(String path, out ProviderInfo provider) #Returns:
Collection<String>Inherited from PSCmdlet
Parameters
- path String
- provider ProviderInfo
public override String GetResourceString(String baseName, String resourceId) #Returns:
StringInherited from Cmdlet
Parameters
- baseName String
- resourceId String
public String GetUnresolvedProviderPathFromPSPath(String path) #Returns:
StringInherited from PSCmdlet
Parameters
- path String
public Object GetVariableValue(String name, Object defaultValue) #Returns:
ObjectInherited from PSCmdlet
Parameters
- name String
public Boolean ShouldContinue(String query, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- query String
- caption String
- hasSecurityImpact Boolean
- yesToAll Boolean
- noToAll Boolean
public Boolean ShouldProcess(String verboseDescription, String verboseWarning, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- verboseDescription String
- verboseWarning String
- caption String
- shouldProcessReason ShouldProcessReason
public Void ThrowTerminatingError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteCommandDetail(String text) #Returns:
VoidInherited from Cmdlet
Parameters
- text String
public Void WriteError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteInformation(InformationRecord informationRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- messageData Object
- tags String[]
public Void WriteObject(Object sendToPipeline) #Returns:
VoidInherited from Cmdlet
Parameters
- sendToPipeline Object
- enumerateCollection Boolean
public Void WriteProgress(ProgressRecord progressRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- progressRecord ProgressRecord
Properties
public String CacheDirectory { get; set; } #Parameter(Mandatory = false)Certificate monitor cache directory containing the inventory folder.
public Nullable<DateTime> SinceUtc { get; set; } #Parameter(Mandatory = false)Only include snapshots captured since this UTC date/time.
public Nullable<DateTime> UntilUtc { get; set; } #Parameter(Mandatory = false)Only include snapshots captured up to this UTC date/time.
public SwitchParameter LatestOnly { get; set; } #Parameter(Mandatory = false)Only evaluate the latest snapshot after date filtering.
public Int32 MaxSnapshots { get; set; } #Parameter(Mandatory = false) ValidateRange(0, 2147483647)Maximum timeline rows returned.
public Nullable<Int32> MaxFailed { get; set; } #Parameter(Mandatory = false) ValidateRange(0, 2147483647)Alert threshold: maximum allowed diagnostics in Failed state.
public Nullable<Int32> MaxCircuitOpen { get; set; } #Parameter(Mandatory = false) ValidateRange(0, 2147483647)Alert threshold: maximum allowed diagnostics in CircuitOpen state.
public Nullable<Int64> MaxLagAfter { get; set; } #Parameter(Mandatory = false) ValidateRange(0, 9223372036854775807)Alert threshold: maximum allowed LagAfter value across diagnostics.
public SwitchParameter FailOnAnyBreach { get; set; } #Parameter(Mandatory = false)When set, fail if any returned snapshot breaches thresholds (otherwise latest snapshot only).
public SwitchParameter FailOnThresholdBreach { get; set; } #Parameter(Mandatory = false)When set, throw a terminating error when threshold breach condition is met.
Inherited Properties
public PSEventManager Events { get; } #Inherited from PSCmdlet
public PSHost Host { get; } #Inherited from PSCmdlet
public CommandInvocationIntrinsics InvokeCommand { get; } #Inherited from PSCmdlet
public ProviderIntrinsics InvokeProvider { get; } #Inherited from PSCmdlet
public JobManager JobManager { get; } #Inherited from PSCmdlet
public JobRepository JobRepository { get; } #Inherited from PSCmdlet
public InvocationInfo MyInvocation { get; } #Inherited from PSCmdlet
public PagingParameters PagingParameters { get; } #Inherited from PSCmdlet
public String ParameterSetName { get; } #Inherited from PSCmdlet
public SessionState SessionState { get; } #Inherited from PSCmdlet
public ICommandRuntime CommandRuntime { get; set; } #Inherited from Cmdlet
public Boolean Stopping { get; } #Inherited from Cmdlet
public CommandOrigin CommandOrigin { get; } #Inherited from InternalCommand