PowerShell-Modul · 17.13
Befehlsreferenz
Die folgende Tabelle listet alle Befehle des Moduls auf, was sie tun und welche Berechtigung sie voraussetzen. Ein Strich bedeutet, dass über den Zugriff auf TLSPilot hinaus keine besondere Berechtigung nötig ist. Die Namen der Berechtigungen sind die in Kapitel RBAC beschriebenen.
| Befehl | Was er tut | Berechtigung |
|---|---|---|
| Sitzung, Status und Logs | ||
Set-TLSPilotBaseUrl | Richtet die aktuelle Sitzung auf einen Management-Host aus. | – |
Get-TLSPilotStatus | Version, Lizenznutzung, Zustand des Dienstes und letzter Zyklus. | – |
Get-TLSPilotApiHealth | Bestätigt, dass die Management API antwortet. | – |
Get-TLSPilotOperation | Zeigt, ob gerade ein Management-Vorgang läuft. | – |
Get-TLSPilotLog | Liest das Operational-, Audit- oder Debug-Log. | –; canManageRbac für -Kind audit |
Get-TLSPilotMe | Listet Ihre Berechtigungen auf. | – |
| Lizenz | ||
Get-TLSPilotLicense | Liest die Lizenz, einschliesslich der Seat-Nutzung. | – |
Invoke-TLSPilotLicenseCheck | Führt die Online-Lizenzprüfung aus. Kein -WhatIf. | canManageLicense |
Unlock-TLSPilotLicense | Bindet diesen Host mit einem Einmalschlüssel. Einmalig verwendbar, kein -WhatIf. | canManageLicense |
| Zertifikate | ||
Get-TLSPilotCertificate | Listet Zertifikate und ihren aktuellen Zustand auf. | – |
New-TLSPilotCertificate | Erstellt ein Zertifikat, optional im DNS-01 Alias Mode. | canCreateCertificates |
Set-TLSPilotCertificate | Speichert ein geändertes Zertifikat; schaltet den DNS-01 Alias Mode mit -DnsValidation und -DnsAliasDomain um. Kein -WhatIf. | canModifyCertificate |
Get-TLSPilotDnsAliasRecords | Listet die CNAME-Records für den DNS-01 Alias Mode auf. Lokal, keine DNS-Abfrage. | – |
Test-TLSPilotDnsAliasRecords | Prüft diese CNAME-Records über DNS over HTTPS. Lokal. | – |
Remove-TLSPilotCertificate | Entfernt ein Zertifikat aus TLSPilot. | canDeleteCertificate |
Invoke-TLSPilotCertificateRenew | Erzwingt jetzt eine Erneuerung. | canForceRenew |
Export-TLSPilotCertificate | Exportiert das Zertifikat oder den Schlüssel als PFX oder PEM, mit Ketten-Optionen. | canExportKeyMaterial |
Invoke-TLSPilotCertificateRevoke | Widerruft das Zertifikat bei der CA. Lässt sich nicht rückgängig machen. | canRevokeCertificate |
Invoke-TLSPilotCertificateRollback | Aktiviert eine aufbewahrte frühere Version. | canModifyCertificate |
Get-TLSPilotCertificateVersion | Listet die aufbewahrten Versionen auf. | – |
| Deployments | ||
Get-TLSPilotDeployment | Listet die Deployments eines Zertifikats auf. | – |
New-TLSPilotDeployment | Fügt ein Deployment-Ziel hinzu, bei Dateizielen mit Ketten-Optionen. | canEditDeployments |
Set-TLSPilotDeployment | Ändert, aktiviert oder deaktiviert ein Ziel. | canEditDeployments |
Remove-TLSPilotDeployment | Entfernt ein Ziel. Das Zertifikat bleibt darauf installiert. | canEditDeployments |
Start-TLSPilotDeployment | Installiert das aktuelle Zertifikat erneut auf seinen Zielen. | canDeploy |
Test-TLSPilotDeployment | Prüft ein Ziel, ohne etwas zu installieren. | canDeploy |
Get-TLSPilotDeploymentHistory | Listet frühere Versuche und ihre Ergebnisse auf. | – |
| Zyklus und Health | ||
Start-TLSPilotCycle | Führt den täglichen Zyklus jetzt aus, für den ganzen Host. Kein -WhatIf. | canTriggerCycle |
Test-TLSPilotHealth | Prüft, ob Zertifikate auf ihren Zielen verwendet werden. | canDeploy, für -DeploymentId |
| Credentials | ||
Set-TLSPilotCredential | Erstellt, aktualisiert oder benennt ein Credential um. | canManageCredentials |
Get-TLSPilotCredential | Listet Credentials auf. Gibt nie das Secret zurück. | – |
Remove-TLSPilotCredential | Löscht ein Credential. | canManageCredentials |
| Backup | ||
New-TLSPilotBackup | Erstellt ein Konfigurations-Backup. | canManageSettings |
Get-TLSPilotBackup | Listet die Backups auf dem Management-Host auf. | canManageSettings |
Remove-TLSPilotBackup | Löscht eine Backup-Datei. | canManageSettings |
| Private CA | ||
Get-TLSPilotPrivateCa | Zustand und aktuelle Version der Private CA. | – |
Export-TLSPilotPrivateCa | Schreibt das CA-Zertifikat in eine Datei. | canManageSettings |
Export-TLSPilotPrivateCaCrl | Schreibt die Zertifikatssperrliste in eine Datei. | canManageSettings |
| Konfiguration | ||
Get-TLSPilotConfig | Liest das Konfigurationsdokument. | – |
Get-TLSPilotAcmeProvider | Listet die konfigurierten ACME-Provider auf, optional gefiltert mit -Id. | canManageSettings |
Set-TLSPilotAcmeEmergency | Schaltet die globale Notfalloption Renew immediately on CA emergency ein oder aus (-Enabled). | canManageSettings |