Skip to main content

Redfish Protocol Validator

Project description

Redfish Protocol Validator

Copyright 2020-2022 DMTF. All rights reserved.

About

The Redfish Protocol Validator tests the HTTP protocol behavior of a Redfish service to validate that it conforms to the Redfish Specification.

Installation

From PyPI:

pip install redfish_protocol_validator

From GitHub:

git clone https://github.com/DMTF/Redfish-Protocol-Validator.git
cd Redfish-Protocol-Validator
python setup.py sdist
pip install dist/redfish_protocol_validator-x.x.x.tar.gz

Requirements

The Redfish Protocol Validator requires Python3.

Required external packages:

aenum
colorama
pyasn1
pyasn1-modules
requests
sseclient-py
urllib3

If installing from GitHub, you may install the external packages by running:

pip install -r requirements.txt

Usage

usage: rf_protocol_validator.py [-h] [--version] --user USER --password
                                PASSWORD --rhost RHOST [--log-level LOG_LEVEL]
                                [--report-dir REPORT_DIR]
                                [--report-type {html,tsv,both}]
                                [--avoid-http-redirect]
                                [--no-cert-check | --ca-bundle CA_BUNDLE]

Validate the protocol conformance of a Redfish service

required arguments:
  --user USER, -u USER  the username for authentication
  --password PASSWORD, -p PASSWORD
                        the password for authentication
  --rhost RHOST, -r RHOST
                        address of the Redfish service (with scheme)

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        the logging level (default: WARNING)
  --report-dir REPORT_DIR
                        the directory for generated report files (default:
                        "reports")
  --report-type {html,tsv,both}
                        the type of report to generate: html, tsv, or both
                        (default: both)
  --avoid-http-redirect
                        avoid attempts to generate HTTP redirects for services
                        that do not support HTTP
  --no-cert-check       disable verification of host SSL certificates
  --ca-bundle CA_BUNDLE
                        the file or directory containing trusted CAs

Example:

rf_protocol_validator -r https://192.168.1.100 -u USERNAME -p PASSWORD

Unit Tests

The Redfish Protocol Validator unit tests are executed using the tox package.

You may install tox by running:

pip install tox

Running the unit tests:

tox

Release Process

  1. Go to the "Actions" page
  2. Select the "Release and Publish" workflow
  3. Click "Run workflow"
  4. Fill out the form
  5. Click "Run workflow"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redfish_protocol_validator-1.2.6.tar.gz (77.4 kB view details)

Uploaded Source

Built Distribution

redfish_protocol_validator-1.2.6-py3-none-any.whl (84.6 kB view details)

Uploaded Python 3

File details

Details for the file redfish_protocol_validator-1.2.6.tar.gz.

File metadata

File hashes

Hashes for redfish_protocol_validator-1.2.6.tar.gz
Algorithm Hash digest
SHA256 f6ac8584ab100dca13a05e31001f949f7a7197e5542fb8311bf160754316d2b7
MD5 e7b648db50cf47afea92a990994cea6d
BLAKE2b-256 344efe2cd1bff997b4bfdb410690edb470d0bd31a41b3865ef0904321b4cf57a

See more details on using hashes here.

File details

Details for the file redfish_protocol_validator-1.2.6-py3-none-any.whl.

File metadata

File hashes

Hashes for redfish_protocol_validator-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7a401fb6ec9acc45d7c84cb583ace59889b55922d9d7d49070e63b62bc266619
MD5 0d58f5a7e999a5ca3489c74909934b81
BLAKE2b-256 ba4c31382cb46b64121f1eead5c941769cb2b25866173dd919b926620e230df0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page