netapp.ontap.na_ontap_broadcast_domain module – NetApp ONTAP manage broadcast domains.

Note

This module is part of the netapp.ontap collection (version 22.14.0).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netapp.ontap.na_ontap_broadcast_domain.

New in netapp.ontap 2.6.0

Synopsis

  • Modify a ONTAP broadcast domain.

Requirements

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

  • Ansible 2.9 or later - 2.12 or later is recommended.

  • Python3 - 3.9 or later is recommended.

  • When using ZAPI, 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.

Parameters

Parameter

Comments

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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_ontap_version

string

added in netapp.ontap 21.23.0

Override the cluster ONTAP version when using REST.

The behavior is undefined if the version does not match the target cluster.

This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

This should be in the form 9.10 or 9.10.1 with each element being an integer number.

When use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

from_ipspace

string

added in netapp.ontap 2.15.0

if used with from_name, it will try to find broadcast domain from_name in from_ipspace, split action either rename broadcast_domain and ipspace or create a new broadcast domain.

If not from_name present, it will try to find name broadcast domain in from_ipspace and modify ipspace using ipspace.

Only supported with REST.

from_name

string

added in netapp.ontap 2.8.0

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.

Choices:

  • false ← (default)

  • true

ipspace

string

Specify the required ipspace for the broadcast domain.

With ZAPI, a domain ipspace cannot be modified after the domain has been created.

With REST, a domain ipspace can be modified.

This option is required while using REST.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

mtu

integer

Specify the required mtu for the broadcast domain.

name

aliases: broadcast_domain

string / required

Specify the broadcast domain name.

ontapi

integer

The ontap api version to use

password

aliases: pass

string

Password for the specified user.

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.

With REST, if exact match of ports found with from_name, split action will rename the broadcast domain using name.

With REST, if partial match of ports with from_name, split action will create a new broadcast domain using name and move partial matched ports from from_name to name.

With REST, if ports not in from_name, split action will create a new broadcast domain using name with ports.

state

string

Whether the specified broadcast domain should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

use_rest

string

Whether to use REST or ZAPI.

always -- will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST.

never -- will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI.

auto -- will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise.

Default: "auto"

username

aliases: user

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://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

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.

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

  • https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Examples

- name: Create broadcast domain
  netapp.ontap.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
  netapp.ontap.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
  netapp.ontap.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
  netapp.ontap.na_ontap_broadcast_domain:
    state: absent
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: ansible_domain
    ipspace: Default
- name: Create broadcast domain REST
  netapp.ontap.na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: ansible_domain
    mtu: 1200
    ipspace: Default
    ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"]
- name: Rename broadcast domain if exact match of ports REST
  netapp.ontap.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", "khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"]
- name: If partial match, remove e0d-12 from new_ansible_domain & create new domain ansible_domain with port e0d-12 REST
  netapp.ontap.na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    from_name: new_ansible_domain
    name: ansible_domain
    mtu: 1200
    ipspace: Default
    ports: ["khutton-vsim1:e0d-12"]
- name: Modify both broadcast domain and ipspace REST.
  netapp.ontap.na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    from_name: ansible_domain
    from_ipspace: Default
    name: ansible_domain_ip1
    ipspace: ipspace_1
    mtu: 1200
    ports: ["khutton-vsim1:e0d-12"]
- name: Modify ipspace only REST.
  netapp.ontap.na_ontap_broadcast_domain:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    from_ipspace: ipspace_1
    name: ansible_domain_ip1
    ipspace: Default
    mtu: 1200
    ports: ["khutton-vsim1:e0d-12"]
- name: Delete broadcast domain new_ansible_domain.
  netapp.ontap.na_ontap_broadcast_domain:
    state: absent
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    name: new_ansible_domain
    mtu: 1200
    ipspace: Default
    ports: ["khutton-vsim1:e0d-13", "khutton-vsim1:e0d-14"]

Authors

  • NetApp Ansible Team (@carchi8py)