Ansible Modules and Sample Playbooks for HPE OneView
Clone or download

Build Status Coverage Status

Ansible Modules for HPE OneView

Modules to manage HPE OneView using Ansible playbooks.



Each OneView resource operation is exposed through an Ansible module. We also provide a specific module to gather facts about the resource.

The detailed documentation for each module is available at: HPE OneView Ansible Modules Documentation

Example of a playbook using Ansible OneView modules

- hosts: all

    - name: Ensure that the Fibre Channel Network is present with fabricType 'DirectAttach'
        config: "/path/to/config.json"
        state: present
          name: 'New FC Network'
          fabricType: 'DirectAttach'

    - name: Ensure that Fibre Channel Network is absent
        config: "/path/to/config.json"
        state: absent
          name: 'New FC Network'

    - name: Gather facts about the FCoE Network with name 'Test FCoE Network Facts'
        config: "/path/to/config.json"
        name: "Test FCoE Network Facts"


Sample playbooks and instructions on how to run the modules can be found in the examples directory.

End-to-end examples


To run the Ansible modules provided in this project, you may run a containerized version or perform a full installation. The containerized version of the oneview-ansible modules is available in the Docker Store. There is also a how-to guide with instructions on how to use the container.

To perform a full installation, you should execute the following steps:

1. Clone the repository


$ git clone

2. Configure the ANSIBLE_LIBRARY environmental variable

Set the environment variables ANSIBLE_LIBRARY and ANSIBLE_MODULE_UTILS, specifying the library full path from the cloned project:

$ export ANSIBLE_LIBRARY=/path/to/oneview-ansible/library
$ export ANSIBLE_MODULE_UTILS=/path/to/oneview-ansible/library/module_utils/

3. OneViewClient Configuration

Using a JSON Configuration File

To use the Ansible OneView modules, you can store the configuration on a JSON file. This file is used to define the settings, which will be used on the OneView appliance connection, like hostname, username, and password. Here's an example:

  "ip": "",
  "credentials": {
    "userName": "Administrator",
    "authLoginDomain": "",
    "password": "secret123"
  "api_version": 200

The api_version specifies the version of the Rest API to invoke. When not defined, it will use 300 as the default value.

If your environment requires a proxy, define the proxy properties in the JSON file using the following syntax:

  "proxy": "<proxy_host>:<proxy_port>"

🔒 Tip: Check the file permissions since the password is stored in clear-text.

The configuration file path must be provided for all of the playbooks config arguments. For example:

- name: Gather facts about the FCoE Network with name 'FCoE Network Test'
    config: "/path/to/config.json"
    name: "FCoE Network Test"

Environment Variables

If you prefer, the configuration can also be stored in environment variables.

# Required
export ONEVIEWSDK_USERNAME='Administrator'
export ONEVIEWSDK_PASSWORD='secret123'

# Optional
export ONEVIEWSDK_API_VERSION='200'  # default value is 300
export ONEVIEWSDK_PROXY='<proxy_host>:<proxy_port>'

🔒 Tip: Make sure no unauthorised person has access to the environment variables, since the password is stored in clear-text.

In this case, you shouldn't provide the config argument. For example:

- name: Gather facts about the FCoE Network with name 'FCoE Network Test'
    name: "FCoE Network Test"

Once you have defined the environment variables, you can run the plays.

Parameters in the playbook

The third way to pass in your HPE OneView credentials to your tasks is through explicit specification on the task.

This option allows the parameters hostname, username, password, api_version and image_streamer_hostname to be passed directly inside your task.

- name: Create a Fibre Channel Network
    username: administrator
    password: my_password
    api_version: 600
    state: present
      name: "{{ network_name }}"
      fabricType: 'FabricAttach'
      linkStabilityTime: '30'
      autoLoginRedistribution: true
  no_log: true
  delegate_to: localhost

Setting no_log: true is highly recommended in this case, as the credentials are otherwise returned in the log after task completion.

4. Setting your OneView version

The Ansible modules for HPE OneView support the API endpoints for HPE OneView 2.0, 3.0, 3.10 and 4.0.

The current default HPE OneView version used by the modules is 3.00, API 300.

To use a different API, you must set the API version together with your credentials, either using the JSON configuration:

"api_version": 600

OR using the Environment variable:


If this property is not specified, it will fall back to the 300 default value.

The API list is as follows:

  • HPE OneView 2.0 API version: 200
  • HPE OneView 3.0 API version: 300
  • HPE OneView 3.10 API version: 500
  • HPE OneView 4.0 API version: 600

5. HPE Synergy Image Streamer

Modules to manage HPE Synergy Image Streamer appliances are also included in this project. To use these modules, you must set the Image Streamer IP on the OneViewClient configuration, either using the JSON configuration:

"image_streamer_ip": ""

OR using the Environment variable:


You can find sample playbooks in the examples folder. Just look for the playbooks with the image_streamer_ prefix.


This project is licensed under the Apache 2.0 license. Please see the LICENSE for more information.

Contributing and feature requests

Contributing: We welcome your contributions to the Ansible Modules for HPE OneView. See for more details.

Feature Requests: If you have a need that is not met by the current implementation, please let us know (via a new issue). This feedback is crucial for us to deliver a useful product. Do not assume that we have already thought of everything, because we assure you that is not the case.

Naming convention

By adding support for a new resource, 3 files are required: self-contained module, test and example. The following is a summary of the code structure and naming conventions for the oneview-ansible modules.


Modules are located in library folder. All modules need to be self-contained, without external dependencies except hpOneView. The module is named according to the HPE OneView API Reference resource title, but in singular. The name should have the "oneview_" prefix, with all characters in lowercase, replacing spaces by underscores. For example: oneview_fc_network


Tests are located in tests folder. The name of the test modules should start with "test_" prefix in addition to the tested module name, for example: test_oneview_fc_network

Playbook Examples

Examples are located in examples folder with the same name of corresponding module, for example: oneview_fc_network.yml


Modules that implement facts follow the same rules of any other modules, but the filenames have a suffix: "_facts", for example: oneview_fc_network_facts


The basic test execution can be achieved by executing the file.

Please refer to for further testing information.