Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hewlettpackard/oneview-ansible-collection
Ansible Collection and Sample Playbooks for HPE OneView
https://github.com/hewlettpackard/oneview-ansible-collection
ansible-collection ansible-modules devops hpe-oneview infrastructure-as-code json-configuration oneview-appliance redhat-automation-hub synergy
Last synced: about 1 month ago
JSON representation
Ansible Collection and Sample Playbooks for HPE OneView
- Host: GitHub
- URL: https://github.com/hewlettpackard/oneview-ansible-collection
- Owner: HewlettPackard
- License: apache-2.0
- Created: 2020-08-28T18:52:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T04:37:36.000Z (2 months ago)
- Last Synced: 2024-10-21T07:23:41.828Z (2 months ago)
- Topics: ansible-collection, ansible-modules, devops, hpe-oneview, infrastructure-as-code, json-configuration, oneview-appliance, redhat-automation-hub, synergy
- Language: Python
- Homepage:
- Size: 7.99 MB
- Stars: 25
- Watchers: 14
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 | 9.20 | 9.10 | 9.00 | 8.90 | 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 |[v9.2.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v9.2.0)|[v9.1.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v9.1.0)|[v9.0.1](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v9.0.1)|[v8.9.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.9.0)|[v8.8.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.8.0)|[v8.7.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.7.0)|[v8.6.2](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.6.2)|[v8.5.1](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.5.1)|[v8.4.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.4.0)|[v8.3.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.3.0)| [v8.2.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.2.0)| [v8.1.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.1.0)| [v8.0.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v8.0.0)| [v7.2.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v7.2.0)| [v7.1.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v7.1.0)| [v7.0.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v7.0.0)| [v6.6.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.6.0)| [v6.5.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.5.0)| [v6.4.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.4.0) | [v6.3.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.3.0) | [v6.2.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.2.0) | [v6.1.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.1.0) | [v6.0.0](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v6.0.0) | [v1.2.1](https://github.com/HewlettPackard/oneview-ansible-collection/releases/tag/v1.2.1) |
Build Status |[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/11361459998)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/9691939684)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/9691939684)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/8787282609)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/7439570515)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/7439570515)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/6569863185)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/5373943572)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/5373943572)|[](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/4423268452)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/4279415399)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/3728995924)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/3442614641)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/2968933264)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/2689579339)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/2306414699)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/2021346524)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/1666302716)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/1474959987)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/1208451472)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/1025475033)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/728874027)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/runs/632343827)| [](https://github.com/HewlettPackard/oneview-ansible-collection/actions/workflows/.ansible-test.yml)|
## Requirements
- Ansible >= 2.9
- python >= 3.4.2
- [HPE OneView Python SDK](https://pypi.org/project/hpeOneView/)
# Installation
To install HPE OneView collection hosted in Galaxy
```bash
ansible-galaxy collection install hpe.oneview
```
To upgrade to the latest version of HPE OneView:
```bash
ansible-galaxy collection install hpe.oneview --force
```
To install dependency packages
```bash
pip install -r ~/.ansible/collections/ansible_collections/hpe/oneview/requirements.txt
```
To install HPE OneView collection from GitHub
```bash
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
```
To install dependency packages
```bash
pip install -r requirements.txt
```
To install HPE OneView collection from Docker Image
```bash
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:
```json
{
"ip": "",
"credentials": {
"userName": "",
"authLoginDomain": "",
"password": ""
},
"api_version": 7000
}
```
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:
```json
"proxy": ":"
```
:lock: 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:
```yml
- 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:
```yaml
- 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:
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
1. 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
2. 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.
```yaml
- name: Create a Fibre Channel Network
oneview_fc_network:
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.
```yaml
- 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:
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.
```yaml
- name: Create a Fibre Channel Network
oneview_fc_network:
hostname:
username:
password:
auth_login_domain:
api_version: 7000
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, 8.90, 9.00, 9.10, 9.20
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:
```json
"api_version": 7000
```
OR using the Environment variable:
```bash
export ONEVIEWSDK_API_VERSION='7000'
```
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 OneView 8.90 API version: `6400`
- HPE OneView 9.00 API version: `6600`
- HPE OneView 9.10 API version: `6800`
- HPE OneView 9.20 API version: `7000`
### 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:
```bash
---
- 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.
```bash
ansible-playbook example_collection.yml
```
## License
This project is licensed under the Apache 2.0 license. Please see the [LICENSE](LICENSE) for more information.
## Contributing and feature requests
**Contributing:** We welcome your contributions to the Ansible Modules for HPE OneView. See [CONTRIBUTING.md](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](https://github.com/HewlettPackard/oneview-ansible-collection/tree/master/roles/),
[modules](https://github.com/HewlettPackard/oneview-ansible-collection/tree/master/plugins/modules),
[sample playbooks](https://github.com/HewlettPackard/oneview-ansible-collection/tree/master/playbooks),
[module_utils](https://github.com/HewlettPackard/oneview-ansible-collection/tree/master/plugins/module_utils)
## Copyright
© Copyright 2024 Hewlett Packard Enterprise Development LP