dellemc.unity.nasserver module – Manage NAS servers on Unity storage system
Note
This module is part of the dellemc.unity collection (version 1.7.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.unity.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.unity.nasserver.
New in dellemc.unity 1.1.0
Synopsis
Managing NAS servers on Unity storage system includes get, modification to the NAS servers.
Aliases: dellemc_unity_nasserver
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
Parameter |
Comments |
|---|---|
This flag is used to mandatorily disable access in case of any user mapping failure. If If It can be mentioned during modification of the NAS server. Choices:
|
|
This is the directory service used for querying identity information for UNIX (such as UIDs, GIDs, net groups). It can be mentioned during modification of the NAS server. Choices:
|
|
Default Unix user name used for granting access in the case of Windows to Unix user mapping failure. It can be mentioned during modification of the NAS server. |
|
Default windows user name used for granting access in the case of Unix to Windows user mapping failure. It can be mentioned during modification of the NAS server. |
|
This parameter indicates whether a Unix to/from Windows user name mapping is enabled. It can be mentioned during modification of the NAS server. Choices:
|
|
It specifies whether the NAS server is used as backup only. It can be mentioned during modification of the NAS server. Choices:
|
|
This parameter indicates whether multiprotocol sharing mode is enabled. It can be mentioned during modification of the NAS server. Choices:
|
|
If the packet has to be reflected, then this parameter has to be set to It can be mentioned during modification of the NAS server. Choices:
|
|
It specifies whether the NAS server is a replication destination. It can be mentioned during modification of the NAS server. Choices:
|
|
The ID of the NAS server. Either nas_server_name or nas_server_id is required to perform the task. The parameters nas_server_name and nas_server_id are mutually exclusive. |
|
The Name of the NAS server. Either nas_server_name or nas_server_id is required to perform the task. The parameters nas_server_name and nas_server_id are mutually exclusive. |
|
The new name of the NAS server. It can be mentioned during modification of the NAS server. |
|
The password of the Unity management server. |
|
Port number through which communication happens with Unity management server. Default: |
|
Settings required for enabling replication. |
|
Name of the destination nas server. Default value will be source nas server name prefixed by ‘DR_’. |
|
Id of pool to allocate destination Luns. Mutually exclusive with destination_pool_name. |
|
Name of pool to allocate destination Luns. Mutually exclusive with destination_pool_id. |
|
Storage process of destination nas server Choices:
|
|
Indicates if the destination nas server is backup. Choices:
|
|
Replication name to rename the session to. |
|
Details of remote system to which the replication is being configured. The remote_system option should be specified if the replication_type is |
|
IP or FQDN for remote Unity unisphere Host. |
|
Password of remote Unity unisphere Host. |
|
Port at which remote Unity unisphere is hosted. Default: |
|
User name of remote Unity unisphere Host. |
|
Boolean variable to specify whether or not to validate SSL certificate of remote Unity unisphere Host.
Choices:
|
|
The replication mode. This is mandatory to enable replication. Choices:
|
|
User defined name for replication session. |
|
Type of replication. Choices:
|
|
Maximum time to wait before the system syncs the source and destination LUNs. The rpo option should be specified if the replication_mode is The value should be in range of |
|
This parameter indicates if existing NAS Server is to be used for replication. Choices:
|
|
State of the replication. Choices:
|
|
Define the state of NAS server on the array. The value present indicates that NAS server should exist on the system after the task is executed. In this release deletion of NAS server is not supported. Hence, if state is set to For any non-existing NAS server, if state is set to Choices:
|
|
IP or FQDN of the Unity management server. |
|
The username of the Unity management server. |
|
Boolean variable to specify whether or not to validate SSL certificate.
Choices:
|
Notes
Note
The check_mode is not supported.
The modules present in this collection named as ‘dellemc.unity’ are built to support the Dell Unity storage platform.
Examples
- name: Get Details of NAS Server
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "{{nas_server_name}}"
state: "present"
- name: Modify Details of NAS Server
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "{{nas_server_name}}"
nas_server_new_name: "updated_sample_nas_server"
is_replication_destination: false
is_backup_only: false
is_multiprotocol_enabled: true
allow_unmapped_user: true
default_unix_user: "default_unix_sample_user"
default_windows_user: "default_windows_sample_user"
enable_windows_to_unix_username_mapping: true
current_unix_directory_service: "LDAP"
is_packet_reflect_enabled: true
state: "present"
- name: Enable replication for NAS Server on Local System
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_id: "nas_10"
replication_reuse_resource: false
replication_params:
replication_name: "test_replication"
destination_nas_server_name: "destination_nas"
replication_mode: "asynchronous"
rpo: 60
replication_type: "local"
destination_pool_name: "Pool_Ansible_Neo_DND"
destination_sp: "SPA"
is_backup: true
replication_state: "enable"
state: "present"
- name: Enable replication for NAS Server on Remote System
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
replication_reuse_resource: false
replication_params:
replication_name: "test_replication"
destination_nas_server_name: "destination_nas"
replication_mode: "asynchronous"
rpo: 60
replication_type: "remote"
remote_system:
remote_system_host: '10.10.10.10'
remote_system_verifycert: false
remote_system_username: 'test1'
remote_system_password: 'test1!'
destination_pool_name: "fastVP_pool"
destination_sp: "SPA"
is_backup: true
replication_state: "enable"
state: "present"
- name: Enable replication for NAS Server on Remote System in existing NAS Server
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
replication_reuse_resource: true
replication_params:
destination_nas_server_name: "destination_nas"
replication_mode: "asynchronous"
rpo: 60
replication_type: "remote"
replication_name: "test_replication"
remote_system:
remote_system_host: '10.10.10.10'
remote_system_verifycert: false
remote_system_username: 'test1'
remote_system_password: 'test1!'
destination_pool_name: "fastVP_pool"
replication_state: "enable"
state: "present"
- name: Modify replication on the nasserver
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
replication_params:
replication_name: "test_repl"
new_replication_name: "test_repl_updated"
replication_mode: "asynchronous"
rpo: 50
replication_state: "enable"
state: "present"
- name: Disable replication on the nasserver
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
replication_state: "disable"
state: "present"
- name: Disable replication by specifying replication_name on the nasserver
dellemc.unity.nasserver:
unispherehost: "{{unispherehost}}"
username: "{{username}}"
password: "{{password}}"
validate_certs: "{{validate_certs}}"
nas_server_name: "dummy_nas"
replication_params:
replication_name: "test_replication"
replication_state: "disable"
state: "present"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Whether or not the resource has changed. Returned: always Sample: |
|
The NAS server details. Returned: When NAS server exists. Sample: |
|
Enable/disable access status in case of any user mapping failure. Returned: success |
|
Directory service used for querying identity information for UNIX (such as UIDs, GIDs, net groups). Returned: success |
|
Default Unix user name used for granting access in the case of Windows to Unix user mapping failure. Returned: success |
|
Default windows user name used for granting access in the case of Unix to Windows user mapping failure. Returned: success |
|
ID of the NAS server. Returned: success |
|
Whether the NAS server is used as backup only. Returned: success |
|
Indicates whether multiprotocol sharing mode is enabled. Returned: success |
|
If the packet reflect has to be enabled. Returned: success |
|
If the NAS server is a replication destination then true. Returned: success |
|
Indicates whether a Unix to/from Windows user name mapping is enabled. Returned: success |
|
Name of the NAS server. Returned: success |