netapp.ontap.na_ontap_cifs_server – NetApp ONTAP CIFS server configuration
Note
This plugin is part of the netapp.ontap collection (version 21.13.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
To use it in a playbook, specify: netapp.ontap.na_ontap_cifs_server.
New in version 2.6.0: of netapp.ontap
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9
Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
REST support requires ONTAP 9.6 or later.
To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
admin_password
string
|
Specifies the cifs server admin password.
When used with absent, the account will be deleted if admin_user_name is also provided.
|
|
|
admin_user_name
string
|
Specifies the cifs server admin username.
When used with absent, the account will be deleted if admin_password is also provided.
|
|
|
cert_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client cert file (.pem).
not supported with python 2.6.
|
|
|
domain
string
|
The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to.
|
|
|
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
|
Enable or disable a new feature.
This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.
Supported keys and values are subject to change without notice. Unknown keys are ignored.
|
|
|
force
boolean
added in 2.7.0 of netapp.ontap
|
|
When state is present, if this is set and a machine account with the same name as specified in 'name' exists in the Active Directory, it will be overwritten and reused.
When state is absent, if this is set, the local CIFS configuration is deleted regardless of communication errors.
|
|
hostname
string
/ required
|
The hostname or IP address of the ONTAP instance.
|
|
|
http_port
integer
|
Override the default port (80 or 443) with this port
|
|
|
https
boolean
|
|
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
|
|
key_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client key file.
|
|
|
name
string
/ required
|
Specifies the cifs_server name.
aliases: cifs_server_name |
|
|
ontapi
integer
|
The ontap api version to use
|
|
|
ou
string
added in 2.7.0 of netapp.ontap
|
The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.
|
|
|
password
string
|
Password for the specified user.
aliases: pass |
|
|
service_state
string
|
|
CIFS Server Administrative Status.
|
|
state
string
|
|
Whether the specified cifs_server should exist or not.
|
|
use_rest
string
|
Default: "auto"
|
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
|
|
username
string
|
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 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.
Two authentication methods are supported
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.
aliases: user |
|
|
validate_certs
boolean
|
|
If set to
no, the SSL certificates will not be validated.This should only set to
False used on personally controlled sites using self-signed certificates. |
|
vserver
string
/ required
|
The name of the vserver to use.
|
|
|
workgroup
string
|
The NetBIOS name of the domain or workgroup this CIFS server belongs to.
|
Examples
- name: Create cifs_server
netapp.ontap.na_ontap_cifs_server:
state: present
name: data2
vserver: svm1
service_state: stopped
domain: "{{ id_domain }}"
admin_user_name: "{{ domain_login }}"
admin_password: "{{ domain_pwd }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete cifs_server
netapp.ontap.na_ontap_cifs_server:
state: absent
name: data2
vserver: svm1
admin_user_name: "{{ domain_login }}"
admin_password: "{{ domain_pwd }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Start cifs_server
netapp.ontap.na_ontap_cifs_server:
state: present
name: data2
vserver: svm1
service_state: started
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Stop cifs_server
netapp.ontap.na_ontap_cifs_server:
state: present
name: data2
vserver: svm1
service_state: stopped
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify cifs_server
netapp.ontap.na_ontap_cifs_server:
state: present
name: data2_new
vserver: svm1
admin_user_name: "{{ domain_login }}"
admin_password: "{{ domain_pwd }}"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
Authors
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>