netapp_e_mgmt_interface – NetApp E-Series management interface configuration — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# netapp_e_mgmt_interface – NetApp E-Series management interface configuration

New in version 2.7.

- Synopsis

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Configure the E-Series management interfaces

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
address - |  | The IPv4 address to assign to the interface. Should be specified in xx.xx.xx.xx form. Mutually exclusive with config_method=dhcp
api_password string / required |  | The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
api_url string / required |  | The url to the SANtricity Web Services Proxy or Embedded Web Services API. Example https://prod-1.wahoo.acme.com/devmgr/v2
api_username string / required |  | The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
channel - |  | The port to modify the configuration for. The channel represents the port number (typically from left to right on the controller), beginning with a value of 1. Mutually exclusive with name.
config_method - | Choices: dhcp static | The configuration method type to use for network interface ports. dhcp is mutually exclusive with address, subnet_mask, and gateway.
controller - / required | Choices: A B | The controller that owns the port you want to configure. Controller names are represented alphabetically, with the first controller as A, the second as B, and so on. Current hardware models have either 1 or 2 available controllers, but that is not a guaranteed hard limitation and could change in the future.
dns_address - |  | Primary IPv4 DNS server address
dns_address_backup - |  | Backup IPv4 DNS server address Queried when primary DNS server fails
dns_config_method - | Choices: dhcp static | The configuration method type to use for DNS services. dhcp is mutually exclusive with dns_address, and dns_address_backup.
gateway - |  | The IPv4 gateway address to utilize for the interface. Should be specified in xx.xx.xx.xx form. Mutually exclusive with config_method=dhcp
log_path - |  | A local path to a file to be used for debug logging
name - |  | The port to modify the configuration for. The list of choices is not necessarily comprehensive. It depends on the number of ports that are present in the system. The name represents the port number (typically from left to right on the controller), beginning with a value of 1. Mutually exclusive with channel. aliases: port, iface
ntp_address - |  | Primary IPv4 NTP server address
ntp_address_backup - |  | Backup IPv4 NTP server address Queried when primary NTP server fails
ntp_config_method - | Choices: disable dhcp static | The configuration method type to use for NTP services. disable is mutually exclusive with ntp_address and ntp_address_backup. dhcp is mutually exclusive with ntp_address and ntp_address_backup.
ssh boolean | Choices: no yes | Enable ssh access to the controller for debug purposes. This is a controller-level setting. rlogin/telnet will be enabled for ancient equipment where ssh is not available.
ssid string | Default: 1 | The ID of the array to manage. This value must be unique for each array.
state - | Choices: enable disable | Enable or disable IPv4 network interface configuration. Either IPv4 or IPv6 must be enabled otherwise error will occur. Only required when enabling or disabling IPv4 network interface aliases: enable_interface
subnet_mask - |  | The subnet mask to utilize for the interface. Should be specified in xx.xx.xx.xx form. Mutually exclusive with config_method=dhcp
validate_certs boolean | Choices: no yes ← | Should https certificates be validated?

## Notes

Note

- Check mode is supported.

- The interface settings are applied synchronously, but changes to the interface itself (receiving a new IP address via dhcp, etc), can take seconds or minutes longer to take effect.

- Known issue: Changes specifically to down ports will result in a failure. However, this may not be the case in up coming NetApp E-Series firmware releases (released after firmware version 11.40.2).

- The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.

- Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.

- netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance.

## Examples

    - name: Configure the first port on the A controller with a static IPv4 address
      netapp_e_mgmt_interface:
        name: "1"
        controller: "A"
        config_method: static
        address: "192.168.1.100"
        subnet_mask: "255.255.255.0"
        gateway: "192.168.1.1"
        ssid: "1"
        api_url: "10.1.1.1:8443"
        api_username: "admin"
        api_password: "myPass"

    - name: Disable ipv4 connectivity for the second port on the B controller
      netapp_e_mgmt_interface:
        name: "2"
        controller: "B"
        enable_interface: no
        ssid: "{{ ssid }}"
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"

    - name: Enable ssh access for ports one and two on controller A
      netapp_e_mgmt_interface:
        name: "{{ item }}"
        controller: "A"
        ssh: yes
        ssid: "{{ ssid }}"
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
      loop:
        - 1
        - 2

    - name: Configure static DNS settings for the first port on controller A
      netapp_e_mgmt_interface:
        name: "1"
        controller: "A"
        dns_config_method: static
        dns_address: "192.168.1.100"
        dns_address_backup: "192.168.1.1"
        ssid: "{{ ssid }}"
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"

    - name: Configure static NTP settings for ports one and two on controller B
      netapp_e_mgmt_interface:
        name: "{{ item }}"
        controller: "B"
        ntp_config_method: static
        ntp_address: "129.100.1.100"
        ntp_address_backup: "127.100.1.1"
        ssid: "{{ ssid }}"
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
      loop:
        - 1
        - 2

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
enabled boolean | on success | Indicates whether IPv4 connectivity has been enabled or disabled. This does not necessarily indicate connectivity. If dhcp was enabled absent a dhcp server, for instance, it is unlikely that the configuration will actually be valid. Sample: True
msg string | on success | Success message Sample: The interface settings have been updated.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Michael Price (@lmprice)

- Nathan Swartz (@ndswartz)

Hint

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