Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2018-2025, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5 from __future__ import absolute_import, division, print_function
6 __metaclass__ = type
7
8 DOCUMENTATION = '''
9 author: NetApp Ansible Team (@carchi8py) <[email protected]>
10 description:
11 - Create/Delete NVMe Service
12 extends_documentation_fragment:
13 - netapp.ontap.netapp.na_ontap
14 module: na_ontap_nvme
15 options:
16 state:
17 choices: ['present', 'absent']
18 description:
19 - Whether the specified NVMe should exist or not.
20 default: present
21 type: str
22 vserver:
23 description:
24 - Name of the vserver to use.
25 required: true
26 type: str
27 status_admin:
28 description:
29 - Whether the status of NVMe should be up or down
30 type: bool
31 short_description: "NetApp ONTAP Manage NVMe Service"
32 version_added: 2.8.0
33 '''
34
35 EXAMPLES = """
36 - name: Create NVMe
37 netapp.ontap.na_ontap_nvme:
38 state: present
39 status_admin: false
40 vserver: "{{ vserver }}"
41 hostname: "{{ netapp_hostname }}"
42 username: "{{ netapp_username }}"
43 password: "{{ netapp_password }}"
44
45 - name: Modify NVMe
46 netapp.ontap.na_ontap_nvme:
47 state: present
48 status_admin: true
49 vserver: "{{ vserver }}"
50 hostname: "{{ netapp_hostname }}"
51 username: "{{ netapp_username }}"
52 password: "{{ netapp_password }}"
53
54 - name: Delete NVMe
55 netapp.ontap.na_ontap_nvme:
56 state: absent
57 vserver: "{{ vserver }}"
58 hostname: "{{ netapp_hostname }}"
59 username: "{{ netapp_username }}"
60 password: "{{ netapp_password }}"
61 """
62
63 RETURN = """
64 """
65
66 import traceback
67 from ansible.module_utils.basic import AnsibleModule
68 from ansible.module_utils._text import to_native
69 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
70 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
71 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
72 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
73
74
75 class NetAppONTAPNVMe:
76 """
77 Class with NVMe service methods
78 """
79
80 def __init__(self):
81 self.svm_uuid = None
82 self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
83 self.argument_spec.update(dict(
84 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
85 vserver=dict(required=True, type='str'),
86 status_admin=dict(required=False, type='bool')
87 ))
88
89 self.module = AnsibleModule(
90 argument_spec=self.argument_spec,
91 supports_check_mode=True
92 )
93
94 self.na_helper = NetAppModule()
95 self.parameters = self.na_helper.set_parameters(self.module.params)
96 self.rest_api = OntapRestAPI(self.module)
97 self.use_rest = self.rest_api.is_rest()
98
99 if not self.use_rest:
100 if not netapp_utils.has_netapp_lib():
101 self.module.fail_json(msg=netapp_utils.netapp_lib_is_required())
102 self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
103
104 def get_nvme(self):
105 """
106 Get current nvme details
107 :return: dict if nvme exists, None otherwise
108 """
109 if self.use_rest:
110 return self.get_nvme_rest()
111 nvme_get = netapp_utils.zapi.NaElement('nvme-get-iter')
112 query = {
113 'query': {
114 'nvme-target-service-info': {
115 'vserver': self.parameters['vserver']
116 }
117 }
118 }
119 nvme_get.translate_struct(query)
120 try:
121 result = self.server.invoke_successfully(nvme_get, enable_tunneling=False)
122 except netapp_utils.zapi.NaApiError as error:
123 self.module.fail_json(msg='Error fetching nvme info: %s' % to_native(error),
124 exception=traceback.format_exc())
125 if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1:
126 attributes_list = result.get_child_by_name('attributes-list')
127 nvme_info = attributes_list.get_child_by_name('nvme-target-service-info')
128 return {'status_admin': self.na_helper.get_value_for_bool(True, nvme_info.get_child_content('is-available'))}
129 return None
130
131 def create_nvme(self):
132 """
133 Create NVMe service
134 """
135 if self.use_rest:
136 return self.create_nvme_rest()
137 nvme_create = netapp_utils.zapi.NaElement('nvme-create')
138 if self.parameters.get('status_admin') is not None:
139 options = {'is-available': self.na_helper.get_value_for_bool(False, self.parameters['status_admin'])}
140 nvme_create.translate_struct(options)
141 try:
142 self.server.invoke_successfully(nvme_create, enable_tunneling=True)
143 except netapp_utils.zapi.NaApiError as error:
144 self.module.fail_json(msg='Error creating nvme for vserver %s: %s'
145 % (self.parameters['vserver'], to_native(error)),
146 exception=traceback.format_exc())
147
148 def delete_nvme(self):
149 """
150 Delete NVMe service
151 """
152 if self.use_rest:
153 return self.delete_nvme_rest()
154 nvme_delete = netapp_utils.zapi.NaElement('nvme-delete')
155 try:
156 self.server.invoke_successfully(nvme_delete, enable_tunneling=True)
157 except netapp_utils.zapi.NaApiError as error:
158 self.module.fail_json(msg='Error deleting nvme for vserver %s: %s'
159 % (self.parameters['vserver'], to_native(error)),
160 exception=traceback.format_exc())
161
162 def modify_nvme(self, status=None):
163 """
164 Modify NVMe service
165 """
166 if status is None:
167 status = self.parameters['status_admin']
168 if self.use_rest:
169 return self.modify_nvme_rest(status)
170 options = {'is-available': status}
171 nvme_modify = netapp_utils.zapi.NaElement('nvme-modify')
172 nvme_modify.translate_struct(options)
173 try:
174 self.server.invoke_successfully(nvme_modify, enable_tunneling=True)
175 except netapp_utils.zapi.NaApiError as error:
176 self.module.fail_json(msg='Error modifying nvme for vserver %s: %s'
177 % (self.parameters['vserver'], to_native(error)),
178 exception=traceback.format_exc())
179
180 def get_nvme_rest(self):
181 api = 'protocols/nvme/services'
182 params = {'svm.name': self.parameters['vserver'], 'fields': 'enabled'}
183 record, error = rest_generic.get_one_record(self.rest_api, api, params)
184 if error:
185 self.module.fail_json(msg='Error fetching nvme info for vserver: %s' % self.parameters['vserver'])
186 if record:
187 self.svm_uuid = record['svm']['uuid']
188 record['status_admin'] = record.pop('enabled')
189 return record
190 return None
191
192 def create_nvme_rest(self):
193 api = 'protocols/nvme/services'
194 body = {'svm.name': self.parameters['vserver']}
195 if self.parameters.get('status_admin') is not None:
196 body['enabled'] = self.parameters['status_admin']
197 dummy, error = rest_generic.post_async(self.rest_api, api, body)
198 if error:
199 self.module.fail_json(msg='Error creating nvme for vserver %s: %s' % (self.parameters['vserver'],
200 to_native(error)),
201 exception=traceback.format_exc())
202
203 def delete_nvme_rest(self):
204 api = 'protocols/nvme/services'
205 dummy, error = rest_generic.delete_async(self.rest_api, api, self.svm_uuid)
206 if error:
207 self.module.fail_json(msg='Error deleting nvme for vserver %s: %s' % (self.parameters['vserver'],
208 to_native(error)),
209 exception=traceback.format_exc())
210
211 def modify_nvme_rest(self, status):
212 if status == 'false':
213 status = False
214 api = 'protocols/nvme/services'
215 dummy, error = rest_generic.patch_async(self.rest_api, api, self.svm_uuid, {'enabled': status})
216 if error:
217 self.module.fail_json(msg='Error modifying nvme for vserver: %s' % self.parameters['vserver'])
218
219 def apply(self):
220 """
221 Apply action to NVMe service
222 """
223 modify = None
224 current = self.get_nvme()
225 cd_action = self.na_helper.get_cd_action(current, self.parameters)
226 if self.parameters.get('status_admin') is not None:
227 if cd_action is None and self.parameters['state'] == 'present':
228 modify = self.na_helper.get_modified_attributes(current, self.parameters)
229 if self.na_helper.changed and not self.module.check_mode:
230 if cd_action == 'create':
231 self.create_nvme()
232 elif cd_action == 'delete':
233 # NVMe status_admin needs to be down before deleting it
234 self.modify_nvme('false')
235 self.delete_nvme()
236 elif modify:
237 self.modify_nvme()
238 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
239 self.module.exit_json(**result)
240
241
242 def main():
243 """Execute action"""
244 community_obj = NetAppONTAPNVMe()
245 community_obj.apply()
246
247
248 if __name__ == '__main__':
249 main()