"""
Salt execution module for VMC DHCP Profiles
Provides methods to Create, Read, Update and Delete DHCP Profiles.
"""
import logging
from saltext.vmware.utils import vmc_constants
from saltext.vmware.utils import vmc_request
from saltext.vmware.utils import vmc_templates
log = logging.getLogger(__name__)
__virtualname__ = "vmc_dhcp_profiles"
def __virtual__():
return __virtualname__
def _create_payload_for_dhcp_profile(dhcp_profile_id, profile_type, user_input):
"""
This function creates the payload for dhcp profile based on the json template and user input passed
"""
template_data = getattr(
vmc_templates,
"create_dhcp_" + profile_type + "_profiles",
vmc_templates.create_dhcp_relay_profiles,
)
data = vmc_request.create_payload_for_request(template_data, user_input)
data["id"] = data["display_name"] = dhcp_profile_id
return data
def _update_payload_for_dhcp_profile(profile_type, existing_data, user_input):
"""
This function creates the payload for update dhcp profile based on the json template, existing data
and user input passed
"""
template_data = getattr(
vmc_templates,
"update_dhcp_" + profile_type + "_profiles",
vmc_templates.update_dhcp_relay_profiles,
)
return vmc_request.create_payload_for_request(template_data, user_input, existing_data)
[docs]def get(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
verify_ssl=True,
cert=None,
sort_by=None,
sort_ascending=None,
page_size=None,
cursor=None,
):
"""
Retrieves DHCP profiles of given profile type for given SDDC
CLI Example:
.. code-block:: bash
salt vm_minion vmc_dhcp_profiles.get hostname=nsxt-manager.local type=server ...
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 the DHCP profiles should be retrieved
type
The type of DHCP profiles to be retrieved. Possible values: server, relay
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.
sort_by
(Optional) Field by which records are sorted
sort_ascending
(Optional) Boolean value to sort result in ascending order. Enabled by default.
page_size
(Optional) Maximum number of results to return in this page. Default page size is 1000.
cursor
(Optional) Opaque cursor to be used for getting next page of records (supplied by current result page)
"""
log.info("Retrieving DHCP %s profiles for SDDC %s", type, sddc_id)
profile_type = vmc_constants.DHCP_CONFIGS.format(type)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"policy/api/v1/infra/{profile_type}"
)
api_url = api_url.format(
base_url=api_url_base, org_id=org_id, sddc_id=sddc_id, profile_type=profile_type
)
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_dhcp_profiles.get",
verify_ssl=verify_ssl,
cert=cert,
params=params,
)
[docs]def get_by_id(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
dhcp_profile_id,
verify_ssl=True,
cert=None,
):
"""
Retrieves given DHCP profile of given profile type for given SDDC
CLI Example:
.. code-block:: bash
salt vm_minion vmc_dhcp_profiles.get_by_id hostname=nsxt-manager.local type=server ...
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 the DHCP profile should be retrieved
type
The type of DHCP profile for which the given DHCP belongs to. Possible values: server, relay
dhcp_profile_id
Id of the DHCP profile to be retrieved from SDDC.
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 DHCP profile %s for SDDC %s", dhcp_profile_id, sddc_id)
profile_type = vmc_constants.DHCP_CONFIGS.format(type)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"policy/api/v1/infra/{profile_type}/{profile_id}"
)
api_url = api_url.format(
base_url=api_url_base,
org_id=org_id,
sddc_id=sddc_id,
profile_type=profile_type,
profile_id=dhcp_profile_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_dhcp_profiles.get_by_id",
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def delete(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
dhcp_profile_id,
verify_ssl=True,
cert=None,
):
"""
Deletes given DHCP profile from the given SDDC
CLI Example:
.. code-block:: bash
salt vm_minion vmc_dhcp_profiles.delete hostname=nsxt-manager.local type=server ...
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 DHCP profile should be deleted
type
The type of DHCP profile for which the given dhcp belongs to. Possible values: server, relay
dhcp_profile_id
Id of the DHCP profile to be deleted from SDDC.
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 DHCP profile %s for SDDC %s", dhcp_profile_id, sddc_id)
profile_type = vmc_constants.DHCP_CONFIGS.format(type)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"policy/api/v1/infra/{profile_type}/{profile_id}"
)
api_url = api_url.format(
base_url=api_url_base,
org_id=org_id,
sddc_id=sddc_id,
profile_type=profile_type,
profile_id=dhcp_profile_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_dhcp_profiles.delete",
responsebody_applicable=False,
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def create(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
dhcp_profile_id,
verify_ssl=True,
cert=None,
server_addresses=None,
tags=vmc_constants.VMC_NONE,
lease_time=None,
):
"""
Creates DHCP profile of given type for the given SDDC
CLI Example:
.. code-block:: bash
salt vm_minion vmc_dhcp_profiles.create hostname=nsxt-manager.local type=server ...
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 the DHCP profile should be added
type
The type of DHCP profile for which the given DHCP belongs to. Possible values: server, relay
dhcp_profile_id
Id of the DHCP profile to be added to SDDC
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.
server_addresses
when type is relay, this field indicates DHCP relay addresses(DHCP server IP addresses
for DHCP relay configuration).
Both IPv4 and IPv6 addresses are supported.
when type is server, this field indicates DHCP server address in CIDR format.
Both IPv4 and IPv6 address families are supported.
Prefix length should be less than or equal to 30 for IPv4 address family
and less than or equal to 126 for IPv6.
When not specified, IPv4 value is auto-assigned to 100.96.0.1/30.
Note: This field is optional only when type is server and
is mandatory when type is relay.
tags
(Optional) Opaque identifiers meaningful to the user.
.. code::
tags='[
{
"tag": "<tag-key-1>"
"scope": "<tag-value-1>"
},
{
"tag": "<tag-key-2>"
"scope": "<tag-value-2>"
}
]'
lease_time
(Optional) IP address lease time in seconds. Minimum value is 60.
Maximum value is 4294967295. Default value is 86400
Note: This field is applicable only when type is server
Example values:
.. code::
dhcp-server-profiles:
{
"server_addresses": [
"10.22.12.2/23"
],
"tags": [
{
"tag": "tag1",
"scope": "scope1"
}
],
"lease_time": 86400
}
dhcp-relay-profiles:
{
"server_addresses": [
"10.1.1.1"
],
"tags": [
{
"tag": "tag1",
"scope": "scope1"
}
]
}
"""
log.info("Creating DHCP profile %s for SDDC %s", dhcp_profile_id, sddc_id)
profile_type = vmc_constants.DHCP_CONFIGS.format(type)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"policy/api/v1/infra/{profile_type}/{profile_id}"
)
api_url = api_url.format(
base_url=api_url_base,
org_id=org_id,
sddc_id=sddc_id,
profile_type=profile_type,
profile_id=dhcp_profile_id,
)
allowed_dict = {"server_addresses": server_addresses, "tags": tags, "lease_time": lease_time}
req_data = vmc_request._filter_kwargs(
allowed_kwargs=allowed_dict.keys(), allow_none=["tags"], **allowed_dict
)
payload = _create_payload_for_dhcp_profile(dhcp_profile_id, type, req_data)
return vmc_request.call_api(
method=vmc_constants.PUT_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_dhcp_profiles.create",
data=payload,
verify_ssl=verify_ssl,
cert=cert,
)
[docs]def update(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
dhcp_profile_id,
verify_ssl=True,
cert=None,
server_addresses=None,
tags=vmc_constants.VMC_NONE,
lease_time=None,
display_name=None,
):
"""
Updates given DHCP profile for the given SDDC
CLI Example:
.. code-block:: bash
salt vm_minion vmc_dhcp_profiles.update hostname=nsxt-manager.local type=relay ...
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 the DHCP profile belongs to
type
The type of DHCP profile for which the given dhcp belongs to. Possible values: server, relay
dhcp_profile_id
Id of the DHCP profile to be updated for given SDDC.
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.
server_addresses
when type is relay, this field indicates DHCP relay addresses(DHCP server IP addresses
for DHCP relay configuration).
Both IPv4 and IPv6 addresses are supported.
when type is server, this field indicates DHCP server address in CIDR format.
Both IPv4 and IPv6 address families are supported.
Prefix length should be less than or equal to 30 for IPv4 address family
and less than or equal to 126 for IPv6.
When not specified, IPv4 value is auto-assigned to 100.96.0.1/30.
Note: This field is optional only when type is server and
is mandatory when type is relay.
tags
(Optional) Opaque identifiers meaningful to the user.
.. code::
tags='[
{
"tag": "<tag-key-1>"
"scope": "<tag-value-1>"
},
{
"tag": "<tag-key-2>"
"scope": "<tag-value-2>"
}
]'
lease_time
(Optional) IP address lease time in seconds. Minimum value is 60.
Maximum value is 4294967295. Default value is 86400
Note: This field is applicable only when type is server
display_name
Identifier to use when displaying entity in logs or GUI.
Example values:
.. code::
dhcp-server-profiles:
{
"display_name": "dhcp-test",
"server_addresses": [
"10.22.12.2/23"
],
"tags": [
{
"tag": "tag1",
"scope": "scope1"
}
],
"lease_time": 86400
}
dhcp-relay-profiles:
{
"display_name": "dhcp-test",
"server_addresses": [
"10.1.1.1"
],
"tags": [
{
"tag": "tag1",
"scope": "scope1"
}
]
}
"""
log.info("Updating DHCP profile %s for SDDC %s", dhcp_profile_id, sddc_id)
profile_type = vmc_constants.DHCP_CONFIGS.format(type)
api_url_base = vmc_request.set_base_url(hostname)
api_url = (
"{base_url}vmc/reverse-proxy/api/orgs/{org_id}/sddcs/{sddc_id}/"
"policy/api/v1/infra/{profile_type}/{profile_id}"
)
api_url = api_url.format(
base_url=api_url_base,
org_id=org_id,
sddc_id=sddc_id,
profile_type=profile_type,
profile_id=dhcp_profile_id,
)
existing_data = get_by_id(
hostname,
refresh_key,
authorization_host,
org_id,
sddc_id,
type,
dhcp_profile_id,
verify_ssl,
cert,
)
# fetch the dhcp profile for the given dhcp_profile_id
if vmc_constants.ERROR in existing_data:
return existing_data
allowed_dict = {
"server_addresses": server_addresses,
"tags": tags,
"lease_time": lease_time,
"display_name": display_name,
}
req_data = vmc_request._filter_kwargs(
allowed_kwargs=allowed_dict.keys(), allow_none=["tags"], **allowed_dict
)
payload = _update_payload_for_dhcp_profile(type, existing_data, req_data)
return vmc_request.call_api(
method=vmc_constants.PATCH_REQUEST_METHOD,
url=api_url,
refresh_key=refresh_key,
authorization_host=authorization_host,
description="vmc_dhcp_profiles.update",
responsebody_applicable=False,
data=payload,
verify_ssl=verify_ssl,
cert=cert,
)