Document update for Release 3.1.0

dell · Jan 25, 2024 · d08ccd2 · d08ccd2
1 parent bec5d72
commit d08ccd2
Show file tree

Hide file tree

Showing 39 changed files with 1,952 additions and 482 deletions.
diff --git a/docs/modules/certificate.rst b/docs/modules/certificate.rst
@@ -21,8 +21,8 @@ Requirements
 The below requirements are needed on the host that executes this module.
 
 - A Dell PowerStore storage system version 3.0.0.0 or later.
-- Ansible-core 2.14 or later.
-- PyPowerStore 2.1.0.
+- Ansible-core 2.13 or later.
+- PyPowerStore 3.0.0.
 - Python 3.9, 3.10 or 3.11.
 
 
@@ -51,7 +51,7 @@ Parameters
 
 
   certificate (optional, str, None)
-    Concatenated PEM encoded x509\_certificate string from end-entity certificate to root certificate.
+    Concatenated PEM encoded x509_certificate string from end-entity certificate to root certificate.
 
 
   remote_address (optional, str, None)
@@ -85,9 +85,9 @@ Parameters
   validate_certs (optional, bool, True)
     Boolean variable to specify whether to validate SSL certificate or not.
 
-    \ :literal:`true`\  - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate.
+    ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
 
-    \ :literal:`false`\  - indicates that the SSL certificate should not be verified.
+    ``false`` - indicates that the SSL certificate should not be verified.
 
 
   user (True, str, None)
@@ -118,10 +118,10 @@ Notes
 
 .. note::
    - Idempotency is not supported for adding/importing certificates, exchange of certificates and the reset of certificates.
-   - Only \ :emphasis:`is\_current`\  parameter is supported for modification of certificate.
+   - Only *is_current* parameter is supported for modification of certificate.
    - Reset operation can reset more than one certificate at a time.
    - Add/import, modify and reset are supported for PowerStore versions 2.0 and above only.
-   - The \ :emphasis:`check\_mode`\  is not supported.
+   - The *check_mode* is not supported.
    - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.
 
 
@@ -228,7 +228,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482
 
 
   members (, complex, )
-    Member certificates included in this x509\_certificate.
+    Member certificates included in this x509_certificate.
 
 
     subject (, str, )
@@ -256,7 +256,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482
 
 
     subject_alternative_names (, list, )
-      Additional DNS names or IP addresses in the x509\_certificate.
+      Additional DNS names or IP addresses in the x509_certificate.
 
 
     public_key_algorithm (, str, )
