Skip to content

Commit

Permalink
Release Version 2.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Bhavneet-Sharma committed Dec 22, 2023
1 parent 9dbe36c commit 71e657d
Show file tree
Hide file tree
Showing 35 changed files with 339 additions and 339 deletions.
50 changes: 25 additions & 25 deletions docs/modules/accesszone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,21 @@ Parameters


directory_create_mask (optional, str, None)
Specifies the \ :literal:`UNIX`\ mask bits (octal) that are removed when a directory is created, restricting permissions.
Specifies the ``UNIX`` mask bits (octal) that are removed when a directory is created, restricting permissions.

Mask bits are applied before mode bits are applied.


directory_create_mode (optional, str, None)
Specifies the \ :literal:`UNIX`\ mode bits (octal) that are added when a directory is created, enabling permissions.
Specifies the ``UNIX`` mode bits (octal) that are added when a directory is created, enabling permissions.


file_create_mask (optional, str, None)
Specifies the \ :literal:`UNIX`\ mask bits (octal) that are removed when a file is created, restricting permissions.
Specifies the ``UNIX`` mask bits (octal) that are removed when a file is created, restricting permissions.


file_create_mode (optional, str, None)
Specifies the \ :literal:`UNIX`\ mode bits (octal) that are added when a file is created, enabling permissions.
Specifies the ``UNIX`` mode bits (octal) that are added when a file is created, enabling permissions.


access_based_enumeration (optional, bool, None)
Expand All @@ -93,44 +93,44 @@ Parameters


commit_asynchronous (optional, bool, None)
Set to \ :literal:`true`\ if NFS commit requests execute asynchronously.
Set to ``true`` if NFS commit requests execute asynchronously.


nfsv4_domain (optional, str, None)
Specifies the domain or realm through which users and groups are associated.


nfsv4_allow_numeric_ids (optional, bool, None)
If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs when look up fails or if the \ :emphasis:`nfsv4\_no\_name`\ property is set to 1.
If ``true``, sends owners and groups as UIDs and GIDs when look up fails or if the *nfsv4_no_name* property is set to 1.


nfsv4_no_domain (optional, bool, None)
If \ :literal:`true`\ , sends owners and groups without a domain name.
If ``true``, sends owners and groups without a domain name.


nfsv4_no_domain_uids (optional, bool, None)
If \ :literal:`true`\ , sends UIDs and GIDs without a domain name.
If ``true``, sends UIDs and GIDs without a domain name.


nfsv4_no_names (optional, bool, None)
If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs.
If ``true``, sends owners and groups as UIDs and GIDs.



provider_state (False, str, None)
Defines whether the auth providers should be added or removed from access zone.

If \ :emphasis:`auth\_providers`\ are given, then \ :emphasis:`provider\_state`\ should also be specified.
If *auth_providers* are given, then *provider_state* should also be specified.

\ :literal:`add`\ - indicates that the auth providers should be added to the access zone.
``add`` - indicates that the auth providers should be added to the access zone.

\ :literal:`remove`\ - indicates that auth providers should be removed from the access zone.
``remove`` - indicates that auth providers should be removed from the access zone.


auth_providers (optional, list, None)
Specifies the auth providers which need to be added or removed from access zone.

If \ :emphasis:`auth\_providers`\ are given, then \ :emphasis:`provider\_state`\ should also be specified.
If *auth_providers* are given, then *provider_state* should also be specified.


provider_name (True, str, None)
Expand All @@ -144,18 +144,18 @@ Parameters
priority (optional, int, None)
Specifies the order of priority of the auth provider which needs to be added to access zone.

\ :literal:`1`\ denotes the topmost priority.
``1`` denotes the topmost priority.

If \ :emphasis:`priority`\ is not provided, authentication provider will have lowest priority.
If *priority* is not provided, authentication provider will have lowest priority.



state (True, str, None)
Defines whether the access zone should exist or not.

