1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
.. _nfsserver_module:
nfsserver -- Manage NFS server on Unity storage system
======================================================
.. contents::
:local:
:depth: 1
Synopsis
--------
Managing the NFS server on the Unity storage system includes creating NFS server, getting NFS server details and deleting NFS server attributes.
Requirements
------------
The below requirements are needed on the host that executes this module.
- A Dell Unity Storage device version 5.1 or later.
- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
Parameters
----------
nas_server_name (optional, str, None)
Name of the NAS server on which NFS server will be hosted.
nas_server_id (optional, str, None)
ID of the NAS server on which NFS server will be hosted.
nfs_server_id (optional, str, None)
ID of the NFS server.
host_name (optional, str, None)
Host name of the NFS server.
nfs_v4_enabled (optional, bool, None)
Indicates whether the NFSv4 is enabled on the NAS server.
is_secure_enabled (optional, bool, None)
Indicates whether the secure NFS is enabled.
kerberos_domain_controller_type (optional, str, None)
Type of Kerberos Domain Controller used for secure NFS service.
kerberos_domain_controller_username (optional, str, None)
Kerberos Domain Controller administrator username.
kerberos_domain_controller_password (optional, str, None)
Kerberos Domain Controller administrator password.
is_extended_credentials_enabled (optional, bool, None)
Indicates whether support for more than 16 unix groups in a Unix credential.
remove_spn_from_kerberos (optional, bool, True)
Indicates whether to remove the SPN from Kerberos Domain Controller.
state (True, str, None)
Define whether the NFS server should exist or not.
unispherehost (True, str, None)
IP or FQDN of the Unity management server.
username (True, str, None)
The username of the Unity management server.
password (True, str, None)
The password of the Unity management server.
validate_certs (optional, bool, True)
Boolean variable to specify whether or not to validate SSL certificate.
``true`` - Indicates that the SSL certificate should be verified.
``false`` - Indicates that the SSL certificate should not be verified.
port (optional, int, 443)
Port number through which communication happens with Unity management server.
Notes
-----
.. note::
- The *check_mode* is supported.
- Modify operation for NFS Server is not supported.
- When *kerberos_domain_controller_type* is ``UNIX``, *kdc_type* in *nfs_server_details* output is displayed as ``null``.
- The modules present in this collection named as 'dellemc.unity' are built to support the Dell Unity storage platform.
Examples
--------
.. code-block:: yaml+jinja
- name: Create NFS server with kdctype as Windows
dellemc.unity.nfsserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
host_name: "dummy_nas23"
is_secure_enabled: True
kerberos_domain_controller_type: "WINDOWS"
kerberos_domain_controller_username: "administrator"
kerberos_domain_controller_password: "Password123!"
is_extended_credentials_enabled: True
nfs_v4_enabled: True
state: "present"
- name: Create NFS server with kdctype as Unix
dellemc.unity.nfsserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
host_name: "dummy_nas23"
is_secure_enabled: True
kerberos_domain_controller_type: "UNIX"
is_extended_credentials_enabled: True
nfs_v4_enabled: True
state: "present"
- name: Get NFS server details
dellemc.unity.nfsserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
state: "present"
- name: Delete NFS server
dellemc.unity.nfsserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
kerberos_domain_controller_username: "administrator"
kerberos_domain_controller_password: "Password123!"
unjoin_server_account: False
state: "absent"
Return Values
-------------
changed (always, bool, True)
Whether or not the resource has changed.
nfs_server_details (When NFS server exists, dict, {'credentials_cache_ttl': '0:15:00', 'existed': True, 'file_interfaces': {'UnityFileInterfaceList': [{'UnityFileInterface': {'hash': 8778980109421, 'id': 'if_37'}}]}, 'hash': 8778980109388, 'host_name': 'dummy_nas23.pie.lab.emc.com', 'id': 'nfs_51', 'is_extended_credentials_enabled': True, 'is_secure_enabled': True, 'kdc_type': 'KdcTypeEnum.WINDOWS', 'nas_server': {'UnityNasServer': {'hash': 8778980109412}}, 'nfs_v4_enabled': True, 'servicee_principal_name': None})
Details of the NFS server.
credentials_cache_ttl (, str, )
Credential cache refresh timeout. Resolution is in minutes. Default value is 15 minutes.
existed (, bool, )
Indicates if NFS Server exists.
host_name (, str, )
Host name of the NFS server.
id (, str, )
Unique identifier of the NFS Server instance.
is_extended_credentials_enabled (, bool, )
Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential.
is_secure_enabled (, bool, )
Indicates whether secure NFS is enabled on the NFS server.
kdc_type (, str, )
Type of Kerberos Domain Controller used for secure NFS service.
nfs_v4_enabled (, bool, )
Indicates whether NFSv4 is enabled on the NAS server.
servicee_principal_name (, str, )
The Service Principal Name (SPN) for the NFS Server.
Status
------
Authors
~~~~~~~
- Meenakshi Dembi (@dembim) <ansible.team@dell.com>
|
