Debian Codegraph @

ansible_collections/netapp/ontap/roles/na_ontap_vserver_delete/README.md

raw
1 Role Name
2 =========
3
4 This role deletes an ONTAP vserver and dependents:
5 - all volumes are deleted, including any user data !!!
6 - clones and snapshots are deleted as well !!!
7 - network interfaces are deleted
8 - as the vserver is deleted, the associated, DNS entries, routes, NFS/CIFS/iSCSI servers as applicable, export policies and rules, are automatically deleted by ONTAP.
9
10 Requirements
11 ------------
12
13 - ONTAP collection.
14 - ONTAP with REST support (9.7 or later).
15
16 - The module requires the jmespath python package.
17 - If json_query is not found, you may need to install the community.general collection.
18 - C(ansible-galaxy collection install community.general)
19
20 Role Variables
21 --------------
22
23 This role expects the following variables to be set:
24 - netapp_hostname: IP address of ONTAP admin interface (can be vsadmin too).
25 - netapp_username: user account with admin or vsadmin role.
26 - netapp_password: for the user account with admin or vsadmin role.
27 - vserver_name: name of vserver to delete.
28
29 In order to delete a CIFS server, the following variables are required
30 - cifs_ad_admin_user_name: AD admin user name
31 - cifs_ad_admin_password: AD admin password
32
33 The following variables are preset but can be changed
34 - https: true
35 - validate_certs: true (true is strongly recommended)
36 - debug_level: 0
37 - enable_check_mode: false
38 - confirm_before_removing_cifs_server: true
39 - confirm_before_removing_igroups: true
40 - confirm_before_removing_interfaces: true
41 - confirm_before_removing_volumes: true
42 - cifs_force_delete: true (delete the CIFS server regardless of communication errors)
43 - confirm_before_removing_nvme_subsystems: true
44
45
46 Example Playbook
47 ----------------
48
49
50
51 ```
52 ---
53 - hosts: localhost
54 gather_facts: no
55 vars:
56 login: &login
57 netapp_hostname: ip_address
58 netapp_username: admin
59 netapp_password: XXXXXXXXX
60 https: true
61 validate_certs: false
62 roles:
63 - role: netapp.ontap.na_ontap_vserver_delete
64 vars:
65 <<: *login
66 vserver_name: ansibleSVM
67 # uncomment the following line to accept volumes will be permanently deleted
68 # removing_volumes_permanently_destroy_user_data: I agree
69 # turn confirmation prompts on or off
70 confirm_before_removing_cifs_server: false
71 confirm_before_removing_igroups: false
72 confirm_before_removing_interfaces: false
73 confirm_before_removing_nvme_subsystems: false
74 # optional - change the following to false to remove any confirmation prompt before deleting volumes !!!
75 # when confirmations are on, you may receive two prompts:
76 # 1. delete all clones if they exist. The prompt is not shown if no clone exists.
77 # 2. delete all volumes if any. The prompt is not shown if no volume exists.
78 confirm_before_removing_volumes: true
79
80 ```
81
82 License
83 -------
84
85 BSD
86
87 Author Information
88 ------------------
89
90 https://github.com/ansible-collections/netapp.ontap