community.general.oneview_fc_network module – Manage OneView Fibre Channel Network resources
Note
This module is part of the community.general collection (version 8.6.4).
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.
Aliases: remote_management.oneview.oneview_fc_network
Requirements
The below requirements are needed on the host that executes this module.
Python >= 2.7.9
hpOneView >= 4.0.0
Parameters
Parameter |
Comments |
---|---|
OneView API Version. |
|
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. |
|
List with the Fibre Channel Network properties. |
|
IP address or hostname for the appliance. |
|
IP address or hostname for the HPE Image Streamer REST API. |
|
Password for API authentication. |
|
Indicates the desired state for the Fibre Channel Network resource. Choices:
|
|
Username for API authentication. |
|
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:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
A sample configuration file for the config parameter can be found at: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
Check how to use environment variables for configuration at: https://github.com/HewlettPackard/oneview-ansible#environment-variables
Additional Playbooks for the HPE OneView Ansible modules can be found at: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
The OneView API version used will directly affect returned and expected fields in resources. Information on setting the desired API version and can be found at: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version
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 |
---|---|
Has the facts about the managed OneView FC Network. Returned: On state ‘present’. Can be null. |