Sync bitbucket and GitHub

Author: carchi8py

plugins/doc_fragments/netapp.py

@@ -37,5 +37,5 @@ class ModuleDocFragment(object):
     - Should https certificates be validated?
     type: bool
 notes:
-  - The modules prefixed with na\\_sg are built to manage NetApp StorageGRID.
+  - The modules prefixed with C(na_sg) are built to manage NetApp StorageGRID.
 """

plugins/modules/na_sg_grid_account.py

@@ -30,24 +30,24 @@
   state:
     description:
     - Whether the specified account should exist or not.
-    - Required for all operations
+    - Required for all operations.
     type: str
     choices: ['present', 'absent']
     default: present
   name:
     description:
     - Name of the tenant.
-    - Required for create or modify operation
+    - Required for create or modify operation.
     type: str
   account_id:
     description:
     - Account Id of the tenant.
-    - May be used for modify or delete operation
+    - May be used for modify or delete operation.
     type: str
   protocol:
     description:
     - Object Storage protocol used by the tenancy.
-    - Required for create operation
+    - Required for create operation.
     type: str
     choices: ['s3', 'swift']
   management:
@@ -66,13 +66,13 @@
   root_access_group:
     description:
     - Existing federated group to have initial Root Access permissions for the tenant.
-    - Must begin with "federated-group/"
+    - Must begin with C(federated-group/)
     type: str
     version_added: 20.11.0
   quota_size:
     description:
-    - Quota to apply to the tenant specified in (quota_size_unit).
-    - If you intend to have no limits, assign 0.
+    - Quota to apply to the tenant specified in I(quota_size_unit).
+    - If you intend to have no limits, assign C(0).
     type: int
     default: 0
   quota_size_unit:
@@ -84,7 +84,7 @@
   password:
     description:
     - Root password for tenant account.
-    - Requires root privilege
+    - Requires root privilege.
     type: str
   update_password:
     description:

plugins/modules/na_sg_grid_certificate.py

@@ -27,23 +27,23 @@
     default: present
   type:
     description:
-    - Which certificate to update
+    - Which certificate to update.
     type: str
     choices: ['storage-api', 'management']
     required: true
   server_certificate:
     description:
-    - X.509 server certificate in PEM-encoding
+    - X.509 server certificate in PEM-encoding.
     type: str
   ca_bundle:
     description:
-    - Intermediate CA certificate bundle in concatenated PEM-encoding
-    - Omit if there is no intermediate CA
+    - Intermediate CA certificate bundle in concatenated PEM-encoding.
+    - Omit if there is no intermediate CA.
     type: str
   private_key:
     description:
-    - Certificate private key in PEM-encoding
-    - Required if C(server_certificate) is specified
+    - Certificate private key in PEM-encoding.
+    - Required if I(server_certificate) is specified.
     type: str
 """
 

plugins/modules/na_sg_grid_dns.py

@@ -30,7 +30,7 @@
   state:
     description:
     - Whether the specified DNS address should exist or not.
-    - Required for all operations
+    - Required for all operations.
     type: str
     choices: ['present']
     default: present

plugins/modules/na_sg_grid_gateway.py

@@ -18,63 +18,63 @@
 author: NetApp Ansible Team (@jkandati) <[email protected]>
 description:
 - Create or Update Load Balancer Endpoints on StorageGRID.
-- This module is idempotent if C(private_key) is not specified
+- This module is idempotent if I(private_key) is not specified.
 options:
   state:
     description:
-    - Whether the specified load balancer endpoint should be configured
+    - Whether the specified load balancer endpoint should be configured.
     type: str
     choices: ['present', 'absent']
     default: present
   display_name:
     description:
-    - A display name for the configuration
-    - This parameter cannot be modified after the load balancer endpoint has been created
+    - A display name for the configuration.
+    - This parameter cannot be modified after the load balancer endpoint has been created.
     type: str
   port:
     description:
