Debian Codegraph @

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

raw
1 na_ontap_vserver_create
2 =========
3
4 Create one or more Vservers.
5
6 Creates Vserver with specified protocol(s). Will join to Windows Domain provided AD credintals are included.
7 Modifies default rule for NFS protocol to 0.0.0.0/0 ro to allow NFS connections
8
9 Requirements
10 ------------
11
12 Since this uses the NetApp ONTAP modules it will require the python library netapp-lib as well as the Ansible 2.8 release.
13
14 Role Variables
15 --------------
16 ```
17 cluster: <short ONTAP name of cluster>
18 netapp_hostname: <ONTAP mgmt ip or fqdn>
19 netapp_username: <ONTAP admin account>
20 netapp_password: <ONTAP admin account password>
21
22 ontap_version: <version minor code> # OPTIONAL This defaults to ontap version minor code 140 (9.4) if running this against 9.3 or below add this variable and set to 120
23
24 #Based on if Variables != or == None determins if a section runs. Each variable will take one or more dictonary entries. Simply omit sections
25 #that you don't want to run. The following would run all sections
26
27 vservers: # Vservers to create
28 - { name: nfs_vserver, aggr: aggr1, protocol: nfs }
29 # aggr_list is optional. If not specified all aggregates will be added to the allowed list.
30 - { name: nfs_vserver2, aggr: aggr1, protocol: nfs, aggr_list: "aggr1,aggr2" }
31 # with protocol: nfs, the keys nfsv3, nfsv4, nfsv41 are optional, the default values are as shown below.
32 - { name: nfs_vserver3, aggr: aggr1, protocol: nfs, nfsv3: enabled, nfsv4: disabled, nfsv41: disabled }
33 - { name: cifs_vserver, aggr: aggr1, protocol: cifs }
34
35 vserver_dns: # DNS at the Vserver level.
36 - { vserver: cifs_vserver, dns_domains: lab.local, dns_nameservers: 172.32.0.40 }
37
38 lifs: # interfaces for the Vservers being created - only IP interfaces are supported.
39 # with REST, ipspace, broadcast_domain, service_policy, interface_type (but only with a value of "ip") are also supported.
40 - { name: nfs_vserver_data_lif, vserver: nfs_vserver, node: cluster-01, port: e0c, protocol: nfs, address: 172.32.0.193, netmask: 255.255.255.0 }
41 - { name: cifs_vserver_data_lif, vserver: cifs_vserver, node: cluster-01, port: e0d, protocol: cifs, address: 172.32.0.194, netmask: 255.255.255.0 }
42 # With 21.24.0, protocol is not required when using REST. When protocol is absent, role and firewall_policy are omitted.
43 # With 21.24.0, vserver management interfaces can also be created when using REST:
44 - { name: vserver_mgmt_lif, vserver: nfs_vserver, node: cluster-01, port: e0e, service_policy: default-management, address: 172.32.0.192, netmask: 255.255.255.0}
45
46 gateway: # To configure the default gateway for the Vserver.
47 - { vserver: nfs_vserver, destination: 0.0.0.0/0, gateway: 172.32.0.1 }
48
49 cifs: # Vservers to join to an AD Domain
50 - { vserver: cifs_vserver, cifs_server_name: netapp1, domain: ansible.local, force: true }
51
52 fcp: # sets FCP ports as Target
53 - { adapter: 0e, node: cluster-01 }
54 ```
55 Dependencies
56 ------------
57
58 The tasks in this role are dependent on information from the na_ontap_gather_facts module.
59 The task for na_ontap_gather_facts can not be excluded.
60
61 Example Playbook
62 ----------------
63 ```
64 ---
65 - hosts: localhost
66 collections:
67 - netapp.ontap
68 vars_prompt:
69 - name: admin_user_name
70 prompt: domain admin (enter if skipped)
71 - name: admin_password
72 prompt: domain admin password (enter if skipped)
73 vars_files:
74 - globals.yml
75 roles:
76 - na_ontap_vserver_create
77 ```
78 I use a globals file to hold my variables.
79 ```
80 ---
81 globals.yml
82 cluster_name: cluster
83
84 netapp_hostname: 172.32.0.182
85 netapp_username: admin
86 netapp_password: netapp123
87
88 vservers:
89 - { name: nfs_vserver, aggr: aggr1, protocol: NFS }
90 - { name: cifs_vserver, aggr: aggr1, protocol: cifs }
91 - { name: nas_vserver, aggr: aggr1, protocol: 'cifs,nfs' }
92
93 lifs:
94 - { name: nfs_vserver_data_lif, vserver: nfs_vserver, node: vsim-01, port: e0c, protocol: nfs, address: 172.32.0.183, netmask: 255.255.255.0 }
95 - { name: cifs_vserver_data_lif, vserver: cifs_vserver, node: vsim-01, port: e0c, protocol: nfs, address: 172.32.0.184, netmask: 255.255.255.0 }
96 - { name: nas_vserver_data_lif, vserver: nas_vserver, node: vsim-02, port: e0c, protocol: nfs, address: 172.32.0.185, netmask: 255.255.255.0 }
97
98 vserver_dns:
99 - { vserver: cifs_vserver, dns_domains: lab.local, dns_nameservers: 172.32.0.40 }
100
101 cifs:
102 - { vserver: cifs_vserver, cifs_server_name: netapp1, domain: openstack.local, force: true }
103 ```
104
105 License
106 -------
107
108 GNU v3
109
110 Author Information
111 ------------------
112 NetApp
113 http://www.netapp.io