Updates docs for plugins

Author: LordHepipud

doc/10-Icinga-Plugins.md

@@ -15,18 +15,19 @@ Please ensure that you will escape the `@` if you are configuring it on the Icin
 To test thresholds with different input values, you can use the Framework Cmdlet `Get-IcingaHelpThresholds`.
 
 * [Invoke-IcingaCheckBiosSerial](plugins/01-Invoke-IcingaCheckBiosSerial.md)
-* [Invoke-IcingaCheckCheckSum](plugins/02-Invoke-IcingaCheckCheckSum.md)
-* [Invoke-IcingaCheckCPU](plugins/03-Invoke-IcingaCheckCPU.md)
-* [Invoke-IcingaCheckDirectory](plugins/04-Invoke-IcingaCheckDirectory.md)
-* [Invoke-IcingaCheckEventlog](plugins/05-Invoke-IcingaCheckEventlog.md)
-* [Invoke-IcingaCheckFirewall](plugins/06-Invoke-IcingaCheckFirewall.md)
-* [Invoke-IcingaCheckICMP](plugins/07-Invoke-IcingaCheckICMP.md)
-* [Invoke-IcingaCheckMemory](plugins/08-Invoke-IcingaCheckMemory.md)
-* [Invoke-IcingaCheckNLA](plugins/09-Invoke-IcingaCheckNLA.md)
-* [Invoke-IcingaCheckPerfcounter](plugins/10-Invoke-IcingaCheckPerfcounter.md)
-* [Invoke-IcingaCheckProcessCount](plugins/11-Invoke-IcingaCheckProcessCount.md)
-* [Invoke-IcingaCheckService](plugins/12-Invoke-IcingaCheckService.md)
-* [Invoke-IcingaCheckUpdates](plugins/13-Invoke-IcingaCheckUpdates.md)
-* [Invoke-IcingaCheckUptime](plugins/14-Invoke-IcingaCheckUptime.md)
-* [Invoke-IcingaCheckUsedPartitionSpace](plugins/15-Invoke-IcingaCheckUsedPartitionSpace.md)
-* [Invoke-IcingaCheckUsers](plugins/16-Invoke-IcingaCheckUsers.md)
+* [Invoke-IcingaCheckCertificate](plugins/02-Invoke-IcingaCheckCertificate.md)
+* [Invoke-IcingaCheckCheckSum](plugins/03-Invoke-IcingaCheckCheckSum.md)
+* [Invoke-IcingaCheckCPU](plugins/04-Invoke-IcingaCheckCPU.md)
+* [Invoke-IcingaCheckDirectory](plugins/05-Invoke-IcingaCheckDirectory.md)
+* [Invoke-IcingaCheckEventlog](plugins/06-Invoke-IcingaCheckEventlog.md)
+* [Invoke-IcingaCheckFirewall](plugins/07-Invoke-IcingaCheckFirewall.md)
+* [Invoke-IcingaCheckICMP](plugins/08-Invoke-IcingaCheckICMP.md)
+* [Invoke-IcingaCheckMemory](plugins/09-Invoke-IcingaCheckMemory.md)
+* [Invoke-IcingaCheckNLA](plugins/10-Invoke-IcingaCheckNLA.md)
+* [Invoke-IcingaCheckPerfcounter](plugins/11-Invoke-IcingaCheckPerfcounter.md)
+* [Invoke-IcingaCheckProcessCount](plugins/12-Invoke-IcingaCheckProcessCount.md)
+* [Invoke-IcingaCheckService](plugins/13-Invoke-IcingaCheckService.md)
+* [Invoke-IcingaCheckUpdates](plugins/14-Invoke-IcingaCheckUpdates.md)
+* [Invoke-IcingaCheckUptime](plugins/15-Invoke-IcingaCheckUptime.md)
+* [Invoke-IcingaCheckUsedPartitionSpace](plugins/16-Invoke-IcingaCheckUsedPartitionSpace.md)
+* [Invoke-IcingaCheckUsers](plugins/17-Invoke-IcingaCheckUsers.md)

doc/plugins/02-Invoke-IcingaCheckCertificate.md