\ :literal:`present`\ - indicates that the access zone should exist on the system.
``present`` - indicates that the access zone should exist on the system.

\ :literal:`absent`\ - indicates that the access zone should not exist on the system.
``absent`` - indicates that the access zone should not exist on the system.


onefs_host (True, str, None)
Expand All @@ -169,9 +169,9 @@ Parameters
verify_ssl (True, bool, None)
boolean variable to specify whether to validate SSL certificate or not.

\ :literal:`true`\ - indicates that the SSL certificate should be verified.
``true`` - indicates that the SSL certificate should be verified.

\ :literal:`false`\ - indicates that the SSL certificate should not be verified.
``false`` - indicates that the SSL certificate should not be verified.


api_user (True, str, None)
Expand All @@ -189,7 +189,7 @@ Notes
-----

.. note::
- The \ :emphasis:`check\_mode`\ is not supported.
- The *check_mode* is not supported.
- Built-in System zone cannot be deleted.
- When access zone is deleted, all associated authentication providers remain available to other zones, the IP addresses are not reassigned to other zones.
- When access zone is deleted, SMB shares, NFS exports, and HDFS data paths are deleted, the directories and data still exist, and new shares, exports, or paths can be mapped in another access zone.
Expand Down Expand Up @@ -399,7 +399,7 @@ access_zone_details (When access zone exists, complex, {'nfs_settings': {'export


commit_asynchronous (, bool, )
Set to \ :literal:`true`\ if NFS commit requests execute asynchronously
Set to ``true`` if NFS commit requests execute asynchronously



Expand All @@ -412,19 +412,19 @@ access_zone_details (When access zone exists, complex, {'nfs_settings': {'export


nfsv4_allow_numeric_ids (, bool, )
If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs when look up fails or if the 'nfsv4\_no\_name' property is set to 1
If ``true``, sends owners and groups as UIDs and GIDs when look up fails or if the 'nfsv4_no_name' property is set to 1


nfsv4_no_domain (, bool, )
If \ :literal:`true`\ , sends owners and groups without a domain name
If ``true``, sends owners and groups without a domain name


nfsv4_no_domain_uids (, bool, )
If \ :literal:`true`\ , sends UIDs and GIDs without a domain name
If ``true``, sends UIDs and GIDs without a domain name


nfsv4_no_names (, bool, )
If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs
If ``true``, sends owners and groups as UIDs and GIDs



Expand Down
30 changes: 15 additions & 15 deletions docs/modules/ads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ Parameters

This is an optional parameter during create, and defaults to the provider name if it is not specified during the create operation.

Get, modify and delete operations can also be performed through instance\_name.
Get, modify and delete operations can also be performed through instance_name.

It is mutually exclusive with \ :emphasis:`domain\_name`\ for get, modify and delete operations.
It is mutually exclusive with *domain_name* for get, modify and delete operations.


ads_user (optional, str, None)
Expand All @@ -64,25 +64,25 @@ Parameters
groupnet (optional, str, None)
Groupnet identifier.

This is an optional parameter and defaults to \ :literal:`groupnet0`\ .
This is an optional parameter and defaults to ``groupnet0``.


home_directory_template (optional, str, None)
Specifies the path to the home directory template.

This is an optional parameter and defaults to \ :literal:`/ifs/home/%D/%U`\ .
This is an optional parameter and defaults to ``/ifs/home/%D/%U``.


login_shell (optional, str, None)
Specifies the login shell path.

This is an optional parameter and defaults to \ :literal:`/bin/zsh`\ .
This is an optional parameter and defaults to ``/bin/zsh``.


machine_account (optional, str, None)
Specifies the machine account name when creating a SAM account with Active Directory.

The default cluster name is called \ :literal:`default`\ .
The default cluster name is called ``default``.


organizational_unit (optional, str, None)
Expand All @@ -101,26 +101,26 @@ Parameters
state (optional, str, present)
The state of the SPN.

\ :literal:`present`\ - indicates that the SPN should exist on the machine account.
``present`` - indicates that the SPN should exist on the machine account.

\ :literal:`absent`\ - indicates that the SPN should not exist on the machine account.
``absent`` - indicates that the SPN should not exist on the machine account.



spn_command (optional, str, None)
Specify command of SPN.

\ :literal:`check`\ - Check for missing SPNs for an AD provider.
``check`` - Check for missing SPNs for an AD provider.

\ :literal:`fix`\ - Adds missing SPNs for an AD provider.
``fix`` - Adds missing SPNs for an AD provider.


state (True, str, None)
The state of the ads provider after the task is performed.

\ :literal:`present`\ - indicates that the ADS provider should exist on the system.
``present`` - indicates that the ADS provider should exist on the system.

\ :literal:`absent`\ - indicates that the ADS provider should not exist on the system.
``absent`` - indicates that the ADS provider should not exist on the system.


onefs_host (True, str, None)
Expand All @@ -134,9 +134,9 @@ Parameters
verify_ssl (True, bool, None)
boolean variable to specify whether to validate SSL certificate or not.

\ :literal:`true`\ - indicates that the SSL certificate should be verified.
``true`` - indicates that the SSL certificate should be verified.

\ :literal:`false`\ - indicates that the SSL certificate should not be verified.
``false`` - indicates that the SSL certificate should not be verified.


api_user (True, str, None)
Expand All @@ -154,7 +154,7 @@ Notes
-----

.. note::
- The \ :emphasis:`check\_mode`\ is not supported.
- The *check_mode* is not supported.
- The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform.


Expand Down
42 changes: 21 additions & 21 deletions docs/modules/filepoolpolicy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ Parameters
policy_id (optional, str, None)
Unique Id of the file pool policy.

It is mutually exclusive with \ :emphasis:`policy\_name`\ .
It is mutually exclusive with *policy_name*.


policy_name (optional, str, None)
Unique name of the file pool policy.

It is mutually exclusive with \ :emphasis:`policy\_id`\ .
It is mutually exclusive with *policy_id*.

Mandatory for file pool policy creation.

Expand Down Expand Up @@ -114,51 +114,51 @@ Parameters
condition (optional, str, None)
The condition to use while comparing an attribute with its value.

If \ :emphasis:`type`\ is \ :literal:`size`\ then the conditions are ['equal', 'not\_equal', 'greater\_than', 'greater\_than\_equal\_to', 'less\_than', 'less\_than\_equal\_to'].
If *type* is ``size`` then the conditions are ['equal', 'not_equal', 'greater_than', 'greater_than_equal_to', 'less_than', 'less_than_equal_to'].

If \ :emphasis:`type`\ is \ :literal:`accessed`\ or \ :literal:`created`\ or \ :literal:`modified`\ or \ :literal:`metadata\_changed`\ then the conditions are ['after','before', 'is\_newer\_than', 'is\_older\_than'].
If *type* is ``accessed`` or ``created`` or ``modified`` or ``metadata_changed`` then the conditions are ['after','before', 'is_newer_than', 'is_older_than'].

If \ :emphasis:`type`\ is \ :literal:`file\_attribute`\ then the conditions are ['matches','does\_not\_match', 'exists', 'does\_not\_exist'].
If *type* is ``file_attribute`` then the conditions are ['matches','does_not_match', 'exists', 'does_not_exist'].

If \ :emphasis:`type`\ is \ :literal:`file\_path`\ then the conditions are ['matches','does\_not\_match', 'contains', 'does\_not\_contain'].
If *type* is ``file_path`` then the conditions are ['matches','does_not_match', 'contains', 'does_not_contain'].

If \ :emphasis:`type`\ is \ :literal:`file\_type`\ or \ :literal:`file\_name`\ then the conditions are ['matches','does\_not\_match'].
If *type* is ``file_type`` or ``file_name`` then the conditions are ['matches','does_not_match'].


value (optional, str, None)
The value to be compared against a file criteria.

Required in case if \ :emphasis:`type`\ is \ :literal:`file\_name`\ or \ :literal:`file\_path`\ or \ :literal:`file\_attribute`\ .
Required in case if *type* is ``file_name`` or ``file_path`` or ``file_attribute``.

If \ :emphasis:`type`\ is \ :literal:`file\_name`\ then value wil have file name.
If *type* is ``file_name`` then value wil have file name.

If \ :emphasis:`type`\ is \ :literal:`file\_path`\ then value wil have file path.
If *type* is ``file_path`` then value wil have file path.

If \ :emphasis:`type`\ is \ :literal:`file\_attribute`\ then value wil have file attribute field value.
If *type* is ``file_attribute`` then value wil have file attribute field value.


field (optional, str, None)
File attribute field name to be compared in a custom comparison.

Required only if the \ :emphasis:`type`\ is \ :literal:`file\_attribute`\ .
Required only if the *type* is ``file_attribute``.


case_sensitive (optional, bool, None)
\ :literal:`true`\ to indicate case sensitivity when comparing file attributes.
``true`` to indicate case sensitivity when comparing file attributes.

Required only if the \ :emphasis:`type`\ is \ :literal:`file\_name`\ or \ :literal:`file\_path`\ .
Required only if the *type* is ``file_name`` or ``file_path``.


file_type_option (optional, str, None)
File type option.

Required only if the \ :emphasis:`type`\ is \ :literal:`file\_type`\ .
Required only if the *type* is ``file_type``.


size_info (optional, dict, None)
File size value and unit.

Required only if the \ :emphasis:`type`\ is \ :literal:`size`\ .
Required only if the *type* is ``size``.


size_value (True, int, None)
Expand All @@ -175,13 +175,13 @@ Parameters

Format is 'YYYY-MM-DD HOUR:MINUTE'

Required only if the \ :emphasis:`type`\ is \ :literal:`accessed`\ or \ :literal:`created`\ or \ :literal:`modified`\ or \ :literal:`metadata\_changed`\ and \\ the \ :emphasis:`condition`\ is \ :literal:`after`\ or \ :literal:`before`\
Required only if the *type* is ``accessed`` or ``created`` or ``modified`` or ``metadata_changed`` and \ the *condition* is ``after`` or ``before``


relative_datetime_count (optional, dict, None)
A relative duration (e.g., 2 years, 3 weeks, 50 seconds).

Required only if the \ :emphasis:`type`\ is \ :literal:`accessed`\ or \ :literal:`created`\ or \ :literal:`modified`\ or \ :literal:`metadata\_changed`\ and \\ the \ :literal:`condition`\ is \ :literal:`is\_newer\_than`\ or \ :literal:`is\_older\_than`\
Required only if the *type* is ``accessed`` or ``created`` or ``modified`` or ``metadata_changed`` and \ the ``condition`` is ``is_newer_than`` or ``is_older_than``


time_value (True, int, None)
Expand Down Expand Up @@ -211,9 +211,9 @@ Parameters
verify_ssl (True, bool, None)
boolean variable to specify whether to validate SSL certificate or not.

\ :literal:`true`\ - indicates that the SSL certificate should be verified.
``true`` - indicates that the SSL certificate should be verified.

\ :literal:`false`\ - indicates that the SSL certificate should not be verified.
``false`` - indicates that the SSL certificate should not be verified.


api_user (True, str, None)
Expand All @@ -232,7 +232,7 @@ Notes

.. note::
- Modifying a file pool policy is not supported.
- The \ :emphasis:`check\_mode`\ is supported.
- The *check_mode* is supported.
- The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform.


Expand Down
Loading

0 comments on commit 71e657d

Please sign in to comment.