Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2020-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_wwpn_alias
8 '''
9
10 from __future__ import absolute_import, division, print_function
11
12 __metaclass__ = type
13
14 ANSIBLE_METADATA = {
15 'metadata_version': '1.1',
16 'status': ['preview'],
17 'supported_by': 'certified'
18 }
19
20 DOCUMENTATION = '''
21
22 module: na_ontap_wwpn_alias
23 author: NetApp Ansible Team (@carchi8py) <[email protected]>
24 short_description: NetApp ONTAP set FCP WWPN Alias
25 extends_documentation_fragment:
26 - netapp.ontap.netapp.na_ontap_rest
27 version_added: '20.4.0'
28 description:
29 - Create/Delete FCP WWPN Alias
30
31 options:
32 state:
33 description:
34 - Whether the specified alias should exist or not.
35 choices: ['present', 'absent']
36 default: present
37 type: str
38
39 name:
40 description:
41 - The name of the alias to create or delete.
42 required: true
43 type: str
44
45 wwpn:
46 description:
47 - WWPN of the alias.
48 type: str
49
50 vserver:
51 description:
52 - The name of the vserver to use.
53 required: true
54 type: str
55
56 '''
57
58 EXAMPLES = '''
59 - name: Create FCP Alias
60 netapp.ontap.na_ontap_wwpn_alias:
61 state: present
62 name: alias1
63 wwpn: 01:02:03:04:0a:0b:0c:0d
64 vserver: ansibleVServer
65 hostname: "{{ netapp_hostname }}"
66 username: "{{ netapp_username }}"
67 password: "{{ netapp_password }}"
68
69 - name: Delete FCP Alias
70 netapp.ontap.na_ontap_wwpn_alias:
71 state: absent
72 name: alias1
73 vserver: ansibleVServer
74 hostname: "{{ netapp_hostname }}"
75 username: "{{ netapp_username }}"
76 password: "{{ netapp_password }}"
77 '''
78
79 RETURN = '''
80 '''
81
82
83 from ansible.module_utils.basic import AnsibleModule
84 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
85 from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
86 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
87
88
89 class NetAppOntapWwpnAlias(object):
90 ''' ONTAP WWPN alias operations '''
91 def __init__(self):
92
93 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
94 self.argument_spec.update(dict(
95 state=dict(required=False, choices=[
96 'present', 'absent'], default='present'),
97 name=dict(required=True, type='str'),
98 wwpn=dict(required=False, type='str'),
99 vserver=dict(required=True, type='str')
100 ))
101
102 self.module = AnsibleModule(
103 argument_spec=self.argument_spec,
104 required_if=[('state', 'present', ['wwpn'])],
105 supports_check_mode=True
106 )
107 self.na_helper = NetAppModule()
108 self.parameters = self.na_helper.set_parameters(self.module.params)
109
110 # REST API should be used for ONTAP 9.6 or higher.
111 self.rest_api = OntapRestAPI(self.module)
112 if self.rest_api.is_rest():
113 self.use_rest = True
114 else:
115 self.module.fail_json(msg=self.rest_api.requires_ontap_9_6('na_ontap_wwpn_alias'))
116
117 def get_alias(self, uuid):
118 params = {'fields': 'alias,wwpn',
119 'alias': self.parameters['name'],
120 'svm.uuid': uuid}
121 api = 'network/fc/wwpn-aliases'
122 message, error = self.rest_api.get(api, params)
123 if error is not None:
124 self.module.fail_json(msg="Error on fetching wwpn alias: %s" % error)
125 if message['num_records'] > 0:
126 return {'name': message['records'][0]['alias'],
127 'wwpn': message['records'][0]['wwpn'],
128 }
129 else:
130 return None
131
132 def create_alias(self, uuid, is_modify=False):
133 params = {'alias': self.parameters['name'],
134 'wwpn': self.parameters['wwpn'],
135 'svm.uuid': uuid}
136 api = 'network/fc/wwpn-aliases'
137 dummy, error = self.rest_api.post(api, params)
138 if error is not None:
139 if is_modify:
140 self.module.fail_json(msg="Error on modifying wwpn alias when trying to re-create alias: %s." % error)
141 else:
142 self.module.fail_json(msg="Error on creating wwpn alias: %s." % error)
143
144 def delete_alias(self, uuid, is_modify=False):
145 api = 'network/fc/wwpn-aliases/%s/%s' % (uuid, self.parameters['name'])
146 dummy, error = self.rest_api.delete(api)
147 if error is not None:
148 if is_modify:
149 self.module.fail_json(msg="Error on modifying wwpn alias when trying to delete alias: %s." % error)
150 else:
151 self.module.fail_json(msg="Error on deleting wwpn alias: %s." % error)
152
153 def get_svm_uuid(self):
154 """
155 Get a svm's UUID
156 :return: uuid of the svm.
157 """
158 params = {'fields': 'uuid', 'name': self.parameters['vserver']}
159 api = "svm/svms"
160 message, error = self.rest_api.get(api, params)
161 if error is not None:
162 self.module.fail_json(msg="Error on fetching svm uuid: %s" % error)
163 return message['records'][0]['uuid']
164
165 def apply(self):
166 cd_action, uuid, modify = None, None, None
167 uuid = self.get_svm_uuid()
168 current = self.get_alias(uuid)
169 cd_action = self.na_helper.get_cd_action(current, self.parameters)
170 if cd_action is None and self.parameters['state'] == 'present':
171 modify = self.na_helper.get_modified_attributes(current, self.parameters)
172
173 if self.na_helper.changed:
174 if self.module.check_mode:
175 pass
176 else:
177 if cd_action == 'create':
178 self.create_alias(uuid)
179 elif cd_action == 'delete':
180 self.delete_alias(uuid)
181 elif modify:
182 self.delete_alias(uuid, is_modify=True)
183 self.create_alias(uuid, is_modify=True)
184 result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify)
185 self.module.exit_json(**result)
186
187
188 def main():
189 alias = NetAppOntapWwpnAlias()
190 alias.apply()
191
192
193 if __name__ == '__main__':
194 main()