oneview_fc_network - Manage OneView Fibre Channel Network resources.

New in version 2.4.

Synopsis

  • Provides an interface to manage Fibre Channel Network resources. Can create, update, and delete.

Requirements (on host that executes module)

  • hpOneView >= 4.0.0
  • python >= 2.7.9

Options

parameter required default choices comments
config
no
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
yes
List with the Fibre Channel Network properties.
state
no
  • present
  • absent
Indicates the desired state for the Fibre Channel Network resource. present will ensure data properties are compliant with OneView. absent will remove the resource from OneView, if it exists.
validate_etag
no True
  • true
  • false
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.

Examples

- name: Ensure that the Fibre Channel Network is present using the default configuration
  oneview_fc_network:
    config: "{{ config_file_path }}"
    state: present
    data:
      name: 'New FC Network'

- name: Ensure that the Fibre Channel Network is present with fabricType 'DirectAttach'
  oneview_fc_network:
    config: "{{ config_file_path }}"
    state: present
    data:
      name: 'New FC Network'
      fabricType: 'DirectAttach'

- name: Ensure that the Fibre Channel Network is present and is inserted in the desired scopes
  oneview_fc_network:
    config: "{{ config_file_path }}"
    state: present
    data:
      name: 'New FC Network'
      scopeUris:
        - '/rest/scopes/00SC123456'
        - '/rest/scopes/01SC123456'

- name: Ensure that the Fibre Channel Network is absent
  oneview_fc_network:
    config: "{{ config_file_path }}"
    state: absent
    data:
      name: 'New FC Network'

Return Values

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

name description returned type sample
fc_network
Has the facts about the managed OneView FC Network.
On state 'present'. Can be null. dict

Notes

Note

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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