Skip to content

Commit 256e63f

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 3278eea commit 256e63f

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ the Keyfactor Command Portal
325325

326326
| Name | Display Name | Description | Type | Default Value/Options | Required |
327327
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
328-
| allowInvalidCert | Allow Invalid Cert on A10 Management API | | Bool | true | ✅ Checked |
328+
| allowInvalidCert | Allow Invalid Cert on A10 Management API | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections. | Bool | true | ✅ Checked |
329329

330330
The Custom Fields tab should look like this:
331331

@@ -568,12 +568,12 @@ the Keyfactor Command Portal
568568

569569
| Name | Display Name | Description | Type | Default Value/Options | Required |
570570
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
571-
| OrchToScpServerIp | Orch To Scp Server Ip | | String | | ✅ Checked |
572-
| ScpPort | Port Used For Scp | | String | | ✅ Checked |
573-
| ScpUserName | UserName Used For Scp | | Secret | | ✅ Checked |
574-
| ScpPassword | Password Used For Scp | | Secret | | ✅ Checked |
575-
| A10ToScpServerIp | A10 Device To Scp Server Ip | | String | | ✅ Checked |
576-
| allowInvalidCert | Allow Invalid Cert on A10 Management API | | Bool | true | ✅ Checked |
571+
| OrchToScpServerIp | Orch To Scp Server Ip | IP address or hostname of the SCP server that the Universal Orchestrator will connect to for uploading certificate files. This SCP server acts as an intermediary storage location before the A10 device retrieves the certificates. | String | | ✅ Checked |
572+
| ScpPort | Port Used For Scp | TCP port number used for SSH/SCP connections to the SCP server. Typically port 22 for standard SSH/SCP operations. | String | | ✅ Checked |
573+
| ScpUserName | UserName Used For Scp | Username credential for authenticating to the SCP server. This account must have write permissions to the target directory path specified in the certificate store configuration. Supports PAM integration for secure credential retrieval. | Secret | | ✅ Checked |
574+
| ScpPassword | Password Used For Scp | Password credential for authenticating to the SCP server. Used in conjunction with ScpUserName for SSH/SCP authentication. Supports PAM integration for secure credential retrieval. | Secret | | ✅ Checked |
575+
| A10ToScpServerIp | A10 Device To Scp Server Ip | IP address or hostname that the A10 vThunder device uses to connect to the SCP server for retrieving certificate files. This may differ from OrchToScpServerIp due to network topology, routing, or firewall configurations where the A10 device and orchestrator access the SCP server through different network paths. | String | | ✅ Checked |
576+
| allowInvalidCert | Allow Invalid Cert on A10 Management API | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections used during the certificate installation process. | Bool | true | ✅ Checked |
577577

578578
The Custom Fields tab should look like this:
579579

@@ -663,7 +663,7 @@ The a10vThunder Universal Orchestrator extension implements 2 Certificate Store
663663
| Client Machine | |
664664
| Store Path | |
665665
| Orchestrator | Select an approved orchestrator capable of managing `ThunderSsl` certificates. Specifically, one with the `ThunderSsl` capability. |
666-
| allowInvalidCert | |
666+
| allowInvalidCert | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections. |
667667

668668
</details>
669669

@@ -689,7 +689,7 @@ The a10vThunder Universal Orchestrator extension implements 2 Certificate Store
689689
| Client Machine | |
690690
| Store Path | |
691691
| Orchestrator | Select an approved orchestrator capable of managing `ThunderSsl` certificates. Specifically, one with the `ThunderSsl` capability. |
692-
| Properties.allowInvalidCert | |
692+
| Properties.allowInvalidCert | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections. |
693693

694694
3. **Import the CSV file to create the certificate stores**
695695

