|
| 1 | +import logging |
| 2 | + |
| 3 | +from ..common import union, Object |
| 4 | +from ..exception import CTERAException |
| 5 | +from .base_command import BaseCommand |
| 6 | +from . import query |
| 7 | + |
| 8 | + |
| 9 | +class Templates(BaseCommand): |
| 10 | + """ |
| 11 | + Portal Configuration Template APIs |
| 12 | + """ |
| 13 | + |
| 14 | + default = ['name'] |
| 15 | + |
| 16 | + def __init__(self, portal): |
| 17 | + super().__init__(portal) |
| 18 | + self.auto_assign = TemplateAutoAssignPolicy(self._portal) |
| 19 | + |
| 20 | + def _get_entire_object(self, name): |
| 21 | + try: |
| 22 | + return self._portal.get('/deviceTemplates/%s' % name) |
| 23 | + except CTERAException as error: |
| 24 | + raise CTERAException('Failed to get template', error) |
| 25 | + |
| 26 | + def get(self, name, include=None): |
| 27 | + """ |
| 28 | + Get a Configuration Template |
| 29 | +
|
| 30 | + :param str name: Name of the template |
| 31 | + :param list[str] include: List of fields to retrieve, defaults to ``['name']`` |
| 32 | + """ |
| 33 | + include = union(include or [], Templates.default) |
| 34 | + include = ['/' + attr for attr in include] |
| 35 | + template = self._portal.get_multi('/deviceTemplates/' + name, include) |
| 36 | + if template.name is None: |
| 37 | + raise CTERAException('Could not find template', None, name=name) |
| 38 | + return template |
| 39 | + |
| 40 | + def add(self, name, description=None, include_sets=None, exclude_sets=None): |
| 41 | + """ |
| 42 | + Add a Configuration Template |
| 43 | +
|
| 44 | + :param str name: Name of the template |
| 45 | + """ |
| 46 | + param = Object() |
| 47 | + param._classname = 'DeviceTemplate' # pylint: disable=protected-access |
| 48 | + param.name = name |
| 49 | + param.description = description |
| 50 | + |
| 51 | + param.deviceSettings = Object() |
| 52 | + param.deviceSettings._classname = 'DeviceTemplateSettings' # pylint: disable=protected-access |
| 53 | + |
| 54 | + if include_sets or exclude_sets: |
| 55 | + param.deviceSettings.backup = Object() |
| 56 | + param.deviceSettings.backup._classname = 'BackupTemplate' # pylint: disable=protected-access |
| 57 | + param.deviceSettings.backup.backupPolicy = Object() |
| 58 | + param.deviceSettings.backup.backupPolicy._classname = 'BackupPolicyTemplate' # pylint: disable=protected-access |
| 59 | + if include_sets: |
| 60 | + param.deviceSettings.backup.backupPolicy.includeSets = include_sets |
| 61 | + if exclude_sets: |
| 62 | + param.deviceSettings.backup.backupPolicy.excludeSets = exclude_sets |
| 63 | + |
| 64 | + logging.getLogger().info('Adding template. %s', {'name': name}) |
| 65 | + response = self._portal.add('/deviceTemplates', param) |
| 66 | + logging.getLogger().info('Template added. %s', {'name': name}) |
| 67 | + return response |
| 68 | + |
| 69 | + def list_templates(self, include=None): |
| 70 | + """ |
| 71 | + List Configuration Templates.\n |
| 72 | + To retrieve templates, you must first browse the tenant, using: `GlobalAdmin.portals.browse()` |
| 73 | +
|
| 74 | + :param list[str],optional include: List of fields to retrieve, defaults to ``['name']`` |
| 75 | + """ |
| 76 | + include = union(include or [], Templates.default) |
| 77 | + param = query.QueryParamBuilder().include(include).build() |
| 78 | + return query.iterator(self._portal, '/deviceTemplates', param) |
| 79 | + |
| 80 | + def delete(self, name): |
| 81 | + """ |
| 82 | + Delete a Configuration Template |
| 83 | +
|
| 84 | + :param str name: Name of the template |
| 85 | + """ |
| 86 | + logging.getLogger().info('Deleting template. %s', {'name': name}) |
| 87 | + response = self._portal.delete('/deviceTemplates/%s' % name) |
| 88 | + logging.getLogger().info('Template deleted. %s', {'name': name}) |
| 89 | + return response |
| 90 | + |
| 91 | + def set_default(self, name, wait=False): |
| 92 | + """ |
| 93 | + Set a Configuration Template as the default template |
| 94 | +
|
| 95 | + :param str name: Name of the template |
| 96 | + :param bool,optional wait: Wait for all changes to apply, defaults to `False` |
| 97 | + """ |
| 98 | + logging.getLogger().info('Setting default template. %s', {'name': name}) |
| 99 | + response = self._portal.execute('/deviceTemplates/%s' % name, 'setAsDefault') |
| 100 | + self.auto_assign.apply_changes(wait=wait) |
| 101 | + logging.getLogger().info('Set default template. %s', {'name': name}) |
| 102 | + return response |
| 103 | + |
| 104 | + def remove_default(self, name, wait=False): |
| 105 | + """ |
| 106 | + Set a Configuration Template not to be the default template |
| 107 | +
|
| 108 | + :param str name: Name of the template |
| 109 | + :param bool,optional wait: Wait for all changes to apply, defaults to `False` |
| 110 | + """ |
| 111 | + template = self.get(name, include=['isDefault']) |
| 112 | + if template.isDefault: |
| 113 | + logging.getLogger().info('Removing default template. %s', {'name': name}) |
| 114 | + response = self._portal.execute('', 'removeDefaultDeviceTemplate') |
| 115 | + logging.getLogger().info('Removed default template. %s', {'name': name}) |
| 116 | + self.auto_assign.apply_changes(wait=wait) |
| 117 | + return response |
| 118 | + logging.getLogger().info('Template not set as default. %s', {'name': name}) |
| 119 | + return None |
| 120 | + |
| 121 | + |
| 122 | +class TemplateAutoAssignPolicy(BaseCommand): |
| 123 | + |
| 124 | + def apply_changes(self, wait=False): |
| 125 | + """ |
| 126 | + Apply provisioning changes.\n |
| 127 | +
|
| 128 | + :param bool,optional wait: Wait for all changes to apply, defaults to `False` |
| 129 | + """ |
| 130 | + task = self._portal.execute('', 'applyAutoAssignmentRules') |
| 131 | + if wait: |
| 132 | + task = self._portal.tasks.wait(task) |
| 133 | + return task |
0 commit comments