Skip to main content
# assisted-service-client

Assisted installation

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install assisted-service-client

(you may need to run pip with root permission: sudo pip install assisted-service-client)

Then import the package:

import assisted_service_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import assisted_service_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import assisted_service_client
from assisted_service_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userAuth
configuration = assisted_service_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = assisted_service_client.AssistedServiceIsoApi(assisted_service_client.ApiClient(configuration))
assisted_service_iso_create_params = assisted_service_client.AssistedServiceIsoCreateParams() # AssistedServiceIsoCreateParams | Parameters for creating an Assisted Service ISO.

try:
    api_instance.create_iso_and_upload_to_s3(assisted_service_iso_create_params)
except ApiException as e:
    print("Exception when calling AssistedServiceIsoApi->create_iso_and_upload_to_s3: %s
" % e)

Documentation for API Endpoints

All URIs are relative to http://api.openshift.com/api/assisted-install/v1

Class Method HTTP request Description
AssistedServiceIsoApi create_iso_and_upload_to_s3 POST /assisted-service-iso
AssistedServiceIsoApi download_iso GET /assisted-service-iso/data
AssistedServiceIsoApi get_presigned_for_assisted_service_iso GET /assisted-service-iso/presigned
BootfilesApi download_boot_files GET /boot-files
EventsApi list_events GET /clusters/{cluster_id}/events
InstallerApi cancel_installation POST /clusters/{cluster_id}/actions/cancel
InstallerApi complete_installation POST /clusters/{cluster_id}/actions/complete_installation
InstallerApi deregister_cluster DELETE /clusters/{cluster_id}
InstallerApi deregister_host DELETE /clusters/{cluster_id}/hosts/{host_id}
InstallerApi disable_host DELETE /clusters/{cluster_id}/hosts/{host_id}/actions/enable
InstallerApi download_cluster_files GET /clusters/{cluster_id}/downloads/files
InstallerApi download_cluster_iso GET /clusters/{cluster_id}/downloads/image
InstallerApi download_cluster_kubeconfig GET /clusters/{cluster_id}/downloads/kubeconfig
InstallerApi download_cluster_logs GET /clusters/{cluster_id}/logs
InstallerApi download_host_ignition GET /clusters/{cluster_id}/hosts/{host_id}/downloads/ignition
InstallerApi download_host_logs GET /clusters/{cluster_id}/hosts/{host_id}/logs
InstallerApi enable_host POST /clusters/{cluster_id}/hosts/{host_id}/actions/enable
InstallerApi generate_cluster_iso POST /clusters/{cluster_id}/downloads/image
InstallerApi get_cluster GET /clusters/{cluster_id}
InstallerApi get_cluster_default_config GET /clusters/default-config
InstallerApi get_cluster_host_requirements GET /clusters/{cluster_id}/host-requirements
InstallerApi get_cluster_install_config GET /clusters/{cluster_id}/install-config
InstallerApi get_credentials GET /clusters/{cluster_id}/credentials
InstallerApi get_discovery_ignition GET /clusters/{cluster_id}/discovery-ignition
InstallerApi get_free_addresses GET /clusters/{cluster_id}/free_addresses
InstallerApi get_host GET /clusters/{cluster_id}/hosts/{host_id}
InstallerApi get_host_ignition GET /clusters/{cluster_id}/hosts/{host_id}/ignition
InstallerApi get_host_requirements GET /host_requirements
InstallerApi get_next_steps GET /clusters/{cluster_id}/hosts/{host_id}/instructions
InstallerApi get_presigned_for_cluster_files GET /clusters/{cluster_id}/downloads/files-presigned
InstallerApi install_cluster POST /clusters/{cluster_id}/actions/install
InstallerApi install_host POST /clusters/{cluster_id}/hosts/{host_id}/actions/install
InstallerApi install_hosts POST /clusters/{cluster_id}/actions/install_hosts
InstallerApi list_clusters GET /clusters
InstallerApi list_hosts GET /clusters/{cluster_id}/hosts
InstallerApi list_of_cluster_operators GET /clusters/{cluster_id}/monitored_operators
InstallerApi post_step_reply POST /clusters/{cluster_id}/hosts/{host_id}/instructions
InstallerApi register_add_hosts_cluster POST /add_hosts_clusters
InstallerApi register_cluster POST /clusters
InstallerApi register_host POST /clusters/{cluster_id}/hosts
InstallerApi report_monitored_operator_status PUT /clusters/{cluster_id}/monitored_operators
InstallerApi reset_cluster POST /clusters/{cluster_id}/actions/reset
InstallerApi reset_host POST /clusters/{cluster_id}/hosts/{host_id}/actions/reset
InstallerApi update_cluster PATCH /clusters/{cluster_id}
InstallerApi update_cluster_install_config PATCH /clusters/{cluster_id}/install-config
InstallerApi update_cluster_install_progress PUT /clusters/{cluster_id}/progress
InstallerApi update_cluster_logs_progress PUT /clusters/{cluster_id}/logs_progress
InstallerApi update_discovery_ignition PATCH /clusters/{cluster_id}/discovery-ignition
InstallerApi update_host_ignition PATCH /clusters/{cluster_id}/hosts/{host_id}/ignition
InstallerApi update_host_install_progress PUT /clusters/{cluster_id}/hosts/{host_id}/progress
InstallerApi update_host_installer_args PATCH /clusters/{cluster_id}/hosts/{host_id}/installer-args
InstallerApi update_host_logs_progress PUT /clusters/{cluster_id}/hosts/{host_id}/logs_progress
InstallerApi upload_cluster_ingress_cert POST /clusters/{cluster_id}/uploads/ingress-cert
InstallerApi upload_host_logs POST /clusters/{cluster_id}/hosts/{host_id}/logs
InstallerApi upload_logs POST /clusters/{cluster_id}/logs
ManagedDomainsApi list_managed_domains GET /domains
ManifestsApi create_cluster_manifest POST /clusters/{cluster_id}/manifests
ManifestsApi delete_cluster_manifest DELETE /clusters/{cluster_id}/manifests
ManifestsApi download_cluster_manifest GET /clusters/{cluster_id}/manifests/files
ManifestsApi list_cluster_manifests GET /clusters/{cluster_id}/manifests
OperatorsApi list_of_cluster_operators GET /clusters/{cluster_id}/monitored_operators
OperatorsApi list_operator_properties GET /supported-operators/{operator_name}
OperatorsApi list_supported_operators GET /supported-operators
OperatorsApi report_monitored_operator_status PUT /clusters/{cluster_id}/monitored_operators
VersionsApi list_component_versions GET /component_versions
VersionsApi list_supported_openshift_versions GET /openshift_versions

Documentation For Models

Documentation For Authorization

agentAuth

  • Type: API key
  • API key parameter name: X-Secret-Key
  • Location: HTTP header

urlAuth

  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

userAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

Release files for assisted-service-client 1.0.18.1.post32

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for assisted-service-client 1.0.18.1.post32
File Size Uploaded
assisted-service-client-1.0.18.1.post32.tar.gz 100.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for assisted-service-client 1.0.18.1.post32
File Interpreter ABI Platform
assisted_service_client-1.0.18.1.post32-py3-none-any.whl Python 3 none any Details

Total release size: 403.3 kB

Release files / assisted-service-client-1.0.18.1.post32.tar.gz

Download URL assisted-service-client-1.0.18.1.post32.tar.gz
Size 100.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5e484021e307c3e0dbcf217e9a2e2e5229c993c146973504656e43a1b9a30ccc
BLAKE2b-256 checksum
How to use checksums
446f79215e25ca07213f86247ae2771d38c2f347d3e620b966e9e46487618014
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.6.8

Release files / assisted_service_client-1.0.18.1.post32-py3-none-any.whl

Download URL assisted_service_client-1.0.18.1.post32-py3-none-any.whl
Size 302.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
358885a7ac04af4c8c84b732392ebca87c692d2c76db07745d30a66830bde8de
BLAKE2b-256 checksum
How to use checksums
1c9179b1b087643bd25bd5b26b20fa988294bda0ff8cfeca42a2ec369386f952
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.6.8

Release history Release notifications | RSS feed

2.1.0

1 release file

2.0.1

2 release files

2.0.0

2 release files

This release

1.0.18.1.post32 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page