diff --git a/lib/core/icingaagent/installer/Install-IcingaAgentCertificates.psm1 b/lib/core/icingaagent/installer/Install-IcingaAgentCertificates.psm1 index 8aee956..0ae7f4e 100644 --- a/lib/core/icingaagent/installer/Install-IcingaAgentCertificates.psm1 +++ b/lib/core/icingaagent/installer/Install-IcingaAgentCertificates.psm1 @@ -1,3 +1,47 @@ +<# +.SYNOPSIS + Installs the required certificates for the Icinga Agent including the entire + signing process either by using the CA-Proxy, the CA-Server directly or + by manually signing the request on the CA master +.DESCRIPTION + Installs the required certificates for the Icinga Agent including the entire + signing process either by using the CA-Proxy, the CA-Server directly or + by manually signing the request on the CA master +.FUNCTIONALITY + Creates, installs and signs required certificates for the Icinga Agent +.EXAMPLE + # Connect to the CA server with a ticket to fully complete the request + PS>Install-IcingaAgentCertificates -Hostname 'windows.example.com' -Endpoint 'icinga2.example.com' -Ticket 'my_secret_ticket'; +.EXAMPLE + # Connect to the CA server without a ticket, to create the sign request on the master + PS>Install-IcingaAgentCertificates -Hostname 'windows.example.com' -Endpoint 'icinga2.example.com'; +.EXAMPLE + # Uses the Icinga ca.crt from a local filesystem and prepares the Icinga Agent for receiving connections from the Master/Satellite for signing + PS>Install-IcingaAgentCertificates -Hostname 'windows.example.com' -CACert 'C:\users\public\icinga2\ca.crt'; +.EXAMPLE + # Uses the Icinga ca.crt from a web resource and prepares the Icinga Agent for receiving connections from the Master/Satellite for signing + PS>Install-IcingaAgentCertificates -Hostname 'windows.example.com' -CACert 'https://example.com/icinga2/ca.crt'; +.PARAMETER Hostname + The hostname of the local system. Has to match the object name within the Icinga configuration +.PARAMETER Endpoint + The address of either the Icinga CA master or a parent node of the Agent to transmit the request to the CA master +.PARAMETER Port + The port used for Icinga communication. Uses 5665 as default +.PARAMETER CACert + Allows to specify the path to the ca.crt from the Icinga CA master on a local, network or web share to allow certificate generation + in case the Icinga Agent is not able to connect to it's parent hosts +.PARAMETER Ticket + The ticket number for the signing request which is either generated by Icinga 2 or the Icinga Director +.PARAMETER Force + Ignores existing certificates and will force the creation, overriding existing certificates +.INPUTS + System.String +.OUTPUTS + System.Boolean +.LINK + https://github.com/Icinga/icinga-powershell-framework +#> + function Install-IcingaAgentCertificates() { param(