community.general.oneview_fcoe_network – Manage OneView FCoE Network resources

From Get docs
Ansible/docs/2.10/collections/community/general/oneview fcoe network module


community.general.oneview_fcoe_network – Manage OneView FCoE Network resources

Note

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

To install it use: ansible-galaxy collection install community.general.

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


Synopsis

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

Requirements

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

  • hpOneView >= 4.0.0
  • python >= 2.7.9

Parameters

Parameter Choices/Defaults Comments

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

string / required

List with FCoE Network properties.

state

string

  • present

  • absent

Indicates the desired state for the FCoE Network resource. present will ensure data properties are compliant with OneView. absent will remove the resource from OneView, if it exists.

validate_etag

boolean

  • 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 FCoE Network is present using the default configuration
  community.general.oneview_fcoe_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: Test FCoE Network
      vlanId: 201
  delegate_to: localhost

- name: Update the FCOE network scopes
  community.general.oneview_fcoe_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: New FCoE Network
      scopeUris:
        - '/rest/scopes/00SC123456'
        - '/rest/scopes/01SC123456'
  delegate_to: localhost

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

Return Values

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

Key Returned Description

fcoe_network

dictionary

On state 'present'. Can be null.

Has the facts about the OneView FCoE Networks.





Authors

  • Felipe Bulsoni (@fgbulsoni)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/oneview_fcoe_network_module.html