ibm_cloud_power 1.1.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +68 -3
- data/docs/CloneTaskReference.md +10 -9
- data/docs/CloneTaskStatus.md +14 -13
- data/docs/ClonedVolume.md +10 -9
- data/docs/ClonedVolumeDetail.md +10 -9
- data/docs/CloudConnection.md +32 -31
- data/docs/CloudConnectionCreate.md +14 -13
- data/docs/CloudConnectionCreateResponse.md +44 -0
- data/docs/CloudConnectionEndpointClassic.md +10 -9
- data/docs/CloudConnectionEndpointGRE.md +10 -9
- data/docs/CloudConnectionEndpointVPC.md +10 -9
- data/docs/CloudConnectionGRETunnel.md +12 -11
- data/docs/CloudConnectionSpeed.md +4 -5
- data/docs/CloudConnectionUpdate.md +18 -17
- data/docs/CloudConnectionVPC.md +10 -9
- data/docs/CloudConnectionVirtualPrivateClouds.md +8 -7
- data/docs/CloudConnectionVirtualPrivateCloudsVirtualPrivateCloudsInner.md +24 -0
- data/docs/CloudConnections.md +8 -7
- data/docs/CloudInstance.md +28 -27
- data/docs/CloudInstanceCreate.md +20 -19
- data/docs/CloudInstanceReference.md +22 -21
- data/docs/CloudInstanceUpdate.md +16 -15
- data/docs/CloudInstanceUsageLimits.md +28 -27
- data/docs/CreateCosImageImportJob.md +38 -0
- data/docs/CreateDataVolume.md +26 -19
- data/docs/CreateImage.md +32 -27
- data/docs/DeadPeerDetection.md +22 -0
- data/docs/Error.md +10 -9
- data/docs/Event.md +24 -23
- data/docs/EventUser.md +12 -11
- data/docs/Events.md +8 -7
- data/docs/ExportImage.md +14 -13
- data/docs/IKEPolicies.md +18 -0
- data/docs/IKEPolicy.md +30 -0
- data/docs/IKEPolicyCreate.md +30 -0
- data/docs/IKEPolicyOptions.md +24 -0
- data/docs/IKEPolicyRef.md +20 -0
- data/docs/IKEPolicyTemplate.md +26 -0
- data/docs/IKEPolicyUpdate.md +30 -0
- data/docs/IPAddressRange.md +10 -9
- data/docs/IPSecPolicies.md +18 -0
- data/docs/IPSecPolicy.md +30 -0
- data/docs/IPSecPolicyCreate.md +28 -0
- data/docs/IPSecPolicyOptions.md +22 -0
- data/docs/IPSecPolicyRef.md +20 -0
- data/docs/IPSecPolicyTemplate.md +24 -0
- data/docs/IPSecPolicyUpdate.md +28 -0
- data/docs/Image.md +32 -31
- data/docs/ImageReference.md +26 -25
- data/docs/ImageSpecifications.md +20 -19
- data/docs/ImageVolume.md +14 -13
- data/docs/Images.md +8 -7
- data/docs/Job.md +24 -0
- data/docs/JobReference.md +20 -0
- data/docs/Jobs.md +18 -0
- data/docs/MaximumStorageAllocation.md +12 -11
- data/docs/MinMaxDefault.md +12 -11
- data/docs/MultiVolumesCreate.md +28 -21
- data/docs/Network.md +28 -27
- data/docs/NetworkCreate.md +20 -19
- data/docs/NetworkID.md +18 -0
- data/docs/NetworkIDs.md +18 -0
- data/docs/NetworkIpAddressMetrics.md +14 -13
- data/docs/NetworkPort.md +22 -21
- data/docs/NetworkPortCreate.md +10 -9
- data/docs/NetworkPortPvmInstance.md +10 -9
- data/docs/NetworkPortUpdate.md +10 -9
- data/docs/NetworkPorts.md +8 -7
- data/docs/NetworkReference.md +18 -17
- data/docs/NetworkUpdate.md +14 -13
- data/docs/Networks.md +8 -7
- data/docs/Operation.md +22 -0
- data/docs/Operations.md +12 -11
- data/docs/Options.md +18 -0
- data/docs/PCloudCloudConnectionsApi.md +229 -94
- data/docs/PCloudEventsApi.md +60 -27
- data/docs/PCloudImagesApi.md +513 -101
- data/docs/PCloudInstancesApi.md +83 -33
- data/docs/PCloudJobsApi.md +208 -0
- data/docs/PCloudNetworksApi.md +287 -118
- data/docs/PCloudPVMInstancesApi.md +628 -208
- data/docs/PCloudPlacementGroupsApi.md +177 -76
- data/docs/PCloudSAPApi.md +86 -36
- data/docs/PCloudSnapshotsApi.md +112 -45
- data/docs/PCloudStorageCapacityApi.md +112 -45
- data/docs/PCloudSystemPoolsApi.md +29 -13
- data/docs/PCloudTasksApi.md +55 -22
- data/docs/PCloudTenantsApi.md +57 -24
- data/docs/PCloudTenantsSSHKeysApi.md +143 -59
- data/docs/PCloudVPNConnectionsApi.md +817 -0
- data/docs/PCloudVPNPoliciesApi.md +677 -0
- data/docs/PCloudVolumesApi.md +629 -256
- data/docs/PVMInstance.md +72 -69
- data/docs/PVMInstanceAction.md +8 -7
- data/docs/PVMInstanceAddNetwork.md +10 -9
- data/docs/PVMInstanceCapture.md +20 -19
- data/docs/PVMInstanceClone.md +22 -21
- data/docs/PVMInstanceConsole.md +8 -7
- data/docs/PVMInstanceCreate.md +50 -45
- data/docs/PVMInstanceFault.md +14 -13
- data/docs/PVMInstanceHealth.md +12 -11
- data/docs/PVMInstanceMultiCreate.md +12 -11
- data/docs/PVMInstanceNetwork.md +24 -23
- data/docs/PVMInstanceNetworks.md +8 -7
- data/docs/PVMInstanceOperation.md +10 -9
- data/docs/PVMInstanceReference.md +68 -61
- data/docs/PVMInstanceRemoveNetwork.md +8 -7
- data/docs/PVMInstanceUpdate.md +26 -23
- data/docs/PVMInstanceUpdateResponse.md +18 -17
- data/docs/PVMInstanceVolumeUpdate.md +8 -7
- data/docs/PVMInstances.md +8 -7
- data/docs/PeerSubnetUpdate.md +18 -0
- data/docs/PeerSubnets.md +18 -0
- data/docs/PeeringNetwork.md +12 -11
- data/docs/PinPolicy.md +4 -5
- data/docs/PlacementGroup.md +14 -13
- data/docs/PlacementGroupCreate.md +10 -9
- data/docs/PlacementGroupServer.md +8 -7
- data/docs/PlacementGroups.md +8 -7
- data/docs/SAPCreate.md +30 -23
- data/docs/SAPProfile.md +16 -15
- data/docs/SAPProfileReference.md +10 -9
- data/docs/SAPProfiles.md +8 -7
- data/docs/SRC.md +10 -9
- data/docs/SSHKey.md +12 -11
- data/docs/SSHKeys.md +8 -7
- data/docs/Snapshot.md +26 -25
- data/docs/SnapshotCreate.md +12 -11
- data/docs/SnapshotCreateResponse.md +8 -7
- data/docs/SnapshotRestore.md +8 -7
- data/docs/SnapshotUpdate.md +10 -9
- data/docs/Snapshots.md +8 -7
- data/docs/SoftwareLicenses.md +16 -15
- data/docs/Status.md +22 -0
- data/docs/StockImage.md +12 -11
- data/docs/StorageAffinity.md +26 -0
- data/docs/StoragePoolCapacity.md +14 -13
- data/docs/StoragePoolsCapacity.md +10 -9
- data/docs/StorageTypeCapacity.md +12 -11
- data/docs/StorageTypesCapacity.md +10 -9
- data/docs/System.md +12 -11
- data/docs/SystemPool.md +22 -21
- data/docs/Task.md +24 -23
- data/docs/TaskReference.md +10 -9
- data/docs/Tenant.md +20 -19
- data/docs/TenantUpdate.md +10 -9
- data/docs/UpdateVolume.md +14 -13
- data/docs/VPNConnection.md +40 -0
- data/docs/VPNConnectionCreate.md +30 -0
- data/docs/VPNConnectionCreateResponse.md +42 -0
- data/docs/VPNConnectionUpdate.md +24 -0
- data/docs/VPNConnections.md +18 -0
- data/docs/VPNaaSOptions.md +26 -0
- data/docs/VirtualCores.md +12 -11
- data/docs/Volume.md +36 -33
- data/docs/VolumeInfo.md +10 -9
- data/docs/VolumeReference.md +38 -35
- data/docs/Volumes.md +8 -7
- data/docs/VolumesClone.md +22 -21
- data/docs/VolumesCloneAsyncRequest.md +10 -9
- data/docs/VolumesCloneCancel.md +8 -7
- data/docs/VolumesCloneCreate.md +10 -9
- data/docs/VolumesCloneDetail.md +24 -23
- data/docs/VolumesCloneExecute.md +10 -9
- data/docs/VolumesCloneRequest.md +10 -9
- data/docs/VolumesCloneResponse.md +8 -7
- data/docs/VolumesClones.md +8 -7
- data/git_push.sh +3 -4
- data/ibm_cloud_power.gemspec +3 -3
- data/lib/ibm_cloud_power/api/p_cloud_cloud_connections_api.rb +43 -29
- data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +9 -7
- data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +325 -32
- data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +17 -11
- data/lib/ibm_cloud_power/api/p_cloud_jobs_api.rb +234 -0
- data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +57 -35
- data/lib/ibm_cloud_power/api/p_cloud_placement_groups_api.rb +45 -30
- data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +256 -64
- data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +17 -11
- data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +21 -14
- data/lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb +17 -13
- data/lib/ibm_cloud_power/api/p_cloud_system_pools_api.rb +5 -4
- data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +9 -7
- data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +13 -8
- data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +29 -18
- data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +125 -76
- data/lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb +898 -0
- data/lib/ibm_cloud_power/api/p_cloud_vpn_policies_api.rb +732 -0
- data/lib/ibm_cloud_power/api_client.rb +56 -52
- data/lib/ibm_cloud_power/api_error.rb +1 -1
- data/lib/ibm_cloud_power/configuration.rb +43 -12
- data/lib/ibm_cloud_power/models/clone_task_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/clone_task_status.rb +19 -8
- data/lib/ibm_cloud_power/models/cloned_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection.rb +20 -9
- data/lib/ibm_cloud_power/models/cloud_connection_create.rb +53 -8
- data/lib/ibm_cloud_power/models/cloud_connection_create_response.rb +406 -0
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_classic.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_gre.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_vpc.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_gre_tunnel.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_speed.rb +2 -1
- data/lib/ibm_cloud_power/models/cloud_connection_update.rb +53 -8
- data/lib/ibm_cloud_power/models/cloud_connection_virtual_private_clouds.rb +20 -9
- data/lib/ibm_cloud_power/models/cloud_connection_virtual_private_clouds_virtual_private_clouds_inner.rb +270 -0
- data/lib/ibm_cloud_power/models/cloud_connection_vpc.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connections.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_create.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_update.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +19 -8
- data/lib/ibm_cloud_power/models/create_cos_image_import_job.rb +387 -0
- data/lib/ibm_cloud_power/models/create_data_volume.rb +59 -14
- data/lib/ibm_cloud_power/models/create_image.rb +41 -22
- data/lib/ibm_cloud_power/models/dead_peer_detection.rb +350 -0
- data/lib/ibm_cloud_power/models/error.rb +32 -21
- data/lib/ibm_cloud_power/models/event.rb +20 -9
- data/lib/ibm_cloud_power/models/event_user.rb +19 -8
- data/lib/ibm_cloud_power/models/events.rb +19 -8
- data/lib/ibm_cloud_power/models/export_image.rb +19 -8
- data/lib/ibm_cloud_power/models/ike_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ike_policy.rb +414 -0
- data/lib/ibm_cloud_power/models/ike_policy_create.rb +414 -0
- data/lib/ibm_cloud_power/models/ike_policy_options.rb +274 -0
- data/lib/ibm_cloud_power/models/ike_policy_ref.rb +241 -0
- data/lib/ibm_cloud_power/models/ike_policy_template.rb +313 -0
- data/lib/ibm_cloud_power/models/ike_policy_update.rb +375 -0
- data/lib/ibm_cloud_power/models/image.rb +21 -10
- data/lib/ibm_cloud_power/models/image_reference.rb +21 -10
- data/lib/ibm_cloud_power/models/image_specifications.rb +19 -8
- data/lib/ibm_cloud_power/models/image_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/images.rb +19 -8
- data/lib/ibm_cloud_power/models/ip_address_range.rb +19 -8
- data/lib/ibm_cloud_power/models/ip_sec_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy.rb +402 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_create.rb +387 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_options.rb +258 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_ref.rb +241 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_template.rb +298 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_update.rb +353 -0
- data/lib/ibm_cloud_power/models/job.rb +263 -0
- data/lib/ibm_cloud_power/models/job_reference.rb +240 -0
- data/lib/ibm_cloud_power/models/jobs.rb +227 -0
- data/lib/ibm_cloud_power/models/maximum_storage_allocation.rb +20 -9
- data/lib/ibm_cloud_power/models/min_max_default.rb +19 -8
- data/lib/ibm_cloud_power/models/multi_volumes_create.rb +57 -12
- data/lib/ibm_cloud_power/models/network.rb +19 -8
- data/lib/ibm_cloud_power/models/network_create.rb +19 -8
- data/lib/ibm_cloud_power/models/network_id.rb +225 -0
- data/lib/ibm_cloud_power/models/network_ids.rb +222 -0
- data/lib/ibm_cloud_power/models/network_ip_address_metrics.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_create.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_update.rb +19 -8
- data/lib/ibm_cloud_power/models/network_ports.rb +19 -8
- data/lib/ibm_cloud_power/models/network_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/network_update.rb +19 -8
- data/lib/ibm_cloud_power/models/networks.rb +19 -8
- data/lib/ibm_cloud_power/models/operation.rb +255 -0
- data/lib/ibm_cloud_power/models/operations.rb +19 -8
- data/lib/ibm_cloud_power/models/options.rb +224 -0
- data/lib/ibm_cloud_power/models/peer_subnet_update.rb +225 -0
- data/lib/ibm_cloud_power/models/peer_subnets.rb +222 -0
- data/lib/ibm_cloud_power/models/peering_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pin_policy.rb +2 -1
- data/lib/ibm_cloud_power/models/placement_group.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_group_create.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_group_server.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_groups.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance.rb +57 -34
- data/lib/ibm_cloud_power/models/pvm_instance_action.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +27 -16
- data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +28 -17
- data/lib/ibm_cloud_power/models/pvm_instance_console.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_create.rb +54 -24
- data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +20 -9
- data/lib/ibm_cloud_power/models/pvm_instance_health.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +55 -12
- data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_update.rb +32 -9
- data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_volume_update.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instances.rb +19 -8
- data/lib/ibm_cloud_power/models/sap_create.rb +56 -16
- data/lib/ibm_cloud_power/models/sap_profile.rb +19 -20
- data/lib/ibm_cloud_power/models/sap_profile_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/sap_profiles.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot.rb +21 -10
- data/lib/ibm_cloud_power/models/snapshot_create.rb +27 -16
- data/lib/ibm_cloud_power/models/snapshot_create_response.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot_restore.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot_update.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshots.rb +19 -8
- data/lib/ibm_cloud_power/models/software_licenses.rb +19 -8
- data/lib/ibm_cloud_power/models/src.rb +19 -8
- data/lib/ibm_cloud_power/models/ssh_key.rb +20 -9
- data/lib/ibm_cloud_power/models/ssh_keys.rb +19 -8
- data/lib/ibm_cloud_power/models/status.rb +250 -0
- data/lib/ibm_cloud_power/models/stock_image.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_affinity.rb +298 -0
- data/lib/ibm_cloud_power/models/storage_pool_capacity.rb +20 -9
- data/lib/ibm_cloud_power/models/storage_pools_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_type_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_types_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/system.rb +19 -8
- data/lib/ibm_cloud_power/models/system_pool.rb +19 -8
- data/lib/ibm_cloud_power/models/task.rb +21 -10
- data/lib/ibm_cloud_power/models/task_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/tenant.rb +20 -9
- data/lib/ibm_cloud_power/models/tenant_update.rb +19 -8
- data/lib/ibm_cloud_power/models/update_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/virtual_cores.rb +19 -8
- data/lib/ibm_cloud_power/models/volume.rb +39 -18
- data/lib/ibm_cloud_power/models/volume_info.rb +19 -8
- data/lib/ibm_cloud_power/models/volume_reference.rb +39 -18
- data/lib/ibm_cloud_power/models/volumes.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone.rb +21 -10
- data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_cancel.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone_create.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_detail.rb +21 -10
- data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone_request.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_response.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clones.rb +19 -8
- data/lib/ibm_cloud_power/models/vp_naa_s_options.rb +280 -0
- data/lib/ibm_cloud_power/models/vpn_connection.rb +437 -0
- data/lib/ibm_cloud_power/models/vpn_connection_create.rb +353 -0
- data/lib/ibm_cloud_power/models/vpn_connection_create_response.rb +453 -0
- data/lib/ibm_cloud_power/models/vpn_connection_update.rb +251 -0
- data/lib/ibm_cloud_power/models/vpn_connections.rb +222 -0
- data/lib/ibm_cloud_power/version.rb +2 -2
- data/lib/ibm_cloud_power.rb +39 -2
- data/spec/api/p_cloud_jobs_api_spec.rb +73 -0
- data/spec/api/p_cloud_vpn_connections_api_spec.rb +194 -0
- data/spec/api/p_cloud_vpn_policies_api_spec.rb +165 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/cloud_connection_create_response_spec.rb +112 -0
- data/spec/models/cloud_connection_virtual_private_clouds_virtual_private_clouds_inner_spec.rb +52 -0
- data/spec/models/create_cos_image_import_job_spec.rb +102 -0
- data/spec/models/dead_peer_detection_spec.rb +50 -0
- data/spec/models/ike_policies_spec.rb +34 -0
- data/spec/models/ike_policy_create_spec.rb +86 -0
- data/spec/models/ike_policy_options_spec.rb +52 -0
- data/spec/models/ike_policy_ref_spec.rb +40 -0
- data/spec/models/ike_policy_spec.rb +86 -0
- data/spec/models/ike_policy_template_spec.rb +58 -0
- data/spec/models/ike_policy_update_spec.rb +86 -0
- data/spec/models/ip_sec_policies_spec.rb +34 -0
- data/spec/models/ip_sec_policy_create_spec.rb +76 -0
- data/spec/models/ip_sec_policy_options_spec.rb +46 -0
- data/spec/models/ip_sec_policy_ref_spec.rb +40 -0
- data/spec/models/ip_sec_policy_spec.rb +82 -0
- data/spec/models/ip_sec_policy_template_spec.rb +52 -0
- data/spec/models/ip_sec_policy_update_spec.rb +76 -0
- data/spec/models/job_reference_spec.rb +40 -0
- data/spec/models/job_spec.rb +52 -0
- data/spec/models/jobs_spec.rb +34 -0
- data/spec/models/network_id_spec.rb +34 -0
- data/spec/models/network_ids_spec.rb +34 -0
- data/spec/models/operation_spec.rb +46 -0
- data/spec/models/options_spec.rb +34 -0
- data/spec/models/peer_subnet_update_spec.rb +34 -0
- data/spec/models/peer_subnets_spec.rb +34 -0
- data/spec/models/status_spec.rb +46 -0
- data/spec/models/storage_affinity_spec.rb +62 -0
- data/spec/models/vp_naa_s_options_spec.rb +58 -0
- data/spec/models/vpn_connection_create_response_spec.rb +114 -0
- data/spec/models/vpn_connection_create_spec.rb +74 -0
- data/spec/models/vpn_connection_spec.rb +108 -0
- data/spec/models/vpn_connection_update_spec.rb +52 -0
- data/spec/models/vpn_connections_spec.rb +34 -0
- data/spec/spec_helper.rb +1 -1
- metadata +262 -111
- data/Gemfile.lock +0 -68
data/docs/PCloudVolumesApi.md
CHANGED
@@ -2,31 +2,30 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**pcloud_cloudinstances_volumes_delete**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Delete a cloud instance volume
|
8
|
-
[**pcloud_cloudinstances_volumes_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Detailed information of a volume
|
9
|
-
[**pcloud_cloudinstances_volumes_getall**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | List all volumes for this cloud instance
|
10
|
-
[**pcloud_cloudinstances_volumes_post**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | Create a new data volume
|
11
|
-
[**pcloud_cloudinstances_volumes_put**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Update a cloud instance volume
|
12
|
-
[**pcloud_pvminstances_volumes_delete**](PCloudVolumesApi.md#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
|
13
|
-
[**pcloud_pvminstances_volumes_get**](PCloudVolumesApi.md#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
|
14
|
-
[**pcloud_pvminstances_volumes_getall**](PCloudVolumesApi.md#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
|
15
|
-
[**pcloud_pvminstances_volumes_post**](PCloudVolumesApi.md#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
|
16
|
-
[**pcloud_pvminstances_volumes_put**](PCloudVolumesApi.md#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
|
17
|
-
[**pcloud_pvminstances_volumes_setboot_put**](PCloudVolumesApi.md#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
|
18
|
-
[**pcloud_v2_volumes_clone_post**](PCloudVolumesApi.md#pcloud_v2_volumes_clone_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 2)
|
19
|
-
[**pcloud_v2_volumes_clonetasks_get**](PCloudVolumesApi.md#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
|
20
|
-
[**pcloud_v2_volumes_post**](PCloudVolumesApi.md#pcloud_v2_volumes_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes | Create multiple data volumes from a single definition
|
21
|
-
[**pcloud_v2_volumesclone_cancel_post**](PCloudVolumesApi.md#pcloud_v2_volumesclone_cancel_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/cancel | Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes.
|
22
|
-
[**pcloud_v2_volumesclone_delete**](PCloudVolumesApi.md#pcloud_v2_volumesclone_delete) | **DELETE** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id} | Delete a volumes-clone request
|
23
|
-
[**pcloud_v2_volumesclone_execute_post**](PCloudVolumesApi.md#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. The Execute action creates the cloned volumes using the volume snapshots.
|
24
|
-
[**pcloud_v2_volumesclone_get**](PCloudVolumesApi.md#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
|
25
|
-
[**pcloud_v2_volumesclone_getall**](PCloudVolumesApi.md#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
|
26
|
-
[**pcloud_v2_volumesclone_post**](PCloudVolumesApi.md#pcloud_v2_volumesclone_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone | Create a new volumes clone request and initiate the Prepare action
|
27
|
-
[**pcloud_v2_volumesclone_start_post**](PCloudVolumesApi.md#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 volume-clone request. The Start action starts the consistency group to initiate the flash copy.
|
28
|
-
[**pcloud_volumes_clone_post**](PCloudVolumesApi.md#pcloud_volumes_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 1 - depricated)
|
29
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**pcloud_cloudinstances_volumes_delete**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Delete a cloud instance volume |
|
8
|
+
| [**pcloud_cloudinstances_volumes_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Detailed information of a volume |
|
9
|
+
| [**pcloud_cloudinstances_volumes_getall**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | List all volumes for this cloud instance |
|
10
|
+
| [**pcloud_cloudinstances_volumes_post**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | Create a new data volume |
|
11
|
+
| [**pcloud_cloudinstances_volumes_put**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Update a cloud instance volume |
|
12
|
+
| [**pcloud_pvminstances_volumes_delete**](PCloudVolumesApi.md#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 |
|
13
|
+
| [**pcloud_pvminstances_volumes_get**](PCloudVolumesApi.md#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 |
|
14
|
+
| [**pcloud_pvminstances_volumes_getall**](PCloudVolumesApi.md#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 |
|
15
|
+
| [**pcloud_pvminstances_volumes_post**](PCloudVolumesApi.md#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 |
|
16
|
+
| [**pcloud_pvminstances_volumes_put**](PCloudVolumesApi.md#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 |
|
17
|
+
| [**pcloud_pvminstances_volumes_setboot_put**](PCloudVolumesApi.md#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 |
|
18
|
+
| [**pcloud_v2_volumes_clone_post**](PCloudVolumesApi.md#pcloud_v2_volumes_clone_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 2) |
|
19
|
+
| [**pcloud_v2_volumes_clonetasks_get**](PCloudVolumesApi.md#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 |
|
20
|
+
| [**pcloud_v2_volumes_post**](PCloudVolumesApi.md#pcloud_v2_volumes_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes | Create multiple data volumes from a single definition |
|
21
|
+
| [**pcloud_v2_volumesclone_cancel_post**](PCloudVolumesApi.md#pcloud_v2_volumesclone_cancel_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/cancel | Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes. |
|
22
|
+
| [**pcloud_v2_volumesclone_delete**](PCloudVolumesApi.md#pcloud_v2_volumesclone_delete) | **DELETE** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id} | Delete a volumes-clone request |
|
23
|
+
| [**pcloud_v2_volumesclone_execute_post**](PCloudVolumesApi.md#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. The Execute action creates the cloned volumes using the volume snapshots. |
|
24
|
+
| [**pcloud_v2_volumesclone_get**](PCloudVolumesApi.md#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 |
|
25
|
+
| [**pcloud_v2_volumesclone_getall**](PCloudVolumesApi.md#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 |
|
26
|
+
| [**pcloud_v2_volumesclone_post**](PCloudVolumesApi.md#pcloud_v2_volumesclone_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone | Create a new volumes clone request and initiate the Prepare action |
|
27
|
+
| [**pcloud_v2_volumesclone_start_post**](PCloudVolumesApi.md#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 volume-clone request. The Start action starts the consistency group to initiate the flash copy. |
|
28
|
+
| [**pcloud_volumes_clone_post**](PCloudVolumesApi.md#pcloud_volumes_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 1 - depricated) |
|
30
29
|
|
31
30
|
|
32
31
|
## pcloud_cloudinstances_volumes_delete
|
@@ -35,10 +34,10 @@ Method | HTTP request | Description
|
|
35
34
|
|
36
35
|
Delete a cloud instance volume
|
37
36
|
|
38
|
-
###
|
37
|
+
### Examples
|
39
38
|
|
40
39
|
```ruby
|
41
|
-
|
40
|
+
require 'time'
|
42
41
|
require 'ibm_cloud_power'
|
43
42
|
|
44
43
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -46,21 +45,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
46
45
|
volume_id = 'volume_id_example' # String | Volume ID
|
47
46
|
|
48
47
|
begin
|
49
|
-
#Delete a cloud instance volume
|
48
|
+
# Delete a cloud instance volume
|
50
49
|
result = api_instance.pcloud_cloudinstances_volumes_delete(cloud_instance_id, volume_id)
|
51
50
|
p result
|
52
51
|
rescue IbmCloudPower::ApiError => e
|
53
|
-
puts "
|
52
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_delete: #{e}"
|
54
53
|
end
|
55
54
|
```
|
56
55
|
|
57
|
-
|
56
|
+
#### Using the pcloud_cloudinstances_volumes_delete_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(Object, Integer, Hash)> pcloud_cloudinstances_volumes_delete_with_http_info(cloud_instance_id, volume_id)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Delete a cloud instance volume
|
65
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_delete_with_http_info(cloud_instance_id, volume_id)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => Object
|
69
|
+
rescue IbmCloudPower::ApiError => e
|
70
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_delete_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
58
73
|
|
74
|
+
### Parameters
|
59
75
|
|
60
|
-
Name | Type | Description
|
61
|
-
|
62
|
-
**cloud_instance_id** | **String
|
63
|
-
**volume_id** | **String
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
79
|
+
| **volume_id** | **String** | Volume ID | |
|
64
80
|
|
65
81
|
### Return type
|
66
82
|
|
@@ -78,14 +94,14 @@ No authorization required
|
|
78
94
|
|
79
95
|
## pcloud_cloudinstances_volumes_get
|
80
96
|
|
81
|
-
> Volume pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
97
|
+
> <Volume> pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
82
98
|
|
83
99
|
Detailed information of a volume
|
84
100
|
|
85
|
-
###
|
101
|
+
### Examples
|
86
102
|
|
87
103
|
```ruby
|
88
|
-
|
104
|
+
require 'time'
|
89
105
|
require 'ibm_cloud_power'
|
90
106
|
|
91
107
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -93,21 +109,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
93
109
|
volume_id = 'volume_id_example' # String | Volume ID
|
94
110
|
|
95
111
|
begin
|
96
|
-
#Detailed information of a volume
|
112
|
+
# Detailed information of a volume
|
97
113
|
result = api_instance.pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
98
114
|
p result
|
99
115
|
rescue IbmCloudPower::ApiError => e
|
100
|
-
puts "
|
116
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_get: #{e}"
|
101
117
|
end
|
102
118
|
```
|
103
119
|
|
104
|
-
|
120
|
+
#### Using the pcloud_cloudinstances_volumes_get_with_http_info variant
|
121
|
+
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
123
|
+
|
124
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_get_with_http_info(cloud_instance_id, volume_id)
|
105
125
|
|
126
|
+
```ruby
|
127
|
+
begin
|
128
|
+
# Detailed information of a volume
|
129
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_get_with_http_info(cloud_instance_id, volume_id)
|
130
|
+
p status_code # => 2xx
|
131
|
+
p headers # => { ... }
|
132
|
+
p data # => <Volume>
|
133
|
+
rescue IbmCloudPower::ApiError => e
|
134
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_get_with_http_info: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
### Parameters
|
106
139
|
|
107
|
-
Name | Type | Description
|
108
|
-
|
109
|
-
**cloud_instance_id** | **String
|
110
|
-
**volume_id** | **String
|
140
|
+
| Name | Type | Description | Notes |
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
142
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
143
|
+
| **volume_id** | **String** | Volume ID | |
|
111
144
|
|
112
145
|
### Return type
|
113
146
|
|
@@ -125,14 +158,14 @@ No authorization required
|
|
125
158
|
|
126
159
|
## pcloud_cloudinstances_volumes_getall
|
127
160
|
|
128
|
-
> Volumes pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
161
|
+
> <Volumes> pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
129
162
|
|
130
163
|
List all volumes for this cloud instance
|
131
164
|
|
132
|
-
###
|
165
|
+
### Examples
|
133
166
|
|
134
167
|
```ruby
|
135
|
-
|
168
|
+
require 'time'
|
136
169
|
require 'ibm_cloud_power'
|
137
170
|
|
138
171
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -142,21 +175,38 @@ opts = {
|
|
142
175
|
}
|
143
176
|
|
144
177
|
begin
|
145
|
-
#List all volumes for this cloud instance
|
178
|
+
# List all volumes for this cloud instance
|
146
179
|
result = api_instance.pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
147
180
|
p result
|
148
181
|
rescue IbmCloudPower::ApiError => e
|
149
|
-
puts "
|
182
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_getall: #{e}"
|
150
183
|
end
|
151
184
|
```
|
152
185
|
|
153
|
-
|
186
|
+
#### Using the pcloud_cloudinstances_volumes_getall_with_http_info variant
|
187
|
+
|
188
|
+
This returns an Array which contains the response data, status code and headers.
|
189
|
+
|
190
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_cloudinstances_volumes_getall_with_http_info(cloud_instance_id, opts)
|
191
|
+
|
192
|
+
```ruby
|
193
|
+
begin
|
194
|
+
# List all volumes for this cloud instance
|
195
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_getall_with_http_info(cloud_instance_id, opts)
|
196
|
+
p status_code # => 2xx
|
197
|
+
p headers # => { ... }
|
198
|
+
p data # => <Volumes>
|
199
|
+
rescue IbmCloudPower::ApiError => e
|
200
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_getall_with_http_info: #{e}"
|
201
|
+
end
|
202
|
+
```
|
154
203
|
|
204
|
+
### Parameters
|
155
205
|
|
156
|
-
Name | Type | Description
|
157
|
-
|
158
|
-
**cloud_instance_id** | **String
|
159
|
-
**affinity** | **String
|
206
|
+
| Name | Type | Description | Notes |
|
207
|
+
| ---- | ---- | ----------- | ----- |
|
208
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
209
|
+
| **affinity** | **String** | A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance | [optional] |
|
160
210
|
|
161
211
|
### Return type
|
162
212
|
|
@@ -174,38 +224,55 @@ No authorization required
|
|
174
224
|
|
175
225
|
## pcloud_cloudinstances_volumes_post
|
176
226
|
|
177
|
-
> Volume pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
227
|
+
> <Volume> pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
178
228
|
|
179
229
|
Create a new data volume
|
180
230
|
|
181
231
|
All regions use Tier 1 (NVMe-based flash storage) or Tier 3 (SSD flash storage) storage types.
|
182
232
|
|
183
|
-
###
|
233
|
+
### Examples
|
184
234
|
|
185
235
|
```ruby
|
186
|
-
|
236
|
+
require 'time'
|
187
237
|
require 'ibm_cloud_power'
|
188
238
|
|
189
239
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
190
240
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
191
|
-
body = IbmCloudPower::CreateDataVolume.new # CreateDataVolume | Parameters for the creation of a new data volume
|
241
|
+
body = IbmCloudPower::CreateDataVolume.new({name: 'name_example', size: 3.56}) # CreateDataVolume | Parameters for the creation of a new data volume
|
192
242
|
|
193
243
|
begin
|
194
|
-
#Create a new data volume
|
244
|
+
# Create a new data volume
|
195
245
|
result = api_instance.pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
196
246
|
p result
|
197
247
|
rescue IbmCloudPower::ApiError => e
|
198
|
-
puts "
|
248
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_post: #{e}"
|
199
249
|
end
|
200
250
|
```
|
201
251
|
|
202
|
-
|
252
|
+
#### Using the pcloud_cloudinstances_volumes_post_with_http_info variant
|
253
|
+
|
254
|
+
This returns an Array which contains the response data, status code and headers.
|
255
|
+
|
256
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_post_with_http_info(cloud_instance_id, body)
|
257
|
+
|
258
|
+
```ruby
|
259
|
+
begin
|
260
|
+
# Create a new data volume
|
261
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_post_with_http_info(cloud_instance_id, body)
|
262
|
+
p status_code # => 2xx
|
263
|
+
p headers # => { ... }
|
264
|
+
p data # => <Volume>
|
265
|
+
rescue IbmCloudPower::ApiError => e
|
266
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_post_with_http_info: #{e}"
|
267
|
+
end
|
268
|
+
```
|
203
269
|
|
270
|
+
### Parameters
|
204
271
|
|
205
|
-
Name | Type | Description
|
206
|
-
|
207
|
-
**cloud_instance_id** | **String
|
208
|
-
**body** | [**CreateDataVolume**](CreateDataVolume.md)| Parameters for the creation of a new data volume |
|
272
|
+
| Name | Type | Description | Notes |
|
273
|
+
| ---- | ---- | ----------- | ----- |
|
274
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
275
|
+
| **body** | [**CreateDataVolume**](CreateDataVolume.md) | Parameters for the creation of a new data volume | |
|
209
276
|
|
210
277
|
### Return type
|
211
278
|
|
@@ -223,14 +290,14 @@ No authorization required
|
|
223
290
|
|
224
291
|
## pcloud_cloudinstances_volumes_put
|
225
292
|
|
226
|
-
> Volume pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
293
|
+
> <Volume> pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
227
294
|
|
228
295
|
Update a cloud instance volume
|
229
296
|
|
230
|
-
###
|
297
|
+
### Examples
|
231
298
|
|
232
299
|
```ruby
|
233
|
-
|
300
|
+
require 'time'
|
234
301
|
require 'ibm_cloud_power'
|
235
302
|
|
236
303
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -239,22 +306,39 @@ volume_id = 'volume_id_example' # String | Volume ID
|
|
239
306
|
body = IbmCloudPower::UpdateVolume.new # UpdateVolume | Parameters to update a cloud instance volume
|
240
307
|
|
241
308
|
begin
|
242
|
-
#Update a cloud instance volume
|
309
|
+
# Update a cloud instance volume
|
243
310
|
result = api_instance.pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
244
311
|
p result
|
245
312
|
rescue IbmCloudPower::ApiError => e
|
246
|
-
puts "
|
313
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_put: #{e}"
|
247
314
|
end
|
248
315
|
```
|
249
316
|
|
250
|
-
|
317
|
+
#### Using the pcloud_cloudinstances_volumes_put_with_http_info variant
|
251
318
|
|
319
|
+
This returns an Array which contains the response data, status code and headers.
|
252
320
|
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
321
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_put_with_http_info(cloud_instance_id, volume_id, body)
|
322
|
+
|
323
|
+
```ruby
|
324
|
+
begin
|
325
|
+
# Update a cloud instance volume
|
326
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_put_with_http_info(cloud_instance_id, volume_id, body)
|
327
|
+
p status_code # => 2xx
|
328
|
+
p headers # => { ... }
|
329
|
+
p data # => <Volume>
|
330
|
+
rescue IbmCloudPower::ApiError => e
|
331
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_put_with_http_info: #{e}"
|
332
|
+
end
|
333
|
+
```
|
334
|
+
|
335
|
+
### Parameters
|
336
|
+
|
337
|
+
| Name | Type | Description | Notes |
|
338
|
+
| ---- | ---- | ----------- | ----- |
|
339
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
340
|
+
| **volume_id** | **String** | Volume ID | |
|
341
|
+
| **body** | [**UpdateVolume**](UpdateVolume.md) | Parameters to update a cloud instance volume | |
|
258
342
|
|
259
343
|
### Return type
|
260
344
|
|
@@ -276,10 +360,10 @@ No authorization required
|
|
276
360
|
|
277
361
|
Detach a volume from a PVM Instance
|
278
362
|
|
279
|
-
###
|
363
|
+
### Examples
|
280
364
|
|
281
365
|
```ruby
|
282
|
-
|
366
|
+
require 'time'
|
283
367
|
require 'ibm_cloud_power'
|
284
368
|
|
285
369
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -288,22 +372,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
288
372
|
volume_id = 'volume_id_example' # String | Volume ID
|
289
373
|
|
290
374
|
begin
|
291
|
-
#Detach a volume from a PVM Instance
|
375
|
+
# Detach a volume from a PVM Instance
|
292
376
|
result = api_instance.pcloud_pvminstances_volumes_delete(cloud_instance_id, pvm_instance_id, volume_id)
|
293
377
|
p result
|
294
378
|
rescue IbmCloudPower::ApiError => e
|
295
|
-
puts "
|
379
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_delete: #{e}"
|
296
380
|
end
|
297
381
|
```
|
298
382
|
|
299
|
-
|
383
|
+
#### Using the pcloud_pvminstances_volumes_delete_with_http_info variant
|
300
384
|
|
385
|
+
This returns an Array which contains the response data, status code and headers.
|
301
386
|
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
387
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_delete_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
388
|
+
|
389
|
+
```ruby
|
390
|
+
begin
|
391
|
+
# Detach a volume from a PVM Instance
|
392
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_delete_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
393
|
+
p status_code # => 2xx
|
394
|
+
p headers # => { ... }
|
395
|
+
p data # => Object
|
396
|
+
rescue IbmCloudPower::ApiError => e
|
397
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_delete_with_http_info: #{e}"
|
398
|
+
end
|
399
|
+
```
|
400
|
+
|
401
|
+
### Parameters
|
402
|
+
|
403
|
+
| Name | Type | Description | Notes |
|
404
|
+
| ---- | ---- | ----------- | ----- |
|
405
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
406
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
407
|
+
| **volume_id** | **String** | Volume ID | |
|
307
408
|
|
308
409
|
### Return type
|
309
410
|
|
@@ -321,14 +422,14 @@ No authorization required
|
|
321
422
|
|
322
423
|
## pcloud_pvminstances_volumes_get
|
323
424
|
|
324
|
-
> Volume pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
425
|
+
> <Volume> pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
325
426
|
|
326
427
|
Detailed information of a volume attached to a PVM Instance
|
327
428
|
|
328
|
-
###
|
429
|
+
### Examples
|
329
430
|
|
330
431
|
```ruby
|
331
|
-
|
432
|
+
require 'time'
|
332
433
|
require 'ibm_cloud_power'
|
333
434
|
|
334
435
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -337,22 +438,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
337
438
|
volume_id = 'volume_id_example' # String | Volume ID
|
338
439
|
|
339
440
|
begin
|
340
|
-
#Detailed information of a volume attached to a PVM Instance
|
441
|
+
# Detailed information of a volume attached to a PVM Instance
|
341
442
|
result = api_instance.pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
342
443
|
p result
|
343
444
|
rescue IbmCloudPower::ApiError => e
|
344
|
-
puts "
|
445
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_get: #{e}"
|
345
446
|
end
|
346
447
|
```
|
347
448
|
|
348
|
-
|
449
|
+
#### Using the pcloud_pvminstances_volumes_get_with_http_info variant
|
450
|
+
|
451
|
+
This returns an Array which contains the response data, status code and headers.
|
452
|
+
|
453
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_pvminstances_volumes_get_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
454
|
+
|
455
|
+
```ruby
|
456
|
+
begin
|
457
|
+
# Detailed information of a volume attached to a PVM Instance
|
458
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_get_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
459
|
+
p status_code # => 2xx
|
460
|
+
p headers # => { ... }
|
461
|
+
p data # => <Volume>
|
462
|
+
rescue IbmCloudPower::ApiError => e
|
463
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_get_with_http_info: #{e}"
|
464
|
+
end
|
465
|
+
```
|
349
466
|
|
467
|
+
### Parameters
|
350
468
|
|
351
|
-
Name | Type | Description
|
352
|
-
|
353
|
-
**cloud_instance_id** | **String
|
354
|
-
**pvm_instance_id** | **String
|
355
|
-
**volume_id** | **String
|
469
|
+
| Name | Type | Description | Notes |
|
470
|
+
| ---- | ---- | ----------- | ----- |
|
471
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
472
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
473
|
+
| **volume_id** | **String** | Volume ID | |
|
356
474
|
|
357
475
|
### Return type
|
358
476
|
|
@@ -370,14 +488,14 @@ No authorization required
|
|
370
488
|
|
371
489
|
## pcloud_pvminstances_volumes_getall
|
372
490
|
|
373
|
-
> Volumes pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
491
|
+
> <Volumes> pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
374
492
|
|
375
493
|
List all volumes attached to a PVM Instance
|
376
494
|
|
377
|
-
###
|
495
|
+
### Examples
|
378
496
|
|
379
497
|
```ruby
|
380
|
-
|
498
|
+
require 'time'
|
381
499
|
require 'ibm_cloud_power'
|
382
500
|
|
383
501
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -385,21 +503,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
385
503
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
386
504
|
|
387
505
|
begin
|
388
|
-
#List all volumes attached to a PVM Instance
|
506
|
+
# List all volumes attached to a PVM Instance
|
389
507
|
result = api_instance.pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
390
508
|
p result
|
391
509
|
rescue IbmCloudPower::ApiError => e
|
392
|
-
puts "
|
510
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_getall: #{e}"
|
393
511
|
end
|
394
512
|
```
|
395
513
|
|
396
|
-
|
514
|
+
#### Using the pcloud_pvminstances_volumes_getall_with_http_info variant
|
515
|
+
|
516
|
+
This returns an Array which contains the response data, status code and headers.
|
517
|
+
|
518
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_pvminstances_volumes_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
519
|
+
|
520
|
+
```ruby
|
521
|
+
begin
|
522
|
+
# List all volumes attached to a PVM Instance
|
523
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
524
|
+
p status_code # => 2xx
|
525
|
+
p headers # => { ... }
|
526
|
+
p data # => <Volumes>
|
527
|
+
rescue IbmCloudPower::ApiError => e
|
528
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_getall_with_http_info: #{e}"
|
529
|
+
end
|
530
|
+
```
|
397
531
|
|
532
|
+
### Parameters
|
398
533
|
|
399
|
-
Name | Type | Description
|
400
|
-
|
401
|
-
**cloud_instance_id** | **String
|
402
|
-
**pvm_instance_id** | **String
|
534
|
+
| Name | Type | Description | Notes |
|
535
|
+
| ---- | ---- | ----------- | ----- |
|
536
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
537
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
403
538
|
|
404
539
|
### Return type
|
405
540
|
|
@@ -421,10 +556,10 @@ No authorization required
|
|
421
556
|
|
422
557
|
Attach a volume to a PVM Instance
|
423
558
|
|
424
|
-
###
|
559
|
+
### Examples
|
425
560
|
|
426
561
|
```ruby
|
427
|
-
|
562
|
+
require 'time'
|
428
563
|
require 'ibm_cloud_power'
|
429
564
|
|
430
565
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -433,22 +568,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
433
568
|
volume_id = 'volume_id_example' # String | Volume ID
|
434
569
|
|
435
570
|
begin
|
436
|
-
#Attach a volume to a PVM Instance
|
571
|
+
# Attach a volume to a PVM Instance
|
437
572
|
result = api_instance.pcloud_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, volume_id)
|
438
573
|
p result
|
439
574
|
rescue IbmCloudPower::ApiError => e
|
440
|
-
puts "
|
575
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_post: #{e}"
|
441
576
|
end
|
442
577
|
```
|
443
578
|
|
444
|
-
|
579
|
+
#### Using the pcloud_pvminstances_volumes_post_with_http_info variant
|
445
580
|
|
581
|
+
This returns an Array which contains the response data, status code and headers.
|
446
582
|
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
583
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
584
|
+
|
585
|
+
```ruby
|
586
|
+
begin
|
587
|
+
# Attach a volume to a PVM Instance
|
588
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
589
|
+
p status_code # => 2xx
|
590
|
+
p headers # => { ... }
|
591
|
+
p data # => Object
|
592
|
+
rescue IbmCloudPower::ApiError => e
|
593
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_post_with_http_info: #{e}"
|
594
|
+
end
|
595
|
+
```
|
596
|
+
|
597
|
+
### Parameters
|
598
|
+
|
599
|
+
| Name | Type | Description | Notes |
|
600
|
+
| ---- | ---- | ----------- | ----- |
|
601
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
602
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
603
|
+
| **volume_id** | **String** | Volume ID | |
|
452
604
|
|
453
605
|
### Return type
|
454
606
|
|
@@ -470,36 +622,53 @@ No authorization required
|
|
470
622
|
|
471
623
|
Update a volume attached to a PVMInstance
|
472
624
|
|
473
|
-
###
|
625
|
+
### Examples
|
474
626
|
|
475
627
|
```ruby
|
476
|
-
|
628
|
+
require 'time'
|
477
629
|
require 'ibm_cloud_power'
|
478
630
|
|
479
631
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
480
632
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
481
633
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
482
634
|
volume_id = 'volume_id_example' # String | Volume ID
|
483
|
-
body = IbmCloudPower::PVMInstanceVolumeUpdate.new # PVMInstanceVolumeUpdate | Parameters to update a volume attached to a PVMInstance
|
635
|
+
body = IbmCloudPower::PVMInstanceVolumeUpdate.new({delete_on_termination: false}) # PVMInstanceVolumeUpdate | Parameters to update a volume attached to a PVMInstance
|
484
636
|
|
485
637
|
begin
|
486
|
-
#Update a volume attached to a PVMInstance
|
638
|
+
# Update a volume attached to a PVMInstance
|
487
639
|
result = api_instance.pcloud_pvminstances_volumes_put(cloud_instance_id, pvm_instance_id, volume_id, body)
|
488
640
|
p result
|
489
641
|
rescue IbmCloudPower::ApiError => e
|
490
|
-
puts "
|
642
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_put: #{e}"
|
491
643
|
end
|
492
644
|
```
|
493
645
|
|
494
|
-
|
646
|
+
#### Using the pcloud_pvminstances_volumes_put_with_http_info variant
|
647
|
+
|
648
|
+
This returns an Array which contains the response data, status code and headers.
|
495
649
|
|
650
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id, body)
|
496
651
|
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
652
|
+
```ruby
|
653
|
+
begin
|
654
|
+
# Update a volume attached to a PVMInstance
|
655
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id, body)
|
656
|
+
p status_code # => 2xx
|
657
|
+
p headers # => { ... }
|
658
|
+
p data # => Object
|
659
|
+
rescue IbmCloudPower::ApiError => e
|
660
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_put_with_http_info: #{e}"
|
661
|
+
end
|
662
|
+
```
|
663
|
+
|
664
|
+
### Parameters
|
665
|
+
|
666
|
+
| Name | Type | Description | Notes |
|
667
|
+
| ---- | ---- | ----------- | ----- |
|
668
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
669
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
670
|
+
| **volume_id** | **String** | Volume ID | |
|
671
|
+
| **body** | [**PVMInstanceVolumeUpdate**](PVMInstanceVolumeUpdate.md) | Parameters to update a volume attached to a PVMInstance | |
|
503
672
|
|
504
673
|
### Return type
|
505
674
|
|
@@ -521,10 +690,10 @@ No authorization required
|
|
521
690
|
|
522
691
|
Set the PVMInstance volume as the boot volume
|
523
692
|
|
524
|
-
###
|
693
|
+
### Examples
|
525
694
|
|
526
695
|
```ruby
|
527
|
-
|
696
|
+
require 'time'
|
528
697
|
require 'ibm_cloud_power'
|
529
698
|
|
530
699
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -533,22 +702,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
533
702
|
volume_id = 'volume_id_example' # String | Volume ID
|
534
703
|
|
535
704
|
begin
|
536
|
-
#Set the PVMInstance volume as the boot volume
|
705
|
+
# Set the PVMInstance volume as the boot volume
|
537
706
|
result = api_instance.pcloud_pvminstances_volumes_setboot_put(cloud_instance_id, pvm_instance_id, volume_id)
|
538
707
|
p result
|
539
708
|
rescue IbmCloudPower::ApiError => e
|
540
|
-
puts "
|
709
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_setboot_put: #{e}"
|
541
710
|
end
|
542
711
|
```
|
543
712
|
|
544
|
-
|
713
|
+
#### Using the pcloud_pvminstances_volumes_setboot_put_with_http_info variant
|
545
714
|
|
715
|
+
This returns an Array which contains the response data, status code and headers.
|
716
|
+
|
717
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_setboot_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
718
|
+
|
719
|
+
```ruby
|
720
|
+
begin
|
721
|
+
# Set the PVMInstance volume as the boot volume
|
722
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_setboot_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
723
|
+
p status_code # => 2xx
|
724
|
+
p headers # => { ... }
|
725
|
+
p data # => Object
|
726
|
+
rescue IbmCloudPower::ApiError => e
|
727
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_setboot_put_with_http_info: #{e}"
|
728
|
+
end
|
729
|
+
```
|
730
|
+
|
731
|
+
### Parameters
|
546
732
|
|
547
|
-
Name | Type | Description
|
548
|
-
|
549
|
-
**cloud_instance_id** | **String
|
550
|
-
**pvm_instance_id** | **String
|
551
|
-
**volume_id** | **String
|
733
|
+
| Name | Type | Description | Notes |
|
734
|
+
| ---- | ---- | ----------- | ----- |
|
735
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
736
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
737
|
+
| **volume_id** | **String** | Volume ID | |
|
552
738
|
|
553
739
|
### Return type
|
554
740
|
|
@@ -566,36 +752,53 @@ No authorization required
|
|
566
752
|
|
567
753
|
## pcloud_v2_volumes_clone_post
|
568
754
|
|
569
|
-
> CloneTaskReference pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
755
|
+
> <CloneTaskReference> pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
570
756
|
|
571
757
|
Create a volume clone for specified volumes (version 2)
|
572
758
|
|
573
|
-
###
|
759
|
+
### Examples
|
574
760
|
|
575
761
|
```ruby
|
576
|
-
|
762
|
+
require 'time'
|
577
763
|
require 'ibm_cloud_power'
|
578
764
|
|
579
765
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
580
766
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
581
|
-
body = IbmCloudPower::VolumesCloneAsyncRequest.new # VolumesCloneAsyncRequest | Parameters for the cloning of volumes
|
767
|
+
body = IbmCloudPower::VolumesCloneAsyncRequest.new({name: 'name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneAsyncRequest | Parameters for the cloning of volumes
|
582
768
|
|
583
769
|
begin
|
584
|
-
#Create a volume clone for specified volumes (version 2)
|
770
|
+
# Create a volume clone for specified volumes (version 2)
|
585
771
|
result = api_instance.pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
586
772
|
p result
|
587
773
|
rescue IbmCloudPower::ApiError => e
|
588
|
-
puts "
|
774
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clone_post: #{e}"
|
589
775
|
end
|
590
776
|
```
|
591
777
|
|
592
|
-
|
778
|
+
#### Using the pcloud_v2_volumes_clone_post_with_http_info variant
|
779
|
+
|
780
|
+
This returns an Array which contains the response data, status code and headers.
|
781
|
+
|
782
|
+
> <Array(<CloneTaskReference>, Integer, Hash)> pcloud_v2_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
783
|
+
|
784
|
+
```ruby
|
785
|
+
begin
|
786
|
+
# Create a volume clone for specified volumes (version 2)
|
787
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
788
|
+
p status_code # => 2xx
|
789
|
+
p headers # => { ... }
|
790
|
+
p data # => <CloneTaskReference>
|
791
|
+
rescue IbmCloudPower::ApiError => e
|
792
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clone_post_with_http_info: #{e}"
|
793
|
+
end
|
794
|
+
```
|
593
795
|
|
796
|
+
### Parameters
|
594
797
|
|
595
|
-
Name | Type | Description
|
596
|
-
|
597
|
-
**cloud_instance_id** | **String
|
598
|
-
**body** | [**VolumesCloneAsyncRequest**](VolumesCloneAsyncRequest.md)| Parameters for the cloning of volumes |
|
798
|
+
| Name | Type | Description | Notes |
|
799
|
+
| ---- | ---- | ----------- | ----- |
|
800
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
801
|
+
| **body** | [**VolumesCloneAsyncRequest**](VolumesCloneAsyncRequest.md) | Parameters for the cloning of volumes | |
|
599
802
|
|
600
803
|
### Return type
|
601
804
|
|
@@ -613,14 +816,14 @@ No authorization required
|
|
613
816
|
|
614
817
|
## pcloud_v2_volumes_clonetasks_get
|
615
818
|
|
616
|
-
> CloneTaskStatus pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
819
|
+
> <CloneTaskStatus> pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
617
820
|
|
618
821
|
Get the status of a volume clone request for the specified clone task ID
|
619
822
|
|
620
|
-
###
|
823
|
+
### Examples
|
621
824
|
|
622
825
|
```ruby
|
623
|
-
|
826
|
+
require 'time'
|
624
827
|
require 'ibm_cloud_power'
|
625
828
|
|
626
829
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -628,21 +831,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
628
831
|
clone_task_id = 'clone_task_id_example' # String | Volumes Clone Task ID
|
629
832
|
|
630
833
|
begin
|
631
|
-
#Get the status of a volume clone request for the specified clone task ID
|
834
|
+
# Get the status of a volume clone request for the specified clone task ID
|
632
835
|
result = api_instance.pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
633
836
|
p result
|
634
837
|
rescue IbmCloudPower::ApiError => e
|
635
|
-
puts "
|
838
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clonetasks_get: #{e}"
|
636
839
|
end
|
637
840
|
```
|
638
841
|
|
639
|
-
|
842
|
+
#### Using the pcloud_v2_volumes_clonetasks_get_with_http_info variant
|
843
|
+
|
844
|
+
This returns an Array which contains the response data, status code and headers.
|
845
|
+
|
846
|
+
> <Array(<CloneTaskStatus>, Integer, Hash)> pcloud_v2_volumes_clonetasks_get_with_http_info(cloud_instance_id, clone_task_id)
|
847
|
+
|
848
|
+
```ruby
|
849
|
+
begin
|
850
|
+
# Get the status of a volume clone request for the specified clone task ID
|
851
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_clonetasks_get_with_http_info(cloud_instance_id, clone_task_id)
|
852
|
+
p status_code # => 2xx
|
853
|
+
p headers # => { ... }
|
854
|
+
p data # => <CloneTaskStatus>
|
855
|
+
rescue IbmCloudPower::ApiError => e
|
856
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clonetasks_get_with_http_info: #{e}"
|
857
|
+
end
|
858
|
+
```
|
640
859
|
|
860
|
+
### Parameters
|
641
861
|
|
642
|
-
Name | Type | Description
|
643
|
-
|
644
|
-
**cloud_instance_id** | **String
|
645
|
-
**clone_task_id** | **String
|
862
|
+
| Name | Type | Description | Notes |
|
863
|
+
| ---- | ---- | ----------- | ----- |
|
864
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
865
|
+
| **clone_task_id** | **String** | Volumes Clone Task ID | |
|
646
866
|
|
647
867
|
### Return type
|
648
868
|
|
@@ -660,36 +880,53 @@ No authorization required
|
|
660
880
|
|
661
881
|
## pcloud_v2_volumes_post
|
662
882
|
|
663
|
-
> Volumes pcloud_v2_volumes_post(cloud_instance_id, body)
|
883
|
+
> <Volumes> pcloud_v2_volumes_post(cloud_instance_id, body)
|
664
884
|
|
665
885
|
Create multiple data volumes from a single definition
|
666
886
|
|
667
|
-
###
|
887
|
+
### Examples
|
668
888
|
|
669
889
|
```ruby
|
670
|
-
|
890
|
+
require 'time'
|
671
891
|
require 'ibm_cloud_power'
|
672
892
|
|
673
893
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
674
894
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
675
|
-
body = IbmCloudPower::MultiVolumesCreate.new # MultiVolumesCreate | Parameters for creating multiple volumes
|
895
|
+
body = IbmCloudPower::MultiVolumesCreate.new({name: 'name_example', size: 37}) # MultiVolumesCreate | Parameters for creating multiple volumes
|
676
896
|
|
677
897
|
begin
|
678
|
-
#Create multiple data volumes from a single definition
|
898
|
+
# Create multiple data volumes from a single definition
|
679
899
|
result = api_instance.pcloud_v2_volumes_post(cloud_instance_id, body)
|
680
900
|
p result
|
681
901
|
rescue IbmCloudPower::ApiError => e
|
682
|
-
puts "
|
902
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_post: #{e}"
|
683
903
|
end
|
684
904
|
```
|
685
905
|
|
686
|
-
|
906
|
+
#### Using the pcloud_v2_volumes_post_with_http_info variant
|
687
907
|
|
908
|
+
This returns an Array which contains the response data, status code and headers.
|
688
909
|
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
910
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_v2_volumes_post_with_http_info(cloud_instance_id, body)
|
911
|
+
|
912
|
+
```ruby
|
913
|
+
begin
|
914
|
+
# Create multiple data volumes from a single definition
|
915
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_post_with_http_info(cloud_instance_id, body)
|
916
|
+
p status_code # => 2xx
|
917
|
+
p headers # => { ... }
|
918
|
+
p data # => <Volumes>
|
919
|
+
rescue IbmCloudPower::ApiError => e
|
920
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_post_with_http_info: #{e}"
|
921
|
+
end
|
922
|
+
```
|
923
|
+
|
924
|
+
### Parameters
|
925
|
+
|
926
|
+
| Name | Type | Description | Notes |
|
927
|
+
| ---- | ---- | ----------- | ----- |
|
928
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
929
|
+
| **body** | [**MultiVolumesCreate**](MultiVolumesCreate.md) | Parameters for creating multiple volumes | |
|
693
930
|
|
694
931
|
### Return type
|
695
932
|
|
@@ -707,14 +944,14 @@ No authorization required
|
|
707
944
|
|
708
945
|
## pcloud_v2_volumesclone_cancel_post
|
709
946
|
|
710
|
-
> VolumesClone pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
947
|
+
> <VolumesClone> pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
711
948
|
|
712
949
|
Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes.
|
713
950
|
|
714
|
-
###
|
951
|
+
### Examples
|
715
952
|
|
716
953
|
```ruby
|
717
|
-
|
954
|
+
require 'time'
|
718
955
|
require 'ibm_cloud_power'
|
719
956
|
|
720
957
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -725,22 +962,39 @@ opts = {
|
|
725
962
|
}
|
726
963
|
|
727
964
|
begin
|
728
|
-
#Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes.
|
965
|
+
# Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes.
|
729
966
|
result = api_instance.pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
730
967
|
p result
|
731
968
|
rescue IbmCloudPower::ApiError => e
|
732
|
-
puts "
|
969
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_cancel_post: #{e}"
|
733
970
|
end
|
734
971
|
```
|
735
972
|
|
736
|
-
|
973
|
+
#### Using the pcloud_v2_volumesclone_cancel_post_with_http_info variant
|
974
|
+
|
975
|
+
This returns an Array which contains the response data, status code and headers.
|
976
|
+
|
977
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_cancel_post_with_http_info(cloud_instance_id, volumes_clone_id, opts)
|
978
|
+
|
979
|
+
```ruby
|
980
|
+
begin
|
981
|
+
# Cancel a volume-clone request, initiates the Cleanup action. The Cleanup action performs the cleanup of the preparatory clones and snapshot volumes.
|
982
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_cancel_post_with_http_info(cloud_instance_id, volumes_clone_id, opts)
|
983
|
+
p status_code # => 2xx
|
984
|
+
p headers # => { ... }
|
985
|
+
p data # => <VolumesClone>
|
986
|
+
rescue IbmCloudPower::ApiError => e
|
987
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_cancel_post_with_http_info: #{e}"
|
988
|
+
end
|
989
|
+
```
|
737
990
|
|
991
|
+
### Parameters
|
738
992
|
|
739
|
-
Name | Type | Description
|
740
|
-
|
741
|
-
**cloud_instance_id** | **String
|
742
|
-
**volumes_clone_id** | **String
|
743
|
-
**body** | [**VolumesCloneCancel**](VolumesCloneCancel.md)| Parameters for cancelling a volumes-clone request | [optional]
|
993
|
+
| Name | Type | Description | Notes |
|
994
|
+
| ---- | ---- | ----------- | ----- |
|
995
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
996
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name | |
|
997
|
+
| **body** | [**VolumesCloneCancel**](VolumesCloneCancel.md) | Parameters for cancelling a volumes-clone request | [optional] |
|
744
998
|
|
745
999
|
### Return type
|
746
1000
|
|
@@ -762,10 +1016,10 @@ No authorization required
|
|
762
1016
|
|
763
1017
|
Delete a volumes-clone request
|
764
1018
|
|
765
|
-
###
|
1019
|
+
### Examples
|
766
1020
|
|
767
1021
|
```ruby
|
768
|
-
|
1022
|
+
require 'time'
|
769
1023
|
require 'ibm_cloud_power'
|
770
1024
|
|
771
1025
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -773,21 +1027,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
773
1027
|
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name
|
774
1028
|
|
775
1029
|
begin
|
776
|
-
#Delete a volumes-clone request
|
1030
|
+
# Delete a volumes-clone request
|
777
1031
|
result = api_instance.pcloud_v2_volumesclone_delete(cloud_instance_id, volumes_clone_id)
|
778
1032
|
p result
|
779
1033
|
rescue IbmCloudPower::ApiError => e
|
780
|
-
puts "
|
1034
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_delete: #{e}"
|
781
1035
|
end
|
782
1036
|
```
|
783
1037
|
|
784
|
-
|
1038
|
+
#### Using the pcloud_v2_volumesclone_delete_with_http_info variant
|
785
1039
|
|
1040
|
+
This returns an Array which contains the response data, status code and headers.
|
786
1041
|
|
787
|
-
|
788
|
-
|
789
|
-
|
790
|
-
|
1042
|
+
> <Array(Object, Integer, Hash)> pcloud_v2_volumesclone_delete_with_http_info(cloud_instance_id, volumes_clone_id)
|
1043
|
+
|
1044
|
+
```ruby
|
1045
|
+
begin
|
1046
|
+
# Delete a volumes-clone request
|
1047
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_delete_with_http_info(cloud_instance_id, volumes_clone_id)
|
1048
|
+
p status_code # => 2xx
|
1049
|
+
p headers # => { ... }
|
1050
|
+
p data # => Object
|
1051
|
+
rescue IbmCloudPower::ApiError => e
|
1052
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_delete_with_http_info: #{e}"
|
1053
|
+
end
|
1054
|
+
```
|
1055
|
+
|
1056
|
+
### Parameters
|
1057
|
+
|
1058
|
+
| Name | Type | Description | Notes |
|
1059
|
+
| ---- | ---- | ----------- | ----- |
|
1060
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1061
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name | |
|
791
1062
|
|
792
1063
|
### Return type
|
793
1064
|
|
@@ -805,38 +1076,55 @@ No authorization required
|
|
805
1076
|
|
806
1077
|
## pcloud_v2_volumesclone_execute_post
|
807
1078
|
|
808
|
-
> VolumesClone pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
1079
|
+
> <VolumesClone> pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
809
1080
|
|
810
1081
|
Initiate the Execute action for a volumes-clone request. The Execute action creates the cloned volumes using the volume snapshots.
|
811
1082
|
|
812
|
-
###
|
1083
|
+
### Examples
|
813
1084
|
|
814
1085
|
```ruby
|
815
|
-
|
1086
|
+
require 'time'
|
816
1087
|
require 'ibm_cloud_power'
|
817
1088
|
|
818
1089
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
819
1090
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
820
1091
|
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name
|
821
|
-
body = IbmCloudPower::VolumesCloneExecute.new # VolumesCloneExecute | Parameters for the cloning of volumes
|
1092
|
+
body = IbmCloudPower::VolumesCloneExecute.new({name: 'name_example'}) # VolumesCloneExecute | Parameters for the cloning of volumes
|
822
1093
|
|
823
1094
|
begin
|
824
|
-
#Initiate the Execute action for a volumes-clone request. The Execute action creates the cloned volumes using the volume snapshots.
|
1095
|
+
# Initiate the Execute action for a volumes-clone request. The Execute action creates the cloned volumes using the volume snapshots.
|
825
1096
|
result = api_instance.pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
826
1097
|
p result
|
827
1098
|
rescue IbmCloudPower::ApiError => e
|
828
|
-
puts "
|
1099
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_execute_post: #{e}"
|
829
1100
|
end
|
830
1101
|
```
|
831
1102
|
|
832
|
-
|
1103
|
+
#### Using the pcloud_v2_volumesclone_execute_post_with_http_info variant
|
1104
|
+
|
1105
|
+
This returns an Array which contains the response data, status code and headers.
|
1106
|
+
|
1107
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_execute_post_with_http_info(cloud_instance_id, volumes_clone_id, body)
|
1108
|
+
|
1109
|
+
```ruby
|
1110
|
+
begin
|
1111
|
+
# Initiate the Execute action for a volumes-clone request. The Execute action creates the cloned volumes using the volume snapshots.
|
1112
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_execute_post_with_http_info(cloud_instance_id, volumes_clone_id, body)
|
1113
|
+
p status_code # => 2xx
|
1114
|
+
p headers # => { ... }
|
1115
|
+
p data # => <VolumesClone>
|
1116
|
+
rescue IbmCloudPower::ApiError => e
|
1117
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_execute_post_with_http_info: #{e}"
|
1118
|
+
end
|
1119
|
+
```
|
833
1120
|
|
1121
|
+
### Parameters
|
834
1122
|
|
835
|
-
Name | Type | Description
|
836
|
-
|
837
|
-
**cloud_instance_id** | **String
|
838
|
-
**volumes_clone_id** | **String
|
839
|
-
**body** | [**VolumesCloneExecute**](VolumesCloneExecute.md)| Parameters for the cloning of volumes |
|
1123
|
+
| Name | Type | Description | Notes |
|
1124
|
+
| ---- | ---- | ----------- | ----- |
|
1125
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1126
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name | |
|
1127
|
+
| **body** | [**VolumesCloneExecute**](VolumesCloneExecute.md) | Parameters for the cloning of volumes | |
|
840
1128
|
|
841
1129
|
### Return type
|
842
1130
|
|
@@ -854,14 +1142,14 @@ No authorization required
|
|
854
1142
|
|
855
1143
|
## pcloud_v2_volumesclone_get
|
856
1144
|
|
857
|
-
> VolumesCloneDetail pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
1145
|
+
> <VolumesCloneDetail> pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
858
1146
|
|
859
1147
|
Get the details for a volumes-clone request
|
860
1148
|
|
861
|
-
###
|
1149
|
+
### Examples
|
862
1150
|
|
863
1151
|
```ruby
|
864
|
-
|
1152
|
+
require 'time'
|
865
1153
|
require 'ibm_cloud_power'
|
866
1154
|
|
867
1155
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -869,21 +1157,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
869
1157
|
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name
|
870
1158
|
|
871
1159
|
begin
|
872
|
-
#Get the details for a volumes-clone request
|
1160
|
+
# Get the details for a volumes-clone request
|
873
1161
|
result = api_instance.pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
874
1162
|
p result
|
875
1163
|
rescue IbmCloudPower::ApiError => e
|
876
|
-
puts "
|
1164
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_get: #{e}"
|
877
1165
|
end
|
878
1166
|
```
|
879
1167
|
|
880
|
-
|
1168
|
+
#### Using the pcloud_v2_volumesclone_get_with_http_info variant
|
1169
|
+
|
1170
|
+
This returns an Array which contains the response data, status code and headers.
|
1171
|
+
|
1172
|
+
> <Array(<VolumesCloneDetail>, Integer, Hash)> pcloud_v2_volumesclone_get_with_http_info(cloud_instance_id, volumes_clone_id)
|
1173
|
+
|
1174
|
+
```ruby
|
1175
|
+
begin
|
1176
|
+
# Get the details for a volumes-clone request
|
1177
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_get_with_http_info(cloud_instance_id, volumes_clone_id)
|
1178
|
+
p status_code # => 2xx
|
1179
|
+
p headers # => { ... }
|
1180
|
+
p data # => <VolumesCloneDetail>
|
1181
|
+
rescue IbmCloudPower::ApiError => e
|
1182
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_get_with_http_info: #{e}"
|
1183
|
+
end
|
1184
|
+
```
|
881
1185
|
|
1186
|
+
### Parameters
|
882
1187
|
|
883
|
-
Name | Type | Description
|
884
|
-
|
885
|
-
**cloud_instance_id** | **String
|
886
|
-
**volumes_clone_id** | **String
|
1188
|
+
| Name | Type | Description | Notes |
|
1189
|
+
| ---- | ---- | ----------- | ----- |
|
1190
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1191
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name | |
|
887
1192
|
|
888
1193
|
### Return type
|
889
1194
|
|
@@ -901,38 +1206,55 @@ No authorization required
|
|
901
1206
|
|
902
1207
|
## pcloud_v2_volumesclone_getall
|
903
1208
|
|
904
|
-
> VolumesClones pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
1209
|
+
> <VolumesClones> pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
905
1210
|
|
906
1211
|
Get the list of volumes-clone request for a cloud instance
|
907
1212
|
|
908
|
-
###
|
1213
|
+
### Examples
|
909
1214
|
|
910
1215
|
```ruby
|
911
|
-
|
1216
|
+
require 'time'
|
912
1217
|
require 'ibm_cloud_power'
|
913
1218
|
|
914
1219
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
915
1220
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
916
1221
|
opts = {
|
917
|
-
filter: '
|
1222
|
+
filter: 'prepare' # String | volumes-clone filter to limit list items: prepare - includes status values (preparing, prepared) start - includes status values (starting, available) execute - includes status values (executing, available-rollback) cancel - includes status values (cancelling) completed - includes status values (completed) failed - includes status values (failed) cancelled - includes status values (cancelled) finalized - included status values (completed, failed, cancelled)
|
918
1223
|
}
|
919
1224
|
|
920
1225
|
begin
|
921
|
-
#Get the list of volumes-clone request for a cloud instance
|
1226
|
+
# Get the list of volumes-clone request for a cloud instance
|
922
1227
|
result = api_instance.pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
923
1228
|
p result
|
924
1229
|
rescue IbmCloudPower::ApiError => e
|
925
|
-
puts "
|
1230
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_getall: #{e}"
|
926
1231
|
end
|
927
1232
|
```
|
928
1233
|
|
929
|
-
|
1234
|
+
#### Using the pcloud_v2_volumesclone_getall_with_http_info variant
|
1235
|
+
|
1236
|
+
This returns an Array which contains the response data, status code and headers.
|
1237
|
+
|
1238
|
+
> <Array(<VolumesClones>, Integer, Hash)> pcloud_v2_volumesclone_getall_with_http_info(cloud_instance_id, opts)
|
1239
|
+
|
1240
|
+
```ruby
|
1241
|
+
begin
|
1242
|
+
# Get the list of volumes-clone request for a cloud instance
|
1243
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_getall_with_http_info(cloud_instance_id, opts)
|
1244
|
+
p status_code # => 2xx
|
1245
|
+
p headers # => { ... }
|
1246
|
+
p data # => <VolumesClones>
|
1247
|
+
rescue IbmCloudPower::ApiError => e
|
1248
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_getall_with_http_info: #{e}"
|
1249
|
+
end
|
1250
|
+
```
|
930
1251
|
|
1252
|
+
### Parameters
|
931
1253
|
|
932
|
-
Name | Type | Description
|
933
|
-
|
934
|
-
**cloud_instance_id** | **String
|
935
|
-
**filter** | **String
|
1254
|
+
| Name | Type | Description | Notes |
|
1255
|
+
| ---- | ---- | ----------- | ----- |
|
1256
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1257
|
+
| **filter** | **String** | volumes-clone filter to limit list items: prepare - includes status values (preparing, prepared) start - includes status values (starting, available) execute - includes status values (executing, available-rollback) cancel - includes status values (cancelling) completed - includes status values (completed) failed - includes status values (failed) cancelled - includes status values (cancelled) finalized - included status values (completed, failed, cancelled) | [optional] |
|
936
1258
|
|
937
1259
|
### Return type
|
938
1260
|
|
@@ -950,36 +1272,53 @@ No authorization required
|
|
950
1272
|
|
951
1273
|
## pcloud_v2_volumesclone_post
|
952
1274
|
|
953
|
-
> VolumesClone pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
1275
|
+
> <VolumesClone> pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
954
1276
|
|
955
1277
|
Create a new volumes clone request and initiate the Prepare action
|
956
1278
|
|
957
|
-
###
|
1279
|
+
### Examples
|
958
1280
|
|
959
1281
|
```ruby
|
960
|
-
|
1282
|
+
require 'time'
|
961
1283
|
require 'ibm_cloud_power'
|
962
1284
|
|
963
1285
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
964
1286
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
965
|
-
body = IbmCloudPower::VolumesCloneCreate.new # VolumesCloneCreate | Parameters for preparing a set of volumes to be cloned (This API requires a minimum of two volumes, a minimum of one volume to be in the 'in-use' state, and a unique volume clone name. The Prepare action does the preparatory work for creating the snapshot volumes.)
|
1287
|
+
body = IbmCloudPower::VolumesCloneCreate.new({name: 'name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneCreate | Parameters for preparing a set of volumes to be cloned (This API requires a minimum of two volumes, a minimum of one volume to be in the 'in-use' state, and a unique volume clone name. The Prepare action does the preparatory work for creating the snapshot volumes.)
|
966
1288
|
|
967
1289
|
begin
|
968
|
-
#Create a new volumes clone request and initiate the Prepare action
|
1290
|
+
# Create a new volumes clone request and initiate the Prepare action
|
969
1291
|
result = api_instance.pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
970
1292
|
p result
|
971
1293
|
rescue IbmCloudPower::ApiError => e
|
972
|
-
puts "
|
1294
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_post: #{e}"
|
973
1295
|
end
|
974
1296
|
```
|
975
1297
|
|
976
|
-
|
1298
|
+
#### Using the pcloud_v2_volumesclone_post_with_http_info variant
|
977
1299
|
|
1300
|
+
This returns an Array which contains the response data, status code and headers.
|
978
1301
|
|
979
|
-
|
980
|
-
|
981
|
-
|
982
|
-
|
1302
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_post_with_http_info(cloud_instance_id, body)
|
1303
|
+
|
1304
|
+
```ruby
|
1305
|
+
begin
|
1306
|
+
# Create a new volumes clone request and initiate the Prepare action
|
1307
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_post_with_http_info(cloud_instance_id, body)
|
1308
|
+
p status_code # => 2xx
|
1309
|
+
p headers # => { ... }
|
1310
|
+
p data # => <VolumesClone>
|
1311
|
+
rescue IbmCloudPower::ApiError => e
|
1312
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_post_with_http_info: #{e}"
|
1313
|
+
end
|
1314
|
+
```
|
1315
|
+
|
1316
|
+
### Parameters
|
1317
|
+
|
1318
|
+
| Name | Type | Description | Notes |
|
1319
|
+
| ---- | ---- | ----------- | ----- |
|
1320
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1321
|
+
| **body** | [**VolumesCloneCreate**](VolumesCloneCreate.md) | Parameters for preparing a set of volumes to be cloned (This API requires a minimum of two volumes, a minimum of one volume to be in the 'in-use' state, and a unique volume clone name. The Prepare action does the preparatory work for creating the snapshot volumes.) | |
|
983
1322
|
|
984
1323
|
### Return type
|
985
1324
|
|
@@ -997,14 +1336,14 @@ No authorization required
|
|
997
1336
|
|
998
1337
|
## pcloud_v2_volumesclone_start_post
|
999
1338
|
|
1000
|
-
> VolumesClone pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1339
|
+
> <VolumesClone> pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1001
1340
|
|
1002
1341
|
Initiate the Start action for a volume-clone request. The Start action starts the consistency group to initiate the flash copy.
|
1003
1342
|
|
1004
|
-
###
|
1343
|
+
### Examples
|
1005
1344
|
|
1006
1345
|
```ruby
|
1007
|
-
|
1346
|
+
require 'time'
|
1008
1347
|
require 'ibm_cloud_power'
|
1009
1348
|
|
1010
1349
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -1012,21 +1351,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
1012
1351
|
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name
|
1013
1352
|
|
1014
1353
|
begin
|
1015
|
-
#Initiate the Start action for a volume-clone request. The Start action starts the consistency group to initiate the flash copy.
|
1354
|
+
# Initiate the Start action for a volume-clone request. The Start action starts the consistency group to initiate the flash copy.
|
1016
1355
|
result = api_instance.pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1017
1356
|
p result
|
1018
1357
|
rescue IbmCloudPower::ApiError => e
|
1019
|
-
puts "
|
1358
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_start_post: #{e}"
|
1020
1359
|
end
|
1021
1360
|
```
|
1022
1361
|
|
1023
|
-
|
1362
|
+
#### Using the pcloud_v2_volumesclone_start_post_with_http_info variant
|
1363
|
+
|
1364
|
+
This returns an Array which contains the response data, status code and headers.
|
1024
1365
|
|
1366
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_start_post_with_http_info(cloud_instance_id, volumes_clone_id)
|
1025
1367
|
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1368
|
+
```ruby
|
1369
|
+
begin
|
1370
|
+
# Initiate the Start action for a volume-clone request. The Start action starts the consistency group to initiate the flash copy.
|
1371
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_start_post_with_http_info(cloud_instance_id, volumes_clone_id)
|
1372
|
+
p status_code # => 2xx
|
1373
|
+
p headers # => { ... }
|
1374
|
+
p data # => <VolumesClone>
|
1375
|
+
rescue IbmCloudPower::ApiError => e
|
1376
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_start_post_with_http_info: #{e}"
|
1377
|
+
end
|
1378
|
+
```
|
1379
|
+
|
1380
|
+
### Parameters
|
1381
|
+
|
1382
|
+
| Name | Type | Description | Notes |
|
1383
|
+
| ---- | ---- | ----------- | ----- |
|
1384
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1385
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID, can be identified by the volumes-clone id or the volumes-clone name | |
|
1030
1386
|
|
1031
1387
|
### Return type
|
1032
1388
|
|
@@ -1044,36 +1400,53 @@ No authorization required
|
|
1044
1400
|
|
1045
1401
|
## pcloud_volumes_clone_post
|
1046
1402
|
|
1047
|
-
> VolumesCloneResponse pcloud_volumes_clone_post(cloud_instance_id, body)
|
1403
|
+
> <VolumesCloneResponse> pcloud_volumes_clone_post(cloud_instance_id, body)
|
1048
1404
|
|
1049
1405
|
Create a volume clone for specified volumes (version 1 - depricated)
|
1050
1406
|
|
1051
|
-
###
|
1407
|
+
### Examples
|
1052
1408
|
|
1053
1409
|
```ruby
|
1054
|
-
|
1410
|
+
require 'time'
|
1055
1411
|
require 'ibm_cloud_power'
|
1056
1412
|
|
1057
1413
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
1058
1414
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
1059
|
-
body = IbmCloudPower::VolumesCloneRequest.new # VolumesCloneRequest | Parameters for the cloning of volumes
|
1415
|
+
body = IbmCloudPower::VolumesCloneRequest.new({display_name: 'display_name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneRequest | Parameters for the cloning of volumes
|
1060
1416
|
|
1061
1417
|
begin
|
1062
|
-
#Create a volume clone for specified volumes (version 1 - depricated)
|
1418
|
+
# Create a volume clone for specified volumes (version 1 - depricated)
|
1063
1419
|
result = api_instance.pcloud_volumes_clone_post(cloud_instance_id, body)
|
1064
1420
|
p result
|
1065
1421
|
rescue IbmCloudPower::ApiError => e
|
1066
|
-
puts "
|
1422
|
+
puts "Error when calling PCloudVolumesApi->pcloud_volumes_clone_post: #{e}"
|
1067
1423
|
end
|
1068
1424
|
```
|
1069
1425
|
|
1070
|
-
|
1426
|
+
#### Using the pcloud_volumes_clone_post_with_http_info variant
|
1071
1427
|
|
1428
|
+
This returns an Array which contains the response data, status code and headers.
|
1429
|
+
|
1430
|
+
> <Array(<VolumesCloneResponse>, Integer, Hash)> pcloud_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
1431
|
+
|
1432
|
+
```ruby
|
1433
|
+
begin
|
1434
|
+
# Create a volume clone for specified volumes (version 1 - depricated)
|
1435
|
+
data, status_code, headers = api_instance.pcloud_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
1436
|
+
p status_code # => 2xx
|
1437
|
+
p headers # => { ... }
|
1438
|
+
p data # => <VolumesCloneResponse>
|
1439
|
+
rescue IbmCloudPower::ApiError => e
|
1440
|
+
puts "Error when calling PCloudVolumesApi->pcloud_volumes_clone_post_with_http_info: #{e}"
|
1441
|
+
end
|
1442
|
+
```
|
1443
|
+
|
1444
|
+
### Parameters
|
1072
1445
|
|
1073
|
-
Name | Type | Description
|
1074
|
-
|
1075
|
-
**cloud_instance_id** | **String
|
1076
|
-
**body** | [**VolumesCloneRequest**](VolumesCloneRequest.md)| Parameters for the cloning of volumes |
|
1446
|
+
| Name | Type | Description | Notes |
|
1447
|
+
| ---- | ---- | ----------- | ----- |
|
1448
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1449
|
+
| **body** | [**VolumesCloneRequest**](VolumesCloneRequest.md) | Parameters for the cloning of volumes | |
|
1077
1450
|
|
1078
1451
|
### Return type
|
1079
1452
|
|