Skip to content

Commit ae0caa0

Browse files
author
Lee Fine
committed
Merge branch 'ab#67386' of https://github.com/Keyfactor/citrix-adc-orchestrator into ab#67386
2 parents 1349b4a + 69570c0 commit ae0caa0

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ To use the Citrix Netscaler Universal Orchestrator extension, you **must** creat
122122

123123
| Name | Display Name | Description | Type | Default Value/Options | Required |
124124
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
125+
| ServerUsername | Server Username | The Citrix username (or valid PAM key if the username is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. | Secret | | 🔲 Unchecked |
126+
| ServerPassword | Server Password | The Citrix password (or valid PAM key if the password is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. | Secret | | 🔲 Unchecked |
125127
| linkToIssuer | Link To Issuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. | Bool | false | 🔲 Unchecked |
126128

127129
The Custom Fields tab should look like this:
@@ -179,6 +181,12 @@ To use the Citrix Netscaler Universal Orchestrator extension, you **must** creat
179181
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
180182
181183
184+
6. **(optional) PAM Integration**
185+
186+
The Citrix Netscaler Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.
187+
188+
To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension, and follow the associated instructions to install it on the Universal Orchestrator (remote).
189+
182190
183191
> The above installation steps can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
184192
@@ -212,11 +220,28 @@ An optional config.json configuration file has been provided in the extensions f
212220
| Client Machine | The DNS or IP Address of the Citrix ADC Appliance. |
213221
| Store Path | The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/ |
214222
| Orchestrator | Select an approved orchestrator capable of managing `CitrixAdc` certificates. Specifically, one with the `CitrixAdc` capability. |
223+
| ServerUsername | The Citrix username (or valid PAM key if the username is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
224+
| ServerPassword | The Citrix password (or valid PAM key if the password is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
215225
| linkToIssuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. |
216226
217227
218228
219229
230+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
231+
232+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
233+
| Attribute | Description |
234+
| --------- | ----------- |
235+
| ServerUsername | The Citrix username (or valid PAM key if the username is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
236+
| ServerPassword | The Citrix password (or valid PAM key if the password is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
237+
238+
239+
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.
240+
241+
> 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.
242+
</details>
243+
244+
220245
</details>
221246
222247
* **Using kfutil**
@@ -238,11 +263,26 @@ An optional config.json configuration file has been provided in the extensions f
238263
| Client Machine | The DNS or IP Address of the Citrix ADC Appliance. |
239264
| Store Path | The path where certificate files are located on the Citrix ADC appliance. This value will likely be /nsconfig/ssl/ |
240265
| Orchestrator | Select an approved orchestrator capable of managing `CitrixAdc` certificates. Specifically, one with the `CitrixAdc` capability. |
266+
| ServerUsername | The Citrix username (or valid PAM key if the username is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
267+
| ServerPassword | The Citrix password (or valid PAM key if the password is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
241268
| linkToIssuer | Determines whether an attempt will be made to link the added certificate (via a Management-Add job) to its issuing CA certificate. |
242269
243270
244271
245272
273+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
274+
275+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
276+
| Attribute | Description |
277+
| --------- | ----------- |
278+
| ServerUsername | The Citrix username (or valid PAM key if the username is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
279+
| ServerPassword | The Citrix password (or valid PAM key if the password is stored in a KF Command configured PAM integration) to be used to log into the Citrix device. |
280+
281+
282+
> 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.
283+
</details>
284+
285+
246286
3. **Import the CSV file to create the certificate stores**
247287
248288
```shell

0 commit comments

Comments
 (0)