Debian Codegraph @

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

raw
1 #!/usr/bin/python
2
3 # (c) 2023-2026, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 from __future__ import absolute_import, division, print_function
7 __metaclass__ = type
8
9 DOCUMENTATION = """
10 module: na_ontap_vserver_peer_permissions
11 short_description: NetApp Ontap - create, delete or modify vserver peer permission.
12 extends_documentation_fragment:
13 - netapp.ontap.netapp.na_ontap_rest
14 version_added: '22.3.0'
15 author: NetApp Ansible Team (@carchi8py) <[email protected]>
16 description:
17 - Create, delete or modify vserver peer permission.
18 options:
19 state:
20 description:
21 - Whether the specified vserver peer permission should exist or not.
22 choices: ['present', 'absent']
23 default: present
24 type: str
25 vserver:
26 description:
27 - Specifies name of the source Vserver in the relationship.
28 required: true
29 type: str
30 applications:
31 type: list
32 elements: str
33 required: true
34 description:
35 - List of applications which can make use of the peering relationship.
36 - FlexCache supported from ONTAP 9.5 onwards.
37 cluster_peer:
38 description:
39 - Specifies name of the peer Cluster.
40 type: str
41 required: true
42 lambda_config:
43 description:
44 - Configuration parameters for AWS Lambda proxy functionality.
45 - These option and suboptions are only supported with REST.
46 type: dict
47 version_added: 23.5.0
48 suboptions:
49 function_name:
50 description:
51 - The name of the AWS Lambda function to invoke.
52 type: str
53 required: true
54 aws_region:
55 description:
56 - The name of the AWS region.
57 type: str
58 required: true
59 aws_profile:
60 description:
61 - The name of the AWS profile to use for authentication.
62 type: str
63
64 notes:
65 - Supports AWS Lambda proxy functionality. See the README file for examples.
66 """
67
68 EXAMPLES = """
69 - name: Create vserver peer permission for an SVM
70 netapp.ontap.na_ontap_vserver_peer_permissions:
71 state: present
72 vserver: ansible
73 cluster_peer: test_cluster
74 applications: ['snapmirror']
75 hostname: "{{ netapp_hostname }}"
76 username: "{{ netapp_username }}"
77 password: "{{ netapp_password }}"
78
79 - name: Modify vserver peer permission for an SVM
80 netapp.ontap.na_ontap_vserver_peer_permissions:
81 state: present
82 vserver: ansible
83 cluster_peer: test_cluster
84 applications: ['snapmirror', 'flexcache']
85 hostname: "{{ netapp_hostname }}"
86 username: "{{ netapp_username }}"
87 password: "{{ netapp_password }}"
88
89 - name: Delete vserver peer permission for an SVM
90 netapp.ontap.na_ontap_vserver_peer_permissions:
91 state: absent
92 vserver: ansible
93 cluster_peer: test_cluster
94 applications: ['snapmirror']
95 hostname: "{{ netapp_hostname }}"
96 username: "{{ netapp_username }}"
97 password: "{{ netapp_password }}"
98 """
99
100 RETURN = """
101 """
102
103 from ansible.module_utils.basic import AnsibleModule
104 import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
105 from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
106 from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic
107
108
109 class NetAppONTAPVserverPeerPermissions:
110 """
111 Class with vserver peer permission methods
112 """
113
114 def __init__(self):
115
116 self.argument_spec = netapp_utils.na_ontap_rest_only_spec()
117 self.argument_spec.update(dict(
118 state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
119 vserver=dict(required=True, type='str'),
120 applications=dict(required=True, type='list', elements='str'),
121 cluster_peer=dict(required=True, type='str')
122 ))
123
124 self.argument_spec.update(netapp_utils.na_ontap_lambda_argument_spec())
125
126 self.module = AnsibleModule(
127 argument_spec=self.argument_spec,
128 supports_check_mode=True,
129 required_if=[['use_lambda', True, ('lambda_config',)]],
130 )
131
132 # set up variables
133 self.na_helper = NetAppModule()
134 self.parameters = self.na_helper.set_parameters(self.module.params)
135 self.rest_api = netapp_utils.OntapRestAPI(self.module)
136 self.rest_api.fail_if_not_rest_minimum_version('na_ontap_vserver_peer_permissions', 9, 6)
137 self.input_validation()
138 self.svm_uuid = None
139 self.cluster_peer_uuid = None
140
141 def input_validation(self):
142 if self.parameters.get('vserver') == '*':
143 self.module.fail_json(msg='As svm name * represents all svms and created by default, please provide a specific SVM name')
144 if self.parameters.get('applications') == [''] and self.parameters.get('state') == 'present':
145 self.module.fail_json(msg='Applications field cannot be empty, at least one application must be specified')
146
147 def get_vserver_peer_permission_rest(self):
148 """
149 Retrieves SVM peer permissions.
150 """
151 api = "svm/peer-permissions"
152 query = {
153 'svm.name': self.parameters['vserver'],
154 "cluster_peer.name": self.parameters['cluster_peer'],
155 'fields': 'svm.uuid,cluster_peer.uuid,applications'
156 }
157 record, error = rest_generic.get_one_record(self.rest_api, api, query)
158 if error:
159 self.module.fail_json(msg="Error on fetching vserver peer permissions: %s" % error)
160 if record:
161 self.svm_uuid = self.na_helper.safe_get(record, ['svm', 'uuid'])
162 self.cluster_peer_uuid = self.na_helper.safe_get(record, ['cluster_peer', 'uuid'])
163 return {
164 'applications': self.na_helper.safe_get(record, ['applications']),
165 }
166 return None
167
168 def create_vserver_peer_permission_rest(self):
169 """
170 Creates an SVM peer permission.
171 """
172 api = "svm/peer-permissions"
173 body = {
174 'svm.name': self.parameters['vserver'],
175 'cluster_peer.name': self.parameters['cluster_peer'],
176 'applications': self.parameters['applications']
177 }
178 record, error = rest_generic.post_async(self.rest_api, api, body)
179 if error:
180 self.module.fail_json(msg="Error on creating vserver peer permissions: %s" % error)
181
182 def delete_vserver_peer_permission_rest(self):
183 """
184 Deletes the SVM peer permissions.
185 """
186 api = "svm/peer-permissions/%s/%s" % (self.cluster_peer_uuid, self.svm_uuid)
187 record, error = rest_generic.delete_async(self.rest_api, api, None)
188 if error:
189 self.module.fail_json(msg="Error on deleting vserver peer permissions: %s" % error)
190
191 def modify_vserver_peer_permission_rest(self, modify):
192 """
193 Updates the SVM peer permissions.
194 """
195 body = {}
196 if 'applications' in modify:
197 body['applications'] = self.parameters['applications']
198 api = "svm/peer-permissions/%s/%s" % (self.cluster_peer_uuid, self.svm_uuid)
199 record, error = rest_generic.patch_async(self.rest_api, api, None, body)
200 if error:
201 self.module.fail_json(msg="Error on modifying vserver peer permissions: %s" % error)
202
203 def apply(self):
204 current = self.get_vserver_peer_permission_rest()
205 cd_action = self.na_helper.get_cd_action(current, self.parameters)
206 modify = self.na_helper.get_modified_attributes(current, self.parameters) if cd_action is None else None
207 if self.na_helper.changed and not self.module.check_mode:
208 if cd_action == 'create':
209 self.create_vserver_peer_permission_rest()
210 elif cd_action == 'delete':
211 self.delete_vserver_peer_permission_rest()
212 elif modify:
213 self.modify_vserver_peer_permission_rest(modify)
214 result = netapp_utils.generate_result(self.na_helper.changed, cd_action)
215 self.module.exit_json(**result)
216
217
218 def main():
219 """
220 Creates the NetApp Ontap vserver peer permission object and runs the correct play task
221 """
222 obj = NetAppONTAPVserverPeerPermissions()
223 obj.apply()
224
225
226 if __name__ == '__main__':
227 main()