@@ -745,12 +745,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
745745
| Client Machine | |
746746
| Store Path | |
747747
| Orchestrator | Select an approved orchestrator capable of managing `ThunderMgmt` certificates. Specifically, one with the `ThunderMgmt` capability. |
748-
| OrchToScpServerIp | |
749-
| ScpPort | |
750-
| ScpUserName | |
751-
| ScpPassword | |
752-
| A10ToScpServerIp | |
753-
| allowInvalidCert | |
748+
| OrchToScpServerIp | IP address or hostname of the SCP server that the Universal Orchestrator will connect to for uploading certificate files. This SCP server acts as an intermediary storage location before the A10 device retrieves the certificates. |
749+
| ScpPort | TCP port number used for SSH/SCP connections to the SCP server. Typically port 22 for standard SSH/SCP operations. |
750+
| ScpUserName | Username credential for authenticating to the SCP server. This account must have write permissions to the target directory path specified in the certificate store configuration. Supports PAM integration for secure credential retrieval. |
751+
| ScpPassword | Password credential for authenticating to the SCP server. Used in conjunction with ScpUserName for SSH/SCP authentication. Supports PAM integration for secure credential retrieval. |
752+
| A10ToScpServerIp | IP address or hostname that the A10 vThunder device uses to connect to the SCP server for retrieving certificate files. This may differ from OrchToScpServerIp due to network topology, routing, or firewall configurations where the A10 device and orchestrator access the SCP server through different network paths. |
753+
| allowInvalidCert | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections used during the certificate installation process. |
754754

755755
</details>
756756

@@ -776,12 +776,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
776776
| Client Machine | |
777777
| Store Path | |
778778
| Orchestrator | Select an approved orchestrator capable of managing `ThunderMgmt` certificates. Specifically, one with the `ThunderMgmt` capability. |
779-
| Properties.OrchToScpServerIp | |
780-
| Properties.ScpPort | |
781-
| Properties.ScpUserName | |
782-
| Properties.ScpPassword | |
783-
| Properties.A10ToScpServerIp | |
784-
| Properties.allowInvalidCert | |
779+
| Properties.OrchToScpServerIp | IP address or hostname of the SCP server that the Universal Orchestrator will connect to for uploading certificate files. This SCP server acts as an intermediary storage location before the A10 device retrieves the certificates. |
780+
| Properties.ScpPort | TCP port number used for SSH/SCP connections to the SCP server. Typically port 22 for standard SSH/SCP operations. |
781+
| Properties.ScpUserName | Username credential for authenticating to the SCP server. This account must have write permissions to the target directory path specified in the certificate store configuration. Supports PAM integration for secure credential retrieval. |
782+
| Properties.ScpPassword | Password credential for authenticating to the SCP server. Used in conjunction with ScpUserName for SSH/SCP authentication. Supports PAM integration for secure credential retrieval. |
783+
| Properties.A10ToScpServerIp | IP address or hostname that the A10 vThunder device uses to connect to the SCP server for retrieving certificate files. This may differ from OrchToScpServerIp due to network topology, routing, or firewall configurations where the A10 device and orchestrator access the SCP server through different network paths. |
784+
| Properties.allowInvalidCert | Boolean value specifying whether to allow connections to the A10 vThunder management API when it presents an invalid or self-signed SSL/TLS certificate. Set to true to bypass certificate validation for AXAPI connections used during the certificate installation process. |
785785

786786
3. **Import the CSV file to create the certificate stores**
787787

@@ -801,8 +801,8 @@ If a PAM provider was installed _on the Universal Orchestrator_ in the [Installa
801801
| --------- | ----------- |
802802
| ServerUsername | Username to use when connecting to server |
803803
| ServerPassword | Password to use when connecting to server |
804-
| ScpUserName | |
805-
| ScpPassword | |
804+
| ScpUserName | Username credential for authenticating to the SCP server. This account must have write permissions to the target directory path specified in the certificate store configuration. Supports PAM integration for secure credential retrieval. |
805+
| ScpPassword | Password credential for authenticating to the SCP server. Used in conjunction with ScpUserName for SSH/SCP authentication. Supports PAM integration for secure credential retrieval. |
806806

807807
Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
808808
> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.

0 commit comments

Comments
 (0)