saltext.vmware.states.vmc_public_ip#

VMC Public IP state module

Add new public IP, update name of an existing public IP and delete existing public IP from an SDDC.

Example usage :

TEST_PUBLIC_IP:
  vmc_public_ip.present:
    - name: TEST_PUBLIC_IP
    - hostname: sample-nsx.vmwarevmc.com
    - refresh_key: 7jPSGSZpCa8e5Ouks4UY5cZyOtynshs
    - authorization_host: console-stg.cloud.vmware.com
    - org_id: 10e1092f-51d0-473a-80f8-137652c39fd0
    - sddc_id: b43da080-2626-f64c-88e8-7f31d9d2c306
    - verify_ssl: False
    - cert: /path/to/client/certificate

Warning

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

saltext.vmware.states.vmc_public_ip.present(name, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None, display_name=None)[source]#

Ensure a given public IP exists for given SDDC.

name: Indicates the ID and name that the public IP will be created with, any unique string identifying the public IP.
hostname: The host name of NSX-T manager.
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations.
authorization_host: Hostname of the VMC cloud console.
org_id: The ID of organization to which the SDDC belongs to.
sddc_id: The ID of SDDC to which public IP should belong to.
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.
display_name: Indicates the new name of the public IP. This is required if you want to update name of the existing public IP.

saltext.vmware.states.vmc_public_ip.absent(name, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Ensure a given public IP does not exist on given SDDC.

name: Indicates the public IP ID, any unique string identifying the public IP.
hostname: The host name of NSX-T manager.
refresh_key: API Token of the user which is used to get the Access Token required for VMC operations.
authorization_host: Hostname of the VMC cloud console.
org_id: The ID of organization to which the SDDC belongs to.
sddc_id: The ID of SDDC to which the public IP belongs to.
verify_ssl: (Optional) Option to enable/disable SSL verification. Enabled by default. If set to False, the certificate validation is skipped.
cert: (Optional) Path to the SSL client certificate file to connect to VMC Cloud Console. The certificate can be retrieved from browser.