netapp.ontap.na_ontap_broadcast_domain – NetApp ONTAP manage broadcast domains.
Note
This plugin is part of the netapp.ontap collection (version 21.1.1).
To install it use: ansible-galaxy collection install netapp.ontap.
To use it in a playbook, specify: netapp.ontap.na_ontap_broadcast_domain.
New in version 2.6.0: of netapp.ontap
Synopsis
- Modify a ONTAP broadcast domain.
 
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 | 
|---|---|---|
|   cert_filepath    string    added in 20.6.0 of netapp.ontap    |    path to SSL client cert file (.pem).  not supported with python 2.6.   |  |
|   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.   |  |
|   from_name    string    added in 2.8.0 of netapp.ontap    |    Specify the broadcast domain name to be split into new broadcast domain.   |  |
|   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.   |  
|   ipspace    string    |    Specify the required ipspace for the broadcast domain.  A domain ipspace can not be modified after the domain has been created.   |  |
|   key_filepath    string    added in 20.6.0 of netapp.ontap    |    path to SSL client key file.   |  |
|   mtu    string    |    Specify the required mtu for the broadcast domain.   |  |
|   name    string / required    |    Specify the broadcast domain name.  aliases: broadcast_domain  |  |
|   ontapi    integer    |    The ontap api version to use   |  |
|   password    string    |    Password for the specified user.  aliases: pass  |  |
|   ports    list / elements=string    |    Specify the ports associated with this broadcast domain. Should be comma separated.  It represents the expected state of a list of ports at any time.  Add a port if it is specified in expected state but not in current state.  Delete a port if it is specified in current state but not in expected state.  For split action, it represents the ports to be split from current broadcast domain and added to the new broadcast domain.  if all ports are removed or split from a broadcast domain, the broadcast domain will be deleted automatically.   |  |
|   state    string    |   
  |    Whether the specified broadcast domain 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. |  
Notes
Note
- The modules prefixed with na\_ontap are built to support the ONTAP storage platform.
 
Examples
- name: create broadcast domain
  na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: ansible_domain
    mtu: 1000
    ipspace: Default
    ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"]
- name: modify broadcast domain
  na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: ansible_domain
    mtu: 1100
    ipspace: Default
    ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"]
- name: split broadcast domain
  na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    from_name: ansible_domain
    name: new_ansible_domain
    mtu: 1200
    ipspace: Default
    ports: khutton-vsim1:e0d-12
- name: delete broadcast domain
  na_ontap_broadcast_domain:
    state: absent
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: ansible_domain
    ipspace: Default
  Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
 
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_broadcast_domain_module.html