saltext.vmware.modules.vmc_public_ip#

Salt execution module for public IP Provides methods to Create, Update, Read and Delete public IP.

saltext.vmware.modules.vmc_public_ip.list_(hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None, cursor=None, page_size=None, sort_by=None, sort_ascending=None)[source]#

Retrieves public IPs from given SDDC.

CLI Example:

salt vm_minion vmc_public_ip.list hostname=nsxt-manager.local  ...

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 from which the public IPs should be retrieved.
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.
cursor: (Optional) Opaque cursor to be used for getting next page of records (supplied by current result page).
page_size: (Optional) Maximum number of results to return in this page. Default page size is 1000.
sort_by: (Optional) Field by which records are sorted.
sort_ascending: (Optional) Boolean value to sort result in ascending order. Enabled by default.

saltext.vmware.modules.vmc_public_ip.get(id, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Retrieves given public IP from the given SDDC.

CLI Example:

salt vm_minion vmc_public_ip.get hostname=nsxt-manager.local id=public-ip-1 ...

id: public IP ID for which details should be retrieved.
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 from which the public IP should be retrieved.
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.

saltext.vmware.modules.vmc_public_ip.delete(id, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Delete given public IP from given SDDC.

CLI Example:

salt vm_minion vmc_public_ip.delete hostname=nsxt-manager.local id=public-ip-1 ...

id: ID of specific public IP to be deleted.
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 from which public IP will be deleted.
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.

saltext.vmware.modules.vmc_public_ip.create(id, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Create public IP for given SDDC.

CLI Example:

salt vm_minion vmc_public_ip.create hostname=nsxt-manager.local id=public-ip-1 ...

id: The ID and name that the public IP will be created with.
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 for which 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 certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.

saltext.vmware.modules.vmc_public_ip.update(id, display_name, hostname, refresh_key, authorization_host, org_id, sddc_id, verify_ssl=True, cert=None)[source]#

Update public IP display name for given public IP ID for given SDDC.

CLI Example:

salt vm_minion vmc_public_ip.create hostname=nsxt-manager.local id=public-ip-1 display_name=public_ip ...

id: ID of the public IP to update.
display_name: The new name of 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 for which 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 certificate file to connect to NSX-T manager. The certificate can be retrieved from browser.