[{"_1":2,"_170":-5,"_171":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_145":146},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_134":-5,"_135":11,"_136":21,"_137":11,"_138":-5,"_139":11,"_140":-5,"_141":142,"_143":91,"_144":-7},"canonicalUrl","https://hub.docker.com/r/chharika/oneview-python/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","chharika","reponame","oneview-python","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-06-15T05:00:57.271016Z","description","","is_private","last_updated","2020-06-19T10:11:48.961581Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",57,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# HPE OneView SDK for Python\n\nThis library provides a pure Python interface to the HPE OneView REST APIs.\n\nHPE OneView is a fresh approach to converged infrastructure management, inspired\nby the way you expect to work, with a single integrated view of your IT\ninfrastructure.\n\nThe HPE OneView Python library depends on the\n[Python-Future](http://python-future.org/index.html) library to provide Python\n2/3 compatibility. This will be installed automatically if you use the installation\nmethods described below.\n\n## Installation\n\n### From source\n\nEither:\n\n```bash\n$ git clone https://github.com/HewlettPackard/oneview-python.git\n$ cd oneview-python\n$ python setup.py install --user # to install in the user directory (~/.local)\n$ sudo python setup.py install # to install globally\n```\n\nOr if using PIP:\n\n```bash\n$ git clone https://github.com/HewlettPackard/oneview-python.git\n$ cd oneview-python\n$ pip install .\n```\n\nBoth installation methods work if you are using virtualenv, which you should be!\n\n### From Pypi\n\n```bash\n$ pip install hpOneView\n```\n\n\n## API Implementation\n\nA status of the HPE OneView REST interfaces that have been implemented in this Python library can be found in the [Wiki section](https://github.com/HewlettPackard/oneview-python/blob/master/endpoints-support.md).\n\n\n## SDK Documentation\n\nThe latest version of the SDK documentation can be found in the [SDK Documentation section](https://hewlettpackard.github.io/oneview-python/index.html).\n\n## Logging\n\nThis module uses Python’s Standard Library logging module. An example of how to configure logging is provided on [```/examples/logger.py```](/examples/logger.py).\n\nMore information about the logging configuration can be found in the Python Documentation.\n\n## Configuration\n\n### JSON\n\nConnection properties for accessing the OneView appliance can be set in a JSON file.\n\nBefore running the samples or your own scripts, you must create the JSON file.\nAn example can be found at: [OneView configuration sample](examples/config-rename.json).\n\nNote: If you have an active and valid login session and want to use it, define the sessionID in the Credentials. When sessionID is defined, you can remove username and password from your JSON (they will be disregarded anyway).\n\nOnce you have created the JSON file, you can initialize the OneViewClient:\n\n```python\noneview_client = OneViewClient.from_json_file('/path/config.json')\n```\n\n:lock: Tip: Check the file permissions because the password is stored in clear-text.\n\n### Environment Variables\n\nConfiguration can also be stored in environment variables:\n\n```bash\n# Required\nexport ONEVIEWSDK_IP='172.16.102.82'\n\nexport ONEVIEWSDK_USERNAME='Administrator'\nexport ONEVIEWSDK_PASSWORD='secret123'\n# Or sessionID\nexport ONEVIEWSDK_SESSIONID='123'\n\n\n# Optional\nexport ONEVIEWSDK_API_VERSION='800'\nexport ONEVIEWSDK_AUTH_LOGIN_DOMAIN='authdomain'\nexport ONEVIEWSDK_SSL_CERTIFICATE=''\nexport ONEVIEWSDK_PROXY=':'\nexport ONEVIEWSDK_CONNECTION_TIMEOUT=''\n```\n\n:lock: Tip: Make sure no unauthorized person has access to the environment variables, since the password is stored in clear-text.\n\nNote: If you have an active and valid login session and want to use it, define the ONEVIEWSDK_SESSIONID. When a sessionID is defined, it will be used for authentication (username and password will be ignored in this case).\n\nOnce you have defined the environment variables, you can initialize the OneViewClient using the following code snippet:\n\n```python\noneview_client = OneViewClient.from_environment_variables()\n```\n\n### Dictionary\n\nYou can also set the configuration using a dictionary. As described above, for authentication you can use username/password:\n\n\n```python\nconfig = {\n \"ip\": \"172.16.102.82\",\n \"credentials\": {\n \"userName\": \"Administrator\",\n \"password\": \"secret123\"\n }\n}\n```\n\n or if you have an active and valid login session and want to use it, define the sessionID in the Credentials:\n\n\n```python\nconfig = {\n \"ip\": \"172.16.102.82\",\n \"credentials\": {\n \"sessionID\": \"123\"\n }\n}\n\noneview_client = OneViewClient(config)\n```\n\n:lock: Tip: Check the file permissions because the password is stored in clear-text.\n\n### SSL Server Certificate\n\nTo enable the SDK to establish a SSL connection to the HPE OneView server, it is necessary to generate a CA Cert file containing the server credentials.\n\n1. Fetch the HPE OneView Appliance CA certificate.\n```bash\n$ openssl s_client -showcerts -host -port 443\n```\n\n2. Copy the server certificate wrapped with a header line and a footer line into a `.crt` file.\n```\n-----BEGIN CERTIFICATE-----\n... (HPE OneView Appliance certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n```\nWhen using HPE Image Streamer, the server certificate for the HPE Image Streamer should also be added to the certificates file. Example:\n```\n-----BEGIN CERTIFICATE-----\n... (HPE OneView Appliance certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n... (HPE Image Streamer Appliance certificate in base64 PEM encoding) ...\n-----END CERTIFICATE-----\n```\n\n3. Declare the CA Certificate location when creating a `config` dictionary.\n```python\nconfig = {\n \"ip\": \"172.16.102.82\",\n \"credentials\": {\n \"userName\": \"Administrator\",\n \"password\": \"secret123\"\n },\n \"ssl_certificate\": \"/home/oneview-python/my_ov_certificate.crt\"\n}\n```\n\n### Proxy\n\nIf your environment requires a proxy, define the proxy properties in the JSON file using the following syntax:\n\n```json\n \"proxy\": \":\"\n```\nOR export the `ONEVIEWSDK_PROXY` environment variable:\n```bash\nexport ONEVIEWSDK_PROXY=':'\n```\n\n### Setting your OneView version\n\nThe OneView Python SDK supports the API endpoints for HPE OneView 4.10, 4.20 and 5.00.\n\nThe current `default` HPE OneView version used by the Python SDK is `4.10`, API `800`.\n\nTo use a different API, you must set the API version on the OneViewClient configuration, either using the JSON configuration:\n\n```json\n\"api_version\": 800\n```\nOR using the Environment variable:\n\n```bash\nexport ONEVIEWSDK_API_VERSION='800'\n```\n\nIf this property is not specified, it will fall back to the ```800``` default value.\n\nThe API list is as follows:\n\n- HPE OneView 4.10 API version: `800`\n- HPE OneView 4.20 API version: `1000`\n- HPE OneView 5.00 API version: `1200`\n\n### HPE Synergy Image Streamer\n\nThe OneView Python SDK also supports the API endpoints for HPE Synergy Image Streamer.\nTo configure the SDK, you must set the Image Streamer IP on the OneViewClient configuration,\neither using the JSON configuration:\n\n```json\n\"image_streamer_ip\": \"100.100.100.100\"\n```\n\nOR using the Environment variable:\n\n```bash\nexport ONEVIEWSDK_IMAGE_STREAMER_IP='100.100.100.100'\n```\n\nTo create the ImageStreamerClient, you must call the `create_image_streamer_client`\nmethod from the pre-existent OneViewClient instance. Through the created\nImageStreamerClient, you are able to access the API Clients of the\nImage Streamer resources:\n\n```python\nimage_streamer_client = oneview_client.create_image_streamer_client()\n\nbuild_plans = image_streamer_client.build_plans.get_all()\n```\n\nYou can find more usage examples in the folder ```/examples/image_streamer```\n\n### OneView Connection Timeout\nBy default the system timeout is used when connecting to OneView. If you want to change this,\nthen the timeout can be set by either:\n\n1. Setting the appropriate environment variable:\n```bash\nexport ONEVIEWSDK_CONNECTION_TIMEOUT=''\n```\n\n2. Setting the time-out in the JSON configuration file using the following syntax:\n```json\n\"timeout\": \n```\n\n## Exception handling\n\nAll exceptions raised by the OneView Python SDK inherit from HPOneViewException.\n\n**HPOneViewException** has the following properties:\n- **msg** - a string containing the error message sent by the OneView REST API;\n- **oneview_response** - contains the entire JSON data dictionary with error details that are returned by the OneView Python SDK. It can be: ```None```.\n\n##### Exception Handling example:\n\n```python\ntry:\n fc_network_client = oneview_client.fc_networks\n fc_network = fc_network_client.get_by_name(name)\nexcept HPOneViewException as e:\n print(e.msg)\n if e.oneview_response:\n \tpprint(e.oneview_response)\n```\n\nFor compatibility purposes, the Exception args property is defined with the error arguments. For example:\n\n```python\nexcept Exception as e:\n\tprint(arg[0]) # e.msg equivalent\n print(arg[1]) # e.oneview_reponse equivalent\n```\n\n## Contributing and feature requests\n\n**Contributing:** You know the drill. Fork it, branch it, change it, commit it, and pull-request it. We are passionate about improving this project, and glad to accept help to make it better.\n\n**NOTE:** We reserve the right to reject changes that we feel do not fit the scope of this project. For feature additions, please open an issue to discuss your ideas before doing the work.\n\n**Feature Requests:** If you have needs not being 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 we have already thought of everything, because we assure you that is not the case.\n\n#### Naming Convention for OneView Resources\n\nThe following summarizes code structure and naming conventions for the OneView resources.\n\n- **Packages:** The package is named according to the **HPE OneView API Reference** group, with all characters in lowercase, replacing spaces with underscores.\n- **Modules:** The module is named according to the **HPE OneView API Reference** endpoint title, with all characters in lowercase, replacing spaces with underscores.\n For example: In the documentation we have **FC Networks**, so the module name will be **fc_networks**.\n- **Classes:** We are using camel case to define the class name, for example: **FcNetworks**.\n- **OneViewClient properties:** In the **oneview_client**, the property name follows exactly the module name, for example: **fc_networks**.\n- **Examples:** The example is named with the same name of the resource module: **fc_networks**.\n- **Tests:** The unit test folders follow the same structure of the resources. The name of the test modules should start with \"test,\" for example: **test_fc_networks**.\n\n#### Testing\n\nWhen contributing code to this project, we require tests to accompany the code being delivered.\nThat ensures a higher standing of quality, and also helps to avoid minor mistakes and future regressions.\n\nWhen writing the unit tests, the standard approach we follow is to use the python library [unittest.mock](https://docs.python.org/3/library/unittest.mock.html) to patch all calls that would be made to a OneView appliance and return mocked values.\n\nWe have packaged everything required to verify if the code is passing the tests in a tox file.\nThe tox call runs all unit tests against Python 2 and 3, runs a flake8 validation, and generates the test coverage report.\n\nTo run it, use the following command:\n\n```\n$ tox\n```\n\nYou can also check out examples of tests for different resources in the [tests](tests) folder.\n\n## License\n\nThis project is licensed under the Apache license. Please see [LICENSE](LICENSE) for more information.\n\n## Version and changes\n\nTo view history and notes for this version, view the [Changelog](CHANGELOG.md).","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",65279091,"orgData","recentTags",[91,128],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",9715075,"full_size",65268731,"id",105563045,"images",[101],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"architecture","amd64","digest","sha256:52d524fdf8aac6e3772fe0b021ecbbc1481d519670c7746f5dae666144c2e6fb","features","last_pulled","2026-09-21T00:53:20.081344879Z","last_pushed","2020-06-15T05:26:30Z","os","linux","os_features","os_version","size","variant","2020-06-19T10:11:48.649131Z","last_updater","last_updater_username","media_type","v5.2.0-OV5.2","repository",9258264,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_92":44,"_93":94,"_95":96,"_97":129,"_99":130,"_50":132,"_118":94,"_119":33,"_120":56,"_57":133,"_122":123,"_124":108,"_125":132,"_126":66,"_127":21},104881390,[131],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"2020-06-15T05:26:29.623232Z","v5.2.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":147,"_154":155,"_141":168,"_169":11},{"_40":148,"_42":149,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":150,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":151,"_79":11,"_80":153,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":152},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_156":157,"_158":-5,"_159":-5,"_160":161},"count",2,"next","previous","results",[162,165],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":163,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[164],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},{"_92":44,"_93":94,"_95":96,"_97":129,"_99":166,"_50":132,"_118":94,"_119":33,"_120":56,"_57":133,"_122":123,"_124":108,"_125":132,"_126":66,"_127":21},[167],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

chharika/oneview-python

Tags for chharika/oneview-python