Debian Codegraph @

ansible_collections/netapp/ontap/plugins/modules/na_ontap_quota_policy.py

raw
1 #!/usr/bin/python
2
3 # (c) 2019-2025, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 '''
7 na_ontap_quota_policy
8 '''
9
10 from __future__ import absolute_import, division, print_function
11
12 __metaclass__ = type
13
14 ANSIBLE_METADATA = {'metadata_version': '1.1',
15 'status': ['preview'],
16 'supported_by': 'certified'}
17
18 DOCUMENTATION = """
19 module: na_ontap_quota_policy
20 short_description: NetApp Ontap create, assign, rename or delete quota policy
21 extends_documentation_fragment:
22 - netapp.ontap.netapp.na_ontap_zapi
23 version_added: '19.11.0'
24 author: NetApp Ansible Team (@carchi8py) <[email protected]>
25 description:
26 - Create, assign, rename or delete the quota policy.
27 options:
28 state:
29 description:
30 - Whether the specified quota policy should exist or not.
31 choices: ['present', 'absent']
32 default: present
33 type: str
34
35 vserver:
36 description:
37 - Specifies the vserver for the quota policy.
38 required: true
39 type: str
40
41 name:
42 description:
43 - Specifies the quota policy name to create or rename to.
44 required: true
45 type: str
46
47 from_name:
48 description:
49 - Name of the existing quota policy to be renamed to name.
50 type: str
51
52 auto_assign:
53 description:
54 - when true, assign the policy to the vserver, whether it is newly created, renamed, or already exists.
55 - when true, the policy identified by name replaces the already assigned policy.
56 - when false, the policy is created if it does not already exist but is not assigned.
57 type: bool
58 default: true
59 version_added: 20.12.0
60 """
61
62 EXAMPLES = """
63 - name: Create quota policy
64 netapp.ontap.na_ontap_quota_policy:
65 state: present
66 vserver: SVM1
67 name: ansible_policy
68 hostname: "{{ netapp_hostname }}"
69 username: "{{ netapp_username }}"
70 password: "{{ netapp_password }}"
71
72 - name: Rename quota policy
73 netapp.ontap.na_ontap_quota_policy:
74 state: present
75 vserver: SVM1
76 name: new_ansible
77 from_name: ansible
78 hostname: "{{ netapp_hostname }}"
79 username: "{{ netapp_username }}"
80 password: "{{ netapp_password }}"
81
82 - name: Delete quota policy
83 netapp.ontap.na_ontap_quota_policy:
84 state: absent
85 vserver: SVM1
86 name: ansible_policy
87 hostname: "{{ netapp_hostname }}"
88 username: "{{ netapp_username }}"
89 password: "{{ netapp_password }}"
90 """
91
92 RETURN = """
93 """
94
95 import traceback
96
97 from ansible.module_utils.basic import AnsibleModule
98 from ansible.module_utils._text import to_native
99 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
100 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
101 from ansible_collections.netapp.ontap.plugins.module_utils import zapis_svm
102
103 HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
104
105
106 class NetAppOntapQuotaPolicy(object):
107 """
108 Create, assign, rename or delete a quota policy
109 """
110
111 def __init__(self):
112 """
113 Initialize the ONTAP quota policy class
114 """
115
116 self.argument_spec = netapp_utils.na_ontap_zapi_only_spec()
117 self.argument_spec.update(dict(
118 state=dict(required=False, choices=['present', 'absent'], default='present'),
119 vserver=dict(required=True, type='str'),
120 name=dict(required=True, type='str'),
121 from_name=dict(required=False, type='str'),
122 auto_assign=dict(required=False, type='bool', default=True),
123 ))
124
125 self.module = AnsibleModule(
126 argument_spec=self.argument_spec,
127 required_if=[
128 ('state', 'present', ['name', 'vserver'])
129 ],
130 supports_check_mode=True
131 )
132
133 # set up variables
134 self.na_helper = NetAppModule()
135 self.parameters = self.na_helper.set_parameters(self.module.params)
136 if HAS_NETAPP_LIB is False:
137 self.module.fail_json(msg='The python NetApp-Lib module is required')
138 else:
139 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
140
141 def get_quota_policy(self, policy_name=None):
142
143 if policy_name is None:
144 policy_name = self.parameters['name']
145
146 return_value = None
147 quota_policy_get_iter = netapp_utils.zapi.NaElement('quota-policy-get-iter')
148 quota_policy_info = netapp_utils.zapi.NaElement('quota-policy-info')
149 quota_policy_info.add_new_child('policy-name', policy_name)
150 quota_policy_info.add_new_child('vserver', self.parameters['vserver'])
151 query = netapp_utils.zapi.NaElement('query')
152 query.add_child_elem(quota_policy_info)
153 quota_policy_get_iter.add_child_elem(query)
154 try:
155 result = self.server.invoke_successfully(quota_policy_get_iter, True)
156 if result.get_child_by_name('attributes-list'):
157 quota_policy_attributes = result['attributes-list']['quota-policy-info']
158 return_value = {
159 'name': quota_policy_attributes['policy-name']
160 }
161 except netapp_utils.zapi.NaApiError as error:
162 self.module.fail_json(msg='Error fetching quota policy %s: %s' % (policy_name, to_native(error)),
163 exception=traceback.format_exc())
164 return return_value
165
166 def create_quota_policy(self):
167 """
168 Creates a new quota policy
169 """
170 quota_policy_obj = netapp_utils.zapi.NaElement("quota-policy-create")
171 quota_policy_obj.add_new_child("policy-name", self.parameters['name'])
172 quota_policy_obj.add_new_child("vserver", self.parameters['vserver'])
173 try:
174 self.server.invoke_successfully(quota_policy_obj, True)
175 except netapp_utils.zapi.NaApiError as error:
176 self.module.fail_json(msg='Error creating quota policy %s: %s' % (self.parameters['name'], to_native(error)),
177 exception=traceback.format_exc())
178
179 def delete_quota_policy(self):
180 """
181 Deletes a quota policy
182 """
183 quota_policy_obj = netapp_utils.zapi.NaElement("quota-policy-delete")
184 quota_policy_obj.add_new_child("policy-name", self.parameters['name'])
185 try:
186 self.server.invoke_successfully(quota_policy_obj, True)
187 except netapp_utils.zapi.NaApiError as error:
188 self.module.fail_json(msg='Error deleting quota policy %s: %s' % (self.parameters['name'], to_native(error)),
189 exception=traceback.format_exc())
190
191 def rename_quota_policy(self):
192 """
193 Rename a quota policy
194 """
195 quota_policy_obj = netapp_utils.zapi.NaElement("quota-policy-rename")
196 quota_policy_obj.add_new_child("policy-name", self.parameters['from_name'])
197 quota_policy_obj.add_new_child("vserver", self.parameters['vserver'])
198 quota_policy_obj.add_new_child("new-policy-name", self.parameters['name'])
199 try:
200 self.server.invoke_successfully(quota_policy_obj, True)
201 except netapp_utils.zapi.NaApiError as error:
202 self.module.fail_json(msg='Error renaming quota policy %s: %s' % (self.parameters['from_name'], to_native(error)),
203 exception=traceback.format_exc())
204
205 def apply(self):
206 current = self.get_quota_policy()
207 # rename and create are mutually exclusive
208 rename, cd_action = None, None
209 cd_action = self.na_helper.get_cd_action(current, self.parameters)
210 if cd_action == 'create' and self.parameters.get('from_name'):
211 # create policy by renaming it
212 rename = self.na_helper.is_rename_action(self.get_quota_policy(self.parameters['from_name']), current)
213 if rename is None:
214 self.module.fail_json(msg='Error renaming quota policy: %s does not exist.' % self.parameters['from_name'])
215
216 # check if policy should be assigned
217 assign_policy = cd_action == 'create' and self.parameters['auto_assign']
218 if cd_action is None and current and self.parameters['auto_assign']:
219 # find out if the existing policy needs to be changed
220 svm = zapis_svm.get_vserver(self.server, self.parameters['vserver'])
221 if svm.get('quota_policy') != self.parameters['name']:
222 assign_policy = True
223 self.na_helper.changed = True
224 if cd_action == 'delete':
225 # can't delete if already assigned
226 svm = zapis_svm.get_vserver(self.server, self.parameters['vserver'])
227 if svm.get('quota_policy') == self.parameters['name']:
228 self.module.fail_json(msg='Error policy %s cannot be deleted as it is assigned to the vserver %s' %
229 (self.parameters['name'], self.parameters['vserver']))
230
231 if self.na_helper.changed and not self.module.check_mode:
232 if rename:
233 self.rename_quota_policy()
234 elif cd_action == 'create':
235 self.create_quota_policy()
236 elif cd_action == 'delete':
237 self.delete_quota_policy()
238 if assign_policy:
239 zapis_svm.modify_vserver(self.server, self.module, self.parameters['vserver'], modify=dict(quota_policy=self.parameters['name']))
240 result = netapp_utils.generate_result(self.na_helper.changed, cd_action)
241 self.module.exit_json(**result)
242
243
244 def main():
245 """
246 Creates the NetApp Ontap quota policy object and runs the correct play task
247 """
248 obj = NetAppOntapQuotaPolicy()
249 obj.apply()
250
251
252 if __name__ == '__main__':
253 main()