Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Assorted documentation updates #220

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
8 changes: 4 additions & 4 deletions plugins/doc_fragments/netapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
32 changes: 15 additions & 17 deletions plugins/modules/na_ontap_active_directory.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,14 @@
-
name: Ontap test
hosts: localhost
collections:
- netapp.ontap
tasks:
- name: Create active directory account.
netapp.ontap.na_ontap_active_directory:
hostname: 10.193.78.219
username: admin
password: netapp1!
https: True
validate_certs: False
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}
https: true
validate_certs: false
vserver: laurentncluster-1
state: present
account_name: carchi
Expand All @@ -92,11 +90,11 @@

- name: Modify domain name.
netapp.ontap.na_ontap_active_directory:
hostname: 10.193.78.219
username: admin
password: netapp1!
https: True
validate_certs: False
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
vserver: laurentncluster-1
state: present
account_name: carchi
Expand All @@ -107,11 +105,11 @@

- name: Delete active directory account.
netapp.ontap.na_ontap_active_directory:
hostname: 10.193.78.219
username: admin
password: netapp1!
https: True
validate_certs: False
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
vserver: laurentncluster-1
state: absent
account_name: carchi
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/na_ontap_active_directory_domain_controllers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
29 changes: 16 additions & 13 deletions plugins/modules/na_ontap_autosupport.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,39 +137,42 @@
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
noteto: [email protected],[email protected]
mail_hosts: 1.2.3.4,5.6.7.8
support: False
support: false
post_url: url/1.0/post

- 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
"""
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/na_ontap_autosupport_invoke.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@

EXAMPLES = '''
- name: Send message
na_ontap_autosupport_invoke:
netapp.ontap.na_ontap_autosupport_invoke:
name: node1
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 = '''
Expand Down
23 changes: 16 additions & 7 deletions plugins/modules/na_ontap_broadcast_domain.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
'''

EXAMPLES = """
- name: create broadcast domain
- name: Create broadcast domain
netapp.ontap.na_ontap_broadcast_domain:
state: present
username: "{{ netapp_username }}"
Expand All @@ -84,7 +84,8 @@
mtu: 1000
ipspace: Default
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"]
- name: modify broadcast domain

- name: Modify broadcast domain
netapp.ontap.na_ontap_broadcast_domain:
state: present
username: "{{ netapp_username }}"
Expand All @@ -94,7 +95,8 @@
mtu: 1100
ipspace: Default
ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"]
- name: split broadcast domain

- name: Split broadcast domain
netapp.ontap.na_ontap_broadcast_domain:
state: present
username: "{{ netapp_username }}"
Expand All @@ -105,15 +107,17 @@
mtu: 1200
ipspace: Default
ports: khutton-vsim1:e0d-12
- name: delete broadcast domain

- name: Delete broadcast domain
netapp.ontap.na_ontap_broadcast_domain:
state: absent
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
name: ansible_domain
ipspace: Default
- name: create broadcast domain REST

- name: Create broadcast domain REST
netapp.ontap.na_ontap_broadcast_domain:
state: present
username: "{{ netapp_username }}"
Expand All @@ -123,7 +127,8 @@
mtu: 1200
ipspace: Default
ports: ["khutton-vsim1:e0d-12","khutton-vsim1:e0d-13","khutton-vsim1:e0d-14"]
- name: rename broadcast domain if exact match of ports REST

- name: Rename broadcast domain if exact match of ports REST
netapp.ontap.na_ontap_broadcast_domain:
state: present
username: "{{ netapp_username }}"
Expand All @@ -134,6 +139,7 @@
mtu: 1200
ipspace: Default
ports: ["khutton-vsim1:e0d-12","khutton-vsim1:e0d-13","khutton-vsim1:e0d-14"]

- name: if partial match, remove e0d-12 from new_ansible_domain & create new domain ansible_domain with port e0d-12 REST
netapp.ontap.na_ontap_broadcast_domain:
state: present
Expand All @@ -145,6 +151,7 @@
mtu: 1200
ipspace: Default
ports: ["khutton-vsim1:e0d-12"]

- name: Modify both broadcast domain and ipspace REST.
netapp.ontap.na_ontap_broadcast_domain:
state: present
Expand All @@ -157,6 +164,7 @@
ipspace: ipspace_1
mtu: 1200
ports: ["khutton-vsim1:e0d-12"]

- name: Modify ipspace only REST.
netapp.ontap.na_ontap_broadcast_domain:
state: present
Expand All @@ -168,7 +176,8 @@
ipspace: Default
mtu: 1200
ports: ["khutton-vsim1:e0d-12"]
- name: delete broadcast domain new_ansible_domain.

- name: Delete broadcast-domain new_ansible_domain.
netapp.ontap.na_ontap_broadcast_domain:
state: absent
username: "{{ netapp_username }}"
Expand Down
33 changes: 17 additions & 16 deletions plugins/modules/na_ontap_broadcast_domain_ports.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +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 = """
Expand Down
15 changes: 8 additions & 7 deletions plugins/modules/na_ontap_cg_snapshot.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,19 @@
'''

EXAMPLES = """
- name:
na_ontap_cg_snapshot:
- name: Create a CG snapshot
netapp.ontap.na_ontap_cg_snapshot:
state: present
vserver: vserver_name
snapshot: snapshot name
volumes: vol_name
snapshot: snapshot_name
volumes:
- vol_name
username: "{{ netapp username }}"
password: "{{ netapp password }}"
hostname: "{{ netapp hostname }}"

- name: Create CG snapshot using CG name - REST
na_ontap_cg_snapshot:
netapp.ontap.na_ontap_cg_snapshot:
state: present
vserver: vserver_name
snapshot: snapshot_name
Expand All @@ -98,7 +99,7 @@
hostname: "{{ netapp hostname }}"

- name: Create CG snapshot using volumes - REST
na_ontap_cg_snapshot:
netapp.ontap.na_ontap_cg_snapshot:
state: present
vserver: vserver_name
snapshot: snapshot_name
Expand All @@ -111,7 +112,7 @@
hostname: "{{ netapp hostname }}"

- name: Delete CG snapshot - REST
na_ontap_cg_snapshot:
netapp.ontap.na_ontap_cg_snapshot:
state: absent
vserver: vserver_name
snapshot: snapshot_name
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/na_ontap_cifs_acl.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"

- name: Modify CIFS share acl permission
netapp.ontap.na_ontap_cifs_acl:
state: present
Expand Down
Loading
Loading