@@ -284,7 +284,7 @@ certificate_details (When certificate exists, complex, {'id': '1f0fd938-f122-482
 
 
     thumbprint_algorithm_l10n (, str, )
-      Localized message string corresponding to thumbprint\_algorithm.
+      Localized message string corresponding to thumbprint_algorithm.
 
 
 

diff --git a/docs/modules/cluster.rst b/docs/modules/cluster.rst
@@ -21,8 +21,8 @@ Requirements
 The below requirements are needed on the host that executes this module.
 
 - A Dell PowerStore storage system version 3.0.0.0 or later.
-- Ansible-core 2.14 or later.
-- PyPowerStore 2.1.0.
+- Ansible-core 2.13 or later.
+- PyPowerStore 3.0.0.
 - Python 3.9, 3.10 or 3.11.
 
 
@@ -53,23 +53,23 @@ Parameters
   appliance_id (optional, str, None)
     ID of the appliance.
 
-    Parameters \ :emphasis:`appliance\_id`\  and \ :emphasis:`appliance\_name`\  are mutually exclusive.
+    Parameters *appliance_id* and *appliance_name* are mutually exclusive.
 
-    Parameter \ :emphasis:`is\_ssh\_enabled`\  has to be passed along with \ :emphasis:`appliance\_id`\ .
+    Parameter *is_ssh_enabled* has to be passed along with *appliance_id*.
 
 
   appliance_name (optional, str, None)
     Name of the appliance.
 
-    Parameters \ :emphasis:`appliance\_id`\  and \ :emphasis:`appliance\_name`\  are mutually exclusive.
+    Parameters *appliance_id* and *appliance_name* are mutually exclusive.
 
-    Parameter \ :emphasis:`is\_ssh\_enabled`\  has to be passed along with \ :emphasis:`appliance\_name`\ .
+    Parameter *is_ssh_enabled* has to be passed along with *appliance_name*.
 
 
   is_ssh_enabled (optional, bool, None)
     Whether SSH access is enabled for the cluster.
 
-    Either \ :emphasis:`appliance\_id`\  or \ :emphasis:`appliance\_name`\  is to be passed along with \ :emphasis:`is\_ssh\_enabled`\ .
+    Either *appliance_id* or *appliance_name* is to be passed along with *is_ssh_enabled*.
 
 
   physical_mtu (optional, int, None)
@@ -150,7 +150,7 @@ Parameters
 
 
       snmp_community_string (optional, str, None)
-        Specifies \ :literal:`SNMPv2`\  community string, if \ :literal:`SNMPv2`\  connect method is selected.
+        Specifies ``SNMPv2`` community string, if ``SNMPv2`` connect method is selected.
 
 
 
@@ -229,7 +229,7 @@ Parameters
 
       This should be specified when creating PowerStore X cluster.
 
-      Mutually exclusive with \ :emphasis:`data\_center\_id`\ .
+      Mutually exclusive with *data_center_id*.
 
 
     data_center_id (optional, str, None)
@@ -239,7 +239,7 @@ Parameters
 
       This should be specified when creating PowerStore X cluster.
 
-      Mutually exclusive with \ :emphasis:`data\_center\_name`\ .
+      Mutually exclusive with *data_center_name*.
 
 
     esx_cluster_name (optional, str, None)
@@ -273,15 +273,15 @@ Parameters
   wait_for_completion (optional, bool, False)
     Flag to indicate if the operation should be run synchronously or asynchronously.
 
-    \ :literal:`true`\  signifies synchronous execution. By default, create cluster operation will run asynchronously.
+    ``true`` signifies synchronous execution. By default, create cluster operation will run asynchronously.
 
 
   state (True, str, None)
     Define whether the cluster should exist or not.
 
-    Value \ :literal:`present`\  indicates that the cluster should exist on the system.
+    Value ``present`` indicates that the cluster should exist on the system.
 
-    Value \ :literal:`absent`\  indicates that the cluster should not exist on the system.
+    Value ``absent`` indicates that the cluster should not exist on the system.
 
 
   array_ip (True, str, None)
@@ -291,9 +291,9 @@ Parameters
   validate_certs (optional, bool, True)
     Boolean variable to specify whether to validate SSL certificate or not.
 
-    \ :literal:`true`\  - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate.
+    ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
 
-    \ :literal:`false`\  - indicates that the SSL certificate should not be verified.
+    ``false`` - indicates that the SSL certificate should not be verified.
 
 
   user (True, str, None)
@@ -324,13 +324,13 @@ Notes
 
 .. note::
    - Deletion of a cluster is not supported by ansible module.
-   - The \ :emphasis:`check\_mode`\  is not supported.
+   - The *check_mode* is not supported.
    - Before performing create operation, the default password for admin user and service user should be changed.
-   - For management type network during cluster creation, \ :emphasis:`storage\_discovery\_address`\  and purposes should not be passed.
-   - The \ :emphasis:`vcenters`\  parameter is mandatory for PowerStore X cluster creation.
+   - For management type network during cluster creation, *storage_discovery_address* and purposes should not be passed.
+   - The *vcenters* parameter is mandatory for PowerStore X cluster creation.
    - Minimum 3 and 5 addresses are required for management network for PowerStore T and X model respectively.
-   - The \ :literal:`File\_Mobility`\  purpose is supported only in FootHills Prime and above.
-   - Parameter \ :emphasis:`is\_http\_redirect\_enabled`\  is supported only in PowerStore FootHills Prime and above.
+   - The ``File_Mobility`` purpose is supported only in FootHills Prime and above.
+   - Parameter *is_http_redirect_enabled* is supported only in PowerStore FootHills Prime and above.
    - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.
 
 
@@ -577,7 +577,7 @@ cluster_details (When Cluster exists., complex, {'appliance_count': 1, 'chap_mod
 
 
   appliance_details (When appliance name or id is passed in the playbook task., complex, )
-    Name and Id of the appliance for which \ :emphasis:`is\_ssh\_enabled`\  parameter is used.
+    Name and Id of the appliance for which *is_ssh_enabled* parameter is used.
 
 
     id (, str, )

diff --git a/docs/modules/dns.rst b/docs/modules/dns.rst
@@ -21,8 +21,8 @@ Requirements
 The below requirements are needed on the host that executes this module.
 
 - A Dell PowerStore storage system version 3.0.0.0 or later.
-- Ansible-core 2.14 or later.
-- PyPowerStore 2.1.0.
+- Ansible-core 2.13 or later.
+- PyPowerStore 3.0.0.
 - Python 3.9, 3.10 or 3.11.
 
 
@@ -39,13 +39,13 @@ Parameters
 
 
   dns_address_state (optional, str, None)
-    State of the addresses mentioned in \ :emphasis:`dns\_addresses`\ .
+    State of the addresses mentioned in *dns_addresses*.
 
 
   state (True, str, None)
     The state of the DNS instance after the task is performed.
 
-    For get and modify operations it should be set to \ :literal:`present`\ .
+    For get and modify operations it should be set to ``present``.
 
 
   array_ip (True, str, None)
@@ -55,9 +55,9 @@ Parameters
   validate_certs (optional, bool, True)
     Boolean variable to specify whether to validate SSL certificate or not.
 
-    \ :literal:`true`\  - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate.
+    ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
 
-    \ :literal:`false`\  - indicates that the SSL certificate should not be verified.
+    ``false`` - indicates that the SSL certificate should not be verified.
 
 
   user (True, str, None)
@@ -88,9 +88,9 @@ Notes
 
 .. note::
    - Minimum 1 and maximum 3 addresses can be associated to a DNS instance.
-   - Parameters \ :emphasis:`dns\_addresses`\  and \ :emphasis:`dns\_address\_state`\  are required together.
+   - Parameters *dns_addresses* and *dns_address_state* are required together.
    - Creation and deletion of DNS is not supported.
-   - The \ :emphasis:`check\_mode`\  is not supported.
+   - The *check_mode* is not supported.
    - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.
 
 

diff --git a/docs/modules/email.rst b/docs/modules/email.rst
@@ -27,8 +27,8 @@ Requirements
 The below requirements are needed on the host that executes this module.
 
 - A Dell PowerStore storage system version 3.0.0.0 or later.
-- Ansible-core 2.14 or later.
-- PyPowerStore 2.1.0.
+- Ansible-core 2.13 or later.
+- PyPowerStore 3.0.0.
 - Python 3.9, 3.10 or 3.11.
 
 
@@ -39,13 +39,13 @@ Parameters
   email_id (optional, str, None)
     Unique identifier of the destination email address.
 
-    Mutually exclusive with \ :emphasis:`email\_address`\ .
+    Mutually exclusive with *email_address*.
 
 
   email_address (optional, str, None)
     Email address to receive notifications.
 
-    Mutually exclusive with \ :emphasis:`email\_id`\ .
+    Mutually exclusive with *email_id*.
 
 
   new_address (optional, str, None)
@@ -80,9 +80,9 @@ Parameters
   state (True, str, None)
     The state of the destination email address after the task is performed.
 
-    For Delete operation only, it should be set to \ :literal:`absent`\ .
+    For Delete operation only, it should be set to ``absent``.
 
-    For all Create, Modify, Test or Get details operations it should be set to \ :literal:`present`\ .
+    For all Create, Modify, Test or Get details operations it should be set to ``present``.
 
 
   array_ip (True, str, None)
@@ -92,9 +92,9 @@ Parameters
   validate_certs (optional, bool, True)
     Boolean variable to specify whether to validate SSL certificate or not.
 
-    \ :literal:`true`\  - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS\_CA\_BUNDLE to the path of the SSL certificate.
+    ``true`` - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
 
-    \ :literal:`false`\  - indicates that the SSL certificate should not be verified.
+    ``false`` - indicates that the SSL certificate should not be verified.
 
 
   user (True, str, None)
@@ -125,7 +125,7 @@ Notes
 
 .. note::
    - Idempotency is not supported for Test operation of Email module.
-   - The \ :emphasis:`check\_mode`\  is not supported.
+   - The *check_mode* is not supported.
    - The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.