Controller: /nodeworx/ssl ========================= :Required Permissions: SSL Action: ``altName`` ------------------- :Added in Version: 6.3.4-1640 :Description: Show ssl alt names an ssl certificate. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``service`` - string - Yes - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit an ssl certificate. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``service`` - string - Yes - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - - * - ``key`` - string - No* - - -----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCz1xcJy4gvZBxX dtaCBt7z38xQHpWtLEG2K97sx+tLzMfAJf2A5iVuFqkVkouEZVT1SRgJ2XWCw19P KoPUYDv9HP5gWtg9Q0vBhXqg2UHLy6L25gYKP5LKfL7o7HJb88Et0SUCcpimA7fE VipMzLjkoyg9b8sm1XooEOuZwM/4ehZMJBzPa3s2Pk6WNvkVgqOINjHFQzAQBQfv z+jXKR3KnixSTJ6FlcdeqVbR3NNVJWwfmokfW0i9zO0FZlcy22ejmgnlrVL3BhHB vyTA9zLriTTDR0EL/enRRg/jt/waVm1ZWpCHcEY1GyNFmUPDpW0LSStIaBLVngQr LVVWrVDFAgMBAAECggEACSSyYykZ727jkf7UwR+gTj3eoWQsr/VEEgMA/oDbkasD rN1BmkAZPxOf3RzqQvzz6NSiiD2qH8/XFKtQsIeEBUZoGHYF8HdvbpNevLbPBZGA 45SmUfcRe4IEIsuCtPIbrDyp6QnygN5HhY/r7qOp8tXowdbhOUQ5Rbg2gkavTC6z CWMSalERaksx1nlwnyDMpL3icdKd/M/TbHvDxZCzI83R/TPHsysfA1qwhKqt7L8h G1Z31apkBop0YHXSNGD+XM22JRS7Sbdv/EDQwMdrDTZ0rxq+8HAqHf40WXvaLHdJ tQlKae36CeAwvLGdiL+nCpWYydfwZqznRj3Wn4CGAQKBgQDZ7lDbaCPg3o/kCgrw nIB2kM6csxWElALz/IVZXVOFGJ059WeZ0ztqShAUsNazOB+Uqna8Rd3z5wjLCT8h uJ4zjixCDulaP/q0s0EnVICdqFo0PtRAt49dzAqi0VkKgV6R50igUc/WNpq/sz5M VgQ1tsKO6SsXxb3/VNVu11/bYQKBgQDTQWO2YwRR3QM6K2u36RJ7NyIwmVGkJwwz lLK5K25II1UD9JOCKkysfKZ7pdldUJJ0ALJ2LJplq4zl1UL4dWItzJZtlCmqxjN9 9sRKIcVFT1xXEASD7T18fRA4iyIev+LK00LYTFauswlBFWbH6zvQ0d1S9v/1VE7Q Cx4Op1Hz5QKBgQC5tWpzvaetTRsjASfXaBXUc4uNXtI8WwC1N3/O6kdsyM/afvQc 0jL0XU6cwyECMhY/Uo/B2mvMFxmYIzYIH1G4rzOpyxkxTgnvCD3CLTE4qCjOEqg+ ye1CychafLk6yYl0Hbn23CCW84slRrIUzMvjlezvaWTOajSBK6KBRMkroQKBgHdX hlv/ne4dO/h9lRHFQmKHJ/JqeruQL41oIHsI9PkdtKZSYY50FPKQTICnlZ7oqION 7UNjOSncevFPw9CWh4s1+3kV7WADLg2n/QWgBFB+X7zzWImq2URdZm968iCK6DUK mcWVgpaYn867p1+jHRx/old/H+PY59kRnr5KebqdAoGAIT6RnbNfaIwyBzN0QQ6H wVj1AExTgUAfuQYZ44s1ESBgcDzY9vk/Zd1sGKidSD/x97UUzmTkYPBungXP59yn hmw8aVIJ4dTvxkt74OnvQhHZouc/48LSR9TcMR47+YgQLYjafJ59XtQBekwoLHRz C510vhFw32b3oQ+NLmAiAlo= -----END PRIVATE KEY----- - * - ``crt`` - string - No* - - -----BEGIN CERTIFICATE----- MIIDyTCCArGgAwIBAgIBADANBgkqhkiG9w0BAQsFADCBjTELMAkGA1UEBhMCVVMx CzAJBgNVBAgMAlBBMRMwEQYDVQQHDApQaXR0c2J1cmdoMRIwEAYDVQQKDAlJbnRl cldvcngxEDAOBgNVBAsMB1Rlc3RpbmcxFDASBgNVBAMMC2V4YW1wbGUuY29tMSAw HgYJKoZIhvcNAQkBFhFhZG1pbkBleGFtcGxlLmNvbTAeFw0yMTA4MDkxOTI5MzVa Fw0yMjA4MDkxOTI5MzVaMIGNMQswCQYDVQQGEwJVUzELMAkGA1UECAwCUEExEzAR BgNVBAcMClBpdHRzYnVyZ2gxEjAQBgNVBAoMCUludGVyV29yeDEQMA4GA1UECwwH VGVzdGluZzEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFk bWluQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA s9cXCcuIL2QcV3bWggbe89/MUB6VrSxBtive7MfrS8zHwCX9gOYlbhapFZKLhGVU 9UkYCdl1gsNfTyqD1GA7/Rz+YFrYPUNLwYV6oNlBy8ui9uYGCj+Syny+6OxyW/PB LdElAnKYpgO3xFYqTMy45KMoPW/LJtV6KBDrmcDP+HoWTCQcz2t7Nj5Oljb5FYKj iDYxxUMwEAUH78/o1ykdyp4sUkyehZXHXqlW0dzTVSVsH5qJH1tIvcztBWZXMttn o5oJ5a1S9wYRwb8kwPcy64k0w0dBC/3p0UYP47f8GlZtWVqQh3BGNRsjRZlDw6Vt C0krSGgS1Z4EKy1VVq1QxQIDAQABozIwMDAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF 4DAWBgNVHREEDzANggtleGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEApx2i CrK+Gk8fMPkNGYKlfC1r2m1MiPz0hJ0nX/CSgbEYoq5iNcsJWw3Om5q3Zx6CmXzV lEi90KmQJe5XoUdTrvBYbXrP5fqUbuCwvw82+d6OnVABg214oCWfwzkwN+Vvr10w x0gU7Ug7Ym0W8NMOPiVq9fmCyVdfp6qLyWvosEMalq1FEYxi3kfOu7XWRsqoK0GT TAipwF7PCbLojz/cExnSTZiMGfbtzUb5YhBxnoPBpdG6dM1KVjuyAVv6LfS9p36d QeKHwiU52wV4neUcsv8RGnpWWHEkXGBmP+5+SPj/m87OUI4clfblEM3g7KYPN2XA pJ2UmsZqQCpVf4iO8w== -----END CERTIFICATE----- - * - ``chain`` - string - No - - -----BEGIN CERTIFICATE----- MIIF6zCCA9OgAwIBAgIIahbzsAr4yaAwDQYJKoZIhvcNAQELBQAwezELMAkGA1UE BhMCVVMxFDASBgNVBAoMC1Vuc3BlY2lmaWVkMR8wHQYDVQQLDBZjYS03NjQ0NTY1 MzU0OTMxODY2MDE2MRQwEgYDVQQDDAt0ZW1wLml3eC5pbzEfMB0GCSqGSIb3DQEJ ARYQcm9vdEB0ZW1wLml3eC5pbzAeFw0yNDA1MjgxOTExMTdaFw0yNTA1MjgxOTEx MTdaMHsxCzAJBgNVBAYTAlVTMRQwEgYDVQQKDAtVbnNwZWNpZmllZDEfMB0GA1UE CwwWY2EtNzY0NDU2NTM1NDkzMTg2NjAxNjEUMBIGA1UEAwwLdGVtcC5pd3guaW8x HzAdBgkqhkiG9w0BCQEWEHJvb3RAdGVtcC5pd3guaW8wggIiMA0GCSqGSIb3DQEB AQUAA4ICDwAwggIKAoICAQCxpnE7DTPXqkX8lulID3dYW/2ctlF6N7oyHz9Q5ruu hMI7C/9NuG04PlgPMzbDFpDOsWooZVMKD5TlKvwJQrvyflFKSdRUV5FQNXaG+6Gp rVsfdo7vT55lecKmpdInq9SHlwXSvKm7jeJaATuElPvIJCy8xpsjKwkwrJoFSzKB PYMhoK0RtN3HfOSZVZ68qY8xJRCp1Bnw227krmYAKF/Yb9zUyGbk1L1S8kdPgn92 khvey17Kfi3nv62SsOYx5mXkAYGYAequtGLgQZ2sglueodro2kd7CLbXtQqqO7mn bOlv9ysWTIG1pP3WhxTMR4rH7qgeYj+WU8lYv47KDtPV8efk1scvmpsuQPTbIiIo 942eqm2XnjEpSvtYUx5tvoZnbsn4NXjPxKFx/POpWHqOUMYsU8T/8G/s/SnC09+N CVHFLmMTQRXEFXT+fipBfFlZxffyrchjWmlSPCTRl7FaxaD+B93CpVEV8Zt8rudW j7bH6EzfDCrPVNA3EY2yKW1WlaZ0r0XPmqrnklaFw7Ellb+EvaqZJ7mfw2Aadwdm X3iqfE+huFMfmssYAJyjbZ2j+khnO0Dv6vO3ZO04Ca9r7yFAH0FmZjJyL8gB8RdO brSZRQ5rGnWiCRTBbwY08oub7OJ9aiI2KYBa0fmSoJUfFI47nvn2zTo5+fB3LLa9 wQIDAQABo3MwcTAOBgNVHQ8BAf8EBAMCAqQwDAYDVR0TBAUwAwEB/zAaBgNVHR4E EzARoA8wDYILdGVtcC5pd3guaW8wFgYDVR0RBA8wDYILdGVtcC5pd3guaW8wHQYD VR0OBBYEFLmtJo4/9xqcj2xaEG2+kDBBHKumMA0GCSqGSIb3DQEBCwUAA4ICAQBy GE5dgvMvaRmEhRHKSeVVt5yBcmFCMxOKkj9MVxvwW/+rnQ4JEcj3cA9ztaqK4W23 /gy1YmxhfPQQho57uNO8pS7htA2kAVAuQsFObxJ77xA7oDQnqqE2AMC9OFi9xRUY 8vsH6LHsufIOlx9jpS7yfgqPYoUFQ8vH2pFmGwlT4DEVlXbuxpeIYvRHnLekfd2D guaY3yaqFhLsUB9ILzUmpeysivnnGX8zLuq4k6xkw4PkYYZ3y+pvhLRUIwy6RIPM WbsvObB5wKVsFrP1JqlZvspWkz4pYPFqOLMMEYdgBtbXEHLN7ww9+L2F12Ez6frw A1YdHhR2cnacE7nk7xP1FgesFgMg4RmOL8+SBMozX3k80lkLdj899SxMOuJqT25e QvJNtkzvU05bf+k0+vE2mcpmhErb5h5GmZBT2UNAHFcpovVR2QW8O4fG+w6tEjVO XpZJ8WyhnjW/JlKE+sc1HhRnyLhwUwKsl+kekY9zcOlhiVQLIq4dONPUopx2wFIq 9MDGQg5ejrwIWq1Tg0rSPrZ4ZjGkeA58MrgAZKvJi++jxDXcqN0XJMc7OmnGOYKR 6HvRFLB42DmDsbomOe2AFgxyMA0+m/wtNumDI26cSJR7qJB9kleQeq0sliBQh932 VbenxRRbmYk37xzKym26RqboQYJ/t6CGwYYDtwLGOA== -----END CERTIFICATE----- - * - ``ssl_ciphersuite`` - string - No - - PROFILE=SYSTEM - This complex directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase. * - ``restart_now`` - integer - No* - 1, 0 - 0 - Most services require a restart before a new SSL Certificate can be used. Selecting 'YES' will restart the service immediately and selecting 'NO' will restart the service within 5 minutes. * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually \* indicates that it's actually required, but probably already has a valid default value. Action: ``fail`` ---------------- :Added in Version: n/a :Description: Magic function - test for failure mechanism. Action: ``generate`` -------------------- :Added in Version: 4.7.0-339 :Description: Generate a self-signed SSL cert. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``key_length`` - integer - No* - 2048, 3072, 4096 - 2048 - * - ``expiration_years`` - integer - No* - - 1 - Specifies the number of years before the self-signed SSL certificate expires. * - ``countryName`` - string - No* - US, CA, AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, ... - US - Please enter the 2-letter country code corresponding to your country. * - ``stateOrProvinceName`` - string - Yes - - - Please enter the name of the state or province in which you reside. * - ``localityName`` - string - Yes - - - Please enter the name of the city in which you reside. * - ``organizationName`` - string - Yes - - - Please enter the name of the company to which this certificate belongs. * - ``organizationalUnitName`` - string - Yes - - - Please enter the name of the company division to which this certificate belongs. * - ``commonName`` - string - Yes - - - Please select the domain name (common name) this certificate will use. If you do not see your desired domain, you will first need to add it as a pointerdomain or as a subdomain in SiteWorx.

