saltext.vmware.states.nsxt_license#

NSX-T Datacenter License Management state module#

maintainer:

<VMware>

maturity:

new

Add new license and delete existing license from NSX-T Manager.

Example usage :

Ensure license exists:
    nsxt_license.present:
        hostname: 10.11.12.13
        username: admin
        password: admin_password
        license_key: ABCDE-12345-ABCDE-12345-ABCDE
        cert: /path/to/client/certificate

Warning

It is recommended to pass the NSX authentication details using Pillars rather than specifying as plain text in SLS files.

saltext.vmware.states.nsxt_license.__virtual__()[source]#

Only load if the nsxt_license module is available in __salt__

saltext.vmware.states.nsxt_license.present(name, hostname, username, password, license_key, verify_ssl=True, cert=None, cert_common_name=None)[source]#

Ensure a given license exists on given NSX-T Manager

hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

license_key

The license key to be added to NSX-T Manager

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against certificate common name.

saltext.vmware.states.nsxt_license.absent(name, hostname, username, password, license_key, verify_ssl=True, cert=None, cert_common_name=None)[source]#

Ensure a given license does not exist on given NSX-T Manager

hostname

The host name of NSX-T manager

username

Username to connect to NSX-T manager

password

Password to connect to NSX-T manager

verify_ssl

(Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.

license_key

The license key to be removed from NSX-T Manager

cert

(Optional) Path to the SSL client certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

cert_common_name

(Optional) By default, the hostname parameter and the common name in certificate is compared for host name verification. If the client certificate common name and hostname do not match (in case of self-signed certificates), specify the certificate common name as part of this parameter. This value is then used to compare against certificate common name.