autosde_openapi_client
AutosdeOpenapiClient - the Ruby gem for the Site Manager API
Site Manager API
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build autosde_openapi_client.gemspec
Then either install the gem locally:
gem install ./autosde_openapi_client-1.0.0.gem
(for development, run gem install --dev ./autosde_openapi_client-1.0.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'autosde_openapi_client', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'autosde_openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'autosde_openapi_client'
# Setup authorization
AutosdeOpenapiClient.configure do |config|
# Configure Bearer authorization: bearerAuth
config.access_token = 'YOUR_BEARER_TOKEN'
end
api_instance = AutosdeOpenapiClient::AbstractCapabilityApi.new
begin
result = api_instance.abstract_capabilities_get
p result
rescue AutosdeOpenapiClient::ApiError => e
puts "Exception when calling AbstractCapabilityApi->abstract_capabilities_get: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://localhost:9000/site-manager/api/v1/engine
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AutosdeOpenapiClient::AbstractCapabilityApi | abstract_capabilities_get | GET /abstract-capabilities | |
| AutosdeOpenapiClient::AbstractCapabilityApi | abstract_capabilities_pk_delete | DELETE /abstract-capabilities/pk | |
| AutosdeOpenapiClient::AbstractCapabilityApi | abstract_capabilities_pk_get | GET /abstract-capabilities/pk | |
| AutosdeOpenapiClient::AbstractCapabilityApi | abstract_capabilities_post | POST /abstract-capabilities | |
| AutosdeOpenapiClient::AccountApi | accounts_get | GET /accounts | |
| AutosdeOpenapiClient::AccountApi | accounts_pk_delete | DELETE /accounts/pk | |
| AutosdeOpenapiClient::AccountApi | accounts_pk_get | GET /accounts/pk | |
| AutosdeOpenapiClient::AccountApi | accounts_pk_put | PUT /accounts/pk | |
| AutosdeOpenapiClient::AccountApi | accounts_post | POST /accounts | |
| AutosdeOpenapiClient::AddressApi | addresses_get | GET /addresses | |
| AutosdeOpenapiClient::AddressApi | addresses_pk_delete | DELETE /addresses/pk | |
| AutosdeOpenapiClient::AddressApi | addresses_pk_get | GET /addresses/pk | |
| AutosdeOpenapiClient::AddressApi | addresses_post | POST /addresses | |
| AutosdeOpenapiClient::AuthenticationApi | token_auth_post | POST /token-auth | |
| AutosdeOpenapiClient::AutoSDEProjectApi | autosde_projects_get | GET /autosde-projects | |
| AutosdeOpenapiClient::AutoSDEProjectApi | autosde_projects_pk_delete | DELETE /autosde-projects/pk | |
| AutosdeOpenapiClient::AutoSDEProjectApi | autosde_projects_pk_get | GET /autosde-projects/pk | |
| AutosdeOpenapiClient::AutoSDEProjectApi | autosde_projects_post | POST /autosde-projects | |
| AutosdeOpenapiClient::AutoSDERoleApi | autosde_roles_get | GET /autosde-roles | |
| AutosdeOpenapiClient::AutoSDERoleApi | autosde_roles_pk_delete | DELETE /autosde-roles/pk | |
| AutosdeOpenapiClient::AutoSDERoleApi | autosde_roles_pk_get | GET /autosde-roles/pk | |
| AutosdeOpenapiClient::AutoSDERoleApi | autosde_roles_post | POST /autosde-roles | |
| AutosdeOpenapiClient::CapabilityTranslationApi | capability_translations_get | GET /capability-translations | |
| AutosdeOpenapiClient::CapabilityTranslationApi | capability_translations_pk_delete | DELETE /capability-translations/pk | |
| AutosdeOpenapiClient::CapabilityTranslationApi | capability_translations_pk_get | GET /capability-translations/pk | |
| AutosdeOpenapiClient::CapabilityTranslationApi | capability_translations_post | POST /capability-translations | |
| AutosdeOpenapiClient::CeleryConfigApi | celery_config_get | GET /celery-config | |
| AutosdeOpenapiClient::CeleryConfigApi | celery_config_post | POST /celery-config | |
| AutosdeOpenapiClient::EventApi | events_get | GET /events | |
| AutosdeOpenapiClient::EventApi | events_pk_delete | DELETE /events/pk | |
| AutosdeOpenapiClient::EventApi | events_pk_get | GET /events/pk | |
| AutosdeOpenapiClient::EventApi | events_post | POST /events | |
| AutosdeOpenapiClient::HostApi | hosts_get | GET /hosts | |
| AutosdeOpenapiClient::HostApi | hosts_pk_delete | DELETE /hosts/pk | |
| AutosdeOpenapiClient::HostApi | hosts_pk_get | GET /hosts/pk | |
| AutosdeOpenapiClient::HostApi | hosts_post | POST /hosts | |
| AutosdeOpenapiClient::HostClusterApi | host_clusters_get | GET /host-clusters | |
| AutosdeOpenapiClient::HostClusterApi | host_clusters_pk_delete | DELETE /host-clusters/pk | |
| AutosdeOpenapiClient::HostClusterApi | host_clusters_pk_get | GET /host-clusters/pk | |
| AutosdeOpenapiClient::HostClusterApi | host_clusters_pk_put | PUT /host-clusters/pk | |
| AutosdeOpenapiClient::HostClusterApi | host_clusters_post | POST /host-clusters | |
| AutosdeOpenapiClient::HostClusterMembershipApi | host_cluster_membership_get | GET /host-cluster-membership | |
| AutosdeOpenapiClient::HostClusterMembershipApi | host_cluster_membership_pk_delete | DELETE /host-cluster-membership/pk | |
| AutosdeOpenapiClient::HostClusterMembershipApi | host_cluster_membership_pk_get | GET /host-cluster-membership/pk | |
| AutosdeOpenapiClient::HostClusterMembershipApi | host_cluster_membership_post | POST /host-cluster-membership | |
| AutosdeOpenapiClient::HostClusterVolumeMappingApi | host_clusters_mapping_get | GET /host-clusters-mapping | |
| AutosdeOpenapiClient::HostClusterVolumeMappingApi | host_clusters_mapping_pk_delete | DELETE /host-clusters-mapping/pk | |
| AutosdeOpenapiClient::HostClusterVolumeMappingApi | host_clusters_mapping_pk_get | GET /host-clusters-mapping/pk | |
| AutosdeOpenapiClient::HostClusterVolumeMappingApi | host_clusters_mapping_post | POST /host-clusters-mapping | |
| AutosdeOpenapiClient::HostVolumeConnectionApi | host_volume_connection_get | GET /host-volume-connection | |
| AutosdeOpenapiClient::HostVolumeConnectionApi | host_volume_connection_pk_delete | DELETE /host-volume-connection/pk | |
| AutosdeOpenapiClient::HostVolumeConnectionApi | host_volume_connection_pk_get | GET /host-volume-connection/pk | |
| AutosdeOpenapiClient::HostVolumeConnectionApi | host_volume_connection_post | POST /host-volume-connection | |
| AutosdeOpenapiClient::JobApi | jobs_get | GET /jobs | |
| AutosdeOpenapiClient::JobApi | jobs_pk_delete | DELETE /jobs/pk | |
| AutosdeOpenapiClient::JobApi | jobs_pk_get | GET /jobs/pk | |
| AutosdeOpenapiClient::JobApi | jobs_post | POST /jobs | |
| AutosdeOpenapiClient::NativeCapabilityApi | native_capabilities_get | GET /native-capabilities | |
| AutosdeOpenapiClient::NativeCapabilityApi | native_capabilities_pk_delete | DELETE /native-capabilities/pk | |
| AutosdeOpenapiClient::NativeCapabilityApi | native_capabilities_pk_get | GET /native-capabilities/pk | |
| AutosdeOpenapiClient::NativeCapabilityApi | native_capabilities_post | POST /native-capabilities | |
| AutosdeOpenapiClient::ProfileApi | profiles_get | GET /profiles | |
| AutosdeOpenapiClient::ProfileApi | profiles_pk_delete | DELETE /profiles/pk | |
| AutosdeOpenapiClient::ProfileApi | profiles_pk_get | GET /profiles/pk | |
| AutosdeOpenapiClient::ProfileApi | profiles_post | POST /profiles | |
| AutosdeOpenapiClient::ProvisioningStrategyApi | provisioning_strategy_get | GET /provisioning-strategy | |
| AutosdeOpenapiClient::ProvisioningStrategyApi | provisioning_strategy_pk_delete | DELETE /provisioning-strategy/pk | |
| AutosdeOpenapiClient::ProvisioningStrategyApi | provisioning_strategy_pk_get | GET /provisioning-strategy/pk | |
| AutosdeOpenapiClient::ProvisioningStrategyApi | provisioning_strategy_post | POST /provisioning-strategy | |
| AutosdeOpenapiClient::RefreshSystemApi | refresh_system_post | POST /refresh-system | |
| AutosdeOpenapiClient::ServiceApi | services_get | GET /services | |
| AutosdeOpenapiClient::ServiceApi | services_pk_delete | DELETE /services/pk | |
| AutosdeOpenapiClient::ServiceApi | services_pk_get | GET /services/pk | |
| AutosdeOpenapiClient::ServiceApi | services_pk_put | PUT /services/pk | |
| AutosdeOpenapiClient::ServiceApi | services_post | POST /services | |
| AutosdeOpenapiClient::ServiceAbstractCapabilityValueApi | service_abstract_capability_values_get | GET /service-abstract-capability-values | |
| AutosdeOpenapiClient::ServiceAbstractCapabilityValueApi | service_abstract_capability_values_pk_delete | DELETE /service-abstract-capability-values/pk | |
| AutosdeOpenapiClient::ServiceAbstractCapabilityValueApi | service_abstract_capability_values_pk_get | GET /service-abstract-capability-values/pk | |
| AutosdeOpenapiClient::ServiceAbstractCapabilityValueApi | service_abstract_capability_values_post | POST /service-abstract-capability-values | |
| AutosdeOpenapiClient::ServiceResourceAttachmentApi | service_resource_attachment_get | GET /service-resource-attachment | |
| AutosdeOpenapiClient::ServiceResourceAttachmentApi | service_resource_attachment_pk_delete | DELETE /service-resource-attachment/pk | |
| AutosdeOpenapiClient::ServiceResourceAttachmentApi | service_resource_attachment_pk_get | GET /service-resource-attachment/pk | |
| AutosdeOpenapiClient::ServiceResourceAttachmentApi | service_resource_attachment_post | POST /service-resource-attachment | |
| AutosdeOpenapiClient::SnapshotApi | snapshots_get | GET /snapshots | |
| AutosdeOpenapiClient::SnapshotApi | snapshots_pk_delete | DELETE /snapshots/pk | |
| AutosdeOpenapiClient::SnapshotApi | snapshots_pk_get | GET /snapshots/pk | |
| AutosdeOpenapiClient::SnapshotApi | snapshots_post | POST /snapshots | |
| AutosdeOpenapiClient::StorageHostApi | storage_hosts_get | GET /storage-hosts | |
| AutosdeOpenapiClient::StorageHostApi | storage_hosts_pk_delete | DELETE /storage-hosts/pk | |
| AutosdeOpenapiClient::StorageHostApi | storage_hosts_pk_get | GET /storage-hosts/pk | |
| AutosdeOpenapiClient::StorageHostApi | storage_hosts_pk_put | PUT /storage-hosts/pk | |
| AutosdeOpenapiClient::StorageHostApi | storage_hosts_post | POST /storage-hosts | |
| AutosdeOpenapiClient::StorageHostWWPNCandidatesApi | storage_hosts_wwpn_candidates_get | GET /storage-hosts-wwpn-candidates | |
| AutosdeOpenapiClient::StorageHostsMappingApi | storage_hosts_mapping_get | GET /storage-hosts-mapping | |
| AutosdeOpenapiClient::StorageHostsMappingApi | storage_hosts_mapping_pk_delete | DELETE /storage-hosts-mapping/pk | |
| AutosdeOpenapiClient::StorageHostsMappingApi | storage_hosts_mapping_pk_get | GET /storage-hosts-mapping/pk | |
| AutosdeOpenapiClient::StorageHostsMappingApi | storage_hosts_mapping_post | POST /storage-hosts-mapping | |
| AutosdeOpenapiClient::StorageResourceApi | storage_resources_get | GET /storage-resources | |
| AutosdeOpenapiClient::StorageResourceApi | storage_resources_pk_delete | DELETE /storage-resources/pk | |
| AutosdeOpenapiClient::StorageResourceApi | storage_resources_pk_get | GET /storage-resources/pk | |
| AutosdeOpenapiClient::StorageResourceApi | storage_resources_pk_put | PUT /storage-resources/pk | |
| AutosdeOpenapiClient::StorageResourceApi | storage_resources_post | POST /storage-resources | |
| AutosdeOpenapiClient::StorageSystemApi | storage_systems_get | GET /storage-systems | |
| AutosdeOpenapiClient::StorageSystemApi | storage_systems_pk_delete | DELETE /storage-systems/pk | |
| AutosdeOpenapiClient::StorageSystemApi | storage_systems_pk_get | GET /storage-systems/pk | |
| AutosdeOpenapiClient::StorageSystemApi | storage_systems_pk_put | PUT /storage-systems/pk | |
| AutosdeOpenapiClient::StorageSystemApi | storage_systems_post | POST /storage-systems | |
| AutosdeOpenapiClient::SystemTypeApi | system_types_get | GET /system-types | |
| AutosdeOpenapiClient::SystemTypeApi | system_types_pk_delete | DELETE /system-types/pk | |
| AutosdeOpenapiClient::SystemTypeApi | system_types_pk_get | GET /system-types/pk | |
| AutosdeOpenapiClient::SystemTypeApi | system_types_post | POST /system-types | |
| AutosdeOpenapiClient::UserApi | autosde_users_get | GET /autosde-users | |
| AutosdeOpenapiClient::UserApi | autosde_users_pk_delete | DELETE /autosde-users/pk | |
| AutosdeOpenapiClient::UserApi | autosde_users_pk_get | GET /autosde-users/pk | |
| AutosdeOpenapiClient::UserApi | autosde_users_pk_put | PUT /autosde-users/pk | |
| AutosdeOpenapiClient::UserApi | autosde_users_post | POST /autosde-users | |
| AutosdeOpenapiClient::ValidateSystemApi | validate_system_post | POST /validate-system | |
| AutosdeOpenapiClient::VolumeApi | volumes_get | GET /volumes | |
| AutosdeOpenapiClient::VolumeApi | volumes_pk_delete | DELETE /volumes/pk | |
| AutosdeOpenapiClient::VolumeApi | volumes_pk_get | GET /volumes/pk | |
| AutosdeOpenapiClient::VolumeApi | volumes_pk_put | PUT /volumes/pk | |
| AutosdeOpenapiClient::VolumeApi | volumes_post | POST /volumes | |
| AutosdeOpenapiClient::VolumeCloneApi | volume_clone_post | POST /volume-clone | |
| AutosdeOpenapiClient::VolumeMigrationApi | volume_migration_post | POST /volume-migration |
Documentation for Models
- AutosdeOpenapiClient::AbstractCapability
- AutosdeOpenapiClient::AbstractCapabilityResponse
- AutosdeOpenapiClient::Account
- AutosdeOpenapiClient::AccountPostRequest
- AutosdeOpenapiClient::AccountPostResponse
- AutosdeOpenapiClient::Address
- AutosdeOpenapiClient::AddressCreate
- AutosdeOpenapiClient::AsyncResponse
- AutosdeOpenapiClient::AuthResponse
- AutosdeOpenapiClient::Authentication
- AutosdeOpenapiClient::AutoSDEProject
- AutosdeOpenapiClient::AutoSDERole
- AutosdeOpenapiClient::CapabilityTranslation
- AutosdeOpenapiClient::CapabilityTranslationCreate
- AutosdeOpenapiClient::CeleryConfig
- AutosdeOpenapiClient::Event
- AutosdeOpenapiClient::EventResponse
- AutosdeOpenapiClient::Host
- AutosdeOpenapiClient::HostCluster
- AutosdeOpenapiClient::HostClusterCreate
- AutosdeOpenapiClient::HostClusterMembership
- AutosdeOpenapiClient::HostClusterResponse
- AutosdeOpenapiClient::HostClusterUpdate
- AutosdeOpenapiClient::HostClusterVolumeMapping
- AutosdeOpenapiClient::HostClusterVolumeMappingCreate
- AutosdeOpenapiClient::HostClusterVolumeMappingResponse
- AutosdeOpenapiClient::HostCreate
- AutosdeOpenapiClient::HostVolumeConnection
- AutosdeOpenapiClient::HostVolumeConnectionCreate
- AutosdeOpenapiClient::Job
- AutosdeOpenapiClient::JobCreate
- AutosdeOpenapiClient::JobResponse
- AutosdeOpenapiClient::NativeCapability
- AutosdeOpenapiClient::Profile
- AutosdeOpenapiClient::ProvisioningStrategy
- AutosdeOpenapiClient::RefreshSystem
- AutosdeOpenapiClient::Service
- AutosdeOpenapiClient::ServiceAbstractCapabilityValue
- AutosdeOpenapiClient::ServiceAbstractCapabilityValueResponse
- AutosdeOpenapiClient::ServiceCreate
- AutosdeOpenapiClient::ServiceResourceAttachment
- AutosdeOpenapiClient::ServiceResourceAttachmentResponse
- AutosdeOpenapiClient::ServiceResponse
- AutosdeOpenapiClient::ServiceUpdate
- AutosdeOpenapiClient::Snapshot
- AutosdeOpenapiClient::SnapshotCreate
- AutosdeOpenapiClient::SnapshotResponse
- AutosdeOpenapiClient::StorageHost
- AutosdeOpenapiClient::StorageHostCreate
- AutosdeOpenapiClient::StorageHostResponse
- AutosdeOpenapiClient::StorageHostUpdate
- AutosdeOpenapiClient::StorageHostWWPNCandidates
- AutosdeOpenapiClient::StorageHostsMapping
- AutosdeOpenapiClient::StorageHostsMappingCreate
- AutosdeOpenapiClient::StorageHostsMappingResponse
- AutosdeOpenapiClient::StorageResource
- AutosdeOpenapiClient::StorageResourceCreate
- AutosdeOpenapiClient::StorageResourceResponse
- AutosdeOpenapiClient::StorageResourceUpdate
- AutosdeOpenapiClient::StorageSystem
- AutosdeOpenapiClient::StorageSystemCreate
- AutosdeOpenapiClient::StorageSystemResponse
- AutosdeOpenapiClient::StorageSystemUpdate
- AutosdeOpenapiClient::SystemType
- AutosdeOpenapiClient::SystemTypeCreate
- AutosdeOpenapiClient::SystemTypeResponse
- AutosdeOpenapiClient::User
- AutosdeOpenapiClient::UserCreate
- AutosdeOpenapiClient::UserUpdate
- AutosdeOpenapiClient::ValidateSystem
- AutosdeOpenapiClient::ValidateSystemData
- AutosdeOpenapiClient::Volume
- AutosdeOpenapiClient::VolumeClone
- AutosdeOpenapiClient::VolumeCreate
- AutosdeOpenapiClient::VolumeMigration
- AutosdeOpenapiClient::VolumeResponse
- AutosdeOpenapiClient::VolumeUpdate
Documentation for Authorization
bearerAuth
- Type: Bearer authentication