Note that 'www.domain.com' is not the same as 'domain.com'.

A wildcard domain begins with an asterisk, '\*', and is valid for all subdomains. For example, a Common Name of '\*.domain.com' would create a CSR that is valid for 'domain.com', 'sub1.domain.com', 'sub2.domain.com', and so on. * - ``subjectAltName`` - struct (string) - No - - - In addition to the primary domain, other domains may be included on the certificate. * - ``emailAddress`` - string - Yes - - - Please enter the email address that is associated with this certificate. * - ``email_ssl_cert`` - integer - No - 1 - - If this option is selected, an email address can be specified. After the certificate is generated, it will be sent to that address. * - ``copy_to_email`` - string - No - - apidocs@interworx.com - * - ``services`` - struct (string) - No - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - - Select which services will have the SSL certificated automatically installed. * - ``restart_now`` - integer - No - 1, 0 - 0 - Most services require a restart before a new SSL Certificate can be used. Selecting 'YES' will restart the service immediately and selecting 'NO' will restart the service within 5 minutes. \* indicates that it's actually required, but probably already has a valid default value. Action: ``listSslCerts`` ------------------------ :Added in Version: 4.8.0-393 :Description: List installed server SSL Certificates. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'shortname' => 'SSL_Apache', 'name' => 'Web-Server Default SSL', 'domain' => 'temp.iwx.io', 'alt_name' => 'temp.iwx.io', 'is_expired' => false, 'nearly_expired' => false, 'expires' => 1578808273, 'issuer' => 'Unspecified', ), 1 => array ( 'shortname' => 'SSL_IWorxWeb', 'name' => 'InterWorx-SSL', 'domain' => 'default-ssl.interworx.com', 'alt_name' => NULL, 'is_expired' => false, 'nearly_expired' => false, 'expires' => 1578808273, 'issuer' => 'INTERWORX LLC', ), 2 => array ( 'shortname' => 'SSL_Proftpd', 'name' => 'FTP Server', 'domain' => 'localhost.localdomain', 'alt_name' => NULL, 'is_expired' => false, 'nearly_expired' => false, 'expires' => 1578808273, 'issuer' => 'SomeOrganization', ), ), 'reply_code' => 205, ) Action: ``queryEdit`` --------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "edit". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``service`` - string - Yes - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'key' => '-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCz1xcJy4gvZBxX dtaCBt7z38xQHpWtLEG2K97sx+tLzMfAJf2A5iVuFqkVkouEZVT1SRgJ2XWCw19P KoPUYDv9HP5gWtg9Q0vBhXqg2UHLy6L25gYKP5LKfL7o7HJb88Et0SUCcpimA7fE VipMzLjkoyg9b8sm1XooEOuZwM/4ehZMJBzPa3s2Pk6WNvkVgqOINjHFQzAQBQfv z+jXKR3KnixSTJ6FlcdeqVbR3NNVJWwfmokfW0i9zO0FZlcy22ejmgnlrVL3BhHB vyTA9zLriTTDR0EL/enRRg/jt/waVm1ZWpCHcEY1GyNFmUPDpW0LSStIaBLVngQr LVVWrVDFAgMBAAECggEACSSyYykZ727jkf7UwR+gTj3eoWQsr/VEEgMA/oDbkasD rN1BmkAZPxOf3RzqQvzz6NSiiD2qH8/XFKtQsIeEBUZoGHYF8HdvbpNevLbPBZGA 45SmUfcRe4IEIsuCtPIbrDyp6QnygN5HhY/r7qOp8tXowdbhOUQ5Rbg2gkavTC6z CWMSalERaksx1nlwnyDMpL3icdKd/M/TbHvDxZCzI83R/TPHsysfA1qwhKqt7L8h G1Z31apkBop0YHXSNGD+XM22JRS7Sbdv/EDQwMdrDTZ0rxq+8HAqHf40WXvaLHdJ tQlKae36CeAwvLGdiL+nCpWYydfwZqznRj3Wn4CGAQKBgQDZ7lDbaCPg3o/kCgrw nIB2kM6csxWElALz/IVZXVOFGJ059WeZ0ztqShAUsNazOB+Uqna8Rd3z5wjLCT8h uJ4zjixCDulaP/q0s0EnVICdqFo0PtRAt49dzAqi0VkKgV6R50igUc/WNpq/sz5M VgQ1tsKO6SsXxb3/VNVu11/bYQKBgQDTQWO2YwRR3QM6K2u36RJ7NyIwmVGkJwwz lLK5K25II1UD9JOCKkysfKZ7pdldUJJ0ALJ2LJplq4zl1UL4dWItzJZtlCmqxjN9 9sRKIcVFT1xXEASD7T18fRA4iyIev+LK00LYTFauswlBFWbH6zvQ0d1S9v/1VE7Q Cx4Op1Hz5QKBgQC5tWpzvaetTRsjASfXaBXUc4uNXtI8WwC1N3/O6kdsyM/afvQc 0jL0XU6cwyECMhY/Uo/B2mvMFxmYIzYIH1G4rzOpyxkxTgnvCD3CLTE4qCjOEqg+ ye1CychafLk6yYl0Hbn23CCW84slRrIUzMvjlezvaWTOajSBK6KBRMkroQKBgHdX hlv/ne4dO/h9lRHFQmKHJ/JqeruQL41oIHsI9PkdtKZSYY50FPKQTICnlZ7oqION 7UNjOSncevFPw9CWh4s1+3kV7WADLg2n/QWgBFB+X7zzWImq2URdZm968iCK6DUK mcWVgpaYn867p1+jHRx/old/H+PY59kRnr5KebqdAoGAIT6RnbNfaIwyBzN0QQ6H wVj1AExTgUAfuQYZ44s1ESBgcDzY9vk/Zd1sGKidSD/x97UUzmTkYPBungXP59yn hmw8aVIJ4dTvxkt74OnvQhHZouc/48LSR9TcMR47+YgQLYjafJ59XtQBekwoLHRz C510vhFw32b3oQ+NLmAiAlo= -----END PRIVATE KEY-----', 'crt' => '-----BEGIN CERTIFICATE----- MIIDyTCCArGgAwIBAgIBADANBgkqhkiG9w0BAQsFADCBjTELMAkGA1UEBhMCVVMx CzAJBgNVBAgMAlBBMRMwEQYDVQQHDApQaXR0c2J1cmdoMRIwEAYDVQQKDAlJbnRl cldvcngxEDAOBgNVBAsMB1Rlc3RpbmcxFDASBgNVBAMMC2V4YW1wbGUuY29tMSAw HgYJKoZIhvcNAQkBFhFhZG1pbkBleGFtcGxlLmNvbTAeFw0yMTA4MDkxOTI5MzVa Fw0yMjA4MDkxOTI5MzVaMIGNMQswCQYDVQQGEwJVUzELMAkGA1UECAwCUEExEzAR BgNVBAcMClBpdHRzYnVyZ2gxEjAQBgNVBAoMCUludGVyV29yeDEQMA4GA1UECwwH VGVzdGluZzEUMBIGA1UEAwwLZXhhbXBsZS5jb20xIDAeBgkqhkiG9w0BCQEWEWFk bWluQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA s9cXCcuIL2QcV3bWggbe89/MUB6VrSxBtive7MfrS8zHwCX9gOYlbhapFZKLhGVU 9UkYCdl1gsNfTyqD1GA7/Rz+YFrYPUNLwYV6oNlBy8ui9uYGCj+Syny+6OxyW/PB LdElAnKYpgO3xFYqTMy45KMoPW/LJtV6KBDrmcDP+HoWTCQcz2t7Nj5Oljb5FYKj iDYxxUMwEAUH78/o1ykdyp4sUkyehZXHXqlW0dzTVSVsH5qJH1tIvcztBWZXMttn o5oJ5a1S9wYRwb8kwPcy64k0w0dBC/3p0UYP47f8GlZtWVqQh3BGNRsjRZlDw6Vt C0krSGgS1Z4EKy1VVq1QxQIDAQABozIwMDAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF 4DAWBgNVHREEDzANggtleGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEApx2i CrK+Gk8fMPkNGYKlfC1r2m1MiPz0hJ0nX/CSgbEYoq5iNcsJWw3Om5q3Zx6CmXzV lEi90KmQJe5XoUdTrvBYbXrP5fqUbuCwvw82+d6OnVABg214oCWfwzkwN+Vvr10w x0gU7Ug7Ym0W8NMOPiVq9fmCyVdfp6qLyWvosEMalq1FEYxi3kfOu7XWRsqoK0GT TAipwF7PCbLojz/cExnSTZiMGfbtzUb5YhBxnoPBpdG6dM1KVjuyAVv6LfS9p36d QeKHwiU52wV4neUcsv8RGnpWWHEkXGBmP+5+SPj/m87OUI4clfblEM3g7KYPN2XA pJ2UmsZqQCpVf4iO8w== -----END CERTIFICATE-----', 'ssl_ciphersuite' => 'PROFILE=SYSTEM', 'restart_now' => '0', 'service' => 'SSL_Apache', ), 'reply_code' => 205, ) Action: ``reroute`` ------------------- :Added in Version: n/a :Description: Action to re-route from the current controller to a different one. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``controller`` - string - Yes - Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, ... - - Action: ``syncLetsEncrypt`` --------------------------- :Added in Version: 5.1.6-1056 :Description: Syncs LetsEncrypt certs across cluster. Action: ``updateall`` --------------------- :Added in Version: 4.7.0-339 :Description: Update all services to use the same SSL cert. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``cert_source`` - string - No - direct, domain, le - direct - When installing service default SSL certificates, you can choose to install the the certificate files directly, or use the certificate files already installed on a domain in SiteWorx. * - ``key`` - string - No - - - * - ``crt`` - string - No - - - * - ``chain`` - string - No - - - * - ``domain`` - integer - No - - - * - ``le_domain`` - string - No - - apidocs.interworx.com - A domain not used in a SiteWorx account that resolves to the server. - *Domain doesn't resolve to this server or belongs to a SiteWorx account.* * - ``le_mode`` - string - No - staging, live - live - "Live" mode will generate a real LetsEncrypt signed certificate. "Staging" mode will generate a fake certificate that should only be used for testing purposes. * - ``services`` - struct (string) - No* - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - ["SSL_Apache","SSL_IWorxWeb","SSL_Proftpd","SSL_Email_SMTP","SSL_Dovecot"] - Select which services will have the SSL certificated automatically installed. * - ``restart_now`` - integer - No - 1, 0 - 0 - Most services require a restart before a new SSL Certificate can be used. Selecting 'YES' will restart the service immediately and selecting 'NO' will restart the service within 5 minutes. * - ``cascade_to_nodes`` - integer - No - 1 - - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually \* indicates that it's actually required, but probably already has a valid default value. Action: ``view`` ---------------- :Added in Version: 4.7.0-339 :Description: View a given ssl cert, and any related information. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``service`` - string - Yes - SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_SMTP, SSL_Dovecot - - Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.