def raise_error_if_def_not_supported(cloudapi_client: CloudApiClient):
"""Raise DefNotSupportedException if defined entities are not supported.
:param cloudapi_client CloudApiClient
"""
if float(cloudapi_client.get_api_version()) < DEF_API_MIN_VERSION:
raise excptn.DefNotSupportedException("Defined entity framework is not"
" supported for {cloudapi_client.get_api_version()}") # noqa: E501
def __init__(self, client):
"""Initialize ComputePolicyManager Object.
:param pyvcloud.vcd.client client:
:raises: OperationNotSupportedException: If cloudapi endpoint is not
found in session.
:raises: ValueError: If non sys admin client is passed during
initialization.
"""
if not client.is_sysadmin():
raise ValueError("Only Sys admin clients should be used to "
"initialize ComputePolicyManager.")
self._vcd_client = client
token = self._vcd_client.get_access_token()
is_jwt_token = True
if not token:
token = self._vcd_client.get_xvcloud_authorization_token()
is_jwt_token = False
self._session = self._vcd_client.get_vcloud_session()
try:
self._cloudapi_client = CloudApiClient(
base_url=self._vcd_client.get_cloudapi_uri(),
token=token,
is_jwt_token=is_jwt_token,
api_version=self._vcd_client.get_api_version(),
verify_ssl=self._vcd_client._verify_ssl_certs)
# Since the /cloudapi endpoint was added before the compute policy
# endpoint. Mere presence of the /cloudapi uri is not enough, we
# need to make sure that this cloud api client will be of actual
# use to us.
self._cloudapi_client.do_request(
method=RequestMethod.GET,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=f"{CloudApiResource.VDC_COMPUTE_POLICIES}") # noqa: E501
except requests.exceptions.HTTPError as err:
LOGGER.error(err)
raise OperationNotSupportedException(
"Cloudapi endpoint unavailable at current api version.")
def __init__(self, client):
"""Initialize ComputePolicyManager Object.
:param pyvcloud.vcd.client client:
:raises: OperationNotSupportedException: If cloudapi endpoint is not
found in session.
:raises: ValueError: If non sys admin client is passed during
initialization.
"""
if not client.is_sysadmin():
raise ValueError("Only Sys admin clients should be used to "
"initialize ComputePolicyManager.")
self._vcd_client = client
# TODO: pyvcloud should expose methods to grab the session and token
# from a client object.
auth_token = \
self._vcd_client._session.headers['x-vcloud-authorization']
# pyvcloud doesn't store the vCD session response in client. So we need
# to get it from vCD.
session = self._vcd_client.rehydrate_from_token(auth_token)
# Ideally this information should be fetched from
# client._session_endpoints. However pyvcloud client doesn't store
# the cloudapi link, so we have to find it manually.
try:
link = find_link(session, RelationType.OPEN_API,
EntityType.APPLICATION_JSON)
except MissingLinkException:
raise OperationNotSupportedException(
"Cloudapi endpoint unavailable at current api version.")
self._cloudapi_client = CloudApiClient(
base_url=link.href,
auth_token=auth_token,
verify_ssl=self._vcd_client._verify_ssl_certs)
class ComputePolicyManager:
"""Manages creating, deleting, updating cloudapi compute policies.
Also provides an interface to assign/remove/list compute policies to/from
vapp templates and org vdcs.
These operations are supposed to be performed by only sytem administrators.
All policy names are prepended with CSE specific literal and restored to
original names when returned back to the caller.
"""
def __init__(self, client):
"""Initialize ComputePolicyManager Object.
:param pyvcloud.vcd.client client:
:raises: OperationNotSupportedException: If cloudapi endpoint is not
found in session.
:raises: ValueError: If non sys admin client is passed during
initialization.
"""
if not client.is_sysadmin():
raise ValueError("Only Sys admin clients should be used to "
"initialize ComputePolicyManager.")
self._vcd_client = client
# TODO: pyvcloud should expose methods to grab the session and token
# from a client object.
auth_token = \
self._vcd_client._session.headers['x-vcloud-authorization']
# pyvcloud doesn't store the vCD session response in client. So we need
# to get it from vCD.
session = self._vcd_client.rehydrate_from_token(auth_token)
# Ideally this information should be fetched from
# client._session_endpoints. However pyvcloud client doesn't store
# the cloudapi link, so we have to find it manually.
try:
link = find_link(session, RelationType.OPEN_API,
EntityType.APPLICATION_JSON)
except MissingLinkException:
raise OperationNotSupportedException(
"Cloudapi endpoint unavailable at current api version.")
self._cloudapi_client = CloudApiClient(
base_url=link.href,
auth_token=auth_token,
verify_ssl=self._vcd_client._verify_ssl_certs)
def list_policies(self):
"""Get all policies that are created by CSE.
:return: list of CSE created policies
:rtype: list of dict
"""
policies = self._cloudapi_client.do_request(
RequestMethod.GET, CloudApiResource.VDC_COMPUTE_POLICIES)
cse_policies = []
for policy in policies['values']:
if policy['name'].startswith(COMPUTE_POLICY_NAME_PREFIX):
policy['display_name'] = \
self._get_original_policy_name(policy['name'])
else:
policy['display_name'] = policy['name']
cse_policies.append(policy)
return cse_policies
def get_policy(self, policy_name):
"""Get the compute policy information for the given policy name.
:param str policy_name: name of the compute policy
:return: policy details if found, else None
:rtype: dict
"""
for policy_dict in self.list_policies():
if policy_dict.get('display_name') == policy_name:
policy_dict['href'] = self._get_policy_href(policy_dict['id'])
return policy_dict
def add_policy(self, policy_name, description=None):
"""Add policy with the given name and description.
:param str policy_name: name of the compute policy
:param str description: description about the policy
:return: created policy information
:rtype: dict
"""
policy_info = {}
policy_info['name'] = self._get_cse_policy_name(policy_name)
if description:
policy_info['description'] = description
created_policy = self._cloudapi_client.do_request(
RequestMethod.POST,
resource_url_relative_path=CloudApiResource.VDC_COMPUTE_POLICIES,
payload=policy_info)
created_policy['display_name'] = self._get_original_policy_name(
created_policy['name'])
created_policy['href'] = self._get_policy_href(created_policy['id'])
return created_policy
def delete_policy(self, policy_name):
"""Delete the compute policy with the given name.
:param str policy_name: name of the compute policy
"""
policy_info = self.get_policy(policy_name)
if policy_info:
resource_url_relative_path = \
f"{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_info['id']}"
return self._cloudapi_client.do_request(
RequestMethod.DELETE,
resource_url_relative_path=resource_url_relative_path)
def update_policy(self, policy_name, new_policy_info):
"""Update the existing compute policy with new policy information.
:param str policy_name: existing policy name
:param dict new_policy_info: updated policy information with name and
optional description
:return: updated policy information; if no policy is found, return None
:rtype: dict
"""
policy_info = self.get_policy(policy_name)
if policy_info and new_policy_info.get('name'):
payload = {}
payload['name'] = \
self._get_cse_policy_name(new_policy_info['name'])
if new_policy_info.get('description'):
payload['description'] = new_policy_info['description']
resource_url_relative_path = \
f"{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_info['id']}"
updated_policy = self._cloudapi_client.do_request(
RequestMethod.PUT,
resource_url_relative_path=resource_url_relative_path,
payload=payload)
updated_policy['display_name'] = \
self._get_original_policy_name(updated_policy['name'])
updated_policy['href'] = policy_info['href']
return updated_policy
def add_compute_policy_to_vdc(self,
policy_href,
vdc_id=None,
org_name=None,
vdc_name=None):
"""Add compute policy to the given vdc.
Atleast one of vdc_id or (org_name, vdc_name) should be provided, so
that the target vdc can be located.
:param policy_href: policy href that is created using cloudapi
:param str vdc_id: id of the vdc to assign the policy
:param str org_name: name of the organization to look for the vdc
:param str vdc_name: name of the vdc to assign the policy
:return: an object containing VdcComputePolicyReferences XML element
that refers to individual VdcComputePolicies.
:rtype: lxml.objectify.ObjectifiedElement
"""
vdc = get_vdc(self._vcd_client,
org_name=org_name,
vdc_name=vdc_name,
vdc_id=vdc_id,
is_admin_operation=True)
return vdc.add_compute_policy(policy_href)
def list_compute_policies_on_vdc(self,
vdc_id=None,
org_name=None,
vdc_name=None):
"""List compute policy currently assigned to a given vdc.
Atleast one of vdc_id or (org_name, vdc_name) should be provided, so
that the target vdc can be located.
:param str vdc_id: id of the vdc for which policies need to be
retrieved.
:param str org_name: name of the organization to look for the vdc.
:param str vdc_name: name of the vdc for which policies need to be
retrieved.
:return: A list of dictionaries with the 'name' and 'href' key
:rtype: List
"""
vdc = get_vdc(self._vcd_client,
org_name=org_name,
vdc_name=vdc_name,
vdc_id=vdc_id,
is_admin_operation=True)
result = []
cp_list = vdc.list_compute_policies()
for cp in cp_list:
result.append({
'name':
self._get_original_policy_name(cp.get('name')),
'href':
cp.get('href')
})
return result
def remove_compute_policy_from_vdc(self,
policy_href,
vdc_id=None,
org_name=None,
vdc_name=None):
"""Delete the compute policy from the specified vdc.
Atleast one of vdc_id or (org_name, vdc_name) should be provided,
so that the target vdc can be located.
:param policy_href: policy href that is created using cloudapi
:param str vdc_id: id of the vdc to assign the policy
:param str org_name: name of the organization to look for the vdc
:param str vdc_name: name of the vdc to assign the policy
:return: an object containing VdcComputePolicyReferences XML element
that refers to individual VdcComputePolicies.
:rtype: lxml.objectify.ObjectifiedElement
"""
vdc = get_vdc(self._vcd_client,
org_name=org_name,
vdc_name=vdc_name,
vdc_id=vdc_id,
is_admin_operation=True)
return vdc.remove_compute_policy(policy_href)
def assign_compute_policy_to_vapp_template_vms(self, compute_policy_href,
org_name, catalog_name,
catalog_item_name):
"""Assign the compute policy to vms of given vapp template.
:param str compute_policy_href: compute policy to be removed
:param str org_name: name of the organization that has the catalog
:param str catalog_name: name of the catalog
:param str catalog_item_name: name of the catalog item that has vms
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = get_org(self._vcd_client, org_name=org_name)
return org.assign_compute_policy_to_vapp_template_vms(
catalog_name=catalog_name,
catalog_item_name=catalog_item_name,
compute_policy_href=compute_policy_href)
def remove_compute_policy_from_vapp_template_vms(self, compute_policy_href,
org_name, catalog_name,
catalog_item_name):
"""Remove the compute policy from vms of given vapp template.
:param str compute_policy_href: compute policy to be removed.
:param str org_name: name of the organization that has the catalog.
:param str catalog_name: name of the catalog.
:param str catalog_item_name: name of the catalog item that has vms.
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application
template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = get_org(self._vcd_client, org_name=org_name)
return org.remove_compute_policy_from_vapp_template_vms(
catalog_name, catalog_item_name, compute_policy_href)
def remove_all_compute_policies_from_vapp_template_vms(
self, org_name, catalog_name, catalog_item_name):
"""Remove all compute policies from vms of given vapp template.
:param str org_name: name of the organization that has the catalog.
:param str catalog_name: name of the catalog.
:param str catalog_item_name: name of the catalog item that has vms.
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application
template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = get_org(self._vcd_client, org_name=org_name)
return org.remove_all_compute_policies_from_vapp_template_vms(
catalog_name, catalog_item_name)
def _get_cse_policy_name(self, policy_name):
"""Add cse specific prefix to the policy name.
:param str policy_name: name of the compute policy
:return: policy name unique to cse
:rtype: str
"""
return f"{COMPUTE_POLICY_NAME_PREFIX}{policy_name}"
def _get_original_policy_name(self, policy_name):
"""Remove cse specific prefix from the given policy name.
:param str policy_name: name of the policy
:return: policy name after removing cse specific prefix
:rtype: str
"""
if policy_name and policy_name.startswith(COMPUTE_POLICY_NAME_PREFIX):
return policy_name.replace(COMPUTE_POLICY_NAME_PREFIX, '', 1)
return policy_name
def _get_policy_href(self, policy_id):
"""Construct policy href from given policy id.
:param str policy_id: policy id
:return: policy href
:rtype: str
"""
return f"{self._cloudapi_client.get_versioned_url()}{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_id}" # noqa
class ComputePolicyManager:
"""Manages creating, deleting, updating cloudapi compute policies.
Also provides an interface to assign/remove/list compute policies to/from
vapp templates and org vdcs.
These operations are supposed to be performed by only sytem administrators.
All policy names are prepended with CSE specific literal and restored to
original names when returned back to the caller.
"""
def __init__(self, client):
"""Initialize ComputePolicyManager Object.
:param pyvcloud.vcd.client client:
:raises: OperationNotSupportedException: If cloudapi endpoint is not
found in session.
:raises: ValueError: If non sys admin client is passed during
initialization.
"""
if not client.is_sysadmin():
raise ValueError("Only Sys admin clients should be used to "
"initialize ComputePolicyManager.")
self._vcd_client = client
token = self._vcd_client.get_access_token()
is_jwt_token = True
if not token:
token = self._vcd_client.get_xvcloud_authorization_token()
is_jwt_token = False
self._session = self._vcd_client.get_vcloud_session()
try:
self._cloudapi_client = CloudApiClient(
base_url=self._vcd_client.get_cloudapi_uri(),
token=token,
is_jwt_token=is_jwt_token,
api_version=self._vcd_client.get_api_version(),
verify_ssl=self._vcd_client._verify_ssl_certs)
# Since the /cloudapi endpoint was added before the compute policy
# endpoint. Mere presence of the /cloudapi uri is not enough, we
# need to make sure that this cloud api client will be of actual
# use to us.
self._cloudapi_client.do_request(
method=RequestMethod.GET,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=f"{CloudApiResource.VDC_COMPUTE_POLICIES}") # noqa: E501
except requests.exceptions.HTTPError as err:
LOGGER.error(err)
raise OperationNotSupportedException(
"Cloudapi endpoint unavailable at current api version.")
def get_all_policies(self):
"""Get all compute policies in vCD that were created by CSE.
Returns a generator that when iterated over will yield all CSE compute
policies in vCD, making multiple requests when necessary.
This is implemented with a generator because cloudapi paginates
the `GET /vdcComputePolicies` endpoint.
:return: Generator that yields all CSE compute policies in vCD
:rtype: Generator[Dict, None, None]
"""
# TODO we can make this function take in filter query parameters
page_num = 0
while True:
page_num += 1
# without the &sortAsc parameter, vCD returns unpredictable results
response_body = self._cloudapi_client.do_request(
method=RequestMethod.GET,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=f"{CloudApiResource.VDC_COMPUTE_POLICIES}?page={page_num}&sortAsc=name") # noqa: E501
if len(response_body['values']) > 0:
for policy in response_body['values']:
cp_name = policy['name']
policy['display_name'] = self._get_policy_display_name(cp_name) # noqa: E501
yield policy
else:
break
def get_policy(self, policy_name):
"""Get the compute policy information for the given policy name.
:param str policy_name: name of the compute policy
:return: dictionary containing policy details
:rtype: dict
:raises: EntityNotFoundException: if compute policy is not found
"""
# NOTE If multiple policies with the same name exist, this function
# returns the first found.
# 'System Default' is the only case where multiple compute
# policies with the same name may exist.
# TODO filter query parameter
# `cloudapi/1.0.0/vdcComputePolicies?filter=` can be used to reduce
# number of api calls
for policy_dict in self.get_all_policies():
if policy_dict.get('display_name') == policy_name:
policy_dict['href'] = self._get_policy_href(policy_dict['id'])
return policy_dict
raise EntityNotFoundException(f"Compute policy '{policy_name}'"
f" does not exist.")
def add_policy(self, policy_name, description=None):
"""Add policy with the given name and description.
:param str policy_name: name of the compute policy
:param str description: description about the policy
:return: created policy information
:rtype: dict
:raises: HTTPError 400 if policy already exists
"""
policy_info = {}
policy_info['name'] = self._get_cse_policy_name(policy_name)
if description:
policy_info['description'] = description
created_policy = self._cloudapi_client.do_request(
method=RequestMethod.POST,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=CloudApiResource.VDC_COMPUTE_POLICIES,
payload=policy_info)
created_policy['display_name'] = self._get_policy_display_name(
created_policy['name'])
created_policy['href'] = self._get_policy_href(created_policy['id'])
return created_policy
def delete_policy(self, policy_name):
"""Delete the compute policy with the given name.
:param str policy_name: name of the compute policy
:return: dictionary containing response text
:rtype: dict
:raises: EntityNotFoundException: if compute policy is not found
"""
policy_info = self.get_policy(policy_name)
resource_url_relative_path = \
f"{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_info['id']}"
return self._cloudapi_client.do_request(
method=RequestMethod.DELETE,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=resource_url_relative_path)
def update_policy(self, policy_name, new_policy_info):
"""Update the existing compute policy with new policy information.
:param str policy_name: existing policy name
:param dict new_policy_info: updated policy information with name and
optional description
:return: updated policy information
:rtype: dict
:raises: EntityNotFoundException: if compute policy is not found
"""
policy_info = self.get_policy(policy_name)
if new_policy_info.get('name'):
payload = {}
payload['name'] = \
self._get_cse_policy_name(new_policy_info['name'])
if 'description' in new_policy_info:
payload['description'] = new_policy_info['description']
resource_url_relative_path = \
f"{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_info['id']}"
updated_policy = self._cloudapi_client.do_request(
method=RequestMethod.PUT,
cloudapi_version=CLOUDAPI_VERSION_1_0_0,
resource_url_relative_path=resource_url_relative_path,
payload=payload)
updated_policy['display_name'] = \
self._get_policy_display_name(updated_policy['name'])
updated_policy['href'] = policy_info['href']
return updated_policy
def add_compute_policy_to_vdc(self, vdc_id, compute_policy_href):
"""Add compute policy to the given vdc.
:param str vdc_id: id of the vdc to assign the policy
:param compute_policy_href: policy href that is created using cloudapi
:return: an object containing VdcComputePolicyReferences XML element
that refers to individual VdcComputePolicies.
:rtype: lxml.objectify.ObjectifiedElement
"""
vdc = pyvcd_utils.get_vdc(self._vcd_client,
vdc_id=vdc_id,
is_admin_operation=True)
return vdc.add_compute_policy(compute_policy_href)
def list_compute_policies_on_vdc(self, vdc_id):
"""List compute policy currently assigned to a given vdc.
:param str vdc_id: id of the vdc for which policies need to be
retrieved.
:return: A list of dictionaries with the keys 'name', 'href', and 'id'
:rtype: List
"""
vdc = pyvcd_utils.get_vdc(self._vcd_client,
vdc_id=vdc_id,
is_admin_operation=True)
result = []
cp_list = vdc.list_compute_policies()
for cp in cp_list:
result.append({
'name': self._get_policy_display_name(cp.get('name')),
'href': cp.get('href'),
'id': cp.get('id')
})
return result
def assign_compute_policy_to_vapp_template_vms(self,
compute_policy_href,
org_name,
catalog_name,
catalog_item_name):
"""Assign the compute policy to vms of given vapp template.
:param str compute_policy_href: compute policy to be removed
:param str org_name: name of the organization that has the catalog
:param str catalog_name: name of the catalog
:param str catalog_item_name: name of the catalog item that has vms
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = pyvcd_utils.get_org(self._vcd_client, org_name=org_name)
return org.assign_compute_policy_to_vapp_template_vms(
catalog_name=catalog_name,
catalog_item_name=catalog_item_name,
compute_policy_href=compute_policy_href)
def remove_compute_policy_from_vapp_template_vms(self,
compute_policy_href,
org_name,
catalog_name,
catalog_item_name):
"""Remove the compute policy from vms of given vapp template.
:param str compute_policy_href: compute policy to be removed.
:param str org_name: name of the organization that has the catalog.
:param str catalog_name: name of the catalog.
:param str catalog_item_name: name of the catalog item that has vms.
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application
template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = pyvcd_utils.get_org(self._vcd_client, org_name=org_name)
return org.remove_compute_policy_from_vapp_template_vms(
catalog_name,
catalog_item_name,
compute_policy_href)
def remove_all_compute_policies_from_vapp_template_vms(self,
org_name,
catalog_name,
catalog_item_name):
"""Remove all compute policies from vms of given vapp template.
:param str org_name: name of the organization that has the catalog.
:param str catalog_name: name of the catalog.
:param str catalog_item_name: name of the catalog item that has vms.
:return: an object of type EntityType.TASK XML which represents
the asynchronous task that is updating virtual application
template.
:rtype: lxml.objectify.ObjectifiedElement
"""
org = pyvcd_utils.get_org(self._vcd_client, org_name=org_name)
return org.remove_all_compute_policies_from_vapp_template_vms(
catalog_name, catalog_item_name)
def _get_cse_policy_name(self, policy_name):
"""Add cse specific prefix to the policy name.
:param str policy_name: name of the compute policy
:return: policy name unique to cse
:rtype: str
"""
return f"{CSE_COMPUTE_POLICY_PREFIX}{policy_name}"
def _get_policy_display_name(self, policy_name):
"""Remove cse specific prefix from the given policy name.
:param str policy_name: name of the policy
:return: policy name after removing cse specific prefix
:rtype: str
"""
if policy_name and policy_name.startswith(CSE_COMPUTE_POLICY_PREFIX):
return policy_name.replace(CSE_COMPUTE_POLICY_PREFIX, '', 1)
return policy_name
def _get_policy_href(self, policy_id):
"""Construct policy href from given policy id.
:param str policy_id: policy id
:return: policy href
:rtype: str
"""
return f"{self._cloudapi_client.get_base_url()}{CLOUDAPI_VERSION_1_0_0}/{CloudApiResource.VDC_COMPUTE_POLICIES}/{policy_id}" # noqa: E501
def remove_compute_policy_from_vdc(self, ovdc_id, compute_policy_href,
remove_compute_policy_from_vms=False):
"""Delete the compute policy from the specified vdc.
:param str ovdc_id: id of the vdc to assign the policy
:param compute_policy_href: policy href to remove
:param bool remove_compute_policy_from_vms: If True, will set affected
VMs' compute policy to 'System Default'
:return: dictionary containing 'task_href'.
"""
vdc = pyvcd_utils.get_vdc(self._vcd_client, vdc_id=ovdc_id)
# TODO is there no better way to get the client href?
org = pyvcd_utils.get_org(self._vcd_client)
org.reload()
user_name = self._session.get('user')
user_href = org.get_user(user_name).get('href')
task = Task(self._vcd_client)
task_resource = task.update(
status=TaskStatus.RUNNING.value,
namespace='vcloud.cse',
operation=f"Removing compute policy (href: {compute_policy_href})"
f" from org VDC (vdc id: {ovdc_id})",
operation_name='Remove org VDC compute policy',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
org_href=org.href)
task_href = task_resource.get('href')
self._remove_compute_policy_from_vdc_async(
task=task,
task_href=task_href,
user_href=user_href,
org_href=org.href,
ovdc_id=ovdc_id,
compute_policy_href=compute_policy_href,
remove_compute_policy_from_vms=remove_compute_policy_from_vms)
return {
'task_href': task_href
}
@utils.run_async
def _remove_compute_policy_from_vdc_async(self, *args,
task,
task_href,
user_href,
org_href,
ovdc_id,
compute_policy_href,
remove_compute_policy_from_vms):
user_name = self._session.get('user')
vdc = pyvcd_utils.get_vdc(self._vcd_client,
vdc_id=ovdc_id,
is_admin_operation=True)
try:
if remove_compute_policy_from_vms:
cp_list = self.list_compute_policies_on_vdc(ovdc_id)
system_default_href = None
for cp_dict in cp_list:
if cp_dict['name'] == _SYSTEM_DEFAULT_COMPUTE_POLICY:
system_default_href = cp_dict['href']
if system_default_href is None:
raise EntityNotFoundException(
f"Error: {_SYSTEM_DEFAULT_COMPUTE_POLICY} "
f"compute policy not found")
compute_policy_id = retrieve_compute_policy_id_from_href(compute_policy_href) # noqa: E501
vapps = pyvcd_utils.get_all_vapps_in_ovdc(self._vcd_client,
ovdc_id)
target_vms = []
for vapp in vapps:
vm_resources = vapp.get_all_vms()
for vm_resource in vm_resources:
if vm_resource.VdcComputePolicy.get('id') == compute_policy_id: # noqa: E501
target_vms.append(vm_resource)
vm_names = [vm.get('name') for vm in target_vms]
task.update(
status=TaskStatus.RUNNING.value,
namespace='vcloud.cse',
operation=f"Setting compute policy to "
f"'{_SYSTEM_DEFAULT_COMPUTE_POLICY}' on "
f"{len(vm_names)} affected VMs: {vm_names}",
operation_name='Remove org VDC compute policy',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
task_href=task_href,
org_href=org_href,
)
task_monitor = self._vcd_client.get_task_monitor()
for vm_resource in target_vms:
vm = VM(self._vcd_client, href=vm_resource.get('href'))
_task = vm.update_compute_policy(system_default_href)
task.update(
status=TaskStatus.RUNNING.value,
namespace='vcloud.cse',
operation=f"Setting compute policy to "
f"'{_SYSTEM_DEFAULT_COMPUTE_POLICY}' on VM "
f"'{vm_resource.get('name')}'",
operation_name='Remove org VDC compute policy',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
task_href=task_href,
org_href=org_href,
)
task_monitor.wait_for_success(_task)
task.update(
status=TaskStatus.RUNNING.value,
namespace='vcloud.cse',
operation=f"Removing compute policy (href:"
f"{compute_policy_href}) from org VDC '{vdc.name}'",
operation_name='Remove org VDC compute policy',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
task_href=task_href,
org_href=org_href,
)
vdc.remove_compute_policy(compute_policy_href)
task.update(
status=TaskStatus.SUCCESS.value,
namespace='vcloud.cse',
operation=f"Removed compute policy (href: "
f"{compute_policy_href}) from org VDC '{vdc.name}'",
operation_name='Updating VDC',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
task_href=task_href,
org_href=org_href,
)
except Exception as err:
LOGGER.error(err, exc_info=True)
task.update(
status=TaskStatus.ERROR.value,
namespace='vcloud.cse',
operation='',
operation_name='Remove org VDC compute policy',
details='',
progress=None,
owner_href=vdc.href,
owner_name=vdc.name,
owner_type=EntityType.VDC.value,
user_href=user_href,
user_name=user_name,
task_href=task_href,
org_href=org_href,
error_message=f"{err}"
)