"""
Salt execution module for public IP
Provides methods to Create, Update, Read and Delete public IP.
"""
import json
import logging
import os
import requests
from requests.exceptions import HTTPError
from requests.exceptions import RequestException
from requests.exceptions import SSLError
from saltext.vmware.utils import vmc_constants
from saltext.vmware.utils import vmc_request
log = logging.getLogger(__name__)
__virtualname__ = "vmc_public_ip"
__func_alias__ = {"list_": "list"}
def __virtual__():
return __virtualname__
[docs]def 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,
):
"""
Retrieves public IPs from given SDDC.
CLI Example:
.. code-block:: bash
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.
"""
log.info("Retrieving public IPs for SDDC %s", sddc_id)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"cloud-service/api/v1/infra/public-ips"
)
api_url = api_url.format(base_url=api_url_base, org_id=org_id, sddc_id=sddc_id)
params = vmc_request._filter_kwargs(
allowed_kwargs=["cursor", "page_size", "sort_ascending", "sort_by"],
cursor=cursor,
page_size=page_size,
sort_by=sort_by,
sort_ascending=sort_ascending,
)
return vmc_request.call_api(
method=vmc_constants.GET_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_public_ip.list",
verify_ssl=verify_ssl,
cert=cert,
params=params,
)
[docs]def get(
id,
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
verify_ssl=True,
cert=None,
):
"""
Retrieves given public IP from the given SDDC.
CLI Example:
.. code-block:: bash
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.
"""
log.info("Retrieving Public IP %s for SDDC %s", id, sddc_id)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"cloud-service/api/v1/infra/public-ips/{public_ip_id}"
)
api_url = api_url.format(base_url=api_url_base, org_id=org_id, sddc_id=sddc_id, public_ip_id=id)
return vmc_request.call_api(
method=vmc_constants.GET_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_public_ip.get",
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def delete(
id,
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
verify_ssl=True,
cert=None,
):
"""
Delete given public IP from given SDDC.
CLI Example:
.. code-block:: bash
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.
"""
log.info("Deleting Public IP %s for SDDC %s", id, sddc_id)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"cloud-service/api/v1/infra/public-ips/{public_ip_id}"
)
api_url = api_url.format(base_url=api_url_base, org_id=org_id, sddc_id=sddc_id, public_ip_id=id)
return vmc_request.call_api(
method=vmc_constants.DELETE_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_public_ip.delete",
responsebody_applicable=False,
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def create(
id,
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
verify_ssl=True,
cert=None,
):
"""
Create public IP for given SDDC.
CLI Example:
.. code-block:: bash
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.
"""
log.info("Creating Public IP %s for SDDC %s", id, sddc_id)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"cloud-service/api/v1/infra/public-ips/{public_ip_id}"
)
api_url = api_url.format(base_url=api_url_base, org_id=org_id, sddc_id=sddc_id, public_ip_id=id)
# not using json infrastructure as all fields are available from user_input
data = {"ip": None, "display_name": id, "id": id}
return vmc_request.call_api(
method=vmc_constants.PUT_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_public_ip.create",
data=data,
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def update(
id,
display_name,
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
verify_ssl=True,
cert=None,
):
"""
Update public IP display name for given public IP ID for given SDDC.
CLI Example:
.. code-block:: bash
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.
"""
log.info("Updating Public IP %s for SDDC %s", id, sddc_id)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"cloud-service/api/v1/infra/public-ips/{public_ip_id}"
)
api_url = api_url.format(base_url=api_url_base, org_id=org_id, sddc_id=sddc_id, public_ip_id=id)
# not using json infrastructure as all feilds details are available from user_input
data = {"display_name": display_name}
return vmc_request.call_api(
method=vmc_constants.PUT_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_public_ip.update",
data=data,
verify_ssl=verify_ssl,
cert=cert,
)