community.general.oneview_fc_network module – Manage OneView Fibre Channel Network resources

Note

This module is part of the community.general collection (version 10.0.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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

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

Requirements

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

  • Python >= 2.7.9

  • hpOneView >= 4.0.0

Parameters

Parameter

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 the Fibre Channel 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 / required

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.

Choices:

  • "present"

  • "absent"

username

string

Username for API authentication.

validate_etag

boolean

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.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

Examples

- name: Ensure that the Fibre Channel Network is present using the default configuration
  community.general.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'
  community.general.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
  community.general.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
  community.general.oneview_fc_network:
    config: "{{ config_file_path }}"
    state: absent
    data:
      name: 'New FC Network'

Return Values

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

Key

Description

fc_network

dictionary

Has the facts about the managed OneView FC Network.

Returned: On state ‘present’. Can be null.

Authors

  • Felipe Bulsoni (@fgbulsoni)