# 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 | |
| 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 | 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 | 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_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_next_steps | GET /v1/clusters/{cluster_id}/hosts/{host_id}/instructions | |
| 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_of_cluster_operators | GET /v1/clusters/{cluster_id}/monitored_operators | |
| InstallerApi | post_step_reply | POST /v1/clusters/{cluster_id}/hosts/{host_id}/instructions | |
| InstallerApi | register_add_hosts_cluster | POST /v1/add_hosts_clusters | |
| InstallerApi | register_cluster | POST /v1/clusters | |
| InstallerApi | register_host | POST /v1/clusters/{cluster_id}/hosts | |
| 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 | 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 | 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_get_host | GET /v2/infra-envs/{infra_env_id}/hosts/{host_id} | |
| InstallerApi | v2_get_next_steps | GET /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions | |
| InstallerApi | v2_post_step_reply | POST /v2/infra-envs/{infra_env_id}/hosts/{host_id}/instructions | |
| InstallerApi | v2_register_host | POST /v2/infra-envs/{infra_env_id}/hosts | |
| InstallerApi | v2_register_infra_env | POST /v2/infra-envs | |
| ManagedDomainsApi | list_managed_domains | GET /v1/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 | |
| 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 | |
| VersionsApi | list_component_versions | GET /v1/component_versions | |
| VersionsApi | list_supported_openshift_versions | GET /v1/openshift_versions |
Documentation For Models
- AddHostsClusterCreateParams
- ApiVipConnectivityRequest
- ApiVipConnectivityResponse
- AssistedServiceIsoCreateParams
- 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
- 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
- HostValidationId
- ImageCreateParams
- ImageInfo
- ImageType
- InfraEnv
- InfraEnvList
- InfraError
- InfraenvCreateParams
- IngressCertParams
- InstallerArgsParams
- Interface
- Inventory
- IoPerf
- L2Connectivity
- L3Connectivity
- ListManagedDomains
- ListManifests
- ListVersions
- LogsProgressParams
- LogsState
- LogsType
- MacInterfaceMap
- MacInterfaceMapInner
- MachineNetwork
- ManagedDomain
- Manifest
- Memory
- MonitoredOperator
- MonitoredOperatorsList
- NetworkConfiguration
- NtpSource
- NtpSynchronizationRequest
- NtpSynchronizationResponse
- OpenshiftVersion
- OpenshiftVersions
- OperatorCreateParams
- OperatorHardwareRequirements
- OperatorHostRequirements
- OperatorMonitorReport
- OperatorProperties
- OperatorProperty
- OperatorStatus
- OperatorType
- Platform
- PlatformType
- PreflightHardwareRequirements
- Presigned
- Proxy
- Route
- ServiceNetwork
- SourceState
- Step
- StepReply
- StepType
- Steps
- StepsReply
- Subnet
- SystemVendor
- Usage
- 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
Release files for assisted-service-client 1.0.23.2.post39
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| assisted-service-client-1.0.23.2.post39.tar.gz | 111.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| assisted_service_client-1.0.23.2.post39-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 441.3 kB
Release files / assisted-service-client-1.0.23.2.post39.tar.gz
| Download URL | assisted-service-client-1.0.23.2.post39.tar.gz |
|---|---|
| Size | 111.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03423a745663082caa82ef5ca35a2161184f0ab0d5726d2038da5a3d0e5f0094
|
|
BLAKE2b-256 checksum How to use checksums |
497ecd82130ef0aeb9fbb3ef4c84017fb60cbb4e73deb683dd52f06bc5bbad5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8
|
Release files / assisted_service_client-1.0.23.2.post39-py3-none-any.whl
| Download URL | assisted_service_client-1.0.23.2.post39-py3-none-any.whl |
|---|---|
| Size | 329.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e895c347d08ea624fc91fab6229c5309caee8289ffafbca21dfa2098a2fe8c22
|
|
BLAKE2b-256 checksum How to use checksums |
65ef60cdc685dd4b71b51b1281322115c73e6b203fcce97f18399ee94d1ec27a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.8
|