Sync bitbucket and GitHub

README.md

@@ -68,6 +68,10 @@ The following modules do not have REST equivalent APIs. They will stop working o
   - na_ontap_svm - updated documentation for `allowed_protocols` & `services`.
   - na_ontap_volume - new option `large_size_enabled` added in REST, requires ONTAP 9.12 or later.
   - na_ontap_dns - updated documentation for `vserver`.
+  - multiple modules - standardized hostname, username, and password parameters to use `netapp_hostname`, `netapp_username`, and `netapp_password` as values.
+  - multiple modules - updated examples to use Fully Qualified Collection Name.
+  - na_ontap_rest_cli - added POST and DELETE examples.
+  - updated dead link in doc_fragments.
 
 ### Bug Fixes
   - Resolved Ansible lint issues.

changelogs/fragments/github-220.yaml

@@ -0,0 +1,5 @@
+minor_changes:
+  - Multiple modules - Standardize hostname, username, and password parameters to use netapp_hostname, netapp_username, and netapp_password as values.
+  - Multiple modules - Update examples to use Fully Qualified Collection Name.
+  - na_ontap_rest_cli - Add POST and DELETE examples.
+  - Update dead link in doc_fragments.

plugins/doc_fragments/netapp.py

@@ -28,9 +28,9 @@ class ModuleDocFragment(object):
   username:
       description:
         - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
-        - For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
+        - For more information, please read the documentation U(https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html).
         - Two authentication methods are supported
-        - 1. basic authentication, using username and password,
+        - 1. Basic authentication, using username and password.
         - 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
         - To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.
       type: str
@@ -125,9 +125,9 @@ class ModuleDocFragment(object):
   username:
       description:
         - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
-        - For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
+        - For more information, please read the documentation U(https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html).
         - Two authentication methods are supported
-        - 1. basic authentication, using username and password,
+        - 1. Basic authentication, using username and password.
         - 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
         - To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.
       type: str
@@ -208,9 +208,9 @@ class ModuleDocFragment(object):
   username:
       description:
         - This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.
-        - For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
+        - For more information, please read the documentation U(https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html).
         - Two authentication methods are supported
-        - 1. basic authentication, using username and password,
+        - 1. Basic authentication, using username and password.
         - 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
         - To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.
       type: str

plugins/modules/na_ontap_active_directory_domain_controllers.py

@@ -55,9 +55,9 @@
 EXAMPLES = """
 - name: Create active directory preferred domain controllers
   netapp.ontap.na_ontap_active_directory_domain_controllers:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     https: true
     validate_certs: false
     vserver: ansible
@@ -67,9 +67,9 @@
 
 - name: Delete active directory preferred domain controllers
   netapp.ontap.na_ontap_active_directory_domain_controllers:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     https: true
     validate_certs: false
     vserver: ansible

plugins/modules/na_ontap_autosupport.py

@@ -137,9 +137,9 @@
 EXAMPLES = """
 - name: Enable autosupport
   netapp.ontap.na_ontap_autosupport:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     state: present
     node_name: test
     transport: https
@@ -150,29 +150,29 @@
 
 - name: Modify autosupport proxy_url with password
   netapp.ontap.na_ontap_autosupport:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     state: present
     node_name: test
     transport: https
     proxy_url: username:[email protected]:8000
 
 - name: Modify autosupport proxy_url without password
   netapp.ontap.na_ontap_autosupport:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     state: present
     node_name: test
     transport: https
     proxy_url: [email protected]:8000
 
 - name: Disable autosupport
   netapp.ontap.na_ontap_autosupport:
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
     state: absent
     node_name: test
 """

plugins/modules/na_ontap_autosupport_invoke.py

@@ -66,9 +66,9 @@
     autosupport_message: invoked test autosupport rest
     uri: http://1.2.3.4/delivery_uri
     type: test
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
 '''
 
 RETURN = '''

plugins/modules/na_ontap_broadcast_domain_ports.py

@@ -45,23 +45,23 @@
 '''
 
 EXAMPLES = """
-- name: Create broadcast domain ports
-  na_ontap_broadcast_domain_ports:
-    state=present
-    username={{ netapp_username }}
-    password={{ netapp_password }}
-    hostname={{ netapp_hostname }}
-    broadcast_domain=123kevin
-    ports=khutton-vsim1:e0d-13
-
-- name: Delete broadcast domain ports
-  na_ontap_broadcast_domain_ports:
-    state=absent
-    username={{ netapp_username }}
-    password={{ netapp_password }}
-    hostname={{ netapp_hostname }}
-    broadcast_domain=123kevin
-    ports=khutton-vsim1:e0d-13
+- name: Create broadcast-domain ports
+  netapp.ontap.na_ontap_broadcast_domain_ports:
+    state: present
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    broadcast_domain: 123kevin
+    ports: khutton-vsim1:e0d-13
+
+- name: Delete broadcast-domain ports
+  netapp.ontap.na_ontap_broadcast_domain_ports:
+    state: absent
+    hostname: "{{ netapp_hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    broadcast_domain: 123kevin
+    ports: khutton-vsim1:e0d-13
 """
 
 RETURN = """