@@ -0,0 +1,66 @@
+
+# Invoke-IcingaCheckCertificate
+
+## Description
+
+Check whether a certificate is still trusted and when it runs out or starts.
+
+Invoke-IcingaCheckCertificate returns either 'OK', 'WARNING' or 'CRITICAL', based on the thresholds set.
+e.g a certificate will run out in 30 days, WARNING is set to '20d:', CRITICAL is set to '50d:'. In this case the check will return 'WARNING'.
+
+More Information on https://github.com/Icinga/icinga-powershell-plugins
+
+## Arguments
+
+| Argument | Type | Required | Default | Description |
+| ---      | ---  | ---      | ---     | ---         |
+| Trusted | SwitchParameter | false | False | Used to switch on trusted behavior. Whether to check, If the certificate is trusted by the system root. Will return Critical in case of untrust.  Note: it is currently required that the root and intermediate CA is known and trusted by the local system. |
+| CriticalStart | Object | false |  | Used to specify a date. The start date of the certificate has to be past the date specified, otherwise the check results in critical. Use carefully. Use format like: 'yyyy-MM-dd' |
+| WarningEnd | Object | false | 30d: | Used to specify a Warning range for the end date of an certificate. In this case a string. Allowed units include: ms, s, m, h, d, w, M, y |
+| CriticalEnd | Object | false | 10d: | Used to specify a Critical range for the end date of an certificate. In this case a string. Allowed units include: ms, s, m, h, d, w, M, y |
+| CertStore | String | false |  | Used to specify which CertStore to check. Valid choices are '*', 'LocalMachine', 'CurrentUser', '' |
+| CertThumbprint | Array | false |  | Used to specify an array of Thumbprints, which are used to determine what certificate to check, within the CertStore. |
+| CertSubject | Array | false |  | Used to specify an array of Subjects, which are used to determine what certificate to check, within the CertStore. |
+| CertStorePath | Object | false | * | Used to specify which path within the CertStore should be checked. |
+| CertPaths | Array | false |  | Used to specify an array of paths on your system, where certificate files are. Use with CertName. |
+| CertName | Array | false |  | Used to specify an array of certificate names of certificate files to check. Use with CertPaths. |
+| Recurse | SwitchParameter | false | False |  |
+| Verbosity | Int32 | false | 3 | Other |
+
+## Examples
+
+### Example Command 1
+
+```powershell
+You can check certificates in the local certificate store of Windows:
+```
+
+### Example Output 1
+
+```powershell
+PS> Invoke-IcingaCheckCertificate -CertStore 'LocalMachine' -CertStorePath 'My' -CertSubject '*' -WarningEnd '30d:' -CriticalEnd '10d:'[OK] Check package "Certificates" (Match All)\_ [OK] Certificate 'test.example.com' (valid until 2033-11-19 : 4993d) valid for: 431464965.59
+```
+
+### Example Command 2
+
+```powershell
+Also a directory with a file name pattern is possible:
+```
+
+### Example Output 2
+
+```powershell
+PS> Invoke-IcingaCheckCertificate -CertPaths "C:\ProgramData\icinga2\var\lib\icinga2\certs" -CertName '*.crt' -WarningEnd '10000d:'[WARNING] Check package "Certificates" (Match All) - [WARNING] Certificate 'test.example.com' (valid until 2033-11-19 : 4993d) valid for, Certificate 'Icinga CA' (valid until 2032-09-18 : 4566d) valid for\_ [WARNING] Certificate 'test.example.com' (valid until 2033-11-19 : 4993d) valid for: Value "431464907.76" is lower than threshold "864000000"\_ [WARNING] Certificate 'Icinga CA' (valid until 2032-09-18 : 4566d) valid for: Value "394583054.72" is lower than threshold "864000000"
+```
+
+### Example Command 3
+
+```powershell
+The checks can be combined into a single check:
+```
+
+### Example Output 3
+
+```powershell
+PS> Invoke-IcingaCheckCertificate -CertStore 'LocalMachine' -CertStorePath 'My' -CertThumbprint '*'-CertPaths "C:\ProgramData\icinga2\var\lib\icinga2\certs" -CertName '*.crt' -Trusted[CRITICAL] Check package "Certificates" (Match All) - [CRITICAL] Certificate 'test.example.com' trusted, Certificate 'Icinga CA' trusted \_ [CRITICAL] Check package "Certificate 'test.example.com'" (Match All) \_ [OK] Certificate 'test.example.com' (valid until 2033-11-19 : 4993d) valid for: 431464853.88 \_ [CRITICAL] Certificate 'test.example.com' trusted: Value "False" is not matching threshold "True"\_ [CRITICAL] Check package "Certificate 'Icinga CA'" (Match All) \_ [OK] Certificate 'Icinga CA' (valid until 2032-09-18 : 4566d) valid for: 394583000.86 \_ [CRITICAL] Certificate 'Icinga CA' trusted: Value "False" is not matching threshold "True"
+```