-    - The TCP port to serve traffic on
-    - This parameter cannot be modified after the load balancer endpoint has been created
+    - The TCP port to serve traffic on.
+    - This parameter cannot be modified after the load balancer endpoint has been created.
     type: int
     required: true
   secure:
     description:
-    - Whether the load balancer endpoint serves HTTP or HTTPS traffic
-    - This parameter cannot be modified after the load balancer endpoint has been created
+    - Whether the load balancer endpoint serves HTTP or HTTPS traffic.
+    - This parameter cannot be modified after the load balancer endpoint has been created.
     type: bool
     default: true
   enable_ipv4:
     description:
-    - Indicates whether to listen for connections on IPv4
+    - Indicates whether to listen for connections on IPv4.
     type: bool
     default: true
   enable_ipv6:
     description:
-    - Indicates whether to listen for connections on IPv6
+    - Indicates whether to listen for connections on IPv6.
     type: bool
     default: true
   default_service_type:
     description:
-    - The type of service to proxy through the load balancer
+    - The type of service to proxy through the load balancer.
     type: str
     choices: ["s3","swift"]
     default: "s3"
   server_certificate:
     description:
-    - X.509 server certificate in PEM-encoding
-    - Omit if using default certificates
+    - X.509 server certificate in PEM-encoding.
+    - Omit if using default certificates.
     type: str
     required: false
   private_key:
     description:
-    - Certficate private key in PEM-encoding
-    - Required if serverCertificateEncoded is not empty
+    - Certficate private key in PEM-encoding.
+    - Required if I(server_certificate) is not empty.
     type: str
     required: false
   ca_bundle:
     description:
-    - Intermediate CA certificate bundle in concatenated PEM-encoding
-    - Omit when there is no intermediate CA
+    - Intermediate CA certificate bundle in concatenated PEM-encoding.
+    - Omit when there is no intermediate CA.
     type: str
     required: false
 

plugins/modules/na_sg_grid_group.py

@@ -40,8 +40,8 @@
     type: str
   unique_name:
     description:
-    - Unique Name for the group. Must begin with "group/" or "federated-group/"
-    - Required for create, modify or delete operation
+    - Unique Name for the group. Must begin with C(group/) or C(federated-group/)
+    - Required for create, modify or delete operation.
     type: str
     required: true
   management_policy:

plugins/modules/na_sg_grid_identity_federation.py

@@ -19,8 +19,8 @@
 author: NetApp Ansible Team (@joshedmonds) <[email protected]>
 description:
 - Configure Grid Identity Federation within NetApp StorageGRID.
-- If module is run with C(check_mode), a connectivity test will be performed using the supplied values without changing the configuration
-- This module is idempotent if C(password) is not specified
+- If module is run with I(check_mode), a connectivity test will be performed using the supplied values without changing the configuration.
+- This module is idempotent if I(password) is not specified.
 options:
   state:
     description:
@@ -60,32 +60,32 @@
   type:
     description:
     - The type of identity source.
-    - Default is 'ldap'.
+    - Default is C(ldap).
     type: str
     default: ldap
   ldap_user_id_attribute:
     description:
     - The LDAP attribute which contains the unique user name of a user.
-    - Should be configured if C(ldap_service_type) is 'Other'.
+    - Should be configured if I(ldap_service_type=Other).
     type: str
   ldap_user_uuid_attribute:
     description:
     - The LDAP attribute which contains the permanent unique identity of a user.
-    - Should be configured if C(ldap_service_type) is 'Other'.
+    - Should be configured if I(ldap_service_type=Other).
     type: str
   ldap_group_id_attribute:
     description:
     - The LDAP attribute which contains the group for a user.
-    - Should be configured if C(ldap_service_type) is 'Other'.
+    - Should be configured if I(ldap_service_type=Other).
     type: str
   ldap_group_uuid_attribute:
     description:
     - The LDAP attribute which contains the group's permanent unique identity.