plugins/modules/na_ontap_cg_snapshot.py

@@ -82,9 +82,9 @@
     vserver: vserver_name
     snapshot: snapshot name
     volumes: vol_name
-    username: "{{ netapp username }}"
-    password: "{{ netapp password }}"
-    hostname: "{{ netapp hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 
 - name: Create CG snapshot using CG name - REST
   na_ontap_cg_snapshot:
@@ -93,32 +93,32 @@
     snapshot: snapshot_name
     consistency_group: cg_name
     snapmirror_label: sm_label
-    username: "{{ netapp username }}"
-    password: "{{ netapp password }}"
-    hostname: "{{ netapp hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 
 - name: Create CG snapshot using volumes - REST
   na_ontap_cg_snapshot:
     state: present
     vserver: vserver_name
     snapshot: snapshot_name
     volumes:
-        - vol1
-        - vol2
+      - vol1
+      - vol2
     snapmirror_label: sm_label
-    username: "{{ netapp username }}"
-    password: "{{ netapp password }}"
-    hostname: "{{ netapp hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 
 - name: Delete CG snapshot - REST
   na_ontap_cg_snapshot:
     state: absent
     vserver: vserver_name
     snapshot: snapshot_name
     consistency_group: cg_name
-    username: "{{ netapp username }}"
-    password: "{{ netapp password }}"
-    hostname: "{{ netapp hostname }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 """
 
 RETURN = """

plugins/modules/na_ontap_cifs_local_group.py

@@ -53,9 +53,9 @@
     state: present
     vserver: svm1
     name: BUILTIN\\administrators
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     https: true
     validate_certs: false
 
@@ -64,9 +64,9 @@
     state: absent
     vserver: svm1
     name: BUILTIN\\administrators
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     https: true
     validate_certs: false
 
@@ -76,9 +76,9 @@
     vserver: svm1
     name: BUILTIN\\administrators
     descrition: 'CIFS local group'
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     https: true
     validate_certs: false
 
@@ -88,9 +88,9 @@
     vserver: svm1
     name: ANSIBLE_CIFS\\test_users
     descrition: 'CIFS local group'
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     https: true
     validate_certs: false
 """

plugins/modules/na_ontap_cifs_local_group_member.py

@@ -55,9 +55,9 @@
     vserver: svm1
     group: BUILTIN\\administrators
     member: DOMAIN\\Domain Admins
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     ontapi: "{{ ontap_facts.ontap_version }}"
     https: true
     validate_certs: false
@@ -68,9 +68,9 @@
     vserver: svm1
     group: BUILTIN\\administrators
     member: DOMAIN\\Domain Admins
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     ontapi: "{{ ontap_facts.ontap_version }}"
     https: true
     validate_certs: false

plugins/modules/na_ontap_cifs_local_user_modify.py

@@ -56,18 +56,18 @@
     name: BUILTIN\\administrators
     vserver: ansible
     is_account_disabled: false
-    username: '{{ username }}'
-    password: '{{ password }}'
-    hostname: '{{ hostname }}'
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 
 - name: Disable local CIFS Administrator account
   na_ontap_cifs_local_user_modify:
     name: BUILTIN\\administrators
     vserver: ansible
     is_account_disabled: true
-    username: '{{ username }}'
-    password: '{{ password }}'
-    hostname: '{{ hostname }}'
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 """
 
 RETURN = """

plugins/modules/na_ontap_cifs_local_user_set_password.py

@@ -51,9 +51,9 @@
     user_name: Administrator
     user_password: Test123!
     vserver: ansible
-    hostname: "{{ hostname }}"
-    username: "{{ username }}"
-    password: "{{ password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
 '''
 
 RETURN = '''

plugins/modules/na_ontap_command.py

@@ -71,27 +71,27 @@
 EXAMPLES = """
 - name: Run ONTAP CLI command
   netapp.ontap.na_ontap_command:
-    hostname: "{{ hostname }}"
-    username: "{{ admin username }}"
-    password: "{{ admin password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     command: ['version']
 
 # Same as above, but returns parseable dictonary
 - name: Run ONTAP CLI command
   netapp.ontap.na_ontap_command:
-    hostname: "{{ hostname }}"
-    username: "{{ admin username }}"
-    password: "{{ admin password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     command: ['node', 'show', '-fields', 'node,health,uptime,model']
     privilege: 'admin'
     return_dict: true
 
 # Same as above, but with lines filtering
 - name: Run ONTAP CLI command
   netapp.ontap.na_ontap_command:
-    hostname: "{{ hostname }}"
-    username: "{{ admin username }}"
-    password: "{{ admin password }}"
+    username: "{{ netapp_username }}"
+    password: "{{ netapp_password }}"
+    hostname: "{{ netapp_hostname }}"
     command: ['node', 'show', '-fields', 'node,health,uptime,model']
     exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node ', or anything else containing 'ode '.
     privilege: 'admin'