Docs4dev
Docs
ansible / latest / collections / hpe / nimble / hpe_nimble_network_module.html

hpe.nimble.hpe_nimble_network – Manage the HPE Nimble Storage network configuration

Note

This plugin is part of the hpe.nimble collection (version 1.1.3).

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 hpe.nimble.

To use it in a playbook, specify: hpe.nimble.hpe_nimble_network.

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the storage network configuration on the HPE Nimble Storage group.

Requirements

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

  • Ansible 2.9 or later
  • Python 3.6 or later
  • HPE Nimble Storage SDK for Python
  • HPE Nimble Storage arrays running NimbleOS 5.0 or later

Parameters

Parameter Choices/Defaults Comments
activate
boolean
    Choices:
  • no
  • yes
Activate a network configuration.
array
list / elements=dictionary
List of array network configs.
change_name
string
Change name of the existing network config.
host
string / required
HPE Nimble Storage IP address.
ignore_validation_mask
integer
Indicates whether to ignore the validation.
iscsi_automatic_connection_method
boolean
    Choices:
  • no
  • yes
Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.
iscsi_connection_rebalancing
boolean
    Choices:
  • no
  • yes
Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.
mgmt_ip
string
Management IP address for the Group. Four numbers in the range (0,255) separated by periods.
name
string / required
    Choices:
  • active
  • backup
  • draft
Name of the network configuration. Use the name 'draft' when creating a draft configuration.
password
string / required
HPE Nimble Storage password.
route
list / elements=dictionary
List of static routes.
secondary_mgmt_ip
string
Secondary management IP address for the Group. Four numbers in the range [0,255] separated by periods.
state
string / required
    Choices:
  • create
  • present
  • absent
The network config operation.
subnet
list / elements=dictionary
List of subnet configs.
username
string / required
HPE Nimble Storage user name.
validate
boolean
    Choices:
  • no
  • yes
Validate a network configuration.

Notes

Note

  • This module does not support check_mode.

Examples

# if state is create, then create network config, fails if it exist or cannot create
# if state is present, then create network config if not present ,else success
- name: Create network config
  hpe.nimble.hpe_nimble_network:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    route: "{{ route }}"
    subnet: "{{ subnet }}"
    array: "{{ array }}"
    iscsi_automatic_connection_method: true
    iscsi_connection_rebalancing: False
    mgmt_ip: "{{ mgmt_ip }}"
    state: "{{ state | default('present') }}"

- name: Delete network config
  hpe.nimble.hpe_nimble_network:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "absent"

- name: Validate network config
  hpe.nimble.hpe_nimble_network:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    ignore_validation_mask: 1
    validate: true

- name: Activate Network config
  hpe.nimble.hpe_nimble_network:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    ignore_validation_mask: 1
    activate: true

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hpe/nimble/hpe_nimble_network_module.html