-    - Should be configured if C(ldap_service_type) is 'Other'.
+    - Should be configured if I(ldap_service_type=Other).
     type: str
   tls:
     description:
-    - Whether Transport Layer Security is used to connect to the LDAP server
+    - Whether Transport Layer Security is used to connect to the LDAP server.
     choices: ['STARTTLS', 'LDAPS', 'Disabled']
     type: str
     default: STARTTLS

plugins/modules/na_sg_grid_info.py

@@ -19,72 +19,72 @@
 author: NetApp Ansible Team (@jasonl4) <[email protected]>
 extends_documentation_fragment:
     - netapp.storagegrid.netapp.sg
-short_description: NetApp StorageGRID Grid information gatherer
+short_description: NetApp StorageGRID Grid information gatherer.
 description:
-    - This module allows you to gather various information about StorageGRID Grid configuration
+    - This module allows you to gather various information about StorageGRID Grid configuration.
 version_added: 20.11.0
 
 options:
     gather_subset:
         type: list
         elements: str
         description:
-            - When supplied, this argument will restrict the information collected
-                to a given subset. Either the info name or the Rest API can be given.
-                Possible values for this argument include
-                'grid_accounts_info' or 'grid/accounts',
-                'grid_alarms_info' or 'grid/alarms',
-                'grid_audit_info' or 'grid/audit',
-                'grid_compliance_global_info' or 'grid/compliance-global',
-                'grid_config_info' or 'grid/config',
-                'grid_config_management_info' or 'grid/config/management',
-                'grid_config_product_version_info' or 'grid/config/product-version',
-                'grid_deactivated_features_info' or 'grid/deactivated-features',
-                'grid_dns_servers_info' or 'grid/dns-servers',
-                'grid_domain_names_info' or 'grid/domain-names',
-                'grid_ec_profiles_info' or 'grid/ec-profiles',
-                'grid_expansion_info' or 'grid/expansion',
-                'grid_expansion_nodes_info' or 'grid/expansion/nodes',
-                'grid_expansion_sites_info' or 'grid/expansion/sites',
-                'grid_grid_networks_info' or 'grid/grid-networks',
-                'grid_groups_info' or 'grid/groups',
-                'grid_health_info' or 'grid/health',
-                'grid_health_topology_info' or 'grid/health/topology',
-                'grid_identity_source_info' or 'grid/identity-source',
-                'grid_ilm_criteria_info' or 'grid/ilm-criteria',
-                'grid_ilm_policies_info' or 'grid/ilm-policies',
-                'grid_ilm_rules_info' or 'grid/ilm-rules',
-                'grid_license_info' or 'grid/license',
-                'grid_management_certificate_info' or 'grid/management-certificate',
-                'grid_ntp_servers_info' or 'grid/ntp-servers',
-                'grid_recovery_available_nodes_info' or 'grid/recovery/available-nodes',
-                'grid_recovery_info' or 'grid/recovery',
-                'grid_regions_info' or 'grid/regions',
-                'grid_schemes_info' or 'grid/schemes',
-                'grid_snmp_info' or 'grid/snmp',
-                'grid_storage_api_certificate_info' or 'grid/storage-api-certificate',
-                'grid_untrusted_client_network_info' or 'grid/untrusted-client-network',
-                'grid_users_info' or 'grid/users',
-                'grid_users_root_info' or 'grid/users/root',
-                'versions_info' or 'versions'
-                Can specify a list of values to include a larger subset.
+            - When supplied, this argument will restrict the information collected to a given subset.
+            - Either the info name or the REST API can be given.
+            - Possible values for this argument include
+            - C(grid_accounts_info) or C(grid/accounts)
+            - C(grid_alarms_info) or C(grid/alarms)
+            - C(grid_audit_info) or C(grid/audit)
+            - C(grid_compliance_global_info) or C(grid/compliance-global)
+            - C(grid_config_info) or C(grid/config)
+            - C(grid_config_management_info) or C(grid/config/management)
+            - C(grid_config_product_version_info) or C(grid/config/product-version)
+            - C(grid_deactivated_features_info) or C(grid/deactivated-features)
+            - C(grid_dns_servers_info) or C(grid/dns-servers)
+            - C(grid_domain_names_info) or C(grid/domain-names)
+            - C(grid_ec_profiles_info) or C(grid/ec-profiles)
+            - C(grid_expansion_info) or C(grid/expansion)
+            - C(grid_expansion_nodes_info) or C(grid/expansion/nodes)
+            - C(grid_expansion_sites_info) or C(grid/expansion/sites)
+            - C(grid_grid_networks_info) or C(grid/grid-networks)
+            - C(grid_groups_info) or C(grid/groups)
+            - C(grid_health_info) or C(grid/health)
+            - C(grid_health_topology_info) or C(grid/health/topology)
+            - C(grid_identity_source_info) or C(grid/identity-source)
+            - C(grid_ilm_criteria_info) or C(grid/ilm-criteria)
+            - C(grid_ilm_policies_info) or C(grid/ilm-policies)
+            - C(grid_ilm_rules_info) or C(grid/ilm-rules)
+            - C(grid_license_info) or C(grid/license)
+            - C(grid_management_certificate_info) or C(grid/management-certificate)
+            - C(grid_ntp_servers_info) or C(grid/ntp-servers)
+            - C(grid_recovery_available_nodes_info) or C(grid/recovery/available-nodes)
+            - C(grid_recovery_info) or C(grid/recovery)
+            - C(grid_regions_info) or C(grid/regions)
+            - C(grid_schemes_info) or C(grid/schemes)
+            - C(grid_snmp_info) or C(grid/snmp)
+            - C(grid_storage_api_certificate_info) or C(grid/storage-api-certificate)
+            - C(grid_untrusted_client_network_info) or C(grid/untrusted-client-network)
+            - C(grid_users_info) or C(grid/users)
+            - C(grid_users_root_info) or C(grid/users/root)
+            - C(versions_info) or C(versions)
+            - Can specify a list of values to include a larger subset.
         default: all
     parameters:
         description:
