Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

assisted-service-client

Package Overview
Dependencies
Maintainers
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

assisted-service-client

AssistedInstall

  • 2.36.0.post20
  • PyPI
  • Socket score

Maintainers
2
# 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: urlAuth
configuration = assisted_service_client.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# 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'
# Configure API key authorization: watcherAuth
configuration = assisted_service_client.Configuration()
configuration.api_key['Watcher-Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Watcher-Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = assisted_service_client.EventsApi(assisted_service_client.ApiClient(configuration))
cluster_id = 'cluster_id_example' # str | The cluster to return events for. (optional)
host_id = 'host_id_example' # str | A host in the specified cluster to return events for (DEPRECATED. Use `host_ids` instead). (optional)
host_ids = ['host_ids_example'] # list[str] | Hosts in the specified cluster to return events for. (optional)
infra_env_id = 'infra_env_id_example' # str | The infra-env to return events for. (optional)
limit = 56 # int | The maximum number of records to retrieve. (optional)
offset = 56 # int | Number of records to skip before starting to return the records. (optional)
order = 'ascending' # str | Order by event_time of events retrieved. (optional) (default to ascending)
severities = ['severities_example'] # list[str] | Retrieved events severities. (optional)
message = 'message_example' # str | Retrieved events message pattern. (optional)
deleted_hosts = true # bool | Deleted hosts flag. (optional)
cluster_level = true # bool | Cluster level events flag. (optional)
categories = ['categories_example'] # list[str] | A comma-separated list of event categories. (optional)

try:
    api_response = api_instance.v2_list_events(cluster_id=cluster_id, host_id=host_id, host_ids=host_ids, infra_env_id=infra_env_id, limit=limit, offset=offset, order=order, severities=severities, message=message, deleted_hosts=deleted_hosts, cluster_level=cluster_level, categories=categories)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->v2_list_events: %s
" % e)

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
EventsApiv2_list_eventsGET /v2/events
EventsApiv2_trigger_eventPOST /v2/events
InstallerApibind_hostPOST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/bind
InstallerApideregister_infra_envDELETE /v2/infra-envs/{infra_env_id}
InstallerApidownload_minimal_initrdGET /v2/infra-envs/{infra_env_id}/downloads/minimal-initrd
InstallerApiget_cluster_supported_platformsGET /v2/clusters/{cluster_id}/supported-platforms
InstallerApiget_infra_envGET /v2/infra-envs/{infra_env_id}
InstallerApiget_infra_env_download_urlGET /v2/infra-envs/{infra_env_id}/downloads/image-url
InstallerApiget_infra_env_presigned_file_urlGET /v2/infra-envs/{infra_env_id}/downloads/files-presigned
InstallerApiget_supported_architecturesGET /v2/support-levels/architectures
InstallerApiget_supported_featuresGET /v2/support-levels/features
InstallerApilist_cluster_hostsGET /v2/clusters/{cluster_id}/hosts
InstallerApilist_infra_envsGET /v2/infra-envs
InstallerApiregenerate_infra_env_signing_keyPOST /v2/infra-envs/{infra_env_id}/regenerate-signing-key
InstallerApiregister_infra_envPOST /v2/infra-envs
InstallerApitransform_cluster_to_adding_hostsPOST /v2/clusters/{cluster_id}/actions/allow-add-hosts
InstallerApitransform_cluster_to_day2POST /v2/clusters/{cluster_id}/actions/allow-add-workers
InstallerApiunbind_hostPOST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/unbind
InstallerApiupdate_infra_envPATCH /v2/infra-envs/{infra_env_id}
InstallerApiv2_cancel_installationPOST /v2/clusters/{cluster_id}/actions/cancel
InstallerApiv2_complete_installationPOST /v2/clusters/{cluster_id}/actions/complete-installation
InstallerApiv2_deregister_clusterDELETE /v2/clusters/{cluster_id}
InstallerApiv2_deregister_hostDELETE /v2/infra-envs/{infra_env_id}/hosts/{host_id}
InstallerApiv2_download_cluster_credentialsGET /v2/clusters/{cluster_id}/downloads/credentials
InstallerApiv2_download_cluster_filesGET /v2/clusters/{cluster_id}/downloads/files
InstallerApiv2_download_cluster_logsGET /v2/clusters/{cluster_id}/logs
InstallerApiv2_download_host_ignitionGET /v2/infra-env/{infra_env_id}/hosts/{host_id}/downloads/ignition
InstallerApiv2_download_infra_env_filesGET /v2/infra-envs/{infra_env_id}/downloads/files
InstallerApiv2_get_clusterGET /v2/clusters/{cluster_id}
InstallerApiv2_get_cluster_default_configGET /v2/clusters/default-config
InstallerApiv2_get_cluster_install_configGET /v2/clusters/{cluster_id}/install-config
InstallerApiv2_get_cluster_ui_settingsGET /v2/clusters/{cluster_id}/ui-settings
InstallerApiv2_get_credentialsGET /v2/clusters/{cluster_id}/credentials
InstallerApiv2_get_hostGET /v2/infra-envs/{infra_env_id}/hosts/{host_id}
InstallerApiv2_get_host_ignitionGET /v2/infra-envs/{infra_env_id}/hosts/{host_id}/ignition
InstallerApiv2_get_ignored_validationsGET /v2/clusters/{cluster_id}/ignored-validations
InstallerApiv2_get_next_stepsGET /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions
InstallerApiv2_get_preflight_requirementsGET /v2/clusters/{cluster_id}/preflight-requirements
InstallerApiv2_get_presigned_for_cluster_credentialsGET /v2/clusters/{cluster_id}/downloads/credentials-presigned
InstallerApiv2_get_presigned_for_cluster_filesGET /v2/clusters/{cluster_id}/downloads/files-presigned
InstallerApiv2_import_clusterPOST /v2/clusters/import
InstallerApiv2_install_clusterPOST /v2/clusters/{cluster_id}/actions/install
InstallerApiv2_install_hostPOST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/install
InstallerApiv2_list_clustersGET /v2/clusters
InstallerApiv2_list_hostsGET /v2/infra-envs/{infra_env_id}/hosts
InstallerApiv2_list_of_cluster_operatorsGET /v2/clusters/{cluster_id}/monitored-operators
InstallerApiv2_post_step_replyPOST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions
InstallerApiv2_register_clusterPOST /v2/clusters
InstallerApiv2_register_hostPOST /v2/infra-envs/{infra_env_id}/hosts
InstallerApiv2_report_monitored_operator_statusPUT /v2/clusters/{cluster_id}/monitored-operators
InstallerApiv2_reset_clusterPOST /v2/clusters/{cluster_id}/actions/reset
InstallerApiv2_reset_hostPOST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/reset
InstallerApiv2_reset_host_validationPATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/reset-validation/{validation_id}Reset failed host validation.
InstallerApiv2_set_ignored_validationsPUT /v2/clusters/{cluster_id}/ignored-validations
InstallerApiv2_update_clusterPATCH /v2/clusters/{cluster_id}
InstallerApiv2_update_cluster_finalizing_progressPUT /v2/clusters/{cluster_id}/progress
InstallerApiv2_update_cluster_install_configPATCH /v2/clusters/{cluster_id}/install-config
InstallerApiv2_update_cluster_logs_progressPUT /v2/clusters/{cluster_id}/logs-progress
InstallerApiv2_update_cluster_ui_settingsPUT /v2/clusters/{cluster_id}/ui-settings
InstallerApiv2_update_hostPATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}
InstallerApiv2_update_host_ignitionPATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/ignition
InstallerApiv2_update_host_install_progressPUT /v2/infra-envs/{infra_env_id}/hosts/{host_id}/progress
InstallerApiv2_update_host_installer_argsPATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/installer-args
InstallerApiv2_update_host_logs_progressPUT /v2/infra-envs/{infra_env_id}/hosts/{host_id}/logs-progress
InstallerApiv2_upload_cluster_ingress_certPOST /v2/clusters/{cluster_id}/uploads/ingress-cert
InstallerApiv2_upload_logsPOST /v2/clusters/{cluster_id}/logs
ManagedDomainsApiv2_list_managed_domainsGET /v2/domains
ManifestsApiv2_create_cluster_manifestPOST /v2/clusters/{cluster_id}/manifests
ManifestsApiv2_delete_cluster_manifestDELETE /v2/clusters/{cluster_id}/manifests
ManifestsApiv2_download_cluster_manifestGET /v2/clusters/{cluster_id}/manifests/files
ManifestsApiv2_list_cluster_manifestsGET /v2/clusters/{cluster_id}/manifests
ManifestsApiv2_update_cluster_manifestPATCH /v2/clusters/{cluster_id}/manifests
OperatorsApiv2_list_of_cluster_operatorsGET /v2/clusters/{cluster_id}/monitored-operators
OperatorsApiv2_list_operator_propertiesGET /v2/supported-operators/{operator_name}
OperatorsApiv2_list_supported_operatorsGET /v2/supported-operators
OperatorsApiv2_report_monitored_operator_statusPUT /v2/clusters/{cluster_id}/monitored-operators
VersionsApiv2_list_component_versionsGET /v2/component-versions
VersionsApiv2_list_release_sourcesGET /v2/release-sources
VersionsApiv2_list_supported_openshift_versionsGET /v2/openshift-versions

Documentation For Models

Documentation For Authorization

agentAuth

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

imageAuth

  • Type: API key
  • API key parameter name: Image-Token
  • Location: HTTP header

imageURLAuth

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

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

watcherAuth

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

Author

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc