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: 2.3.1
  • 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::DatacentersApi.new
datacenter_region = 'datacenter_region_example' # String | Datacenter Region

begin
  #Get a Datacenter's information and capabilities
  result = api_instance.v1_datacenters_get(datacenter_region)
  p result
rescue IbmCloudPower::ApiError => e
  puts "Exception when calling DatacentersApi->v1_datacenters_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
IbmCloudPower::DatacentersApi v1_datacenters_get GET /v1/datacenters/datacenter_region Get a Datacenter's information and capabilities
IbmCloudPower::DatacentersApi v1_datacenters_getall GET /v1/datacenters Get all Datacenters information and capabilities
IbmCloudPower::DatacentersApi v1_datacenters_private_get GET /v1/datacenters/private/datacenter_region Get a private Datacenter's information and capabilities
IbmCloudPower::DatacentersApi v1_datacenters_private_getall GET /v1/datacenters/private Get private Datacenter information and capabilities
IbmCloudPower::HostGroupsApi v1_available_hosts GET /v1/available-hosts List all the hosts that can be reserved
IbmCloudPower::HostGroupsApi v1_host_groups_get GET /v1/host-groups Get the list of host groups for the workspace
IbmCloudPower::HostGroupsApi v1_host_groups_id_get GET /v1/host-groups/host_group_id Get the details of a host group
IbmCloudPower::HostGroupsApi v1_host_groups_id_put PUT /v1/host-groups/host_group_id Share/unshare a host group with another workspace
IbmCloudPower::HostGroupsApi v1_host_groups_post POST /v1/host-groups Create a host group with one (or more) host
IbmCloudPower::HostGroupsApi v1_hosts_get GET /v1/hosts Get the list of all the hosts the workspace has access to
IbmCloudPower::HostGroupsApi v1_hosts_id_delete DELETE /v1/hosts/host_id Release a host from its host group
IbmCloudPower::HostGroupsApi v1_hosts_id_get GET /v1/hosts/host_id Get the details about a host
IbmCloudPower::HostGroupsApi v1_hosts_id_put PUT /v1/hosts/host_id Modify the display name of a host
IbmCloudPower::HostGroupsApi v1_hosts_post POST /v1/hosts Add new host(s) to an existing host group
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_get GET /v1/network-address-groups Get the list of Network Address Groups for a workspace
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_id_delete DELETE /v1/network-address-groups/network_address_group_id Delete a Network Address Group from a workspace
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_id_get GET /v1/network-address-groups/network_address_group_id Get the detail of a Network Address Group
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_id_put PUT /v1/network-address-groups/network_address_group_id Update a Network Address Group
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_members_delete DELETE /v1/network-address-groups/network_address_group_id/members/network_address_group_member_id Delete the member from a Network Address Group
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_members_post POST /v1/network-address-groups/network_address_group_id/members Add a member to a Network Address Group
IbmCloudPower::NetworkAddressGroupsApi v1_network_address_groups_post POST /v1/network-address-groups Create a new Network Address Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_action_post POST /v1/network-security-groups/action Perform a Network Security Groups action (enable, disable) on a workspace. On enablement, a default Network Security Group is created to allow all traffic for all active network iterfaces
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_id_delete DELETE /v1/network-security-groups/network_security_group_id Delete a Network Security Group from a workspace
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_id_get GET /v1/network-security-groups/network_security_group_id Get the detail of a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_id_post POST /v1/network-security-groups/network_security_group_id Clone a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_id_put PUT /v1/network-security-groups/network_security_group_id Update a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_list GET /v1/network-security-groups Get the list of Network Security Groups for a workspace
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_members_delete DELETE /v1/network-security-groups/network_security_group_id/members/network_security_group_member_id Delete the member from a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_members_post POST /v1/network-security-groups/network_security_group_id/members Add a member to a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_move_member_post POST /v1/network-security-groups/network_security_group_id/move_member Move a Network Security Group member to another Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_post POST /v1/network-security-groups Create a new Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_rules_delete DELETE /v1/network-security-groups/network_security_group_id/rules/network_security_group_rule_id Delete the rule from a Network Security Group
IbmCloudPower::NetworkSecurityGroupsApi v1_network_security_groups_rules_post POST /v1/network-security-groups/network_security_group_id/rules Add a rule to a Network Security Group
IbmCloudPower::NetworksApi v1_networks_network_interfaces_delete DELETE /v1/networks/network_id/network-interfaces/network_interface_id Delete a Network Interface
IbmCloudPower::NetworksApi v1_networks_network_interfaces_get GET /v1/networks/network_id/network-interfaces/network_interface_id Get a Network Interface's information
IbmCloudPower::NetworksApi v1_networks_network_interfaces_getall GET /v1/networks/network_id/network-interfaces Get all Network Interfaces for this network
IbmCloudPower::NetworksApi v1_networks_network_interfaces_post POST /v1/networks/network_id/network-interfaces Perform Network Interface addition, deletion, and listing
IbmCloudPower::NetworksApi v1_networks_network_interfaces_put PUT /v1/networks/network_id/network-interfaces/network_interface_id Update a Network Interface's information
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections/cloud_connection_id Delete a Cloud Connection
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_get GET /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections/cloud_connection_id Get a cloud connection's state/information
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections Get all cloud connections in this cloud instance
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_networks_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections/cloud_connection_id/networks/network_id Detach a network from a Cloud Connection
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_networks_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections/cloud_connection_id/networks/network_id Attach a network to the cloud connection
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_post POST /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections Create a new cloud connection
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections/cloud_connection_id Update a Cloud Connection
IbmCloudPower::PCloudCloudConnectionsApi pcloud_cloudconnections_virtualprivateclouds_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/cloud-connections-virtual-private-clouds Get all virtual private cloud connections in this cloud instance
IbmCloudPower::PCloudDisasterRecoveryApi pcloud_locations_disasterrecovery_get GET /pcloud/v1/cloud-instances/cloud_instance_id/locations/disaster-recovery Get the disaster recovery site details for the current location
IbmCloudPower::PCloudDisasterRecoveryApi pcloud_locations_disasterrecovery_getall GET /pcloud/v1/locations/disaster-recovery Get all disaster recovery locations supported by Power Virtual Server
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 info of an image
IbmCloudPower::PCloudImagesApi pcloud_cloudinstances_images_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/images List all 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_cloudinstances_stockimages_get GET /pcloud/v1/cloud-instances/cloud_instance_id/stock-images/image_id Detailed info of an available stock image
IbmCloudPower::PCloudImagesApi pcloud_cloudinstances_stockimages_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/stock-images List all available stock images
IbmCloudPower::PCloudImagesApi pcloud_images_get GET /pcloud/v1/images/image_id Detailed info of an image in the image-catalog
IbmCloudPower::PCloudImagesApi pcloud_images_getall GET /pcloud/v1/images List all the images in the image-catalog
IbmCloudPower::PCloudImagesApi pcloud_v1_cloudinstances_cosimages_get GET /pcloud/v1/cloud-instances/cloud_instance_id/cos-images Get detail of last cos-image import job
IbmCloudPower::PCloudImagesApi pcloud_v1_cloudinstances_cosimages_post POST /pcloud/v1/cloud-instances/cloud_instance_id/cos-images Create an cos-image import job
IbmCloudPower::PCloudImagesApi pcloud_v2_images_export_get GET /pcloud/v2/cloud-instances/cloud_instance_id/images/image_id/export Get detail of last image export job
IbmCloudPower::PCloudImagesApi pcloud_v2_images_export_post POST /pcloud/v2/cloud-instances/cloud_instance_id/images/image_id/export Add image export job to the jobs queue
IbmCloudPower::PCloudInstancesApi pcloud_cloudinstances_get GET /pcloud/v1/cloud-instances/cloud_instance_id Get a Cloud Instance's current state/information
IbmCloudPower::PCloudJobsApi pcloud_cloudinstances_jobs_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/jobs/job_id Delete a cloud instance job
IbmCloudPower::PCloudJobsApi pcloud_cloudinstances_jobs_get GET /pcloud/v1/cloud-instances/cloud_instance_id/jobs/job_id List the detail of a job
IbmCloudPower::PCloudJobsApi pcloud_cloudinstances_jobs_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/jobs List up to the last 5 jobs initiated by the 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/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 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 PVMInstance and create a deployable image
IbmCloudPower::PCloudPVMInstancesApi pcloud_pvminstances_console_get GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/console List all console languages
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_console_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/console Update PVMInstance console language code
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 Address 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
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 Power VM 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::PCloudPVMInstancesApi pcloud_v2_pvminstances_capture_get GET /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/capture Get detail of last capture job
IbmCloudPower::PCloudPVMInstancesApi pcloud_v2_pvminstances_capture_post POST /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/capture Add a capture pvm-instance to the jobs queue
IbmCloudPower::PCloudPVMInstancesApi pcloud_v2_pvminstances_getall GET /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances Get all the pvm instances for this cloud instance
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups/placement_group_id Delete Server Placement Group
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_get GET /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups/placement_group_id Get Server Placement Group detail
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups Get all Server Placement Groups
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_members_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups/placement_group_id/members Remove Server from Placement Group
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_members_post POST /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups/placement_group_id/members Add Server to Placement Group
IbmCloudPower::PCloudPlacementGroupsApi pcloud_placementgroups_post POST /pcloud/v1/cloud-instances/cloud_instance_id/placement-groups Create a new Server Placement Group
IbmCloudPower::PCloudPodCapacityApi pcloud_podcapacity_get GET /pcloud/v1/cloud-instances/cloud_instance_id/pod-capacity List of available resources within a particular Pod
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::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups/spp_placement_group_id Delete a Shared Processor Pool Placement Group from a cloud instance
IbmCloudPower::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_get GET /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups/spp_placement_group_id Get the detail of a Shared Processor Pool Placement Group for a cloud instance
IbmCloudPower::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups Get the list of Shared Processor Pool Placement Groups for a cloud instance
IbmCloudPower::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_members_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups/spp_placement_group_id/members/shared_processor_pool_id Delete Shared Processor Pool member from a Shared Processor Pool Placement Group
IbmCloudPower::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_members_post POST /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups/spp_placement_group_id/members/shared_processor_pool_id Add Shared Processor Pool as a member of a Shared Processor Pool Placement Group
IbmCloudPower::PCloudSPPPlacementGroupsApi pcloud_sppplacementgroups_post POST /pcloud/v1/cloud-instances/cloud_instance_id/spp-placement-groups Create a new Shared Processor Pool Placement Group
IbmCloudPower::PCloudSharedProcessorPoolsApi pcloud_sharedprocessorpools_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/shared-processor-pools/shared_processor_pool_id Delete a Shared Processor Pool from a cloud instance
IbmCloudPower::PCloudSharedProcessorPoolsApi pcloud_sharedprocessorpools_get GET /pcloud/v1/cloud-instances/cloud_instance_id/shared-processor-pools/shared_processor_pool_id Get the detail of a Shared Processor Pool for a cloud instance
IbmCloudPower::PCloudSharedProcessorPoolsApi pcloud_sharedprocessorpools_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/shared-processor-pools Get the list of Shared Processor Pools for a cloud instance
IbmCloudPower::PCloudSharedProcessorPoolsApi pcloud_sharedprocessorpools_post POST /pcloud/v1/cloud-instances/cloud_instance_id/shared-processor-pools Create a new Shared Processor Pool
IbmCloudPower::PCloudSharedProcessorPoolsApi pcloud_sharedprocessorpools_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/shared-processor-pools/shared_processor_pool_id Update a Shared Processor Pool for a cloud 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::PCloudStorageCapacityApi pcloud_storagecapacity_pools_get GET /pcloud/v1/cloud-instances/cloud_instance_id/storage-capacity/storage-pools/storage_pool_name Storage capacity for a storage pool in a region
IbmCloudPower::PCloudStorageCapacityApi pcloud_storagecapacity_pools_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/storage-capacity/storage-pools Storage capacity for all available storage pools in a region
IbmCloudPower::PCloudStorageCapacityApi pcloud_storagecapacity_types_get GET /pcloud/v1/cloud-instances/cloud_instance_id/storage-capacity/storage-types/storage_type_name Storage capacity for a storage type in a region
IbmCloudPower::PCloudStorageCapacityApi pcloud_storagecapacity_types_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/storage-capacity/storage-types Storage capacity for all available storage types in a region
IbmCloudPower::PCloudStorageTiersApi pcloud_cloudinstances_storagetiers_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/storage-tiers List all supported storage tiers for this cloud instance
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/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::PCloudVPNConnectionsApi pcloud_vpnconnections_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id Delete VPN Connection
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_get GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id Get VPN Connection
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections Get all VPN Connections
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_networks_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/networks Detach network
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_networks_get GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/networks Get attached networks
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_networks_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/networks Attach network
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_peersubnets_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/peer-subnets Detach Peer Subnet
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_peersubnets_get GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/peer-subnets Get Peer Subnets
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_peersubnets_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id/peer-subnets Attach Peer Subnet
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_post POST /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections Create VPN Connection
IbmCloudPower::PCloudVPNConnectionsApi pcloud_vpnconnections_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/vpn/vpn-connections/vpn_connection_id Update VPN Connection
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ikepolicies_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ike-policies/ike_policy_id Delete IKE Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ikepolicies_get GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ike-policies/ike_policy_id Get the specified IKE Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ikepolicies_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ike-policies Get all IKE Policies
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ikepolicies_post POST /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ike-policies Add IKE Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ikepolicies_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ike-policies/ike_policy_id Update IKE Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ipsecpolicies_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ipsec-policies/ipsec_policy_id Delete IPSec Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ipsecpolicies_get GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ipsec-policies/ipsec_policy_id Get the specified IPSec Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ipsecpolicies_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ipsec-policies Get all IPSec Policies
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ipsecpolicies_post POST /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ipsec-policies Add IPSec Policy
IbmCloudPower::PCloudVPNPoliciesApi pcloud_ipsecpolicies_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/vpn/ipsec-policies/ipsec_policy_id Update IPSec Policy
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_pvminstances_virtualserialnumber_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/virtual-serial-number Unassign Virtual Serial Number from a PVM Instance
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_pvminstances_virtualserialnumber_get GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/virtual-serial-number Get a PVM Instance's Virtual Serial Number Information
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_pvminstances_virtualserialnumber_post POST /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/virtual-serial-number Assign Virtual Serial Number to a PVM Instance
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_pvminstances_virtualserialnumber_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/virtual-serial-number Update a Virtual Serial Number
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_virtualserialnumber_delete DELETE /v1/virtual-serial-number/virtual_serial_number Unreserve a retained Virtual Serial Number
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_virtualserialnumber_get GET /v1/virtual-serial-number/virtual_serial_number Get information for a Virtual Serial Number
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_virtualserialnumber_getall GET /v1/virtual-serial-number List all utilized and retained VSNs
IbmCloudPower::PCloudVirtualSerialNumberApi pcloud_virtualserialnumber_put PUT /v1/virtual-serial-number/virtual_serial_number Update Description of a Reserved Virtual Serial Number
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_action_post POST /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id/action Perform an action on a volume group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_delete DELETE /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id Delete a cloud instance volume group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id Get volume Group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_get_details GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id/details Get volume Group details
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups Get all volume groups
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_getall_details GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/details Get all volume groups with details
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_post POST /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups Create a new volume group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_put PUT /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id updates the volume group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_remote_copy_relationships_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id/remote-copy-relationships Get remote copy relationships of the volume belonging to volume group
IbmCloudPower::PCloudVolumeGroupsApi pcloud_volumegroups_storage_details_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volume-groups/volume_group_id/storage-details Get storage details of volume group
IbmCloudPower::PCloudVolumeOnboardingApi pcloud_volume_onboarding_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/onboarding/volume_onboarding_id Get the information of volume onboarding operation
IbmCloudPower::PCloudVolumeOnboardingApi pcloud_volume_onboarding_getall GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/onboarding List all volume onboardings for this cloud instance
IbmCloudPower::PCloudVolumeOnboardingApi pcloud_volume_onboarding_post POST /pcloud/v1/cloud-instances/cloud_instance_id/volumes/onboarding Onboard auxiliary volumes to target site
IbmCloudPower::PCloudVolumesApi pcloud_cloudinstances_volumes_action_post POST /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id/action Perform an action on a Volume
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_flash_copy_mappings_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id/flash-copy-mappings Get a list of flashcopy mappings of a given volume
IbmCloudPower::PCloudVolumesApi pcloud_cloudinstances_volumes_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id Detailed info 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_cloudinstances_volumes_remote_copy_relationship_get GET /pcloud/v1/cloud-instances/cloud_instance_id/volumes/volume_id/remote-copy Get remote copy relationship of a 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 PVMInstance
IbmCloudPower::PCloudVolumesApi pcloud_pvminstances_volumes_get GET /pcloud/v1/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes/volume_id Detailed info of a volume attached to a PVMInstance
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 PVMInstance
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_pvminstances_volumes_delete DELETE /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes Detach multiple volumes from a PVMInstance
IbmCloudPower::PCloudVolumesApi pcloud_v2_pvminstances_volumes_post POST /pcloud/v2/cloud-instances/cloud_instance_id/pvm-instances/pvm_instance_id/volumes Attach all volumes to a PVMInstance
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumes_clone_post POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes/clone Create a volume clone for specified volumes
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 volumes clone request for the specified clone task ID
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumes_delete DELETE /pcloud/v2/cloud-instances/cloud_instance_id/volumes Delete all volumes
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_v2_volumesclone_cancel_post POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone/volumes_clone_id/cancel Cancel a volumes-clone request
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_delete DELETE /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone/volumes_clone_id Delete a volumes-clone request
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_execute_post POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone/volumes_clone_id/execute Initiate the Execute action for a volumes-clone request
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_get GET /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone/volumes_clone_id Get the details for a volumes-clone request
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_getall GET /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone Get the list of volumes-clone request for a cloud instance
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_post POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone Create a new volumes clone request and initiates the Prepare action
IbmCloudPower::PCloudVolumesApi pcloud_v2_volumesclone_start_post POST /pcloud/v2/cloud-instances/cloud_instance_id/volumes-clone/volumes_clone_id/start Initiate the Start action for a volumes-clone request
IbmCloudPower::PCloudVolumesApi pcloud_volumes_clone_post POST /pcloud/v1/cloud-instances/cloud_instance_id/volumes/clone Create a volume clone for specified volumes
IbmCloudPower::SnapshotsApi v1_snapshots_get GET /v1/snapshots/snapshot_id Get the detail of a snapshot
IbmCloudPower::SnapshotsApi v1_snapshots_getall GET /v1/snapshots Get a list of all the snapshots on a workspace
IbmCloudPower::SnapshotsApi v1_volume_snapshots_get GET /v1/volume-snapshots Get the list of volume snapshots on a workspace
IbmCloudPower::SnapshotsApi v1_volume_snapshots_getall GET /v1/volume-snapshots/volume_snapshot_uuid Get the detail of a volume snapshot
IbmCloudPower::WorkspacesApi v1_workspaces_get GET /v1/workspaces/workspace_id Get a Workspace's information and capabilities
IbmCloudPower::WorkspacesApi v1_workspaces_getall GET /v1/workspaces Get all Workspaces information and capabilities for a tenant

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.