Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #89

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d06c4a
Update README.md
The-rambunctious-S Aug 4, 2020
0990d6d
Update README.md
The-rambunctious-S Aug 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 45 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,79 +1,81 @@
# python-redfish-lenovo
# Python-redfish-Lenovo

Sample Python scripts for using the Redfish API on Lenovo servers

Description
## Introduction

This project includes a set of sample Python scripts that utilize the Redfish API to manage Lenovo ThinkSystem servers. The scripts use the [DMTF python-redfish-library](https://github.com/DMTF/python-redfish-library). For more information on the Redfish API, visit [DMTF's Redfish Developer Hub](http://redfish.dmtf.org/)

----------

This project includes a set of sample Python scripts that utilize the Redfish API to manage Lenovo ThinkSystem servers. The scripts use the DMTF python-redfish-library <https://github.com/DMTF/python-redfish-library>
## Installation

For more information on the Redfish API, visit <http://redfish.dmtf.org/>
* To install the python-redfish-library, follow these two steps:

Installing
----------
1. Get the code from [python-redfish-library](https://github.com/DMTF/python-redfish-library).

* To install the python-redfish-library, get the code from <https://github.com/DMTF/python-redfish-library> , then:
2. Run the following command in your terminal:

`python setup.py install`

* To install configparser:
* To install configparser, run the following command in your terminal:

`pip install configparser`

Requirements
----------

* python-redfish-library need to be installed
## Software requirements


* Python-redfish-library needs to be installed.

Usage
----------
A set of python examples is provided under the examples directory of this project.

## Usage

A set of python examples are provided under the examples directory of this project.

* Common parameters configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use a configuration file to store common parameters for the Lenovo PowerShell Redfish Scripts,
such as the BMC IP address, user name, and password. Default configuration file is config.ini.
You can create your own configuration file and specify it using the "--config" option.
The scripts will load config.ini automatically if no configuration file is specified in command line.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Using the python examples to get and set values

Simply run the python script to print out the values form the HTTP GET operation.
You can use a configuration file to store common parameters such as the BMC IP address, user name, and password for the Lenovo PowerShell Redfish Scripts. Default configuration file is *config.ini*.

This example prints the current system power state (such as On or Off)
You can also create your own configuration file and specify it using the *"--config"* option. The scripts will load *config.ini* automatically if no configuration file is specified in command line.

cd examples
python get_power_state.py
This example prints the system reset types that are supported by this server, then passes one of the values (ForceOff) to force the server to shutdown:
* Values viewing and setting

cd examples
python lenovo_get_reset_types.py
['On', 'Nmi', 'GracefulShutdown', 'GracefulRestart', 'ForceOn', 'ForceOff', 'ForceRestart']

Python lenovo_set_reset_types.py ForceOff
Run the relevant python script to show values in the HTTP GET operation. Here are two examples:

Contributing
----------
1. By running the following code, the terminal will show the current power state of the system (such as On or Off):
~~~~
cd examples
python get_power_state.py
~~~~


2. By running the following code, the terminal will show system reset types that are supported by your server, then passes one of the values (ForceOff) to force the server to shutdown:
~~~~
cd examples
python lenovo_get_reset_types.py
['On', 'Nmi', 'GracefulShutdown', 'GracefulRestart', 'ForceOn', 'ForceOff', 'ForceRestart']
Python lenovo_set_reset_types.py ForceOff
~~~~


-----------

## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

Copyright and License

---------------------

Copyright 2019 Lenovo Corporation
## Copyright and License

Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
Copyright 2019 Lenovo Corporation

http://www.apache.org/licenses/LICENSE-2.0
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.