{"id":25190150,"url":"https://github.com/keyfactor/vmware-nsx-orchestrator","last_synced_at":"2025-09-03T00:34:03.771Z","repository":{"id":72061217,"uuid":"592941698","full_name":"Keyfactor/vmware-nsx-orchestrator","owner":"Keyfactor","description":"This orchestrator interfaces with the VMware NSX Advanced Load Balancer (ALB) which was formerly known as Avi Vantage from Avi Networks.","archived":false,"fork":false,"pushed_at":"2025-03-11T21:42:05.000Z","size":181,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-11T22:24:31.964Z","etag":null,"topics":["keyfactor-universal-orchestrator"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Keyfactor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-24T21:29:32.000Z","updated_at":"2024-07-25T15:28:13.000Z","dependencies_parsed_at":"2025-02-17T18:28:55.944Z","dependency_job_id":"d0db7ec0-17cf-47dd-a84b-2eba2ee6b34c","html_url":"https://github.com/Keyfactor/vmware-nsx-orchestrator","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Keyfactor%2Fvmware-nsx-orchestrator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Keyfactor%2Fvmware-nsx-orchestrator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Keyfactor%2Fvmware-nsx-orchestrator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Keyfactor%2Fvmware-nsx-orchestrator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Keyfactor","download_url":"https://codeload.github.com/Keyfactor/vmware-nsx-orchestrator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247167843,"owners_count":20895015,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["keyfactor-universal-orchestrator"],"created_at":"2025-02-09T21:19:04.567Z","updated_at":"2025-09-03T00:34:03.709Z","avatar_url":"https://github.com/Keyfactor.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\" style=\"border-bottom: none\"\u003e\n    VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator Extension\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003c!-- Badges --\u003e\n\u003cimg src=\"https://img.shields.io/badge/integration_status-production-3D1973?style=flat-square\" alt=\"Integration Status: production\" /\u003e\n\u003ca href=\"https://github.com/Keyfactor/vmware-nsx-orchestrator/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/Keyfactor/vmware-nsx-orchestrator?style=flat-square\" alt=\"Release\" /\u003e\u003c/a\u003e\n\u003cimg src=\"https://img.shields.io/github/issues/Keyfactor/vmware-nsx-orchestrator?style=flat-square\" alt=\"Issues\" /\u003e\n\u003cimg src=\"https://img.shields.io/github/downloads/Keyfactor/vmware-nsx-orchestrator/total?style=flat-square\u0026label=downloads\u0026color=28B905\" alt=\"GitHub Downloads (all assets, all releases)\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003c!-- TOC --\u003e\n  \u003ca href=\"#support\"\u003e\n    \u003cb\u003eSupport\u003c/b\u003e\n  \u003c/a\u003e\n  ·\n  \u003ca href=\"#installation\"\u003e\n    \u003cb\u003eInstallation\u003c/b\u003e\n  \u003c/a\u003e\n  ·\n  \u003ca href=\"#license\"\u003e\n    \u003cb\u003eLicense\u003c/b\u003e\n  \u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/orgs/Keyfactor/repositories?q=orchestrator\"\u003e\n    \u003cb\u003eRelated Integrations\u003c/b\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Overview\n\nThe VMware NSX ALB certificate store type is set up so that each Certificate Store points to a specific NSX ALB instance (and optionally a specific tenant) and certificate type.\nIt is able to Inventory and Manage Application, System, and CA certificates.\n\nApplication and System certs are used by NSX ALB for SSL offloading and require private keys. CA certs are used to build and validate certificate chains and do not require private keys.\n\n\n\n## Compatibility\n\nThis integration is compatible with Keyfactor Universal Orchestrator version 10.1 and later.\n\n## Support\nThe VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.\n\n\u003e To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.\n\n## Requirements \u0026 Prerequisites\n\nBefore installing the VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.\n\n\nThe NSX ALB platform needs some configuration in order to allow the Orchestrator to communicate with it.\nThe listed SSL/TLS certificate under Administration -\u003e Settings -\u003e Access Settings  needs to be trusted by the Orchestrator so that HTTPS can be used successfully.\n\nA user also needs to be set up with a password that can be used to authenticate during Orchestrator requests. This user should be a Tenant Admin or Security Admin on the tenant that will be managed.\nIf a user should be used for multiple tenants, they will need to be a system admin. The tenant that they are initially assigned to be will be considered the \"default\" tenant if no tenant is specified for the certificate store.\n\nWhen creating the store, if a tenant other than the API user's default tenant should be used, the Client Machine should be prefaced with [tenant] in brackets. If the [tenant] is not specified, you may not see the certificates you expect to see if they are in a different tenant.\nFor multiple certificate types on the same NSX instance, create a certificate store for each type to manage. If certificates under multiple tenants need to be managed, a seperate certificate store for each tenant should be created.\n\nExample:\n| Certs to target | Client Machine | Store Path |\n| - | - | - |\n| CA certs in user's default configured tenant | https://my.nsx.url/ | CA |\n| Application certs in tenant \"Operations\" | [Operations]https://my.nsx.url/ | Application |\n| System certs in tenant \"IT\" | [IT]https://my.nsx.url/ | System |\n\nThe required alias acts as the name for the certificate in the VMware NSX ALB system. These are also used to renew/replace and delete existing certificates.\nWhen adding a certificate, selecting `Overwrite` and entering the same name (alias) as an existing certificate will replace that certificate, allowing for renewals of existing certificates.\n\nAdditionally, while private keys are optional for CA type certificates, they _are required_ for Application or Controller type certificates.\n\n\n## VMware-NSX Certificate Store Type\n\nTo use the VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension, you **must** create the VMware-NSX Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.\n\n\n\n\n\n\n\n\n#### Supported Operations\n\n| Operation    | Is Supported                                                                                                           |\n|--------------|------------------------------------------------------------------------------------------------------------------------|\n| Add          | ✅ Checked        |\n| Remove       | ✅ Checked     |\n| Discovery    | 🔲 Unchecked  |\n| Reenrollment | 🔲 Unchecked |\n| Create       | 🔲 Unchecked     |\n\n#### Store Type Creation\n\n##### Using kfutil:\n`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.\nFor more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart)\n   \u003cdetails\u003e\u003csummary\u003eClick to expand VMware-NSX kfutil details\u003c/summary\u003e\n\n   ##### Using online definition from GitHub:\n   This will reach out to GitHub and pull the latest store-type definition\n   ```shell\n   # VMware-NSX\n   kfutil store-types create VMware-NSX\n   ```\n\n   ##### Offline creation using integration-manifest file:\n   If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo.\n   You would first download the [integration-manifest.json](./integration-manifest.json) and then run the following command\n   in your offline environment.\n   ```shell\n   kfutil store-types create --from-file integration-manifest.json\n   ```\n   \u003c/details\u003e\n\n\n#### Manual Creation\nBelow are instructions on how to create the VMware-NSX store type manually in\nthe Keyfactor Command Portal\n   \u003cdetails\u003e\u003csummary\u003eClick to expand manual VMware-NSX details\u003c/summary\u003e\n\n   Create a store type called `VMware-NSX` with the attributes in the tables below:\n\n   ##### Basic Tab\n   | Attribute | Value | Description |\n   | --------- | ----- | ----- |\n   | Name | VMware-NSX | Display name for the store type (may be customized) |\n   | Short Name | VMware-NSX | Short display name for the store type |\n   | Capability | VMware-NSX | Store type name orchestrator will register with. Check the box to allow entry of value |\n   | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add |\n   | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove |\n   | Supports Discovery | 🔲 Unchecked |  Indicates that the Store Type supports Discovery |\n   | Supports Reenrollment | 🔲 Unchecked |  Indicates that the Store Type supports Reenrollment |\n   | Supports Create | 🔲 Unchecked |  Indicates that the Store Type supports store creation |\n   | Needs Server | ✅ Checked | Determines if a target server name is required when creating store |\n   | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |\n   | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |\n   | Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |\n   | Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |\n\n   The Basic tab should look like this:\n\n   ![VMware-NSX Basic Tab](docsource/images/VMware-NSX-basic-store-type-dialog.png)\n\n   ##### Advanced Tab\n   | Attribute | Value | Description |\n   | --------- | ----- | ----- |\n   | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |\n   | Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |\n   | PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |\n\n   The Advanced tab should look like this:\n\n   ![VMware-NSX Advanced Tab](docsource/images/VMware-NSX-advanced-store-type-dialog.png)\n\n   \u003e For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.\n\n   ##### Custom Fields Tab\n   Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:\n\n   | Name | Display Name | Description | Type | Default Value/Options | Required |\n   | ---- | ------------ | ---- | --------------------- | -------- | ----------- |\n   | ServerUsername | Server Username | The username of the user to log on as in VMware NSX ALB. | Secret |  | ✅ Checked |\n   | ServerPassword | Server Password | The password of the user to log on as in VMware NSX ALB. | Secret |  | ✅ Checked |\n   | ApiVersion | X-Avi-Version | The API Version of Avi / NSX to target. A default is set for the version this was originally developed and tested against. | String | 20.1.1 | ✅ Checked |\n\n   The Custom Fields tab should look like this:\n\n   ![VMware-NSX Custom Fields Tab](docsource/images/VMware-NSX-custom-fields-store-type-dialog.png)\n\n   \u003c/details\u003e\n\n## Installation\n\n1. **Download the latest VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension from GitHub.**\n\n    Navigate to the [VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/vmware-nsx-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.\n\n   | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `vmware-nsx-orchestrator` .NET version to download |\n   | --------- | ----------- | ----------- | ----------- |\n   | Older than `11.0.0` | | | `net6.0` |\n   | Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |\n   | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |\n   | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |\n   | `11.6` _and_ newer | `net8.0` | | `net8.0` |\n\n    Unzip the archive containing extension assemblies to a known location.\n\n    \u003e **Note** If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for `net6.0`.\n\n2. **Locate the Universal Orchestrator extensions directory.**\n\n    * **Default on Windows** - `C:\\Program Files\\Keyfactor\\Keyfactor Orchestrator\\extensions`\n    * **Default on Linux** - `/opt/keyfactor/orchestrator/extensions`\n\n3. **Create a new directory for the VMware NSX Advanced Load Balancer (Avi) Universal Orchestrator extension inside the extensions directory.**\n\n    Create a new directory called `vmware-nsx-orchestrator`.\n    \u003e The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.\n\n4. **Copy the contents of the downloaded and unzipped assemblies from __step 2__ to the `vmware-nsx-orchestrator` directory.**\n\n5. **Restart the Universal Orchestrator service.**\n\n    Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).\n\n\n6. **(optional) PAM Integration**\n\n    The VMware NSX Advanced Load Balancer (Avi) 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.\n\n    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).\n\n\n\u003e The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).\n\n\n\n## Defining Certificate Stores\n\n\n\n### Store Creation\n\n#### Manually with the Command UI\n\n\u003cdetails\u003e\u003csummary\u003eClick to expand details\u003c/summary\u003e\n\n1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.**\n\n    Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_.\n\n2. **Add a Certificate Store.**\n\n    Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.\n\n   | Attribute | Description                                             |\n   | --------- |---------------------------------------------------------|\n   | Category | Select \"VMware-NSX\" or the customized certificate store name from the previous step. |\n   | Container | Optional container to associate certificate store with. |\n   | Client Machine | This is the URL for the VMware NSX instance. It also includes an optional tenant in square brackets before the URL. A tenant value is required when the certificates being managed are in a different tenant from the default tenant set for the NSX User specified for the store. This should look like either: [optional-tenant-name]https://my.nsx.url/ OR https://my.nsx.url/  |\n   | Store Path | A selection from the different certificate types supported: Application, Controller, or CA. |\n   | Orchestrator | Select an approved orchestrator capable of managing `VMware-NSX` certificates. Specifically, one with the `VMware-NSX` capability. |\n   | ServerUsername | The username of the user to log on as in VMware NSX ALB. |\n   | ServerPassword | The password of the user to log on as in VMware NSX ALB. |\n   | ApiVersion | The API Version of Avi / NSX to target. A default is set for the version this was originally developed and tested against. |\n\n\u003c/details\u003e\n\n\n\n#### Using kfutil CLI\n\n\u003cdetails\u003e\u003csummary\u003eClick to expand details\u003c/summary\u003e\n\n1. **Generate a CSV template for the VMware-NSX certificate store**\n\n    ```shell\n    kfutil stores import generate-template --store-type-name VMware-NSX --outpath VMware-NSX.csv\n    ```\n2. **Populate the generated CSV file**\n\n    Open the CSV file, and reference the table below to populate parameters for each **Attribute**.\n\n   | Attribute | Description |\n   | --------- | ----------- |\n   | Category | Select \"VMware-NSX\" or the customized certificate store name from the previous step. |\n   | Container | Optional container to associate certificate store with. |\n   | Client Machine | This is the URL for the VMware NSX instance. It also includes an optional tenant in square brackets before the URL. A tenant value is required when the certificates being managed are in a different tenant from the default tenant set for the NSX User specified for the store. This should look like either: [optional-tenant-name]https://my.nsx.url/ OR https://my.nsx.url/  |\n   | Store Path | A selection from the different certificate types supported: Application, Controller, or CA. |\n   | Orchestrator | Select an approved orchestrator capable of managing `VMware-NSX` certificates. Specifically, one with the `VMware-NSX` capability. |\n   | Properties.ServerUsername | The username of the user to log on as in VMware NSX ALB. |\n   | Properties.ServerPassword | The password of the user to log on as in VMware NSX ALB. |\n   | Properties.ApiVersion | The API Version of Avi / NSX to target. A default is set for the version this was originally developed and tested against. |\n\n3. **Import the CSV file to create the certificate stores**\n\n    ```shell\n    kfutil stores import csv --store-type-name VMware-NSX --file VMware-NSX.csv\n    ```\n\n\u003c/details\u003e\n\n\n#### PAM Provider Eligible Fields\n\u003cdetails\u003e\u003csummary\u003eAttributes eligible for retrieval by a PAM Provider on the Universal Orchestrator\u003c/summary\u003e\n\nIf 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_.\n\n   | Attribute | Description |\n   | --------- | ----------- |\n   | ServerUsername | The username of the user to log on as in VMware NSX ALB. |\n   | ServerPassword | The password of the user to log on as in VMware NSX ALB. |\n\nPlease 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.\n\u003e 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.\n\n\u003c/details\u003e\n\n\n\u003e The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).\n\n\n\n\n\n## License\n\nApache License 2.0, see [LICENSE](LICENSE).\n\n## Related Integrations\n\nSee all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyfactor%2Fvmware-nsx-orchestrator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeyfactor%2Fvmware-nsx-orchestrator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyfactor%2Fvmware-nsx-orchestrator/lists"}