Python client for HP OneView.
Go to file
OpenDev Sysadmins 2dff5e35f0 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:51:37 +00:00
doc/source Update usage documentation of python-oneviewclient 2015-10-13 14:37:53 +00:00
oneview_client Remove old validations of memory_mb before manage state 2017-08-22 15:09:28 -03:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:54:14 +00:00
.gitignore Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
.gitreview OpenDev Migration Patch 2019-04-19 19:51:37 +00:00
.mailmap Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
.testr.conf Bugfix+removing invalid tests+functional at gate 2016-06-01 20:14:44 +00:00
CONTRIBUTING.rst Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
HACKING.rst Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
LICENSE Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
MANIFEST.in Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
README.rst Add auditing instrumentation for python-oneviewclient 2016-09-07 20:58:10 +00:00
babel.cfg Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
openstack-common.conf Initial Cookiecutter Commit. 2015-08-13 17:57:27 -03:00
requirements.txt Updated from global requirements 2017-05-22 22:50:27 +00:00
setup.cfg Drop py26 and py33 support 2015-12-15 19:27:01 +09:00
setup.py Updated from global requirements 2017-05-22 22:50:27 +00:00
test-requirements.txt Updated from global requirements 2017-05-22 22:50:27 +00:00
tox.ini Update the python version in tox.ini 2017-03-30 14:12:53 -03:00

README.rst

python-oneviewclient

Library to use HPE OneView to provide nodes for Ironic

This library adds a communication layer between Ironic and OneView and abstracts the version of OneView in place.

Features

Audit logging

python-oneviewclient is capable of logging method calls to OneView for auditing. Currently, data about request timing and method names, parameters and return values, can be recorded to be used in the auditing process to discover and better understand hotspots, bottlenecks and to measure how the user code and OneView integration performs.

Enabling audit logging

To enable audit logging, the user code has to set three parameters in the constructor of the client object. namely: audit_enabled, audit_map_file and audit_output_file. audit_map_file and audit_output_file must be filled with the absolute path to the audit map file and the audit output file.

The audit map file

The audit map file is composed of two sections, audit and cases. In the audit section there should be a case option where one, and just one, of the audit logging cases needs to be specified. The cases section needs to be filled with a name for a case followed by the methods that the user wants to audit logging. The methods that are allowed for the audit logging are those decorated by @auditing.audit in python-oneviewclient.

See an example of an audit map file:

[audit]

# Case to be audit logged from those declared in cases section.

case = case_number_one

[cases]

# Possible auditable case name followed by the audit loggable
# methods' names.

case_number_one = first_method,second_method,third_method
case_number_two = first_method,third_method,fifth_method

The audit output file

The result of the audit logging process is a JSON formatted file that can be used by auditors, operators and engineers to obtain valuable information about performance impacts of using python-oneviewclient to access OneView, and better understand possible hotspots and bottlenecks in the integration of the user code and OneView.

See an example of an audit output file:

{
    "method": "get_node_power_state",
    "client_instance_id": 140396067361488,
    "initial_time": "2016-08-29T17:32:01.403420",
    "end_time": "2016-08-29T17:32:01.439126",
    "is_ironic_request": true,
    "is_oneview_request": false,
    "ret": "Off"
}