Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solarwinds/orionsdk-python
Python client for interacting with the SolarWinds Orion API
https://github.com/solarwinds/orionsdk-python
Last synced: 4 days ago
JSON representation
Python client for interacting with the SolarWinds Orion API
- Host: GitHub
- URL: https://github.com/solarwinds/orionsdk-python
- Owner: solarwinds
- License: apache-2.0
- Created: 2016-02-17T22:26:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-11T12:52:18.000Z (8 months ago)
- Last Synced: 2024-04-26T21:20:47.308Z (7 months ago)
- Language: Python
- Homepage:
- Size: 70.3 KB
- Stars: 206
- Watchers: 72
- Forks: 86
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Orion SDK for Python
This project contains a python client for interacting with the SolarWinds Orion API
## API Documentation
For documentation about the SolarWinds Orion API, please see the [wiki](https://github.com/solarwinds/OrionSDK/wiki), [tools](https://github.com/solarwinds/OrionSDK/releases), and sample code (in languages other than Python) in the main [OrionSDK project](https://github.com/solarwinds/OrionSDK).
## Install
```
pip install orionsdk
```
## Usage
```python
import orionsdk
swis = orionsdk.SwisClient("server", "username", "password")
aliases = swis.invoke('Metadata.Entity', 'GetAliases', 'SELECT B.Caption FROM Orion.Nodes B')
print(aliases)
```
## SSL Certificate Verification
Initial support for SSL certificate valuation was added in 0.0.4. To
enable this, you will need to save the self-signed cert to a file. One
way of doing this is with OpenSSL:
```bash
openssl s_client -connect server:17778
```
Then add an entry to your hosts file for ``SolarWinds-Orion`` and you
will be able to verify via doing the following:
```python
import orionsdk
swis = orionsdk.SwisClient("SolarWinds-Orion", "username", "password", verify="server.pem")
swis.query("SELECT NodeID from Orion.Nodes")
```
## Setting Timeout
```python
import orionsdk
import requests
session = requests.Session()
session.timeout = 30 # Set your timeout in seconds
swis = orionsdk.SwisClient("SolarWinds-Orion", "username", "password", verify="server.pem", session=session)
swis.query("SELECT NodeID from Orion.Nodes")
```
## Setting Retry
```python
import orionsdk
import requests
from requests.adapters import HTTPAdapter
from requests.packages.urllib3.util.retry import Retry
def retry_session(retries=3,
backoff_factor=0.3,
status_forcelist=(500, 502, 504)):
session = requests.Session()
retry = Retry(
total=retries,
read=retries,
connect=retries,
backoff_factor=backoff_factor,
status_forcelist=status_forcelist)
adapter = HTTPAdapter(max_retries=retry)
session.mount('http://', adapter)
session.mount('https://', adapter)
return session
swis = orionsdk.SwisClient(
"SolarWinds-Orion",
"username",
"password",
verify="server.pem",
session=retry_session())
swis.query("SELECT NodeID from Orion.Nodes")
```
## License
This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.
Copyright © 2015 SolarWinds Worldwide, LLC. All rights reserved.
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.
## Related Projects
### Solarwinds Interface Traffic Forecaster
[SolarwindsInterfaceTrafficPrediction](https://github.com/andrewbury/SolarwindsInterfaceTrafficPrediction) is an example of using the Orion SDK for Python and machine learning techniques to predict network interface traffic.