# 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
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AssistedServiceIsoApi | create_iso_and_upload_to_s3 | POST /v1/assisted-service-iso | |
| AssistedServiceIsoApi | download_iso | GET /v1/assisted-service-iso/data | |
| AssistedServiceIsoApi | get_presigned_for_assisted_service_iso | GET /v1/assisted-service-iso/presigned | |
| EventsApi | list_events | GET /v1/clusters/{cluster_id}/events | |
| EventsApi | v2_list_events | GET /v2/events | |
| InstallerApi | bind_host | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/bind | |
| InstallerApi | cancel_installation | POST /v1/clusters/{cluster_id}/actions/cancel | |
| InstallerApi | complete_installation | POST /v1/clusters/{cluster_id}/actions/complete_installation | |
| InstallerApi | deregister_cluster | DELETE /v1/clusters/{cluster_id} | |
| InstallerApi | deregister_host | DELETE /v1/clusters/{cluster_id}/hosts/{host_id} | |
| InstallerApi | deregister_infra_env | DELETE /v2/infra-envs/{infra_env_id} | |
| InstallerApi | disable_host | DELETE /v1/clusters/{cluster_id}/hosts/{host_id}/actions/enable | |
| InstallerApi | download_cluster_files | GET /v1/clusters/{cluster_id}/downloads/files | |
| InstallerApi | download_cluster_iso | GET /v1/clusters/{cluster_id}/downloads/image | |
| InstallerApi | download_cluster_iso_headers | HEAD /v1/clusters/{cluster_id}/downloads/image | |
| InstallerApi | download_cluster_kubeconfig | GET /v1/clusters/{cluster_id}/downloads/kubeconfig | |
| InstallerApi | download_cluster_logs | GET /v1/clusters/{cluster_id}/logs | |
| InstallerApi | download_host_ignition | GET /v1/clusters/{cluster_id}/hosts/{host_id}/downloads/ignition | |
| InstallerApi | download_host_logs | GET /v1/clusters/{cluster_id}/hosts/{host_id}/logs | |
| InstallerApi | download_infra_env_discovery_image | GET /v2/infra-envs/{infra_env_id}/downloads/image | |
| InstallerApi | download_infra_env_discovery_image_headers | HEAD /v2/infra-envs/{infra_env_id}/downloads/image | |
| InstallerApi | download_minimal_initrd | GET /v2/infra-envs/{infra_env_id}/downloads/minimal-initrd | |
| InstallerApi | enable_host | POST /v1/clusters/{cluster_id}/hosts/{host_id}/actions/enable | |
| InstallerApi | generate_cluster_iso | POST /v1/clusters/{cluster_id}/downloads/image | |
| InstallerApi | get_cluster | GET /v1/clusters/{cluster_id} | |
| InstallerApi | get_cluster_default_config | GET /v1/clusters/default-config | |
| InstallerApi | get_cluster_host_requirements | GET /v1/clusters/{cluster_id}/host-requirements | |
| InstallerApi | get_cluster_install_config | GET /v1/clusters/{cluster_id}/install-config | |
| InstallerApi | get_cluster_supported_platforms | GET /v2/clusters/{cluster_id}/supported-platforms | |
| InstallerApi | get_credentials | GET /v1/clusters/{cluster_id}/credentials | |
| InstallerApi | get_discovery_ignition | GET /v1/clusters/{cluster_id}/discovery-ignition | |
| InstallerApi | get_free_addresses | GET /v1/clusters/{cluster_id}/free_addresses | |
| InstallerApi | get_host | GET /v1/clusters/{cluster_id}/hosts/{host_id} | |
| InstallerApi | get_host_ignition | GET /v1/clusters/{cluster_id}/hosts/{host_id}/ignition | |
| InstallerApi | get_infra_env | GET /v2/infra-envs/{infra_env_id} | |
| InstallerApi | get_preflight_requirements | GET /v1/clusters/{cluster_id}/preflight-requirements | |
| InstallerApi | get_presigned_for_cluster_files | GET /v1/clusters/{cluster_id}/downloads/files-presigned | |
| InstallerApi | install_cluster | POST /v1/clusters/{cluster_id}/actions/install | |
| InstallerApi | install_host | POST /v1/clusters/{cluster_id}/hosts/{host_id}/actions/install | |
| InstallerApi | install_hosts | POST /v1/clusters/{cluster_id}/actions/install_hosts | |
| InstallerApi | list_clusters | GET /v1/clusters | |
| InstallerApi | list_hosts | GET /v1/clusters/{cluster_id}/hosts | |
| InstallerApi | list_infra_envs | GET /v2/infra-envs | |
| InstallerApi | list_of_cluster_operators | GET /v1/clusters/{cluster_id}/monitored_operators | |
| InstallerApi | register_add_hosts_cluster | POST /v1/add_hosts_clusters | |
| InstallerApi | register_cluster | POST /v1/clusters | |
| InstallerApi | register_infra_env | POST /v2/infra-envs | |
| InstallerApi | report_monitored_operator_status | PUT /v1/clusters/{cluster_id}/monitored_operators | |
| InstallerApi | reset_cluster | POST /v1/clusters/{cluster_id}/actions/reset | |
| InstallerApi | reset_host | POST /v1/clusters/{cluster_id}/hosts/{host_id}/actions/reset | |
| InstallerApi | reset_host_validation | PATCH /v1/clusters/{cluster_id}/hosts/{host_id}/actions/reset-validation/{validation_id} | Reset failed host validation. |
| InstallerApi | unbind_host | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/unbind | |
| InstallerApi | update_cluster | PATCH /v1/clusters/{cluster_id} | |
| InstallerApi | update_cluster_install_config | PATCH /v1/clusters/{cluster_id}/install-config | |
| InstallerApi | update_cluster_logs_progress | PUT /v1/clusters/{cluster_id}/logs_progress | |
| InstallerApi | update_discovery_ignition | PATCH /v1/clusters/{cluster_id}/discovery-ignition | |
| InstallerApi | update_host_ignition | PATCH /v1/clusters/{cluster_id}/hosts/{host_id}/ignition | |
| InstallerApi | update_host_install_progress | PUT /v1/clusters/{cluster_id}/hosts/{host_id}/progress | |
| InstallerApi | update_host_installer_args | PATCH /v1/clusters/{cluster_id}/hosts/{host_id}/installer-args | |
| InstallerApi | update_host_logs_progress | PUT /v1/clusters/{cluster_id}/hosts/{host_id}/logs_progress | |
| InstallerApi | update_infra_env | PATCH /v2/infra-envs/{infra_env_id} | |
| InstallerApi | upload_cluster_ingress_cert | POST /v1/clusters/{cluster_id}/uploads/ingress-cert | |
| InstallerApi | upload_host_logs | POST /v1/clusters/{cluster_id}/hosts/{host_id}/logs | |
| InstallerApi | upload_logs | POST /v1/clusters/{cluster_id}/logs | |
| InstallerApi | v2_cancel_installation | POST /v2/clusters/{cluster_id}/actions/cancel | |
| InstallerApi | v2_complete_installation | POST /v2/clusters/{cluster_id}/actions/complete-installation | |
| InstallerApi | v2_deregister_cluster | DELETE /v2/clusters/{cluster_id} | |
| InstallerApi | v2_deregister_host | DELETE /v2/infra-envs/{infra_env_id}/hosts/{host_id} | |
| InstallerApi | v2_download_cluster_credentials | GET /v2/clusters/{cluster_id}/downloads/credentials | |
| InstallerApi | v2_download_cluster_files | GET /v2/clusters/{cluster_id}/downloads/files | |
| InstallerApi | v2_download_cluster_logs | GET /v2/clusters/{cluster_id}/logs | |
| InstallerApi | v2_download_host_ignition | GET /v2/infra-env/{infra_env_id}/hosts/{host_id}/downloads/ignition | |
| InstallerApi | v2_download_infra_env_files | GET /v2/infra-envs/{infra_env_id}/downloads/files | |
| InstallerApi | v2_get_cluster | GET /v2/clusters/{cluster_id} | |
| InstallerApi | v2_get_cluster_default_config | GET /v2/clusters/default-config | |
| InstallerApi | v2_get_cluster_install_config | GET /v2/clusters/{cluster_id}/install-config | |
| InstallerApi | v2_get_credentials | GET /v2/clusters/{cluster_id}/credentials | |
| InstallerApi | v2_get_host | GET /v2/infra-envs/{infra_env_id}/hosts/{host_id} | |
| InstallerApi | v2_get_host_ignition | GET /v2/infra-envs/{infra_env_id}/hosts/{host_id}/ignition | |
| InstallerApi | v2_get_next_steps | GET /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions | |
| InstallerApi | v2_get_preflight_requirements | GET /v2/clusters/{cluster_id}/preflight-requirements | |
| InstallerApi | v2_get_presigned_for_cluster_files | GET /v2/clusters/{cluster_id}/downloads/files-presigned | |
| InstallerApi | v2_install_cluster | POST /v2/clusters/{cluster_id}/actions/install | |
| InstallerApi | v2_install_host | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/install | |
| InstallerApi | v2_list_clusters | GET /v2/clusters | |
| InstallerApi | v2_list_hosts | GET /v2/infra-envs/{infra_env_id}/hosts | |
| InstallerApi | v2_list_of_cluster_operators | GET /v2/clusters/{cluster_id}/monitored-operators | |
| InstallerApi | v2_post_step_reply | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions | |
| InstallerApi | v2_register_cluster | POST /v2/clusters | |
| InstallerApi | v2_register_host | POST /v2/infra-envs/{infra_env_id}/hosts | |
| InstallerApi | v2_report_monitored_operator_status | PUT /v2/clusters/{cluster_id}/monitored-operators | |
| InstallerApi | v2_reset_cluster | POST /v2/clusters/{cluster_id}/actions/reset | |
| InstallerApi | v2_reset_host | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/reset | |
| InstallerApi | v2_reset_host_validation | PATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/actions/reset-validation/{validation_id} | Reset failed host validation. |
| InstallerApi | v2_update_cluster | PATCH /v2/clusters/{cluster_id} | |
| InstallerApi | v2_update_cluster_install_config | PATCH /v2/clusters/{cluster_id}/install-config | |
| InstallerApi | v2_update_cluster_logs_progress | PUT /v2/clusters/{cluster_id}/logs-progress | |
| InstallerApi | v2_update_host | PATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id} | |
| InstallerApi | v2_update_host_ignition | PATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/ignition | |
| InstallerApi | v2_update_host_install_progress | PUT /v2/infra-envs/{infra_env_id}/hosts/{host_id}/progress | |
| InstallerApi | v2_update_host_installer_args | PATCH /v2/infra-envs/{infra_env_id}/hosts/{host_id}/installer-args | |
| InstallerApi | v2_update_host_logs_progress | PUT /v2/infra-envs/{infra_env_id}/hosts/{host_id}/logs-progress | |
| InstallerApi | v2_upload_cluster_ingress_cert | POST /v2/clusters/{cluster_id}/uploads/ingress-cert | |
| InstallerApi | v2_upload_logs | POST /v2/clusters/{cluster_id}/logs | |
| ManagedDomainsApi | list_managed_domains | GET /v1/domains | |
| ManagedDomainsApi | v2_list_managed_domains | GET /v2/domains | |
| ManifestsApi | create_cluster_manifest | POST /v1/clusters/{cluster_id}/manifests | |
| ManifestsApi | delete_cluster_manifest | DELETE /v1/clusters/{cluster_id}/manifests | |
| ManifestsApi | download_cluster_manifest | GET /v1/clusters/{cluster_id}/manifests/files | |
| ManifestsApi | list_cluster_manifests | GET /v1/clusters/{cluster_id}/manifests | |
| ManifestsApi | v2_create_cluster_manifest | POST /v2/clusters/{cluster_id}/manifests | |
| ManifestsApi | v2_delete_cluster_manifest | DELETE /v2/clusters/{cluster_id}/manifests | |
| ManifestsApi | v2_download_cluster_manifest | GET /v2/clusters/{cluster_id}/manifests/files | |
| ManifestsApi | v2_list_cluster_manifests | GET /v2/clusters/{cluster_id}/manifests | |
| OperatorsApi | list_of_cluster_operators | GET /v1/clusters/{cluster_id}/monitored_operators | |
| OperatorsApi | list_operator_properties | GET /v1/supported-operators/{operator_name} | |
| OperatorsApi | list_supported_operators | GET /v1/supported-operators | |
| OperatorsApi | report_monitored_operator_status | PUT /v1/clusters/{cluster_id}/monitored_operators | |
| OperatorsApi | v2_list_of_cluster_operators | GET /v2/clusters/{cluster_id}/monitored-operators | |
| OperatorsApi | v2_list_operator_properties | GET /v2/supported-operators/{operator_name} | |
| OperatorsApi | v2_list_supported_operators | GET /v2/supported-operators | |
| OperatorsApi | v2_report_monitored_operator_status | PUT /v2/clusters/{cluster_id}/monitored-operators | |
| VersionsApi | list_component_versions | GET /v1/component_versions | |
| VersionsApi | list_supported_openshift_versions | GET /v1/openshift_versions | |
| VersionsApi | v2_list_component_versions | GET /v2/component-versions | |
| VersionsApi | v2_list_supported_openshift_versions | GET /v2/openshift-versions |
Documentation For Models
- AddHostsClusterCreateParams
- ApiVipConnectivityRequest
- ApiVipConnectivityResponse
- AssistedServiceIsoCreateParams
- BindHostParams
- Boot
- Cluster
- ClusterCreateParams
- ClusterDefaultConfig
- ClusterHostRequirements
- ClusterHostRequirementsDetails
- ClusterHostRequirementsList
- ClusterList
- ClusterNetwork
- ClusterProgressInfo
- ClusterUpdateParams
- ClusterValidationId
- ClusterupdateparamsDisksSelectedConfig
- ClusterupdateparamsHostsMachineConfigPoolNames
- ClusterupdateparamsHostsNames
- ClusterupdateparamsHostsRoles
- CompletionParams
- ConnectivityCheckHost
- ConnectivityCheckNic
- ConnectivityCheckParams
- ConnectivityRemoteHost
- ConnectivityReport
- ContainerImageAvailability
- ContainerImageAvailabilityRequest
- ContainerImageAvailabilityResponse
- ContainerImageAvailabilityResult
- Cpu
- CreateManifestParams
- Credentials
- DhcpAllocationRequest
- DhcpAllocationResponse
- DiscoveryIgnitionParams
- Disk
- DiskConfigParams
- DiskEncryption
- DiskInfo
- DiskInstallationEligibility
- DiskRole
- DiskSpeed
- DiskSpeedCheckRequest
- DiskSpeedCheckResponse
- DomainResolutionRequest
- DomainResolutionRequestDomains
- DomainResolutionResponse
- DomainResolutionResponseResolutions
- Error
- Event
- EventList
- FreeAddressesList
- FreeAddressesRequest
- FreeNetworkAddresses
- FreeNetworksAddresses
- Gpu
- Host
- HostCreateParams
- HostIgnitionParams
- HostList
- HostNetwork
- HostProgress
- HostProgressInfo
- HostRegistrationResponse
- HostRegistrationResponseNextStepRunnerCommand
- HostRole
- HostRoleUpdateParams
- HostStage
- HostStaticNetworkConfig
- HostTypeHardwareRequirements
- HostTypeHardwareRequirementsWrapper
- HostUpdateParams
- HostValidationId
- ImageCreateParams
- ImageInfo
- ImageType
- InfraEnv
- InfraEnvCreateParams
- InfraEnvList
- InfraEnvUpdateParams
- InfraError
- IngressCertParams
- InstallerArgsParams
- Interface
- Inventory
- IoPerf
- L2Connectivity
- L3Connectivity
- ListManagedDomains
- ListManifests
- ListVersions
- LogsProgressParams
- LogsState
- LogsType
- MacInterfaceMap
- MacInterfaceMapInner
- MachineNetwork
- ManagedDomain
- Manifest
- Memory
- MemoryMethod
- MonitoredOperator
- MonitoredOperatorsList
- NtpSource
- NtpSynchronizationRequest
- NtpSynchronizationResponse
- OpenshiftVersion
- OpenshiftVersions
- OperatorCreateParams
- OperatorHardwareRequirements
- OperatorHostRequirements
- OperatorMonitorReport
- OperatorProperties
- OperatorProperty
- OperatorStatus
- OperatorType
- OsImage
- OsImages
- Platform
- PlatformType
- PreflightHardwareRequirements
- Presigned
- Proxy
- ReleaseImage
- ReleaseImages
- Route
- ServiceNetwork
- SourceState
- Step
- StepReply
- StepType
- Steps
- StepsReply
- Subnet
- SystemVendor
- Usage
- V2ClusterUpdateParams
- VersionedHostRequirements
- Versions
- VspherePlatform
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file assisted-service-client-1.0.26.0.post39.tar.gz.
File metadata
- Download URL: assisted-service-client-1.0.26.0.post39.tar.gz
- Upload date:
- Size: 135.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d463c9baa79c5f4e2131a4ee96ebd3711bace0652cfb744a333b5592ebebd6b8
|
|
| MD5 |
256b352ec606bb0b70260b2a623e6a08
|
|
| BLAKE2b-256 |
52cbc08e8a8783dcdb13bb9d2401c949f64904d5b95efcc6d57aa3d084a7fbab
|
File details
Details for the file assisted_service_client-1.0.26.0.post39-py3-none-any.whl.
File metadata
- Download URL: assisted_service_client-1.0.26.0.post39-py3-none-any.whl
- Upload date:
- Size: 365.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa096921b30c77a7b5396f38887542b48aef8ce7237e0e8f6d107c7fb7f8236c
|
|
| MD5 |
d859a2b7ec20f554cad4ac86d0648e28
|
|
| BLAKE2b-256 |
5bee4a5bbdf7871949800308ba95da4ce17813568f56a3f24f36c540d9e5de6f
|
