Ansible Collection for HPE OneView

This collection provides a series of Ansible modules and plugins for interacting with the HPE OneView Modules.

Build Status

OV Version	8.80	8.70	8.60	8.50	8.40	8.30	8.20	8.10	8.00	7.20	7.10	7.00	6.60	6.50	6.40	6.30	6.20	6.10	6.00	5.60
SDK Version/Tag	v8.8.0	v8.7.0	v8.6.2	v8.5.1	v8.4.0	v8.3.0	v8.2.0	v8.1.0	v8.0.0	v7.2.0	v7.1.0	v7.0.0	v6.6.0	v6.5.0	v6.4.0	v6.3.0	v6.2.0	v6.1.0	v6.0.0	v1.2.1
Build Status

Requirements

Ansible >= 2.9
python >= 3.4.2
HPE OneView Python SDK

Installation

To install HPE OneView collection hosted in Galaxy

ansible-galaxy collection install hpe.oneview

To upgrade to the latest version of HPE OneView:

ansible-galaxy collection install hpe.oneview --force

To install dependency packages

pip install -r ~/.ansible/collections/ansible_collections/hpe/oneview/requirements.txt

To install HPE OneView collection from GitHub

git clone https://github.com/HewlettPackard/oneview-ansible-collection.git
cd oneview-ansible-collection
ansible-galaxy collection build .

Now a tar file is generated. Install that file.

ansible-galaxy collection install <tar_file>

To install dependency packages

pip install -r requirements.txt

To install HPE OneView collection from Docker Image

docker build -t oneview-ansible-collections .
docker run -it --rm -v (pwd)/:/root/oneview-ansible-collections oneview-ansible-collections

That's it. If you would like to modify any role, simply modify role and re-run the image.

OneViewClient Configuration

Using a JSON Configuration File

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

{
  "ip": "<ip>",
  "credentials": {
    "userName": "<userName>",
    "authLoginDomain": "",
    "password": "<password>"
  },
  "api_version": 6200
}

The api_version specifies the version of the Rest API to invoke. When not defined, it will pick the OneView appliance version as default.

The authLoginDomain specifies the login domain directory of the appliance. When it is not specified, it will consider the appliance's default domain directory.

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 roles config arguments. For example:

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

Once you have defined the config variables, you can run the roles.

Pass Login SessionID as param

To run any task, we first need to login to HPE OneView appliance by passing the credentials in form of configuration. As part of the login process, Ansible Collection SDK gets the session id from OneView and individual sessionID is generated for each task. This could cause a session limit exceeded issue if there are more number of tasks.

So it is recommended to use a single sessionID for all tasks. But it is optional. If sessionID is not passed explicitly, it will work as earlier.

To reuse a single sessionID, it has to be passed as param sessionID inside your task.

Here's an example:

- name: Fetch Session Id
  oneview_get_session_id:
    config: "{{ config }}"
    name: "Test_Session"
  delegate_to: localhost
  register: session

- name: Create a Fibre Channel Network
  oneview_fc_network:
    hostname: <hostname>
    sessionID: "{{ session.ansible_facts.session }}"
    state: present
    data:
      name: "{{ network_name }}"
      fabricType: 'FabricAttach'
      linkStabilityTime: '30'
      autoLoginRedistribution: true
  no_log: true
  delegate_to: localhost

A SessionID remains valid for 24 hours.

Logout from Session

Ansible SDK handles OneView session in two different way

By default OneView session will be logged out when each task run from Ansible collection SDK. In this case always new session gets created whenever any task invoked from the SDK
One can run multiple tasks using same session. In this case first one needs to use task to get a session id and then use the same session id for all the subsequent tasks. At the end, logout task need to be invoked to delete that specific session

Scenario 1: In the below task, session will be logged out once it is done. So if we run multiple tasks then in no condition multiple sessions remain active.

- name: Create a Fibre Channel Network
  oneview_fc_network:
    hostname: <hostname>
    state: present
    data:
      name: "{{ network_name }}"
      fabricType: 'FabricAttach'
      linkStabilityTime: '30'
      autoLoginRedistribution: true
  no_log: true
  delegate_to: localhost

Scenario-2: In this example, a session is fetched, then the OneView session id is passed as param for the create fc network task. In this case, it will not do a session logout and user can logout the session once all tasks are done.

- name: Fetch Session Id
  oneview_get_session_id:
    config: "{{ config }}"
    name: "Test_Session"
  delegate_to: localhost
  register: session

- name: Create a Fibre Channel Network
  oneview_fc_network:
    hostname: <hostname>
    sessionID: "{{ session.ansible_facts.session }}"
    state: present
    data:
      name: "{{ network_name }}"
      fabricType: 'FabricAttach'
      linkStabilityTime: '30'
      autoLoginRedistribution: true
  no_log: true
  delegate_to: localhost

- name: Logout Session
  oneview_logout_session:
    config: "{{ config }}"
    sessionID: "{{ session.ansible_facts.session }}"
  delegate_to: localhost

Parameters in roles

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

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

- name: Create a Fibre Channel Network
  oneview_fc_network:
    hostname: <hostname>
    username: <username>
    password: <password>
    auth_login_domain: <domain_directory>
    api_version: 6200
    state: present
    data:
      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.

Setting your OneView version

The Ansible collections for HPE OneView support the API endpoints for HPE OneView 6.00, 6.10, 6.20, 6.30, 6.40, 6.50, 6.60, 7.00, 7.10, 7.20, 8.00, 8.10, 8.20, 8.30, 8.40, 8.50, 8.60, 8.70, 8.80

The current default HPE OneView version will pick the OneView appliance version.

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

"api_version": 6200

OR using the Environment variable:

export ONEVIEWSDK_API_VERSION='6200'

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

The API list is as follows:

HPE OneView 5.60 API version: 2400
HPE OneView 6.00 API version: 2600
HPE OneView 6.10 API version: 2800
HPE OneView 6.20 API version: 3000
HPE OneView 6.30 API version: 3200
HPE OneView 6.40 API version: 3400
HPE OneView 6.50 API version: 3600
HPE OneView 6.60 API version: 3800
HPE OneView 7.00 API version: 4000
HPE OneView 7.10 API version: 4200
HPE OneView 7.20 API version: 4400
HPE OneView 8.00 API version: 4600
HPE OneView 8.10 API version: 4800
HPE OneView 8.20 API version: 5000
HPE OneView 8.30 API version: 5200
HPE OneView 8.40 API version: 5400
HPE OneView 8.50 API version: 5600
HPE OneView 8.60 API version: 5800
HPE OneView 8.70 API version: 6000
HPE OneView 8.80 API version: 6200

HPE Synergy Image Streamer

From Release 8.1, Image streamer is no longer supported.

Usage

Playbooks

To use a module from HPE OneView collection, please reference the full namespace, collection name, and modules name that you want to use:

---
- name: Using HPE OneView collection
  hosts: all
  collections:
    - hpe.oneview
  roles:
    - hpe.oneview.oneview_fc_network
    - hpe.oneview.oneview_fc_network_facts

Run the above created playbooks as shown below.

ansible-playbook example_collection.yml

License

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 CONTRIBUTING.md 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.

Features

The HPE.Oneview collection includes roles, modules, sample playbooks, module_utils

HewlettPackard / oneview-ansible-collection