na_ontap_broadcast_domain – NetApp ONTAP manage broadcast domains

From Get docs
Ansible/docs/2.8/modules/na ontap broadcast domain module


na_ontap_broadcast_domain – NetApp ONTAP manage broadcast domains

New in version 2.6.


Synopsis

  • Modify a ONTAP broadcast domain.

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
  • Ansible 2.6
  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
  • 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

from_name

-

added in 2.8

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

  • no

  • yes

Enable and disable https

ipspace

-

Specify the required ipspace for the broadcast domain.

A domain ipspace can not be modified after the domain has been created.

mtu

-

Specify the required mtu for the broadcast domain.

name

- / required

Specify the broadcast domain name.


aliases: broadcast_domain

ontapi

integer

The ontap api version to use

password

string / required

Password for the specified user.


aliases: pass

ports

-

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 splited from a broadcast domain, the broadcast domain will be deleted automatically.

state

-

  • present

  • absent

Whether the specified broadcast domain should exist or not.

username

string / required

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/.


aliases: user

validate_certs

boolean

  • no
  • yes

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

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/na_ontap_broadcast_domain_module.html