community.general.oneview_ethernet_network – Manage OneView Ethernet Network resources

Note

This plugin is part of the community.general collection (version 3.8.1).

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 community.general.

To use it in a playbook, specify: community.general.oneview_ethernet_network.

Synopsis

  • Provides an interface to manage Ethernet Network resources. Can create, update, or delete.

Requirements

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

  • hpOneView >= 3.1.0
  • python >= 2.7.9

Parameters

Parameter Choices/Defaults Comments
api_version
integer
OneView API Version.
config
path
Path to a .json configuration file containing the OneView client configuration. The configuration file is optional and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration will be loaded from environment variables. For links to example configuration files or how to use the environment variables verify the notes section.
data
dictionary / required
List with Ethernet Network properties.
hostname
string
IP address or hostname for the appliance.
image_streamer_hostname
string
IP address or hostname for the HPE Image Streamer REST API.
password
string
Password for API authentication.
state
string
    Choices:
  • present
  • absent
  • default_bandwidth_reset
Indicates the desired state for the Ethernet Network resource. - present will ensure data properties are compliant with OneView. - absent will remove the resource from OneView, if it exists. - default_bandwidth_reset will reset the network connection template to the default.
username
string
Username for API authentication.
validate_etag
boolean
    Choices:
  • no
  • yes
When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag for the resource matches the ETag provided in the data.

Notes

Note

Examples

- name: Ensure that the Ethernet Network is present using the default configuration
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      vlanId: '201'
  delegate_to: localhost

- name: Update the Ethernet Network changing bandwidth and purpose
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      purpose: Management
      bandwidth:
          maximumBandwidth: 3000
          typicalBandwidth: 2000
  delegate_to: localhost

- name: Ensure that the Ethernet Network is present with name 'Renamed Ethernet Network'
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      newName: 'Renamed Ethernet Network'
  delegate_to: localhost

- name: Ensure that the Ethernet Network is absent
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: absent
    data:
      name: 'New Ethernet Network'
  delegate_to: localhost

- name: Create Ethernet networks in bulk
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      vlanIdRange: '1-10,15,17'
      purpose: General
      namePrefix: TestNetwork
      smartLink: false
      privateNetwork: false
      bandwidth:
        maximumBandwidth: 10000
        typicalBandwidth: 2000
  delegate_to: localhost

- name: Reset to the default network connection template
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: default_bandwidth_reset
    data:
      name: 'Test Ethernet Network'
  delegate_to: localhost

Return Values

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

Key Returned Description
ethernet_network
dictionary
On state 'present'. Can be null.
Has the facts about the Ethernet Networks.

ethernet_network_bulk
dictionary
When 'vlanIdRange' attribute is in data argument. Can be null.
Has the facts about the Ethernet Networks affected by the bulk insert.

ethernet_network_connection_template
dictionary
On state 'default_bandwidth_reset'. Can be null.
Has the facts about the Ethernet Network Connection Template.



Authors

  • Felipe Bulsoni (@fgbulsoni)
  • Thiago Miotto (@tmiotto)
  • Adriane Cardozo (@adriane-cardozo)

© 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/community/general/oneview_ethernet_network_module.html