ibm_cloud_power
IbmCloudPower - the Ruby gem for the Power Cloud API
IBM Power Cloud API for Power Hardware / Infrastructure
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 For more information, please visit https://github.ibm.com/power-iaas
Installation
Build a gem
To build the Ruby code into a gem:
gem build ibm_cloud_power.gemspec
Then either install the gem locally:
gem install ./ibm_cloud_power-1.0.0.gem
(for development, run gem install --dev ./ibm_cloud_power-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 'ibm_cloud_power', '~> 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 'ibm_cloud_power', :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 'ibm_cloud_power'
api_instance = IbmCloudPower::PCloudEventsApi.new
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
event_id = 'event_id_example' # String | Event ID
opts = {
accept_language: 'accept_language_example' # String | The language requested for the return document
}
begin
#Get a single event
result = api_instance.pcloud_events_get(cloud_instance_id, event_id, opts)
p result
rescue IbmCloudPower::ApiError => e
puts "Exception when calling PCloudEventsApi->pcloud_events_get: #{e}"
end
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| IbmCloudPower::PCloudEventsApi | pcloud_events_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/events/event_id | Get a single event |
| IbmCloudPower::PCloudEventsApi | pcloud_events_getsince | GET /pcloud/v1/cloud-instances/cloud_instance_id/events | Get events from this cloud instance since a specific timestamp |
| IbmCloudPower::PCloudImagesApi | pcloud_cloudinstances_images_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/images/image_id | Delete an image from a cloud instance |
| IbmCloudPower::PCloudImagesApi | pcloud_cloudinstances_images_export_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/images/image_id/export | Export an image |
| IbmCloudPower::PCloudImagesApi | pcloud_cloudinstances_images_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/images/image_id | Detailed information of an image |
| IbmCloudPower::PCloudImagesApi | pcloud_cloudinstances_images_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/images | List all of the images for this cloud instance |
| IbmCloudPower::PCloudImagesApi | pcloud_cloudinstances_images_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/images | Create a new image from available images |
| IbmCloudPower::PCloudImagesApi | pcloud_images_get | GET /pcloud/v1/images/image_id | Detailed information of an available image |
| IbmCloudPower::PCloudImagesApi | pcloud_images_getall | GET /pcloud/v1/images | List all images available for copying into cloud instances |
| IbmCloudPower::PCloudInstancesApi | pcloud_cloudinstances_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id | Delete a Power Cloud instance |
| IbmCloudPower::PCloudInstancesApi | pcloud_cloudinstances_get | GET /pcloud/v1/cloud-instances/cloud_instance_id | Get a cloud instance's current state or information |
| IbmCloudPower::PCloudInstancesApi | pcloud_cloudinstances_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id | Update or upgrade a cloud instance |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id | Delete a network |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id | Get a network's current state or information |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/networks | Get all networks in this cloud instance |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_ports_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id/ports/port_id | Delete a network port |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_ports_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id/ports/port_id | Get a port's information |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_ports_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id/ports | Get all ports for this network |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_ports_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id/ports | Perform port addition, deletion, and listing |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_ports_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id/ports/port_id | Update a port's information |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/networks | Create a new network |
| IbmCloudPower::PCloudNetworksApi | pcloud_networks_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/networks/network_id | Update a network |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_action_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/action | Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_capture_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/capture | Capture a PVM instance and create a deployable image |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_console_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/console | Generate the noVNC console URL |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id | Delete a PCloud PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id | Get a PVM instance's current state or information |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances | Get all the PVM instances for this cloud instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_networks_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/networks/network_id | Remove all addresses of network from a PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_networks_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/networks/network_id | Get a PVM instance's network information |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_networks_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/networks | Get all networks for this PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_networks_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/networks | Perform network addition, deletion, and listing |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_operations_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/operations | Perform an operation on a PVMInstance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances | Create a new PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id | Update a PCloud PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_snapshots_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/snapshots | Get all snapshots for this PVM instance |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_snapshots_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/snapshots | Create a PVM instance snapshot |
| IbmCloudPower::PCloudPVMInstancesApi | pcloud_pvminstances_snapshots_restore_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/snapshots/snapshot_id/restore | Restore a PVM Instance snapshot |
| IbmCloudPower::PCloudSAPApi | pcloud_sap_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/sap/sap_profile_id | Get the information on an SAP profile |
| IbmCloudPower::PCloudSAPApi | pcloud_sap_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/sap | Get list of SAP profiles |
| IbmCloudPower::PCloudSAPApi | pcloud_sap_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/sap | Create a new SAP PVM Instance |
| IbmCloudPower::PCloudSnapshotsApi | pcloud_cloudinstances_snapshots_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/snapshots/snapshot_id | Delete a PVM instance snapshot of a cloud instance |
| IbmCloudPower::PCloudSnapshotsApi | pcloud_cloudinstances_snapshots_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/snapshots/snapshot_id | Get the detail of a snapshot |
| IbmCloudPower::PCloudSnapshotsApi | pcloud_cloudinstances_snapshots_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/snapshots | List all PVM instance snapshots for this cloud instance |
| IbmCloudPower::PCloudSnapshotsApi | pcloud_cloudinstances_snapshots_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/snapshots/snapshot_id | Update a PVM instance snapshot |
| IbmCloudPower::PCloudSystemPoolsApi | pcloud_systempools_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/system-pools | List of available system pools within a particular data center |
| IbmCloudPower::PCloudTasksApi | pcloud_tasks_delete | DELETE /pcloud/v1/tasks/task_id | Delete a task |
| IbmCloudPower::PCloudTasksApi | pcloud_tasks_get | GET /pcloud/v1/tasks/task_id | Get a task |
| IbmCloudPower::PCloudTenantsApi | pcloud_tenants_get | GET /pcloud/v1/tenants/tenant_id | Get a tenant's current state or information |
| IbmCloudPower::PCloudTenantsApi | pcloud_tenants_put | PUT /pcloud/v1/tenants/tenant_id | Update a tenant |
| IbmCloudPower::PCloudTenantsSSHKeysApi | pcloud_tenants_sshkeys_delete | DELETE /pcloud/v1/tenants/tenant_id/sshkeys/sshkey_name | Delete a tenant's SSH key |
| IbmCloudPower::PCloudTenantsSSHKeysApi | pcloud_tenants_sshkeys_get | GET /pcloud/v1/tenants/tenant_id/sshkeys/sshkey_name | Get a tenant's SSH Key by name |
| IbmCloudPower::PCloudTenantsSSHKeysApi | pcloud_tenants_sshkeys_getall | GET /pcloud/v1/tenants/tenant_id/sshkeys | List a tenant's SSH Keys |
| IbmCloudPower::PCloudTenantsSSHKeysApi | pcloud_tenants_sshkeys_post | POST /pcloud/v1/tenants/tenant_id/sshkeys | Add a new SSH key to the tenant |
| IbmCloudPower::PCloudTenantsSSHKeysApi | pcloud_tenants_sshkeys_put | PUT /pcloud/v1/tenants/tenant_id/sshkeys/sshkey_name | Update an SSH Key |
| IbmCloudPower::PCloudVolumesApi | pcloud_cloudinstances_volumes_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id | Delete a cloud instance volume |
| IbmCloudPower::PCloudVolumesApi | pcloud_cloudinstances_volumes_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id | Detailed information of a volume |
| IbmCloudPower::PCloudVolumesApi | pcloud_cloudinstances_volumes_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes | List all volumes for this cloud instance |
| IbmCloudPower::PCloudVolumesApi | pcloud_cloudinstances_volumes_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/volumes | Create a new data volume |
| IbmCloudPower::PCloudVolumesApi | pcloud_cloudinstances_volumes_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id | Update a cloud instance volume |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_delete | DELETE /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id | Detach a volume from a PVM Instance |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_get | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id | Detailed information of a volume attached to a PVM Instance |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_getall | GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes | List all volumes attached to a PVM Instance |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id | Attach a volume to a PVM Instance |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id | Update a volume attached to a PVMInstance |
| IbmCloudPower::PCloudVolumesApi | pcloud_pvminstances_volumes_setboot_put | PUT /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id/setboot | Set the PVMInstance volume as the boot volume |
| IbmCloudPower::PCloudVolumesApi | pcloud_v2_volumes_clone_post | POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes/clone | Create a volume clone for specified volumes (version 2) |
| IbmCloudPower::PCloudVolumesApi | pcloud_v2_volumes_clonetasks_get | GET /pcloud/v2/cloud-instances/cloud_instance_id/volumes/clone-tasks/clone_task_id | Get the status of a volume clone request for the specified clone task ID |
| IbmCloudPower::PCloudVolumesApi | pcloud_v2_volumes_post | POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes | Create multiple data volumes from a single definition |
| IbmCloudPower::PCloudVolumesApi | pcloud_volumes_clone_post | POST /pcloud/v1/cloud-instances/cloud_instance_id/volumes/clone | Create a volume clone for specified volumes (version 1 - depricated) |
Documentation for Models
- IbmCloudPower::CloneTaskReference
- IbmCloudPower::CloneTaskStatus
- IbmCloudPower::ClonedVolume
- IbmCloudPower::ClonedVolumeDetail
- IbmCloudPower::CloudInstance
- IbmCloudPower::CloudInstanceCreate
- IbmCloudPower::CloudInstanceReference
- IbmCloudPower::CloudInstanceUpdate
- IbmCloudPower::CloudInstanceUsageLimits
- IbmCloudPower::CreateDataVolume
- IbmCloudPower::CreateImage
- IbmCloudPower::Error
- IbmCloudPower::Event
- IbmCloudPower::EventUser
- IbmCloudPower::Events
- IbmCloudPower::ExportImage
- IbmCloudPower::IPAddressRange
- IbmCloudPower::Image
- IbmCloudPower::ImageReference
- IbmCloudPower::ImageSpecifications
- IbmCloudPower::ImageVolume
- IbmCloudPower::Images
- IbmCloudPower::MinMaxDefault
- IbmCloudPower::MultiVolumesCreate
- IbmCloudPower::Network
- IbmCloudPower::NetworkCreate
- IbmCloudPower::NetworkIpAddressMetrics
- IbmCloudPower::NetworkPort
- IbmCloudPower::NetworkPortCreate
- IbmCloudPower::NetworkPortPvmInstance
- IbmCloudPower::NetworkPortUpdate
- IbmCloudPower::NetworkPorts
- IbmCloudPower::NetworkReference
- IbmCloudPower::NetworkUpdate
- IbmCloudPower::Networks
- IbmCloudPower::Operations
- IbmCloudPower::PVMInstance
- IbmCloudPower::PVMInstanceAction
- IbmCloudPower::PVMInstanceAddNetwork
- IbmCloudPower::PVMInstanceCapture
- IbmCloudPower::PVMInstanceClone
- IbmCloudPower::PVMInstanceConsole
- IbmCloudPower::PVMInstanceCreate
- IbmCloudPower::PVMInstanceFault
- IbmCloudPower::PVMInstanceHealth
- IbmCloudPower::PVMInstanceMultiCreate
- IbmCloudPower::PVMInstanceNetwork
- IbmCloudPower::PVMInstanceNetworks
- IbmCloudPower::PVMInstanceOperation
- IbmCloudPower::PVMInstanceReference
- IbmCloudPower::PVMInstanceRemoveNetwork
- IbmCloudPower::PVMInstanceUpdate
- IbmCloudPower::PVMInstanceUpdateResponse
- IbmCloudPower::PVMInstanceVolumeUpdate
- IbmCloudPower::PVMInstances
- IbmCloudPower::PeeringNetwork
- IbmCloudPower::PinPolicy
- IbmCloudPower::SAPCreate
- IbmCloudPower::SAPProfile
- IbmCloudPower::SAPProfileReference
- IbmCloudPower::SAPProfiles
- IbmCloudPower::SRC
- IbmCloudPower::SSHKey
- IbmCloudPower::SSHKeys
- IbmCloudPower::Snapshot
- IbmCloudPower::SnapshotCreate
- IbmCloudPower::SnapshotCreateResponse
- IbmCloudPower::SnapshotRestore
- IbmCloudPower::SnapshotUpdate
- IbmCloudPower::Snapshots
- IbmCloudPower::SoftwareLicenses
- IbmCloudPower::StockImage
- IbmCloudPower::System
- IbmCloudPower::SystemPool
- IbmCloudPower::Task
- IbmCloudPower::TaskReference
- IbmCloudPower::Tenant
- IbmCloudPower::TenantUpdate
- IbmCloudPower::UpdateVolume
- IbmCloudPower::VirtualCores
- IbmCloudPower::Volume
- IbmCloudPower::VolumeInfo
- IbmCloudPower::VolumeReference
- IbmCloudPower::Volumes
- IbmCloudPower::VolumesClone
- IbmCloudPower::VolumesCloneAsyncRequest
- IbmCloudPower::VolumesCloneCancel
- IbmCloudPower::VolumesCloneCreate
- IbmCloudPower::VolumesCloneDetail
- IbmCloudPower::VolumesCloneExecute
- IbmCloudPower::VolumesCloneRequest
- IbmCloudPower::VolumesCloneResponse
- IbmCloudPower::VolumesClones
Documentation for Authorization
All endpoints do not require authorization.