diff --git a/docs/modules/accesszone.rst b/docs/modules/accesszone.rst index a08a829e..463969f0 100644 --- a/docs/modules/accesszone.rst +++ b/docs/modules/accesszone.rst @@ -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) @@ -93,7 +93,7 @@ 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) @@ -101,36 +101,36 @@ Parameters 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) @@ -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) @@ -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) @@ -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. @@ -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 @@ -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 diff --git a/docs/modules/ads.rst b/docs/modules/ads.rst index e2b56d92..04d909ea 100644 --- a/docs/modules/ads.rst +++ b/docs/modules/ads.rst @@ -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) @@ -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) @@ -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) @@ -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) @@ -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. diff --git a/docs/modules/filepoolpolicy.rst b/docs/modules/filepoolpolicy.rst index 8ee69e0c..0144db98 100644 --- a/docs/modules/filepoolpolicy.rst +++ b/docs/modules/filepoolpolicy.rst @@ -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. @@ -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) @@ -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) @@ -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) @@ -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. diff --git a/docs/modules/groupnet.rst b/docs/modules/groupnet.rst index c5088d5e..9065fdd3 100644 --- a/docs/modules/groupnet.rst +++ b/docs/modules/groupnet.rst @@ -46,7 +46,7 @@ Parameters dns_server_state (optional, str, None) - Specifies if the \ :emphasis:`dns\_servers`\ should be added or removed from the groupnet. + Specifies if the *dns_servers* should be added or removed from the groupnet. dns_search_suffix (optional, list, None) @@ -60,9 +60,9 @@ Parameters state (True, str, None) The state of the groupnet after the task is performed. - \ :literal:`present`\ - indicates that the groupnet should exist on the system. + ``present`` - indicates that the groupnet should exist on the system. - \ :literal:`absent`\ - indicates that the groupnet should not exist on the system. + ``absent`` - indicates that the groupnet should not exist on the system. onefs_host (True, str, None) @@ -76,9 +76,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) @@ -96,7 +96,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. diff --git a/docs/modules/info.rst b/docs/modules/info.rst index 647ebadc..808b3d45 100644 --- a/docs/modules/info.rst +++ b/docs/modules/info.rst @@ -14,9 +14,9 @@ Synopsis Gathering information about Specified PowerScale Storage entities, includes attributes, access zones, nodes, authentication providers for all access zones, users and groups for an access zone. -Get list of smb\_shares, nfs\_exports, nfs\_aliases, active clients, SyncIQ reports, SyncIQ target reports, SyncIQ target cluster certificates, SyncIQ policies, SyncIQ performance rules. +Get list of smb_shares, nfs_exports, nfs_aliases, active clients, SyncIQ reports, SyncIQ target reports, SyncIQ target cluster certificates, SyncIQ policies, SyncIQ performance rules. -Get list of network groupnets, network pools for all access zones or a specific access zone, network rules, network subnets, network interfaces, node pools, storage pool tiers, smb open files, s3 buckets, ntp\_servers. +Get list of network groupnets, network pools for all access zones or a specific access zone, network rules, network subnets, network interfaces, node pools, storage pool tiers, smb open files, s3 buckets, ntp_servers. Get list of user mapping rules, ldap providers of the PowerScale cluster. @@ -52,7 +52,7 @@ Parameters include_all_access_zones (optional, bool, None) Specifies if requested component details need to be fetched from all access zones. - It is mutually exclusive with \ :emphasis:`access\_zone`\ . + It is mutually exclusive with *access_zone*. access_zone (optional, str, System) @@ -60,13 +60,13 @@ Parameters scope (optional, str, effective) - The scope of ldap. If no scope is specified, the \ :literal:`effective`\ scope would be taken by default. + The scope of ldap. If no scope is specified, the ``effective`` scope would be taken by default. - If specified as \ :literal:`effective`\ or not specified, all fields are returned. + If specified as ``effective`` or not specified, all fields are returned. - If specified as \ :literal:`user`\ , only fields with non-default values are shown. + If specified as ``user``, only fields with non-default values are shown. - If specified as \ :literal:`default`\ , the original values are returned. + If specified as ``default``, the original values are returned. gather_subset (True, list, None) @@ -74,65 +74,65 @@ Parameters List of all PowerScale Storage System entities supported by the module. - Attributes - \ :literal:`attributes`\ . + Attributes - ``attributes``. - Access zones - \ :literal:`access\_zones`\ . + Access zones - ``access_zones``. - Nodes - \ :literal:`nodes`\ . + Nodes - ``nodes``. - Providers - \ :literal:`providers`\ . + Providers - ``providers``. - Users - \ :literal:`users`\ . + Users - ``users``. - Groups - \ :literal:`groups`\ . + Groups - ``groups``. - Smb shares - \ :literal:`smb\_shares`\ . + Smb shares - ``smb_shares``. - Nfs exports - \ :literal:`nfs\_exports`\ . + Nfs exports - ``nfs_exports``. - Nfs aliases - \ :literal:`nfs\_aliases`\ . + Nfs aliases - ``nfs_aliases``. - Clients - \ :literal:`clients`\ . + Clients - ``clients``. - Synciq reports - \ :literal:`synciq\_reports`\ . + Synciq reports - ``synciq_reports``. - Synciq target reports - \ :literal:`synciq\_target\_reports`\ . + Synciq target reports - ``synciq_target_reports``. - Synciq policies - \ :literal:`synciq\_policies`\ . + Synciq policies - ``synciq_policies``. - Synciq target cluster certificates - \ :literal:`synciq\_target\_cluster\_certificates`\ . + Synciq target cluster certificates - ``synciq_target_cluster_certificates``. - Synciq performance rules - \ :literal:`synciq\_performance\_rules`\ . + Synciq performance rules - ``synciq_performance_rules``. - Network groupnets - \ :literal:`network\_groupnets`\ . + Network groupnets - ``network_groupnets``. - Network pools - \ :literal:`network\_pools`\ . + Network pools - ``network_pools``. - Network rules - \ :literal:`network\_rules`\ . + Network rules - ``network_rules``. - Network interfaces - \ :literal:`network\_interfaces`\ . + Network interfaces - ``network_interfaces``. - Network subnets - \ :literal:`network\_subnets`\ . + Network subnets - ``network_subnets``. - Node pools - \ :literal:`node\_pools`\ . + Node pools - ``node_pools``. - Storagepool tiers - \ :literal:`storagepool\_tiers`\ . + Storagepool tiers - ``storagepool_tiers``. - SMB files - \ :literal:`smb\_files`\ . + SMB files - ``smb_files``. - User mapping rules - \ :literal:`user\_mapping\_rules`\ . + User mapping rules - ``user_mapping_rules``. - LDAPs - \ :literal:`ldap`\ . + LDAPs - ``ldap``. - NFS zone settings - \ :literal:`nfs\_zone\_settings`\ . + NFS zone settings - ``nfs_zone_settings``. - NFS default settings - \ :literal:`nfs\_default\_settings`\ . + NFS default settings - ``nfs_default_settings``. - SyncIQ global settings - \ :literal:`synciq\_global\_settings`\ . + SyncIQ global settings - ``synciq_global_settings``. - S3 buckets - \ :literal:`s3\_buckets`\ . + S3 buckets - ``s3_buckets``. - The list of \ :emphasis:`attributes`\ , \ :emphasis:`access\_zones`\ and \ :emphasis:`nodes`\ is for the entire PowerScale cluster. + The list of *attributes*, *access_zones* and *nodes* is for the entire PowerScale cluster. The list of providers for the entire PowerScale cluster. @@ -152,17 +152,17 @@ Parameters The list of ldap providers of PowerScale cluster. - SMB global settings - \ :literal:`smb\_global\_settings`\ . + SMB global settings - ``smb_global_settings``. - NTP servers \ :literal:`ntp\_servers`\ + NTP servers ``ntp_servers`` - Email settings \ :literal:`email\_settings`\ + Email settings ``email_settings`` - Cluster identity \ :literal:`cluster\_identity`\ + Cluster identity ``cluster_identity`` - Cluster owner \ :literal:`cluster\_owner`\ + Cluster owner ``cluster_owner`` - SNMP settings - \ :literal:`snmp\_settings`\ . + SNMP settings - ``snmp_settings``. onefs_host (True, str, None) @@ -176,9 +176,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) @@ -196,9 +196,9 @@ Notes ----- .. note:: - - The parameters \ :emphasis:`access\_zone`\ and \ :emphasis:`include\_all\_access\_zones`\ are mutually exclusive. - - Listing of SyncIQ target cluster certificates is not supported by isi\_sdk\_8\_1\_1 version. - - The \ :emphasis:`check\_mode`\ is supported. + - The parameters *access_zone* and *include_all_access_zones* are mutually exclusive. + - Listing of SyncIQ target cluster certificates is not supported by isi_sdk_8_1_1 version. + - The *check_mode* is supported. - The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform. @@ -840,7 +840,7 @@ NfsZoneSettings (When C(nfs_zone_settings) is in a given I(gather_subset), dict, nfsv4_allow_numeric_ids (, bool, ) - If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs when look up fails or if the \ :emphasis:`nfsv4\_no\_names`\ property is set to 1. + If ``true``, sends owners and groups as UIDs and GIDs when look up fails or if the *nfsv4_no_names* property is set to 1. nfsv4_domain (, str, ) @@ -848,19 +848,19 @@ NfsZoneSettings (When C(nfs_zone_settings) is in a given I(gather_subset), dict, 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. nfsv4_replace_domain (, bool, ) - If \ :literal:`true`\ , replaces the owner or group domain with an NFS domain name. + If ``true``, replaces the owner or group domain with an NFS domain name. zone (, str, ) @@ -1465,7 +1465,7 @@ S3_bucket_details (When C(s3_buckets) is in a given I(gather_subset), dict, {'ac path (, str, ) - Path of S3 bucket with in \ :literal:`'/ifs'`\ . + Path of S3 bucket with in ``'/ifs'``. zid (, int, ) @@ -1637,7 +1637,7 @@ ntp_servers (Always, dict, {'servers': [{'id': '10.**.**.**', 'key': None, 'name key (, str, ) - Key value from \ :emphasis:`key\_file`\ that maps to this server. + Key value from *key_file* that maps to this server. name (, str, ) @@ -1668,7 +1668,7 @@ cluster_identity (Always, dict, {'cluster_identity': {'description': 'asdadasdas mttdl_level_msg (, str, ) - mttdl\_level\_msg. + mttdl_level_msg. name (, str, ) diff --git a/docs/modules/ldap.rst b/docs/modules/ldap.rst index f6dd4007..b66052c9 100644 --- a/docs/modules/ldap.rst +++ b/docs/modules/ldap.rst @@ -38,15 +38,15 @@ Parameters This parameter is mandatory during create. - \ :emphasis:`server\_uris`\ should begin with ldap:// or ldaps:// if not validation error will be displayed. + *server_uris* should begin with ldap:// or ldaps:// if not validation error will be displayed. server_uri_state (optional, str, None) - Specifies if the \ :emphasis:`server\_uris`\ need to be added or removed from the provider. + Specifies if the *server_uris* need to be added or removed from the provider. - This parameter is mandatory if \ :emphasis:`server\_uris`\ is specified. + This parameter is mandatory if *server_uris* is specified. - While creating LDAP provider, this parameter value should be specified as \ :literal:`present-in-ldap`\ . + While creating LDAP provider, this parameter value should be specified as ``present-in-ldap``. base_dn (optional, str, None) @@ -77,9 +77,9 @@ Parameters state (True, str, None) The state of the LDAP provider after the task is performed. - \ :literal:`present`\ - indicates that the LDAP provider should exist on the system. + ``present`` - indicates that the LDAP provider should exist on the system. - \ :literal:`absent`\ - indicates that the LDAP provider should not exist on the system. + ``absent`` - indicates that the LDAP provider should not exist on the system. onefs_host (True, str, None) @@ -93,9 +93,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) @@ -113,9 +113,9 @@ Notes ----- .. note:: - - This module does not support modification of \ :emphasis:`bind\_password`\ of LDAP provider. - - The value specified for \ :emphasis:`bind\_password`\ will be ignored during modify. - - The \ :emphasis:`check\_mode`\ is not supported. + - This module does not support modification of *bind_password* of LDAP provider. + - The value specified for *bind_password* will be ignored during modify. + - 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. diff --git a/docs/modules/networkpool.rst b/docs/modules/networkpool.rst index 1086e5e2..32e44a47 100644 --- a/docs/modules/networkpool.rst +++ b/docs/modules/networkpool.rst @@ -158,7 +158,7 @@ Parameters aggregation_mode (optional, str, None) - OneFS supports the following \ :literal:`NIC`\ aggregation modes. + OneFS supports the following ``NIC`` aggregation modes. @@ -173,9 +173,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) @@ -193,8 +193,8 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is not supported. - - Removal of \ :emphasis:`sc\_dns\_zone\_aliases`\ is not supported. + - The *check_mode* is not supported. + - Removal of *sc_dns_zone_aliases* is not supported. - The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform. diff --git a/docs/modules/networkrule.rst b/docs/modules/networkrule.rst index 170a09ec..ab8c018b 100644 --- a/docs/modules/networkrule.rst +++ b/docs/modules/networkrule.rst @@ -84,9 +84,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) @@ -104,7 +104,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. diff --git a/docs/modules/networksettings.rst b/docs/modules/networksettings.rst index f725ef2d..3ad776ae 100644 --- a/docs/modules/networksettings.rst +++ b/docs/modules/networksettings.rst @@ -48,9 +48,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) @@ -68,7 +68,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. diff --git a/docs/modules/nfs.rst b/docs/modules/nfs.rst index 77c6c060..fe20eccf 100644 --- a/docs/modules/nfs.rst +++ b/docs/modules/nfs.rst @@ -50,7 +50,7 @@ Parameters clients (optional, list, None) - Specifies the clients to the export. The type of access to clients in this list is determined by the \ :emphasis:`read\_only`\ parameter. + Specifies the clients to the export. The type of access to clients in this list is determined by the *read_only* parameter. This list can be changed anytime during the lifetime of the NFS export. @@ -80,7 +80,7 @@ Parameters sub_directories_mountable (optional, bool, None) - \ :literal:`true`\ if all directories under the specified paths are mountable. If not set, sub-directories will not be mountable. + ``true`` if all directories under the specified paths are mountable. If not set, sub-directories will not be mountable. This setting can be modified any time. @@ -94,17 +94,17 @@ Parameters state (True, str, None) Defines whether the NFS export should exist or not. - Value \ :literal:`present`\ indicates that the NFS export should exist in system. + Value ``present`` indicates that the NFS export should exist in system. - Value \ :literal:`absent`\ indicates that the NFS export should not exist in system. + Value ``absent`` indicates that the NFS export should not exist in system. client_state (optional, str, None) Defines whether the clients can access the NFS export. - Value \ :literal:`present-in-export`\ indicates that the clients can access the NFS export. + Value ``present-in-export`` indicates that the clients can access the NFS export. - Value \ :literal:`absent-in-export`\ indicates that the client cannot access the NFS export. + Value ``absent-in-export`` indicates that the client cannot access the NFS export. Required when adding or removing access of clients from the export. @@ -190,9 +190,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) @@ -210,7 +210,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. @@ -365,7 +365,7 @@ NFS_export_details (always, complex, {'all_dir': 'false', 'block_size': 8192, 'c all_dirs (, bool, ) - \ :emphasis:`sub\_directories\_mountable`\ flag value. + *sub_directories_mountable* flag value. id (, int, 12) diff --git a/docs/modules/nfs_alias.rst b/docs/modules/nfs_alias.rst index e4a52bc3..8fcc140f 100644 --- a/docs/modules/nfs_alias.rst +++ b/docs/modules/nfs_alias.rst @@ -50,9 +50,9 @@ Parameters scope (optional, str, effective) - When specified as \ :literal:`effective`\ , or not specified, all fields are returned. + When specified as ``effective``, or not specified, all fields are returned. - When specified as \ :literal:`user`\ , only fields with non-default values are shown. + When specified as ``user``, only fields with non-default values are shown. check (optional, bool, False) @@ -66,9 +66,9 @@ Parameters state (optional, str, present) Defines whether the NFS alias should exist or not. - \ :literal:`present`\ indicates that the NFS alias should exist in system. + ``present`` indicates that the NFS alias should exist in system. - \ :literal:`absent`\ indicates that the NFS alias should not exist in system. + ``absent`` indicates that the NFS alias should not exist in system. onefs_host (True, str, None) @@ -82,9 +82,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) @@ -102,7 +102,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/nfs_default_settings.rst b/docs/modules/nfs_default_settings.rst index a9aac3ff..8bf6cb02 100644 --- a/docs/modules/nfs_default_settings.rst +++ b/docs/modules/nfs_default_settings.rst @@ -375,9 +375,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) @@ -395,7 +395,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/nfs_global_settings.rst b/docs/modules/nfs_global_settings.rst index 079f1b0f..7654c01d 100644 --- a/docs/modules/nfs_global_settings.rst +++ b/docs/modules/nfs_global_settings.rst @@ -90,9 +90,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) @@ -110,7 +110,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/nfs_zone_settings.rst b/docs/modules/nfs_zone_settings.rst index a650f227..950bae69 100644 --- a/docs/modules/nfs_zone_settings.rst +++ b/docs/modules/nfs_zone_settings.rst @@ -34,7 +34,7 @@ Parameters nfsv4_allow_numeric_ids (optional, bool, None) - If \ :literal:`true`\ , send owner and groups as UIDs and GIDs when look up fails or \ :emphasis:`nfsv4\_no\_names`\ is set \ :literal:`rue`\ . + If ``true``, send owner and groups as UIDs and GIDs when look up fails or *nfsv4_no_names* is set ``rue``. nfsv4_domain (optional, str, None) @@ -42,19 +42,19 @@ Parameters 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. nfsv4_replace_domain (optional, bool, None) - If \ :literal:`true`\ , replaces the owner or group domain with an NFS domain name. + If ``true``, replaces the owner or group domain with an NFS domain name. onefs_host (True, str, None) @@ -68,9 +68,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) @@ -88,7 +88,7 @@ Notes ----- .. note:: - - 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. @@ -134,7 +134,7 @@ nfs_zone_settings_details (always, dict, {'nfsv4_allow_numeric_ids': False, 'nfs nfsv4_allow_numeric_ids (, bool, ) - If \ :literal:`true`\ , sends owners and groups as UIDs and GIDs when look up fails or if the \ :emphasis:`nfsv4\_no\_names`\ property is set to 1. + If ``true``, sends owners and groups as UIDs and GIDs when look up fails or if the *nfsv4_no_names* property is set to 1. nfsv4_domain (, str, ) @@ -142,19 +142,19 @@ nfs_zone_settings_details (always, dict, {'nfsv4_allow_numeric_ids': False, 'nfs 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. nfsv4_replace_domain (, bool, ) - If \ :literal:`true`\ , replaces the owner or group domain with an NFS domain name. + If ``true``, replaces the owner or group domain with an NFS domain name. zone (, str, ) diff --git a/docs/modules/node.rst b/docs/modules/node.rst index e46a0a14..64db9ae5 100644 --- a/docs/modules/node.rst +++ b/docs/modules/node.rst @@ -48,9 +48,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) @@ -68,7 +68,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. diff --git a/docs/modules/s3_bucket.rst b/docs/modules/s3_bucket.rst index b9fde1fc..5daeae05 100644 --- a/docs/modules/s3_bucket.rst +++ b/docs/modules/s3_bucket.rst @@ -36,7 +36,7 @@ Parameters If your access zone is System, and you have 'directory1' in the access zone, the path provided should be '/ifs/directory1'. - \ :emphasis:`path`\ is required while creating a S3 bucket. + *path* is required while creating a S3 bucket. The S3 bucket path can not be modified after creation. @@ -44,7 +44,7 @@ Parameters create_path (optional, bool, None) Will create the path if does not exist. - API default is \ :literal:`false`\ . + API default is ``false``. access_zone (optional, str, System) @@ -56,21 +56,21 @@ Parameters s3_bucket_name (True, str, None) Name of the S3 bucket. - \ :emphasis:`s3\_bucket\_name`\ while creating the S3 bucket. + *s3_bucket_name* while creating the S3 bucket. owner (optional, str, None) Specifies the owner of the S3 bucket. - If \ :emphasis:`owner`\ not passed, then \ :literal:`root`\ will be default \ :emphasis:`owner`\ for \ :literal:`System`\ access zone only. + If *owner* not passed, then ``root`` will be default *owner* for ``System`` access zone only. - If owner belongs to another provider domain, it should be mentioned along with domain name as "DOMAIN\_NAME\\\\username" or DOMAIN\_NAME\\username. + If owner belongs to another provider domain, it should be mentioned along with domain name as "DOMAIN_NAME\\username" or DOMAIN_NAME\username. description (optional, str, None) Specifies the description of the S3 bucket. - Pass empty string to remove the \ :emphasis:`description`\ . + Pass empty string to remove the *description*. object_acl_policy (optional, str, None) @@ -84,15 +84,15 @@ Parameters permission (True, str, None) Specifies the S3 permission being allowed. - \ :emphasis:`permission`\ and \ :emphasis:`grantee`\ are required together. + *permission* and *grantee* are required together. grantee (True, dict, None) Specifies the properties of grantee. - \ :emphasis:`permission`\ and \ :emphasis:`grantee`\ are required together. + *permission* and *grantee* are required together. - It consists of \ :emphasis:`name`\ , \ :emphasis:`type`\ , and \ :emphasis:`provider\_type`\ . + It consists of *name*, *type*, and *provider_type*. name (True, str, None) @@ -116,9 +116,9 @@ Parameters state (optional, str, present) Defines whether the S3 bucket should exist or not. - Value \ :literal:`present`\ indicates that the S3 bucket should exist in system. + Value ``present`` indicates that the S3 bucket should exist in system. - Value \ :literal:`absent`\ indicates that the S3 bucket should not exist in system. + Value ``absent`` indicates that the S3 bucket should not exist in system. onefs_host (True, str, None) @@ -132,9 +132,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) @@ -153,7 +153,7 @@ Notes .. note:: - To delete the S3 bucket, the S3 service must be enabled. - - 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. @@ -320,7 +320,7 @@ S3_bucket_details (always, complex, {'access_zone': 'System', 'acl': [{'grantee' path (, str, ) - Path of S3 bucket with in \ :literal:`'/ifs'`\ . + Path of S3 bucket with in ``'/ifs'``. zid (, int, ) diff --git a/docs/modules/smartpoolsettings.rst b/docs/modules/smartpoolsettings.rst index 1e6face2..514246a2 100644 --- a/docs/modules/smartpoolsettings.rst +++ b/docs/modules/smartpoolsettings.rst @@ -52,9 +52,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) @@ -72,7 +72,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. diff --git a/docs/modules/smartquota.rst b/docs/modules/smartquota.rst index 8f3341e2..adce38ce 100644 --- a/docs/modules/smartquota.rst +++ b/docs/modules/smartquota.rst @@ -58,7 +58,7 @@ Parameters provider_type (optional, str, local) This option defines the type which is used to authenticate the user/group. - If the \ :emphasis:`provider\_type`\ is 'ads' then the domain name of the Active Directory Server has to be mentioned in the \ :emphasis:`user\_name`\ . The format for the \ :emphasis:`user\_name`\ should be 'DOMAIN\_NAME\\user\_name' or "DOMAIN\_NAME\\\\user\_name". + If the *provider_type* is 'ads' then the domain name of the Active Directory Server has to be mentioned in the *user_name*. The format for the *user_name* should be 'DOMAIN_NAME\user_name' or "DOMAIN_NAME\\user_name". This option acts as a filter for all operations except creation. @@ -80,7 +80,7 @@ Parameters thresholds_on (optional, str, None) - For SDK 9.0.0 the parameter \ :emphasis:`include\_overheads`\ is deprecated and \ :emphasis:`thresholds\_on`\ is used. + For SDK 9.0.0 the parameter *include_overheads* is deprecated and *thresholds_on* is used. advisory_limit_size (optional, float, None) @@ -88,11 +88,11 @@ Parameters soft_limit_size (optional, float, None) - Threshold value after which the soft limit exceeded notification will be sent and the \ :emphasis:`soft\_grace`\ period will start. + Threshold value after which the soft limit exceeded notification will be sent and the *soft_grace* period will start. Write access will be restricted after the grace period expires. - Both \ :emphasis:`soft\_grace\_period`\ and \ :emphasis:`soft\_limit\_size`\ are required to modify soft threshold for the quota. + Both *soft_grace_period* and *soft_limit_size* are required to modify soft threshold for the quota. soft_grace_period (optional, int, None) @@ -100,15 +100,15 @@ Parameters After the grace period, the write access to the quota will be restricted. - Both \ :emphasis:`soft\_grace\_period`\ and \ :emphasis:`soft\_limit\_size`\ are required to modify soft threshold for the quota. + Both *soft_grace_period* and *soft_limit_size* are required to modify soft threshold for the quota. period_unit (optional, str, None) - Unit of the time period for \ :emphasis:`soft\_grace\_period`\ . + Unit of the time period for *soft_grace_period*. For months the number of days is assumed to be 30 days. - This parameter is required only if the \ :emphasis:`soft\_grace\_period`\ , is specified. + This parameter is required only if the *soft_grace_period*, is specified. hard_limit_size (optional, float, None) @@ -124,16 +124,16 @@ Parameters container (optional, bool, False) - If \ :literal:`true`\ , SMB shares using the quota directory see the quota thresholds as share size. + If ``true``, SMB shares using the quota directory see the quota thresholds as share size. state (True, str, None) Define whether the Smart Quota should exist or not. - \ :literal:`present`\ - indicates that the Smart Quota should exist on the system. + ``present`` - indicates that the Smart Quota should exist on the system. - \ :literal:`absent`\ - indicates that the Smart Quota should not exist on the system. + ``absent`` - indicates that the Smart Quota should not exist on the system. onefs_host (True, str, None) @@ -147,9 +147,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) @@ -167,10 +167,10 @@ Notes ----- .. note:: - - To perform any operation, path, quota\_type and state are mandatory parameters. + - To perform any operation, path, quota_type and state are mandatory parameters. - There can be two quotas for each type per directory, one with snapshots included and one without snapshots included. - Once the limits are assigned, then the quota cannot be converted to accounting. Only modification to the threshold limits is permitted. - - 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. @@ -327,11 +327,11 @@ quota_details (When Quota exists., complex, {'container': True, 'description': ' container (, bool, True) - If \ :literal:`true`\ , SMB shares using the quota directory see the quota thresholds as share size. + If ``true``, SMB shares using the quota directory see the quota thresholds as share size. thresholds (, dict, {'advisory': 3221225472, 'advisory(GB)': '3.0', 'advisory_exceeded': False, 'advisory_last_exceeded': 0, 'hard': 6442450944, 'hard(GB)': '6.0', 'hard_exceeded': False, 'hard_last_exceeded': 0, 'soft': 5368709120, 'soft(GB)': '5.0', 'soft_exceeded': False, 'soft_grace': 3024000, 'soft_last_exceeded': 0}) - Includes information about all the limits imposed on quota. The limits are mentioned in bytes and \ :emphasis:`soft\_grace`\ is in seconds. + Includes information about all the limits imposed on quota. The limits are mentioned in bytes and *soft_grace* is in seconds. type (, str, directory) diff --git a/docs/modules/smb.rst b/docs/modules/smb.rst index 4fda5310..91261ef6 100644 --- a/docs/modules/smb.rst +++ b/docs/modules/smb.rst @@ -66,15 +66,15 @@ Parameters This is a list of dictionaries. Each dictionry entry has 3 mandatory values as listed below. - 1)\ :emphasis:`user\_name`\ /\ :emphasis:`group\_name`\ /\ :emphasis:`wellknown`\ can have actual name of the trustee like \ :literal:`user`\ /\ :literal:`group`\ /\ :literal:`wellknown`\ . + 1)*user_name*/*group_name*/*wellknown* can have actual name of the trustee like ``user``/``group``/``wellknown``. - 2)\ :emphasis:`permission`\ can be \ :literal:`read`\ /'\ :literal:`write`\ /\ :literal:`full`\ . + 2)*permission* can be ``read``/'``write``/``full``. - 3)\ :emphasis:`permission\_type`\ can be \ :literal:`allow`\ /\ :literal:`deny`\ . + 3)*permission_type* can be ``allow``/``deny``. - The fourth entry \ :emphasis:`provider\_type`\ is optional (default is \ :literal:`local`\ ). + The fourth entry *provider_type* is optional (default is ``local``). - 4)\ :emphasis:`provider\_type`\ can be \ :literal:`local`\ /\ :literal:`file`\ /\ :literal:`ads`\ /\ :literal:`ldap`\ /\ :literal:`nis`\ . + 4)*provider_type* can be ``local``/``file``/``ads``/``ldap``/``nis``. access_based_enumeration (optional, bool, None) @@ -134,7 +134,7 @@ Parameters type (optional, str, deny) - Specifies if filter list is for \ :literal:`deny`\ or \ :literal:`allow`\ . Default is \ :literal:`deny`\ . + Specifies if filter list is for ``deny`` or ``allow``. Default is ``deny``. state (optional, str, None) @@ -155,7 +155,7 @@ Parameters unit (optional, str, seconds) - Unit of the \ :emphasis:`ca\_timeout`\ . + Unit of the *ca_timeout*. @@ -215,9 +215,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) @@ -235,7 +235,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. diff --git a/docs/modules/smb_file.rst b/docs/modules/smb_file.rst index 15bb6a47..389d71a7 100644 --- a/docs/modules/smb_file.rst +++ b/docs/modules/smb_file.rst @@ -30,11 +30,11 @@ Parameters ---------- file_id (optional, int, None) - Unique id of SMB open file. Mutually exclusive with \ :emphasis:`file\_path`\ . + Unique id of SMB open file. Mutually exclusive with *file_path*. file_path (optional, str, None) - Path of SMB file. Mutually exclusive with \ :emphasis:`file\_id`\ . + Path of SMB file. Mutually exclusive with *file_id*. If file path is provided all the open file sessions in the path will be closed. @@ -42,9 +42,9 @@ Parameters state (optional, str, present) Defines the state of SMB file. - \ :literal:`present`\ indicates that the SMB file should exist in system. + ``present`` indicates that the SMB file should exist in system. - \ :literal:`absent`\ indicates that the SMB file is closed in system. + ``absent`` indicates that the SMB file is closed in system. onefs_host (True, str, None) @@ -58,9 +58,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) @@ -78,8 +78,8 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is supported. - - If \ :emphasis:`state`\ is \ :literal:`absent`\ , the file will be closed. + - The *check_mode* is supported. + - If *state* is ``absent``, the file will be closed. - The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform. diff --git a/docs/modules/smb_global_settings.rst b/docs/modules/smb_global_settings.rst index 6e5d16ed..01731b90 100644 --- a/docs/modules/smb_global_settings.rst +++ b/docs/modules/smb_global_settings.rst @@ -116,9 +116,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) @@ -136,7 +136,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/snapshot.rst b/docs/modules/snapshot.rst index ae30b4b6..5f5e255a 100644 --- a/docs/modules/snapshot.rst +++ b/docs/modules/snapshot.rst @@ -92,9 +92,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) @@ -112,7 +112,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. diff --git a/docs/modules/snapshotschedule.rst b/docs/modules/snapshotschedule.rst index 73ddbd45..04bdf28e 100644 --- a/docs/modules/snapshotschedule.rst +++ b/docs/modules/snapshotschedule.rst @@ -108,9 +108,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) @@ -128,7 +128,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. diff --git a/docs/modules/snmp_settings.rst b/docs/modules/snmp_settings.rst index 3871dcf3..c0bed8e1 100644 --- a/docs/modules/snmp_settings.rst +++ b/docs/modules/snmp_settings.rst @@ -32,7 +32,7 @@ Parameters read_only_community (optional, str, None) SNMP read-only community name. - The system default value of the read-only community name is \ :literal:`I$ilonpublic`\ . + The system default value of the read-only community name is ``I$ilonpublic``. Update the read-only community name while enabling SNMP v2c. @@ -78,7 +78,7 @@ Parameters read_only_user (optional, str, None) The read-only user for SNMP v3 requests. - The system default value of read-only user is \ :literal:`general`\ . + The system default value of read-only user is ``general``. @@ -107,9 +107,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) @@ -127,7 +127,7 @@ Notes ----- .. note:: - - The \ :emphasis:`check\_mode`\ is supported. + - The *check_mode* is supported. - Users can configure SNMP version 3 alone or in combination with version 2c. - Idempotency is not supported for SNMP v3's password and privacy password. - The modules present in this collection named as 'dellemc.powerscale' are built to support the Dell PowerScale storage platform. diff --git a/docs/modules/storagepooltier.rst b/docs/modules/storagepooltier.rst index 112354b7..e94d93a9 100644 --- a/docs/modules/storagepooltier.rst +++ b/docs/modules/storagepooltier.rst @@ -32,13 +32,13 @@ Parameters tier_id (optional, int, None) Unique Id of the storage pool tier. - It is mutually exclusive with \ :emphasis:`tier\_name`\ . + It is mutually exclusive with *tier_name*. tier_name (optional, str, None) Unique name of the storage pool tier. - It is mutually exclusive with \ :emphasis:`tier\_id`\ . + It is mutually exclusive with *tier_id*. Mandatory for storage pool tier creation. @@ -62,9 +62,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) @@ -83,7 +83,7 @@ Notes .. note:: - Modifying a storage pool tier 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. diff --git a/docs/modules/subnet.rst b/docs/modules/subnet.rst index a9150575..e0f4c869 100644 --- a/docs/modules/subnet.rst +++ b/docs/modules/subnet.rst @@ -66,16 +66,16 @@ Parameters start_range (True, str, None) - Specifies the start range for \ :emphasis:`sc\_service\_addrs`\ . + Specifies the start range for *sc_service_addrs*. end_range (True, str, None) - Specifies the end range for \ :emphasis:`sc\_service\_addrs`\ . + Specifies the end range for *sc_service_addrs*. sc_service_addrs_state (optional, str, None) - Specifies if the \ :emphasis:`sc\_service\_addrs`\ range need to be added or removed from the subnet. + Specifies if the *sc_service_addrs* range need to be added or removed from the subnet. mtu (optional, int, None) @@ -94,9 +94,9 @@ Parameters state (True, str, None) The state of the subnet after the task is performed. - \ :literal:`present`\ - indicates that the subnet should exist on the system. + ``present`` - indicates that the subnet should exist on the system. - \ :literal:`absent`\ - indicates that the subnet should not exist on the system. + ``absent`` - indicates that the subnet should not exist on the system. onefs_host (True, str, None) @@ -110,9 +110,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) @@ -130,7 +130,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. diff --git a/docs/modules/synciq_global_settings.rst b/docs/modules/synciq_global_settings.rst index 4aaa0fe5..ee11519c 100644 --- a/docs/modules/synciq_global_settings.rst +++ b/docs/modules/synciq_global_settings.rst @@ -30,9 +30,9 @@ Parameters ---------- service (optional, str, on) - Specifies if the SyncIQ service currently \ :literal:`on`\ , \ :literal:`paused`\ , or \ :literal:`off`\ . + Specifies if the SyncIQ service currently ``on``, ``paused``, or ``off``. - If \ :literal:`paused`\ , all sync jobs will be paused. If turned \ :literal:`off`\ , all jobs will be canceled. + If ``paused``, all sync jobs will be paused. If turned ``off``, all jobs will be canceled. encryption_required (optional, bool, False) @@ -50,9 +50,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) @@ -70,7 +70,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/synciqcertificate.rst b/docs/modules/synciqcertificate.rst index 4779e82c..bf62b68d 100644 --- a/docs/modules/synciqcertificate.rst +++ b/docs/modules/synciqcertificate.rst @@ -68,9 +68,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) @@ -88,7 +88,7 @@ Notes ----- .. note:: - - 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. diff --git a/docs/modules/synciqjob.rst b/docs/modules/synciqjob.rst index 8e662f0d..9537681d 100644 --- a/docs/modules/synciqjob.rst +++ b/docs/modules/synciqjob.rst @@ -40,9 +40,9 @@ Parameters state (True, str, None) The state of the SyncIQ job after the task is performed. - \ :literal:`present`\ - indicates that the SyncIQ job should exist on the system. + ``present`` - indicates that the SyncIQ job should exist on the system. - \ :literal:`absent`\ - indicates that the SyncIQ job should not exist on the system. + ``absent`` - indicates that the SyncIQ job should not exist on the system. onefs_host (True, str, None) @@ -56,9 +56,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) @@ -77,7 +77,7 @@ Notes .. note:: - There is delay in the actual state change of the SyncIQ job. The state change of jobs in 'scheduled' state 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.powerscale' are built to support the Dell PowerScale storage platform. diff --git a/docs/modules/synciqpolicy.rst b/docs/modules/synciqpolicy.rst index f4b6178a..b09dfea0 100644 --- a/docs/modules/synciqpolicy.rst +++ b/docs/modules/synciqpolicy.rst @@ -32,21 +32,21 @@ Parameters policy_name (optional, str, None) The name of the policy. - Required at the time of policy creation, for the rest of the operations either \ :emphasis:`policy\_name`\ or \ :emphasis:`policy\_id`\ is required. + Required at the time of policy creation, for the rest of the operations either *policy_name* or *policy_id* is required. policy_id (optional, str, None) - The \ :emphasis:`policy\_id`\ is auto generated at the time of creation. + The *policy_id* is auto generated at the time of creation. - For get/modify operations either \ :emphasis:`policy\_name`\ or \ :emphasis:`policy\_id`\ is needed. + For get/modify operations either *policy_name* or *policy_id* is needed. - Parameters \ :emphasis:`policy\_name`\ and \ :emphasis:`policy\_id`\ are mutually exclusive. + Parameters *policy_name* and *policy_id* are mutually exclusive. new_policy_name (optional, str, None) The new name of the policy while renaming an existing policy. - \ :emphasis:`policy\_name`\ or \ :emphasis:`policy\_id`\ is required together with \ :emphasis:`new\_policy\_name`\ . + *policy_name* or *policy_id* is required together with *new_policy_name*. action (optional, str, None) @@ -70,35 +70,35 @@ Parameters job_delay (optional, int, None) - If \ :emphasis:`run\_job`\ is set to \ :literal:`when-source-modified`\ , \ :emphasis:`job\_delay`\ is the duration to wait before triggering a job once there is modification on source. + If *run_job* is set to ``when-source-modified``, *job_delay* is the duration to wait before triggering a job once there is modification on source. job_delay_unit (optional, str, seconds) - Unit for \ :emphasis:`job\_delay`\ . + Unit for *job_delay*. rpo_alert (optional, int, None) - If \ :emphasis:`run\_job`\ is set to \ :literal:`on-schedule`\ it is set to time/date, an alert is created if the specified RPO for this policy is exceeded. + If *run_job* is set to ``on-schedule`` it is set to time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts. rpo_alert_unit (optional, str, minutes) - Unit for \ :emphasis:`rpo\_alert`\ . + Unit for *rpo_alert*. snapshot_sync_pattern (optional, str, None) - The naming pattern that a snapshot must match to trigger a sync when the schedule is \ :literal:`when-snapshot-taken`\ . + The naming pattern that a snapshot must match to trigger a sync when the schedule is ``when-snapshot-taken``. skip_when_source_unmodified (optional, bool, None) If true and schedule is set , the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed. - Option modifiable when \ :emphasis:`run\_job`\ is \ :literal:`on-schedule`\ . + Option modifiable when *run_job* is ``on-schedule``. schedule (optional, str, None) - Schedule set when \ :emphasis:`run\_policy`\ is \ :literal:`on-schedule`\ . + Schedule set when *run_policy* is ``on-schedule``. It must be in isidate format. @@ -106,25 +106,25 @@ Parameters source_cluster (optional, dict, None) - Defines the details of \ :emphasis:`source\_cluster`\ . + Defines the details of *source_cluster*. source_root_path (optional, str, None) The root directory on the source cluster where the files will be synced from. - Source root path should begin with /ifs. For example, if we want to create a synciq policy for the directory 'source' in the base path /ifs, then the \ :emphasis:`source\_root\_path`\ will be '/ifs/source'. + Source root path should begin with /ifs. For example, if we want to create a synciq policy for the directory 'source' in the base path /ifs, then the *source_root_path* will be '/ifs/source'. source_exclude_directories (optional, list, None) List of path to the directories that should be excluded while running a policy. - For example, if we want to exclude directory 'exclude1' at location '/ifs/source', then the \ :emphasis:`source\_exclude\_directories`\ will be '/ifs/source/exclude1'. + For example, if we want to exclude directory 'exclude1' at location '/ifs/source', then the *source_exclude_directories* will be '/ifs/source/exclude1'. source_include_directories (optional, list, None) List of path to the directories that should be included while running a policy - For example, if we want to include directory 'include1' at location '/ifs/source', then the \ :emphasis:`source\_exclude\_directories`\ will be '/ifs/source/include1'. + For example, if we want to include directory 'include1' at location '/ifs/source', then the *source_exclude_directories* will be '/ifs/source/include1'. source_network (optional, dict, None) @@ -156,15 +156,15 @@ Parameters target_certificate_id (optional, str, None) The ID of the target cluster certificate being used for encryption - This parameter is not supported by isi\_sdk\_8\_1\_1 + This parameter is not supported by isi_sdk_8_1_1 target_certificate_name (optional, str, None) The name of the target cluster certificate being used for encryption - Parameters \ :emphasis:`target\_certficate\_name`\ and \ :emphasis:`target\_certificate\_id`\ are mutually exclusive + Parameters *target_certficate_name* and *target_certificate_id* are mutually exclusive - This parameter is not supported by isi\_sdk\_8\_1\_1 + This parameter is not supported by isi_sdk_8_1_1 @@ -183,7 +183,7 @@ Parameters exp_time_unit (optional, str, years) - Unit of \ :emphasis:`target\_snapshot`\ expiration time. + Unit of *target_snapshot* expiration time. @@ -204,22 +204,22 @@ Parameters workers_per_node (optional, int, None) - Specifies the desired workers per node. This parameter is valid for \ :emphasis:`allow\_write`\ , and \ :emphasis:`allow\_write\_revert`\ operation. This is an optional parameter and it defaults to 3. + Specifies the desired workers per node. This parameter is valid for *allow_write*, and *allow_write_revert* operation. This is an optional parameter and it defaults to 3. accelerated_failback (optional, bool, None) - If set to \ :literal:`true`\ , SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. + If set to ``true``, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations. - It defaults to \ :literal:`true`\ , if not specified. + It defaults to ``true``, if not specified. restrict_target_network (optional, bool, None) - If set to \ :literal:`true`\ then replication policies will connect only to nodes in the specified SmartConnect zone. + If set to ``true`` then replication policies will connect only to nodes in the specified SmartConnect zone. - If set to \ :literal:`false`\ , replication policies are not restricted to specific nodes on the target cluster. + If set to ``false``, replication policies are not restricted to specific nodes on the target cluster. onefs_host (True, str, None) @@ -233,9 +233,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) @@ -254,7 +254,7 @@ Notes .. note:: - There is a delay to view the jobs running on the policy. - - 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. diff --git a/docs/modules/synciqreports.rst b/docs/modules/synciqreports.rst index e04cb529..a41c6cc4 100644 --- a/docs/modules/synciqreports.rst +++ b/docs/modules/synciqreports.rst @@ -60,9 +60,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) @@ -80,7 +80,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. diff --git a/docs/modules/synciqrules.rst b/docs/modules/synciqrules.rst index 886baea6..1fa5244e 100644 --- a/docs/modules/synciqrules.rst +++ b/docs/modules/synciqrules.rst @@ -40,7 +40,7 @@ Parameters sync_rule_id (optional, str, None) This is an auto generated ID at the time of creation of SyncIQ performance rule. - For get/modify/delete operations \ :emphasis:`sync\_rule\_id`\ is required. + For get/modify/delete operations *sync_rule_id* is required. The ID of a performance rule is not absolute to a particular existing rule configuration. The IDs are auto-sequenced during creation/deletion of a performance rule. @@ -101,9 +101,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) @@ -122,7 +122,7 @@ Notes .. note:: - Operations performed in parallel from other interfaces apart from playbook cannot guarantee desirable results. - - 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. diff --git a/docs/modules/synciqtargetreports.rst b/docs/modules/synciqtargetreports.rst index 81106b72..ace32d81 100644 --- a/docs/modules/synciqtargetreports.rst +++ b/docs/modules/synciqtargetreports.rst @@ -60,9 +60,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) @@ -80,7 +80,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. diff --git a/docs/modules/user.rst b/docs/modules/user.rst index 4ffd1cf6..bb3aa3d6 100644 --- a/docs/modules/user.rst +++ b/docs/modules/user.rst @@ -34,9 +34,9 @@ Parameters user_id (optional, int, None) - The \ :emphasis:`user\_id`\ is auto generated or can be assigned at the time of creation. + The *user_id* is auto generated or can be assigned at the time of creation. - For all other operations either \ :emphasis:`user\_name`\ or \ :emphasis:`user\_id`\ is needed. + For all other operations either *user_name* or *user_id* is needed. password (optional, str, None) @@ -50,9 +50,9 @@ Parameters access_zone (optional, str, system) This option mentions the zone in which a user is created. - For creation, \ :emphasis:`access\_zone`\ acts as an attribute for the user. + For creation, *access_zone* acts as an attribute for the user. - For all other operations \ :emphasis:`access\_zone`\ acts as a filter. + For all other operations *access_zone* acts as a filter. provider_type (optional, str, local) @@ -64,7 +64,7 @@ Parameters Getting user details is allowed for all users. - If the \ :emphasis:`provider\_type`\ is 'ads' then domain name of the Active Directory Server has to be mentioned in the \ :emphasis:`user\_name`\ . The format for the \ :emphasis:`user\_name`\ should be 'DOMAIN\_NAME\\user\_name' or "DOMAIN\_NAME\\\\user\_name". + If the *provider_type* is 'ads' then domain name of the Active Directory Server has to be mentioned in the *user_name*. The format for the *user_name* should be 'DOMAIN_NAME\user_name' or "DOMAIN_NAME\\user_name". This option acts as a filter for all operations except creation. @@ -96,7 +96,7 @@ Parameters full_name (optional, str, None) - The additional information about the user can be provided using full\_name option. + The additional information about the user can be provided using full_name option. email (optional, str, None) @@ -116,19 +116,19 @@ Parameters role_state (optional, str, None) - The \ :emphasis:`role\_state`\ option is used to mention the existence of the role for a particular user. + The *role_state* option is used to mention the existence of the role for a particular user. It is required when a role is added or removed from user. update_password (optional, str, always) - This parameter controls the way the \ :emphasis:`password`\ is updated during the creation and modification of a user. + This parameter controls the way the *password* is updated during the creation and modification of a user. - \ :literal:`always`\ will update password for each execution. + ``always`` will update password for each execution. - \ :literal:`on\_create`\ will only set while creating a user. + ``on_create`` will only set while creating a user. - For modifying \ :emphasis:`password`\ , set the \ :emphasis:`update\_password`\ to \ :literal:`always`\ . + For modifying *password*, set the *update_password* to ``always``. onefs_host (True, str, None) @@ -142,9 +142,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) @@ -162,7 +162,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. diff --git a/docs/modules/user_mapping_rule.rst b/docs/modules/user_mapping_rule.rst index ee8e95ac..84dd04cf 100644 --- a/docs/modules/user_mapping_rule.rst +++ b/docs/modules/user_mapping_rule.rst @@ -54,7 +54,7 @@ Parameters break_on_match (optional, bool, None) - If \ :literal:`true`\ , and the rule was applied successfuly, stop processing further. + If ``true``, and the rule was applied successfuly, stop processing further. default_user (optional, dict, None) @@ -71,15 +71,15 @@ Parameters group (optional, bool, None) - If \ :literal:`true`\ , the primary GID and primary group SID should be copied to the existing credential. + If ``true``, the primary GID and primary group SID should be copied to the existing credential. groups (optional, bool, None) - If \ :literal:`true`\ , all additional identifiers should be copied to the existing credential. + If ``true``, all additional identifiers should be copied to the existing credential. user (optional, bool, None) - If \ :literal:`true`\ , the primary UID and primary user SID should be copied to the existing credential. + If ``true``, the primary UID and primary user SID should be copied to the existing credential. @@ -129,9 +129,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) @@ -150,7 +150,7 @@ Notes .. note:: - Idempotency is not supported for create and delete operations. - - 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. @@ -246,19 +246,19 @@ user_mapping_rule_details (When a rule exists, dict, {'user_mapping_rule_details _break (, bool, ) - If \ :literal:`true`\ , and the rule was applied successfuly, stop processing further. + If ``true``, and the rule was applied successfuly, stop processing further. group (, bool, ) - If \ :literal:`true`\ , the primary GID and primary group SID should be copied to the existing credential. + If ``true``, the primary GID and primary group SID should be copied to the existing credential. groups (, bool, ) - If \ :literal:`true`\ , all additional identifiers should be copied to the existing credential. + If ``true``, all additional identifiers should be copied to the existing credential. user (, bool, ) - If \ :literal:`true`\ , the primary UID and primary user SID should be copied to the existing credential. + If ``true``, the primary UID and primary user SID should be copied to the existing credential. default_user (, dict, )