summaryrefslogtreecommitdiffstats
path: root/ansible_collections/dellemc/unity/docs/modules
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-18 05:52:22 +0000
commit38b7c80217c4e72b1d8988eb1e60bb6e77334114 (patch)
tree356e9fd3762877d07cde52d21e77070aeff7e789 /ansible_collections/dellemc/unity/docs/modules
parentAdding upstream version 7.7.0+dfsg. (diff)
downloadansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.tar.xz
ansible-38b7c80217c4e72b1d8988eb1e60bb6e77334114.zip
Adding upstream version 9.4.0+dfsg.upstream/9.4.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/dellemc/unity/docs/modules')
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/cifsserver.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/consistencygroup.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/filesystem.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/filesystem_snapshot.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/host.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/info.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/interface.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/nasserver.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/nfs.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/nfsserver.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/replication_session.rst294
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/smbshare.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/snapshot.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/snapshotschedule.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/storagepool.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/tree_quota.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/user_quota.rst2
-rw-r--r--ansible_collections/dellemc/unity/docs/modules/volume.rst2
18 files changed, 311 insertions, 17 deletions
diff --git a/ansible_collections/dellemc/unity/docs/modules/cifsserver.rst b/ansible_collections/dellemc/unity/docs/modules/cifsserver.rst
index 71b7527f2..2c3c9286e 100644
--- a/ansible_collections/dellemc/unity/docs/modules/cifsserver.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/cifsserver.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/consistencygroup.rst b/ansible_collections/dellemc/unity/docs/modules/consistencygroup.rst
index ac5727cfd..4f6060c9f 100644
--- a/ansible_collections/dellemc/unity/docs/modules/consistencygroup.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/consistencygroup.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/filesystem.rst b/ansible_collections/dellemc/unity/docs/modules/filesystem.rst
index 81881dfbb..05ff4ebb9 100644
--- a/ansible_collections/dellemc/unity/docs/modules/filesystem.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/filesystem.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/filesystem_snapshot.rst b/ansible_collections/dellemc/unity/docs/modules/filesystem_snapshot.rst
index c75f81611..02fa2a6de 100644
--- a/ansible_collections/dellemc/unity/docs/modules/filesystem_snapshot.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/filesystem_snapshot.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/host.rst b/ansible_collections/dellemc/unity/docs/modules/host.rst
index b0afe55b9..d2e48dd18 100644
--- a/ansible_collections/dellemc/unity/docs/modules/host.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/host.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/info.rst b/ansible_collections/dellemc/unity/docs/modules/info.rst
index 7b1ef111c..6b2a9d8ad 100644
--- a/ansible_collections/dellemc/unity/docs/modules/info.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/info.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/interface.rst b/ansible_collections/dellemc/unity/docs/modules/interface.rst
index aad1c02e8..cc33254f5 100644
--- a/ansible_collections/dellemc/unity/docs/modules/interface.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/interface.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/nasserver.rst b/ansible_collections/dellemc/unity/docs/modules/nasserver.rst
index 284f37326..97d298b9c 100644
--- a/ansible_collections/dellemc/unity/docs/modules/nasserver.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/nasserver.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/nfs.rst b/ansible_collections/dellemc/unity/docs/modules/nfs.rst
index cce2058f5..c64c8983a 100644
--- a/ansible_collections/dellemc/unity/docs/modules/nfs.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/nfs.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/nfsserver.rst b/ansible_collections/dellemc/unity/docs/modules/nfsserver.rst
index 0836bb63c..15d786d58 100644
--- a/ansible_collections/dellemc/unity/docs/modules/nfsserver.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/nfsserver.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/replication_session.rst b/ansible_collections/dellemc/unity/docs/modules/replication_session.rst
new file mode 100644
index 000000000..b401c403d
--- /dev/null
+++ b/ansible_collections/dellemc/unity/docs/modules/replication_session.rst
@@ -0,0 +1,294 @@
+.. _replication_session_module:
+
+
+replication_session -- Manage replication session on Unity storage system
+=========================================================================
+
+.. contents::
+ :local:
+ :depth: 1
+
+
+Synopsis
+--------
+
+Managing replication session on Unity storage system includes getting details, pause, resume, sync, failover, failback and deleting the replication session.
+
+
+
+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
+----------
+
+ session_id (optional, str, None)
+ ID of replication session.
+
+
+ session_name (optional, str, None)
+ Name of replication session.
+
+
+ pause (optional, bool, None)
+ Pause or resume replication session.
+
+
+ sync (optional, bool, None)
+ Sync a replication session.
+
+
+ failover_with_sync (optional, bool, None)
+ If ``true``, Sync the source and destination resources before failing over the asynchronous replication session or keep them in sync after failing over the synchronous replication session.
+
+ If ``false``, Failover a replication session.
+
+
+ failback (optional, bool, None)
+ Failback a replication session.
+
+
+ force_full_copy (optional, bool, None)
+ Indicates whether to sync back all data from the destination SP to the source SP during the failback session. Needed during resume operation when replication session goes out of sync due to a fault.
+
+
+ force (optional, bool, None)
+ Skip pre-checks on file system(s) replication sessions of a NAS server when a replication failover is issued from the source NAS server.
+
+
+ state (optional, str, present)
+ State variable to determine whether replication session will 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.
+ - 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: Get replication session details
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+
+ - name: Get replication session details based on session_id
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_id: "103079215114_APM00213404195_0000_103079215274_APM00213404194_0000"
+
+ - name: Pause a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ pause: true
+
+ - name: Resume a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ pause: false
+ force_full_copy: true
+
+ - name: Sync a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ sync: true
+
+ - name: Failover with sync a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ failover_with_sync: true
+ force: true
+
+ - name: Failover a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ failover_with_sync: false
+
+ - name: Failback a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ failback: true
+ force_full_copy: true
+
+ - name: Delete a replication session
+ dellemc.unity.replication_session:
+ unispherehost: "{{unispherehost}}"
+ username: "{{username}}"
+ password: "{{password}}"
+ validate_certs: "{{validate_certs}}"
+ session_name: "fs_replication"
+ state: "absent"
+
+
+
+Return Values
+-------------
+
+changed (always, bool, True)
+ Whether or not the resource has changed.
+
+
+replication_session_details (When replication session exists., dict, {'current_transfer_est_remain_time': 0, 'daily_snap_replication_policy': None, 'dst_resource_id': 'nas_8', 'dst_spa_interface': {'UnityRemoteInterface': {'hash': 8771253398547, 'id': 'APM00213404195:if_181'}}, 'dst_spb_interface': {'UnityRemoteInterface': {'hash': 8771253424144, 'id': 'APM00213404195:if_180'}}, 'dst_status': 'ReplicationSessionStatusEnum.OK', 'existed': True, 'hash': 8771259012271, 'health': {'UnityHealth': {'hash': 8771253424168}}, 'hourly_snap_replication_policy': None, 'id': '103079215114_APM00213404195_0000_103079215274_APM00213404194_0000', 'last_sync_time': '2023-04-18 10:35:25+00:00', 'local_role': 'ReplicationSessionReplicationRoleEnum.DESTINATION', 'max_time_out_of_sync': 0, 'members': None, 'name': 'rep_sess_nas', 'network_status': 'ReplicationSessionNetworkStatusEnum.OK', 'remote_system': {'UnityRemoteSystem': {'hash': 8771253380142}}, 'replication_resource_type': 'ReplicationEndpointResourceTypeEnum.NASSERVER', 'src_resource_id': 'nas_213', 'src_spa_interface': {'UnityRemoteInterface': {'hash': 8771253475010, 'id': 'APM00213404194:if_195'}}, 'src_spb_interface': {'UnityRemoteInterface': {'hash': 8771253374169, 'id': 'APM00213404194:if_194'}}, 'src_status': 'ReplicationSessionStatusEnum.OK', 'status': 'ReplicationOpStatusEnum.ACTIVE', 'sync_progress': 0, 'sync_state': 'ReplicationSessionSyncStateEnum.IN_SYNC'})
+ Details of the replication session.
+
+
+ id (, str, )
+ Unique identifier of the replicationSession instance.
+
+
+ name (, str, )
+ User-specified replication session name.
+
+
+ replicationResourceType (, str, )
+ Replication resource type of replication session endpoints.
+
+
+ status (, str, )
+ Replication status of the replication session.
+
+
+ remoteSystem (, dict, )
+ Specifies the remote system to use as the destination for the replication session.
+
+
+ UnityRemoteSystem (, dict, )
+ Information about remote storage system.
+
+
+ id (, str, )
+ Unique identifier of the remote system instance.
+
+
+ serialNumber (, str, )
+ Serial number of the remote system.
+
+
+
+
+ maxTimeOutOfSync (, int, )
+ Maximum time to wait before the system syncs the source and destination resources.
+
+
+ srcStatus (, str, )
+ Status of the source end of the session.
+
+
+ networkStatus (, str, )
+ Status of the network connection used by the replication session.
+
+
+ dstStatus (, str, )
+ Status of the destination end of the replication session.
+
+
+ lastSyncTime (, str, )
+ Date and time of the last replication synchronization.
+
+
+ syncState (, str, )
+ Synchronization state between source and destination resource of the replication session.
+
+
+ syncProgress (, int, )
+ Synchronization completion percentage between source and destination resources of the replication session.
+
+
+ dstResourceId (, str, )
+ Identifier of the destination resource.
+
+
+ currentTransferEstRemainTime (, int, )
+ Estimated time left for the replication synchronization to complete.
+
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Jennifer John (@Jennifer-John) <ansible.team@dell.com>
+
diff --git a/ansible_collections/dellemc/unity/docs/modules/smbshare.rst b/ansible_collections/dellemc/unity/docs/modules/smbshare.rst
index 697bda3ff..027fcee25 100644
--- a/ansible_collections/dellemc/unity/docs/modules/smbshare.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/smbshare.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/snapshot.rst b/ansible_collections/dellemc/unity/docs/modules/snapshot.rst
index 46b2aa997..5ef582114 100644
--- a/ansible_collections/dellemc/unity/docs/modules/snapshot.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/snapshot.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/snapshotschedule.rst b/ansible_collections/dellemc/unity/docs/modules/snapshotschedule.rst
index 4e9a37de2..2ee511e8c 100644
--- a/ansible_collections/dellemc/unity/docs/modules/snapshotschedule.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/snapshotschedule.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/storagepool.rst b/ansible_collections/dellemc/unity/docs/modules/storagepool.rst
index 764f2a812..48875898f 100644
--- a/ansible_collections/dellemc/unity/docs/modules/storagepool.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/storagepool.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/tree_quota.rst b/ansible_collections/dellemc/unity/docs/modules/tree_quota.rst
index 285ab9d79..68afe348f 100644
--- a/ansible_collections/dellemc/unity/docs/modules/tree_quota.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/tree_quota.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/user_quota.rst b/ansible_collections/dellemc/unity/docs/modules/user_quota.rst
index 7d0bbb808..1f7be59b2 100644
--- a/ansible_collections/dellemc/unity/docs/modules/user_quota.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/user_quota.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.
diff --git a/ansible_collections/dellemc/unity/docs/modules/volume.rst b/ansible_collections/dellemc/unity/docs/modules/volume.rst
index ed4c5f202..bcb767f65 100644
--- a/ansible_collections/dellemc/unity/docs/modules/volume.rst
+++ b/ansible_collections/dellemc/unity/docs/modules/volume.rst
@@ -21,7 +21,7 @@ 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.12 or later.
+- Ansible-core 2.13 or later.
- Python 3.9, 3.10 or 3.11.
- Storops Python SDK 1.2.11.