-        - Allows for any rest option to be passed in
+        - Allows for any rest option to be passed in.
         type: dict
 """
 
 EXAMPLES = """
 - name: Gather StorageGRID Grid info
-  na_sg_grid_info:
+  netapp.storagegrid.na_sg_grid_info:
     api_url: "https://1.2.3.4/"
     auth_token: "storagegrid-auth-token"
     validate_certs: false
   register: sg_grid_info
 
 - name: Gather StorageGRID Grid info for grid/accounts and grid/config subsets
-  na_sg_grid_info:
+  netapp.storagegrid.na_sg_grid_info:
     api_url: "https://1.2.3.4/"
     auth_token: "storagegrid-auth-token"
     validate_certs: false
@@ -94,7 +94,7 @@
   register: sg_grid_info
 
 - name: Gather StorageGRID Grid info for all subsets
-  na_sg_grid_info:
+  netapp.storagegrid.na_sg_grid_info:
     api_url: "https://1.2.3.4/"
     auth_token: "storagegrid-auth-token"
     validate_certs: false
@@ -103,7 +103,7 @@
   register: sg_grid_info
 
 - name: Gather StorageGRID Grid info for grid/accounts and grid/users subsets, limit to 5 results for each subset
-  na_sg_grid_info:
+  netapp.storagegrid.na_sg_grid_info:
     api_url: "https://1.2.3.4/"
     auth_token: "storagegrid-auth-token"
     validate_certs: false

plugins/modules/na_sg_grid_ntp.py

@@ -35,7 +35,7 @@
     default: present
   ntp_servers:
     description:
-    - List of comma separated NTP server address
+    - List of comma separated NTP server address.
     type: list
     elements: str
     required: true