ibm_cloud_power 1.1.1 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/README.md +207 -68
- data/docs/AuxiliaryVolumeForOnboarding.md +20 -0
- data/docs/AuxiliaryVolumesForOnboarding.md +20 -0
- 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 +34 -31
- data/docs/CloudConnectionCreate.md +22 -13
- data/docs/CloudConnectionCreateResponse.md +46 -0
- data/docs/CloudConnectionEndpointClassic.md +10 -9
- data/docs/CloudConnectionEndpointClassicUpdate.md +20 -0
- data/docs/CloudConnectionEndpointGRE.md +10 -9
- data/docs/CloudConnectionEndpointVPC.md +10 -9
- data/docs/CloudConnectionGRETunnel.md +10 -11
- data/docs/CloudConnectionGRETunnelCreate.md +20 -0
- 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/ConsoleLanguage.md +20 -0
- data/docs/ConsoleLanguages.md +18 -0
- data/docs/CreateCosImageImportJob.md +38 -0
- data/docs/CreateDataVolume.md +28 -19
- data/docs/CreateImage.md +32 -27
- data/docs/DeadPeerDetection.md +22 -0
- data/docs/DisasterRecoveryLocation.md +20 -0
- data/docs/DisasterRecoveryLocations.md +18 -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/FlashCopyMapping.md +30 -0
- data/docs/IKEPolicies.md +18 -0
- data/docs/IKEPolicy.md +30 -0
- data/docs/IKEPolicyAuthentication.md +15 -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/IPSECPolicyAuthentication.md +15 -0
- 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 +30 -21
- data/docs/Network.md +32 -27
- data/docs/NetworkCloudConnectionsInner.md +20 -0
- 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 +20 -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 +245 -110
- data/docs/PCloudDisasterRecoveryApi.md +130 -0
- data/docs/PCloudEventsApi.md +66 -31
- data/docs/PCloudImagesApi.md +525 -109
- data/docs/PCloudInstancesApi.md +22 -100
- data/docs/PCloudJobsApi.md +208 -0
- data/docs/PCloudNetworksApi.md +292 -123
- data/docs/PCloudPVMInstancesApi.md +774 -226
- data/docs/PCloudPlacementGroupsApi.md +183 -82
- data/docs/PCloudSAPApi.md +86 -36
- data/docs/PCloudSPPPlacementGroupsApi.md +399 -0
- data/docs/PCloudSharedProcessorPoolsApi.md +332 -0
- data/docs/PCloudSnapshotsApi.md +113 -46
- data/docs/PCloudStorageCapacityApi.md +112 -45
- data/docs/PCloudSystemPoolsApi.md +30 -14
- data/docs/PCloudTasksApi.md +58 -25
- data/docs/PCloudTenantsApi.md +58 -25
- data/docs/PCloudTenantsSSHKeysApi.md +147 -63
- data/docs/PCloudVPNConnectionsApi.md +752 -0
- data/docs/PCloudVPNPoliciesApi.md +677 -0
- data/docs/PCloudVolumeGroupsApi.md +657 -0
- data/docs/PCloudVolumeOnboardingApi.md +200 -0
- data/docs/PCloudVolumesApi.md +915 -276
- data/docs/PVMInstance.md +86 -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 +58 -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 +80 -61
- data/docs/PVMInstanceRemoveNetwork.md +8 -7
- data/docs/PVMInstanceUpdate.md +28 -23
- data/docs/PVMInstanceUpdateResponse.md +20 -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/RemoteCopyRelationship.md +44 -0
- data/docs/SAPCreate.md +36 -23
- data/docs/SAPProfile.md +16 -15
- data/docs/SAPProfileReference.md +10 -9
- data/docs/SAPProfiles.md +8 -7
- data/docs/SPPPlacementGroup.md +24 -0
- data/docs/SPPPlacementGroupCreate.md +20 -0
- data/docs/SPPPlacementGroups.md +18 -0
- data/docs/SRC.md +10 -9
- data/docs/SSHKey.md +12 -11
- data/docs/SSHKeys.md +8 -7
- data/docs/SharedProcessorPool.md +36 -0
- data/docs/SharedProcessorPoolCreate.md +24 -0
- data/docs/SharedProcessorPoolDetail.md +20 -0
- data/docs/SharedProcessorPoolPlacementGroup.md +22 -0
- data/docs/SharedProcessorPoolServer.md +32 -0
- data/docs/SharedProcessorPoolUpdate.md +20 -0
- data/docs/SharedProcessorPools.md +18 -0
- data/docs/Site.md +20 -0
- 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/StatusDescription.md +18 -0
- data/docs/StatusDescriptionError.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 +58 -33
- data/docs/VolumeAction.md +18 -0
- data/docs/VolumeGroup.md +28 -0
- data/docs/VolumeGroupAction.md +22 -0
- data/docs/VolumeGroupActionReset.md +18 -0
- data/docs/VolumeGroupActionStart.md +18 -0
- data/docs/VolumeGroupActionStop.md +18 -0
- data/docs/VolumeGroupCreate.md +22 -0
- data/docs/VolumeGroupCreateResponse.md +24 -0
- data/docs/VolumeGroupDetails.md +30 -0
- data/docs/VolumeGroupRemoteCopyRelationships.md +20 -0
- data/docs/VolumeGroupStorageDetails.md +34 -0
- data/docs/VolumeGroupUpdate.md +20 -0
- data/docs/VolumeGroups.md +18 -0
- data/docs/VolumeGroupsDetails.md +18 -0
- data/docs/VolumeInfo.md +10 -9
- data/docs/VolumeOnboarding.md +30 -0
- data/docs/VolumeOnboardingCommon.md +24 -0
- data/docs/VolumeOnboardingCreate.md +20 -0
- data/docs/VolumeOnboardingCreateResponse.md +20 -0
- data/docs/VolumeOnboardingFailure.md +20 -0
- data/docs/VolumeOnboardings.md +18 -0
- data/docs/VolumeReference.md +60 -35
- data/docs/VolumeRemoteCopyRelationship.md +48 -0
- data/docs/Volumes.md +8 -7
- data/docs/VolumesAttach.md +18 -0
- data/docs/VolumesAttachmentResponse.md +18 -0
- 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 +10 -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 +77 -63
- data/lib/ibm_cloud_power/api/p_cloud_disaster_recovery_api.rb +138 -0
- data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +21 -19
- data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +343 -44
- data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +7 -134
- data/lib/ibm_cloud_power/api/p_cloud_jobs_api.rb +234 -0
- data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +67 -45
- data/lib/ibm_cloud_power/api/p_cloud_placement_groups_api.rb +61 -46
- data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +431 -98
- data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +17 -11
- data/lib/ibm_cloud_power/api/p_cloud_shared_processor_pools_api.rb +367 -0
- data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +23 -16
- data/lib/ibm_cloud_power/api/p_cloud_spp_placement_groups_api.rb +435 -0
- 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 +7 -6
- data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +14 -12
- data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +15 -10
- data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +37 -26
- data/lib/ibm_cloud_power/api/p_cloud_volume_groups_api.rb +707 -0
- data/lib/ibm_cloud_power/api/p_cloud_volume_onboarding_api.rb +222 -0
- data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +458 -115
- data/lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb +835 -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/auxiliary_volume_for_onboarding.rb +235 -0
- data/lib/ibm_cloud_power/models/auxiliary_volumes_for_onboarding.rb +241 -0
- data/lib/ibm_cloud_power/models/clone_task_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/clone_task_status.rb +48 -37
- data/lib/ibm_cloud_power/models/cloned_volume.rb +33 -22
- data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +37 -26
- data/lib/ibm_cloud_power/models/cloud_connection.rb +114 -93
- data/lib/ibm_cloud_power/models/cloud_connection_create.rb +108 -23
- data/lib/ibm_cloud_power/models/cloud_connection_create_response.rb +416 -0
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_classic.rb +20 -9
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_classic_update.rb +229 -0
- 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 +30 -29
- data/lib/ibm_cloud_power/models/cloud_connection_gre_tunnel_create.rb +240 -0
- data/lib/ibm_cloud_power/models/cloud_connection_speed.rb +2 -1
- data/lib/ibm_cloud_power/models/cloud_connection_update.rb +77 -32
- 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 +33 -22
- data/lib/ibm_cloud_power/models/cloud_connections.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance.rb +101 -90
- data/lib/ibm_cloud_power/models/cloud_instance_create.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +69 -58
- data/lib/ibm_cloud_power/models/cloud_instance_update.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +60 -49
- data/lib/ibm_cloud_power/models/console_language.rb +235 -0
- data/lib/ibm_cloud_power/models/console_languages.rb +227 -0
- data/lib/ibm_cloud_power/models/create_cos_image_import_job.rb +387 -0
- data/lib/ibm_cloud_power/models/create_data_volume.rb +98 -43
- data/lib/ibm_cloud_power/models/create_image.rb +91 -62
- data/lib/ibm_cloud_power/models/dead_peer_detection.rb +350 -0
- data/lib/ibm_cloud_power/models/disaster_recovery_location.rb +232 -0
- data/lib/ibm_cloud_power/models/disaster_recovery_locations.rb +227 -0
- data/lib/ibm_cloud_power/models/error.rb +32 -21
- data/lib/ibm_cloud_power/models/event.rb +84 -73
- data/lib/ibm_cloud_power/models/event_user.rb +34 -23
- data/lib/ibm_cloud_power/models/events.rb +19 -8
- data/lib/ibm_cloud_power/models/export_image.rb +35 -24
- data/lib/ibm_cloud_power/models/flash_copy_mapping.rb +285 -0
- data/lib/ibm_cloud_power/models/ike_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ike_policy.rb +401 -0
- data/lib/ibm_cloud_power/models/ike_policy_authentication.rb +42 -0
- data/lib/ibm_cloud_power/models/ike_policy_create.rb +424 -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 +386 -0
- data/lib/ibm_cloud_power/models/image.rb +105 -94
- data/lib/ibm_cloud_power/models/image_reference.rb +100 -89
- data/lib/ibm_cloud_power/models/image_specifications.rb +48 -37
- data/lib/ibm_cloud_power/models/image_volume.rb +40 -29
- data/lib/ibm_cloud_power/models/images.rb +19 -8
- data/lib/ibm_cloud_power/models/ip_address_range.rb +38 -27
- data/lib/ibm_cloud_power/models/ip_sec_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy.rb +389 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_create.rb +397 -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 +364 -0
- data/lib/ibm_cloud_power/models/ipsec_policy_authentication.rb +41 -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 +40 -29
- data/lib/ibm_cloud_power/models/min_max_default.rb +40 -29
- data/lib/ibm_cloud_power/models/multi_volumes_create.rb +112 -57
- data/lib/ibm_cloud_power/models/network.rb +127 -94
- data/lib/ibm_cloud_power/models/network_cloud_connections_inner.rb +230 -0
- data/lib/ibm_cloud_power/models/network_create.rb +55 -44
- 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 +35 -24
- data/lib/ibm_cloud_power/models/network_port.rb +70 -59
- data/lib/ibm_cloud_power/models/network_port_create.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +33 -22
- 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 +77 -56
- data/lib/ibm_cloud_power/models/network_update.rb +42 -31
- 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 +38 -27
- data/lib/ibm_cloud_power/models/pin_policy.rb +8 -4
- data/lib/ibm_cloud_power/models/placement_group.rb +40 -29
- 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 +311 -219
- data/lib/ibm_cloud_power/models/pvm_instance_action.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +33 -22
- data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +51 -40
- data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +69 -58
- data/lib/ibm_cloud_power/models/pvm_instance_console.rb +20 -9
- data/lib/ibm_cloud_power/models/pvm_instance_create.rb +236 -154
- data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +33 -22
- data/lib/ibm_cloud_power/models/pvm_instance_health.rb +33 -22
- data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +30 -19
- data/lib/ibm_cloud_power/models/pvm_instance_network.rb +72 -61
- data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +37 -26
- data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +284 -180
- data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_update.rb +79 -46
- data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +64 -43
- 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/remote_copy_relationship.rb +360 -0
- data/lib/ibm_cloud_power/models/sap_create.rb +123 -53
- data/lib/ibm_cloud_power/models/sap_profile.rb +56 -45
- data/lib/ibm_cloud_power/models/sap_profile_reference.rb +38 -27
- data/lib/ibm_cloud_power/models/sap_profiles.rb +19 -8
- data/lib/ibm_cloud_power/models/shared_processor_pool.rb +337 -0
- data/lib/ibm_cloud_power/models/shared_processor_pool_create.rb +265 -0
- data/lib/ibm_cloud_power/models/shared_processor_pool_detail.rb +241 -0
- data/lib/ibm_cloud_power/models/shared_processor_pool_placement_group.rb +255 -0
- data/lib/ibm_cloud_power/models/shared_processor_pool_server.rb +290 -0
- data/lib/ibm_cloud_power/models/shared_processor_pool_update.rb +230 -0
- data/lib/ibm_cloud_power/models/shared_processor_pools.rb +222 -0
- data/lib/ibm_cloud_power/models/site.rb +230 -0
- data/lib/ibm_cloud_power/models/snapshot.rb +90 -79
- data/lib/ibm_cloud_power/models/snapshot_create.rb +39 -28
- 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 +33 -22
- data/lib/ibm_cloud_power/models/snapshots.rb +19 -8
- data/lib/ibm_cloud_power/models/software_licenses.rb +35 -24
- data/lib/ibm_cloud_power/models/spp_placement_group.rb +267 -0
- data/lib/ibm_cloud_power/models/spp_placement_group_create.rb +274 -0
- data/lib/ibm_cloud_power/models/spp_placement_groups.rb +222 -0
- data/lib/ibm_cloud_power/models/src.rb +33 -22
- data/lib/ibm_cloud_power/models/ssh_key.rb +33 -22
- 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/status_description.rb +223 -0
- data/lib/ibm_cloud_power/models/status_description_error.rb +243 -0
- data/lib/ibm_cloud_power/models/stock_image.rb +34 -23
- data/lib/ibm_cloud_power/models/storage_affinity.rb +298 -0
- data/lib/ibm_cloud_power/models/storage_pool_capacity.rb +30 -19
- data/lib/ibm_cloud_power/models/storage_pools_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_type_capacity.rb +33 -22
- 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 +51 -40
- data/lib/ibm_cloud_power/models/task.rb +85 -74
- data/lib/ibm_cloud_power/models/task_reference.rb +38 -27
- data/lib/ibm_cloud_power/models/tenant.rb +72 -61
- data/lib/ibm_cloud_power/models/tenant_update.rb +19 -8
- data/lib/ibm_cloud_power/models/update_volume.rb +37 -26
- data/lib/ibm_cloud_power/models/virtual_cores.rb +34 -23
- data/lib/ibm_cloud_power/models/volume.rb +263 -98
- data/lib/ibm_cloud_power/models/volume_action.rb +225 -0
- data/lib/ibm_cloud_power/models/volume_group.rb +279 -0
- data/lib/ibm_cloud_power/models/volume_group_action.rb +238 -0
- data/lib/ibm_cloud_power/models/volume_group_action_reset.rb +262 -0
- data/lib/ibm_cloud_power/models/volume_group_action_start.rb +262 -0
- data/lib/ibm_cloud_power/models/volume_group_action_stop.rb +226 -0
- data/lib/ibm_cloud_power/models/volume_group_create.rb +247 -0
- data/lib/ibm_cloud_power/models/volume_group_create_response.rb +265 -0
- data/lib/ibm_cloud_power/models/volume_group_details.rb +291 -0
- data/lib/ibm_cloud_power/models/volume_group_remote_copy_relationships.rb +232 -0
- data/lib/ibm_cloud_power/models/volume_group_storage_details.rb +307 -0
- data/lib/ibm_cloud_power/models/volume_group_update.rb +234 -0
- data/lib/ibm_cloud_power/models/volume_groups.rb +227 -0
- data/lib/ibm_cloud_power/models/volume_groups_details.rb +227 -0
- data/lib/ibm_cloud_power/models/volume_info.rb +33 -22
- data/lib/ibm_cloud_power/models/volume_onboarding.rb +296 -0
- data/lib/ibm_cloud_power/models/volume_onboarding_common.rb +257 -0
- data/lib/ibm_cloud_power/models/volume_onboarding_create.rb +236 -0
- data/lib/ibm_cloud_power/models/volume_onboarding_create_response.rb +230 -0
- data/lib/ibm_cloud_power/models/volume_onboarding_failure.rb +232 -0
- data/lib/ibm_cloud_power/models/volume_onboardings.rb +227 -0
- data/lib/ibm_cloud_power/models/volume_reference.rb +290 -125
- data/lib/ibm_cloud_power/models/volume_remote_copy_relationship.rb +387 -0
- data/lib/ibm_cloud_power/models/volumes.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_attach.rb +227 -0
- data/lib/ibm_cloud_power/models/volumes_attachment_response.rb +225 -0
- data/lib/ibm_cloud_power/models/volumes_clone.rb +68 -57
- data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +31 -20
- 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 +75 -64
- data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +20 -9
- data/lib/ibm_cloud_power/models/volumes_clone_request.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_response.rb +32 -13
- 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 +93 -6
- data/pkg/ibm_cloud_power-2.1.0.gem +0 -0
- data/spec/api/p_cloud_disaster_recovery_api_spec.rb +56 -0
- data/spec/api/p_cloud_jobs_api_spec.rb +73 -0
- data/spec/api/p_cloud_shared_processor_pools_api_spec.rb +95 -0
- data/spec/api/p_cloud_spp_placement_groups_api_spec.rb +108 -0
- data/spec/api/p_cloud_volume_groups_api_spec.rb +155 -0
- data/spec/api/p_cloud_volume_onboarding_api_spec.rb +70 -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/auxiliary_volume_for_onboarding_spec.rb +40 -0
- data/spec/models/auxiliary_volumes_for_onboarding_spec.rb +40 -0
- data/spec/models/cloud_connection_create_response_spec.rb +112 -0
- data/spec/models/cloud_connection_endpoint_classic_update_spec.rb +40 -0
- data/spec/models/cloud_connection_gre_tunnel_create_spec.rb +40 -0
- data/spec/models/cloud_connection_virtual_private_clouds_virtual_private_clouds_inner_spec.rb +52 -0
- data/spec/models/console_language_spec.rb +40 -0
- data/spec/models/console_languages_spec.rb +34 -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/disaster_recovery_location_spec.rb +40 -0
- data/spec/models/disaster_recovery_locations_spec.rb +34 -0
- data/spec/models/flash_copy_mapping_spec.rb +70 -0
- data/spec/models/ike_policies_spec.rb +34 -0
- data/spec/models/ike_policy_authentication_spec.rb +28 -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/ipsec_policy_authentication_spec.rb +28 -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_cloud_connections_inner_spec.rb +40 -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/remote_copy_relationship_spec.rb +112 -0
- data/spec/models/shared_processor_pool_create_spec.rb +52 -0
- data/spec/models/shared_processor_pool_detail_spec.rb +40 -0
- data/spec/models/shared_processor_pool_placement_group_spec.rb +46 -0
- data/spec/models/shared_processor_pool_server_spec.rb +76 -0
- data/spec/models/shared_processor_pool_spec.rb +88 -0
- data/spec/models/shared_processor_pool_update_spec.rb +40 -0
- data/spec/models/shared_processor_pools_spec.rb +34 -0
- data/spec/models/site_spec.rb +40 -0
- data/spec/models/spp_placement_group_create_spec.rb +44 -0
- data/spec/models/spp_placement_group_spec.rb +52 -0
- data/spec/models/spp_placement_groups_spec.rb +34 -0
- data/spec/models/status_description_error_spec.rb +46 -0
- data/spec/models/status_description_spec.rb +34 -0
- data/spec/models/status_spec.rb +46 -0
- data/spec/models/storage_affinity_spec.rb +62 -0
- data/spec/models/volume_action_spec.rb +34 -0
- data/spec/models/volume_group_action_reset_spec.rb +38 -0
- data/spec/models/volume_group_action_spec.rb +46 -0
- data/spec/models/volume_group_action_start_spec.rb +38 -0
- data/spec/models/volume_group_action_stop_spec.rb +34 -0
- data/spec/models/volume_group_create_response_spec.rb +52 -0
- data/spec/models/volume_group_create_spec.rb +46 -0
- data/spec/models/volume_group_details_spec.rb +70 -0
- data/spec/models/volume_group_remote_copy_relationships_spec.rb +40 -0
- data/spec/models/volume_group_spec.rb +64 -0
- data/spec/models/volume_group_storage_details_spec.rb +82 -0
- data/spec/models/volume_group_update_spec.rb +40 -0
- data/spec/models/volume_groups_details_spec.rb +34 -0
- data/spec/models/volume_groups_spec.rb +34 -0
- data/spec/models/volume_onboarding_common_spec.rb +52 -0
- data/spec/models/volume_onboarding_create_response_spec.rb +40 -0
- data/spec/models/volume_onboarding_create_spec.rb +40 -0
- data/spec/models/volume_onboarding_failure_spec.rb +40 -0
- data/spec/models/volume_onboarding_spec.rb +70 -0
- data/spec/models/volume_onboardings_spec.rb +34 -0
- data/spec/models/volume_remote_copy_relationship_spec.rb +124 -0
- data/spec/models/volumes_attach_spec.rb +34 -0
- data/spec/models/volumes_attachment_response_spec.rb +34 -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 +374 -4
data/docs/PCloudVolumesApi.md
CHANGED
@@ -2,31 +2,100 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**
|
8
|
-
[**
|
9
|
-
[**
|
10
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
18
|
-
[**
|
19
|
-
[**
|
20
|
-
[**
|
21
|
-
[**
|
22
|
-
[**
|
23
|
-
[**
|
24
|
-
[**
|
25
|
-
[**
|
26
|
-
[**
|
27
|
-
[**
|
28
|
-
[**
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**pcloud_cloudinstances_volumes_action_post**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_action_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/action | Perform an action on a Volume |
|
8
|
+
| [**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 |
|
9
|
+
| [**pcloud_cloudinstances_volumes_flash_copy_mappings_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_flash_copy_mappings_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/flash-copy-mappings | Get a list of flashcopy mappings of a given volume |
|
10
|
+
| [**pcloud_cloudinstances_volumes_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Detailed info of a volume |
|
11
|
+
| [**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 |
|
12
|
+
| [**pcloud_cloudinstances_volumes_post**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | Create a new data Volume |
|
13
|
+
| [**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 |
|
14
|
+
| [**pcloud_cloudinstances_volumes_remote_copy_relationship_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_remote_copy_relationship_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/remote-copy | Get remote copy relationship of a volume |
|
15
|
+
| [**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 PVMInstance |
|
16
|
+
| [**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 info of a volume attached to a PVMInstance |
|
17
|
+
| [**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 |
|
18
|
+
| [**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 PVMInstance |
|
19
|
+
| [**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 |
|
20
|
+
| [**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 |
|
21
|
+
| [**pcloud_v2_pvminstances_volumes_post**](PCloudVolumesApi.md#pcloud_v2_pvminstances_volumes_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes | Attach all volumes to a PVMInstance |
|
22
|
+
| [**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 |
|
23
|
+
| [**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 volumes clone request for the specified clone task ID |
|
24
|
+
| [**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 |
|
25
|
+
| [**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 volumes-clone request, initiates the Cleanup action Cleanup action performs the cleanup of the preparatory clones and snapshot volumes |
|
26
|
+
| [**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 |
|
27
|
+
| [**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 Execute action creates the cloned volumes using the volume snapshots |
|
28
|
+
| [**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 |
|
29
|
+
| [**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 |
|
30
|
+
| [**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 initiates the Prepare action Requires a minimum of two volumes Requires a minimum of one volume to be in the 'in-use' state Requires a unique volumes clone name Prepare action does the preparatory work for creating the snapshot volumes |
|
31
|
+
| [**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 volumes-clone request Start action starts the consistency group to initiate the flash copy |
|
32
|
+
| [**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 |
|
33
|
+
|
34
|
+
|
35
|
+
## pcloud_cloudinstances_volumes_action_post
|
36
|
+
|
37
|
+
> Object pcloud_cloudinstances_volumes_action_post(cloud_instance_id, volume_id, body)
|
38
|
+
|
39
|
+
Perform an action on a Volume
|
40
|
+
|
41
|
+
### Examples
|
29
42
|
|
43
|
+
```ruby
|
44
|
+
require 'time'
|
45
|
+
require 'ibm_cloud_power'
|
46
|
+
|
47
|
+
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
48
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
49
|
+
volume_id = 'volume_id_example' # String | Volume ID
|
50
|
+
body = IbmCloudPower::VolumeAction.new({replication_enabled: false}) # VolumeAction | Parameters for the desired action
|
51
|
+
|
52
|
+
begin
|
53
|
+
# Perform an action on a Volume
|
54
|
+
result = api_instance.pcloud_cloudinstances_volumes_action_post(cloud_instance_id, volume_id, body)
|
55
|
+
p result
|
56
|
+
rescue IbmCloudPower::ApiError => e
|
57
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_action_post: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
#### Using the pcloud_cloudinstances_volumes_action_post_with_http_info variant
|
62
|
+
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
64
|
+
|
65
|
+
> <Array(Object, Integer, Hash)> pcloud_cloudinstances_volumes_action_post_with_http_info(cloud_instance_id, volume_id, body)
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
begin
|
69
|
+
# Perform an action on a Volume
|
70
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_action_post_with_http_info(cloud_instance_id, volume_id, body)
|
71
|
+
p status_code # => 2xx
|
72
|
+
p headers # => { ... }
|
73
|
+
p data # => Object
|
74
|
+
rescue IbmCloudPower::ApiError => e
|
75
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_action_post_with_http_info: #{e}"
|
76
|
+
end
|
77
|
+
```
|
78
|
+
|
79
|
+
### Parameters
|
80
|
+
|
81
|
+
| Name | Type | Description | Notes |
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
83
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
84
|
+
| **volume_id** | **String** | Volume ID | |
|
85
|
+
| **body** | [**VolumeAction**](VolumeAction.md) | Parameters for the desired action | |
|
86
|
+
|
87
|
+
### Return type
|
88
|
+
|
89
|
+
**Object**
|
90
|
+
|
91
|
+
### Authorization
|
92
|
+
|
93
|
+
No authorization required
|
94
|
+
|
95
|
+
### HTTP request headers
|
96
|
+
|
97
|
+
- **Content-Type**: application/json
|
98
|
+
- **Accept**: application/json
|
30
99
|
|
31
100
|
|
32
101
|
## pcloud_cloudinstances_volumes_delete
|
@@ -35,10 +104,10 @@ Method | HTTP request | Description
|
|
35
104
|
|
36
105
|
Delete a cloud instance volume
|
37
106
|
|
38
|
-
###
|
107
|
+
### Examples
|
39
108
|
|
40
109
|
```ruby
|
41
|
-
|
110
|
+
require 'time'
|
42
111
|
require 'ibm_cloud_power'
|
43
112
|
|
44
113
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -46,21 +115,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
46
115
|
volume_id = 'volume_id_example' # String | Volume ID
|
47
116
|
|
48
117
|
begin
|
49
|
-
#Delete a cloud instance volume
|
118
|
+
# Delete a cloud instance volume
|
50
119
|
result = api_instance.pcloud_cloudinstances_volumes_delete(cloud_instance_id, volume_id)
|
51
120
|
p result
|
52
121
|
rescue IbmCloudPower::ApiError => e
|
53
|
-
puts "
|
122
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_delete: #{e}"
|
54
123
|
end
|
55
124
|
```
|
56
125
|
|
57
|
-
|
126
|
+
#### Using the pcloud_cloudinstances_volumes_delete_with_http_info variant
|
127
|
+
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
129
|
+
|
130
|
+
> <Array(Object, Integer, Hash)> pcloud_cloudinstances_volumes_delete_with_http_info(cloud_instance_id, volume_id)
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
begin
|
134
|
+
# Delete a cloud instance volume
|
135
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_delete_with_http_info(cloud_instance_id, volume_id)
|
136
|
+
p status_code # => 2xx
|
137
|
+
p headers # => { ... }
|
138
|
+
p data # => Object
|
139
|
+
rescue IbmCloudPower::ApiError => e
|
140
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_delete_with_http_info: #{e}"
|
141
|
+
end
|
142
|
+
```
|
58
143
|
|
144
|
+
### Parameters
|
59
145
|
|
60
|
-
Name | Type | Description
|
61
|
-
|
62
|
-
**cloud_instance_id** | **String
|
63
|
-
**volume_id** | **String
|
146
|
+
| Name | Type | Description | Notes |
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
148
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
149
|
+
| **volume_id** | **String** | Volume ID | |
|
64
150
|
|
65
151
|
### Return type
|
66
152
|
|
@@ -76,16 +162,80 @@ No authorization required
|
|
76
162
|
- **Accept**: */*
|
77
163
|
|
78
164
|
|
165
|
+
## pcloud_cloudinstances_volumes_flash_copy_mappings_get
|
166
|
+
|
167
|
+
> <Array<FlashCopyMapping>> pcloud_cloudinstances_volumes_flash_copy_mappings_get(cloud_instance_id, volume_id)
|
168
|
+
|
169
|
+
Get a list of flashcopy mappings of a given volume
|
170
|
+
|
171
|
+
### Examples
|
172
|
+
|
173
|
+
```ruby
|
174
|
+
require 'time'
|
175
|
+
require 'ibm_cloud_power'
|
176
|
+
|
177
|
+
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
178
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
179
|
+
volume_id = 'volume_id_example' # String | Volume ID
|
180
|
+
|
181
|
+
begin
|
182
|
+
# Get a list of flashcopy mappings of a given volume
|
183
|
+
result = api_instance.pcloud_cloudinstances_volumes_flash_copy_mappings_get(cloud_instance_id, volume_id)
|
184
|
+
p result
|
185
|
+
rescue IbmCloudPower::ApiError => e
|
186
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_flash_copy_mappings_get: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the pcloud_cloudinstances_volumes_flash_copy_mappings_get_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
> <Array(<Array<FlashCopyMapping>>, Integer, Hash)> pcloud_cloudinstances_volumes_flash_copy_mappings_get_with_http_info(cloud_instance_id, volume_id)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# Get a list of flashcopy mappings of a given volume
|
199
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_flash_copy_mappings_get_with_http_info(cloud_instance_id, volume_id)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => <Array<FlashCopyMapping>>
|
203
|
+
rescue IbmCloudPower::ApiError => e
|
204
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_flash_copy_mappings_get_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
213
|
+
| **volume_id** | **String** | Volume ID | |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**Array<FlashCopyMapping>**](FlashCopyMapping.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
No authorization required
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: Not defined
|
226
|
+
- **Accept**: application/json
|
227
|
+
|
228
|
+
|
79
229
|
## pcloud_cloudinstances_volumes_get
|
80
230
|
|
81
|
-
> Volume pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
231
|
+
> <Volume> pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
82
232
|
|
83
|
-
Detailed
|
233
|
+
Detailed info of a volume
|
84
234
|
|
85
|
-
###
|
235
|
+
### Examples
|
86
236
|
|
87
237
|
```ruby
|
88
|
-
|
238
|
+
require 'time'
|
89
239
|
require 'ibm_cloud_power'
|
90
240
|
|
91
241
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -93,21 +243,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
93
243
|
volume_id = 'volume_id_example' # String | Volume ID
|
94
244
|
|
95
245
|
begin
|
96
|
-
#Detailed
|
246
|
+
# Detailed info of a volume
|
97
247
|
result = api_instance.pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
|
98
248
|
p result
|
99
249
|
rescue IbmCloudPower::ApiError => e
|
100
|
-
puts "
|
250
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_get: #{e}"
|
101
251
|
end
|
102
252
|
```
|
103
253
|
|
104
|
-
|
254
|
+
#### Using the pcloud_cloudinstances_volumes_get_with_http_info variant
|
255
|
+
|
256
|
+
This returns an Array which contains the response data, status code and headers.
|
105
257
|
|
258
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_get_with_http_info(cloud_instance_id, volume_id)
|
106
259
|
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
260
|
+
```ruby
|
261
|
+
begin
|
262
|
+
# Detailed info of a volume
|
263
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_get_with_http_info(cloud_instance_id, volume_id)
|
264
|
+
p status_code # => 2xx
|
265
|
+
p headers # => { ... }
|
266
|
+
p data # => <Volume>
|
267
|
+
rescue IbmCloudPower::ApiError => e
|
268
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_get_with_http_info: #{e}"
|
269
|
+
end
|
270
|
+
```
|
271
|
+
|
272
|
+
### Parameters
|
273
|
+
|
274
|
+
| Name | Type | Description | Notes |
|
275
|
+
| ---- | ---- | ----------- | ----- |
|
276
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
277
|
+
| **volume_id** | **String** | Volume ID | |
|
111
278
|
|
112
279
|
### Return type
|
113
280
|
|
@@ -125,38 +292,59 @@ No authorization required
|
|
125
292
|
|
126
293
|
## pcloud_cloudinstances_volumes_getall
|
127
294
|
|
128
|
-
> Volumes pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
295
|
+
> <Volumes> pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
129
296
|
|
130
297
|
List all volumes for this cloud instance
|
131
298
|
|
132
|
-
###
|
299
|
+
### Examples
|
133
300
|
|
134
301
|
```ruby
|
135
|
-
|
302
|
+
require 'time'
|
136
303
|
require 'ibm_cloud_power'
|
137
304
|
|
138
305
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
139
306
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
140
307
|
opts = {
|
141
|
-
|
308
|
+
replication_enabled: true, # Boolean | true or false, limits a volumes list to replication or non replication enabled volumes
|
309
|
+
affinity: 'affinity_example', # String | A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance
|
310
|
+
auxiliary: true # Boolean | true or false, limits a volume list to auxiliary or non auxiliary volumes
|
142
311
|
}
|
143
312
|
|
144
313
|
begin
|
145
|
-
#List all volumes for this cloud instance
|
314
|
+
# List all volumes for this cloud instance
|
146
315
|
result = api_instance.pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
|
147
316
|
p result
|
148
317
|
rescue IbmCloudPower::ApiError => e
|
149
|
-
puts "
|
318
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_getall: #{e}"
|
150
319
|
end
|
151
320
|
```
|
152
321
|
|
153
|
-
|
322
|
+
#### Using the pcloud_cloudinstances_volumes_getall_with_http_info variant
|
323
|
+
|
324
|
+
This returns an Array which contains the response data, status code and headers.
|
325
|
+
|
326
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_cloudinstances_volumes_getall_with_http_info(cloud_instance_id, opts)
|
327
|
+
|
328
|
+
```ruby
|
329
|
+
begin
|
330
|
+
# List all volumes for this cloud instance
|
331
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_getall_with_http_info(cloud_instance_id, opts)
|
332
|
+
p status_code # => 2xx
|
333
|
+
p headers # => { ... }
|
334
|
+
p data # => <Volumes>
|
335
|
+
rescue IbmCloudPower::ApiError => e
|
336
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_getall_with_http_info: #{e}"
|
337
|
+
end
|
338
|
+
```
|
154
339
|
|
340
|
+
### Parameters
|
155
341
|
|
156
|
-
Name | Type | Description
|
157
|
-
|
158
|
-
**cloud_instance_id** | **String
|
159
|
-
**
|
342
|
+
| Name | Type | Description | Notes |
|
343
|
+
| ---- | ---- | ----------- | ----- |
|
344
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
345
|
+
| **replication_enabled** | **Boolean** | true or false, limits a volumes list to replication or non replication enabled volumes | [optional] |
|
346
|
+
| **affinity** | **String** | A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance | [optional] |
|
347
|
+
| **auxiliary** | **Boolean** | true or false, limits a volume list to auxiliary or non auxiliary volumes | [optional] |
|
160
348
|
|
161
349
|
### Return type
|
162
350
|
|
@@ -174,38 +362,53 @@ No authorization required
|
|
174
362
|
|
175
363
|
## pcloud_cloudinstances_volumes_post
|
176
364
|
|
177
|
-
> Volume pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
365
|
+
> <Volume> pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
178
366
|
|
179
|
-
Create a new data
|
367
|
+
Create a new data Volume
|
180
368
|
|
181
|
-
|
182
|
-
|
183
|
-
### Example
|
369
|
+
### Examples
|
184
370
|
|
185
371
|
```ruby
|
186
|
-
|
372
|
+
require 'time'
|
187
373
|
require 'ibm_cloud_power'
|
188
374
|
|
189
375
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
190
376
|
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
|
377
|
+
body = IbmCloudPower::CreateDataVolume.new({name: 'name_example', size: 3.56}) # CreateDataVolume | Parameters for the creation of a new data volume
|
192
378
|
|
193
379
|
begin
|
194
|
-
#Create a new data
|
380
|
+
# Create a new data Volume
|
195
381
|
result = api_instance.pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
|
196
382
|
p result
|
197
383
|
rescue IbmCloudPower::ApiError => e
|
198
|
-
puts "
|
384
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_post: #{e}"
|
199
385
|
end
|
200
386
|
```
|
201
387
|
|
202
|
-
|
388
|
+
#### Using the pcloud_cloudinstances_volumes_post_with_http_info variant
|
389
|
+
|
390
|
+
This returns an Array which contains the response data, status code and headers.
|
391
|
+
|
392
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_post_with_http_info(cloud_instance_id, body)
|
393
|
+
|
394
|
+
```ruby
|
395
|
+
begin
|
396
|
+
# Create a new data Volume
|
397
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_post_with_http_info(cloud_instance_id, body)
|
398
|
+
p status_code # => 2xx
|
399
|
+
p headers # => { ... }
|
400
|
+
p data # => <Volume>
|
401
|
+
rescue IbmCloudPower::ApiError => e
|
402
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_post_with_http_info: #{e}"
|
403
|
+
end
|
404
|
+
```
|
203
405
|
|
406
|
+
### Parameters
|
204
407
|
|
205
|
-
Name | Type | Description
|
206
|
-
|
207
|
-
**cloud_instance_id** | **String
|
208
|
-
**body** | [**CreateDataVolume**](CreateDataVolume.md)| Parameters for the creation of a new data volume |
|
408
|
+
| Name | Type | Description | Notes |
|
409
|
+
| ---- | ---- | ----------- | ----- |
|
410
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
411
|
+
| **body** | [**CreateDataVolume**](CreateDataVolume.md) | Parameters for the creation of a new data volume | |
|
209
412
|
|
210
413
|
### Return type
|
211
414
|
|
@@ -223,14 +426,14 @@ No authorization required
|
|
223
426
|
|
224
427
|
## pcloud_cloudinstances_volumes_put
|
225
428
|
|
226
|
-
> Volume pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
429
|
+
> <Volume> pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
227
430
|
|
228
431
|
Update a cloud instance volume
|
229
432
|
|
230
|
-
###
|
433
|
+
### Examples
|
231
434
|
|
232
435
|
```ruby
|
233
|
-
|
436
|
+
require 'time'
|
234
437
|
require 'ibm_cloud_power'
|
235
438
|
|
236
439
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -239,22 +442,39 @@ volume_id = 'volume_id_example' # String | Volume ID
|
|
239
442
|
body = IbmCloudPower::UpdateVolume.new # UpdateVolume | Parameters to update a cloud instance volume
|
240
443
|
|
241
444
|
begin
|
242
|
-
#Update a cloud instance volume
|
445
|
+
# Update a cloud instance volume
|
243
446
|
result = api_instance.pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
|
244
447
|
p result
|
245
448
|
rescue IbmCloudPower::ApiError => e
|
246
|
-
puts "
|
449
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_put: #{e}"
|
247
450
|
end
|
248
451
|
```
|
249
452
|
|
250
|
-
|
453
|
+
#### Using the pcloud_cloudinstances_volumes_put_with_http_info variant
|
251
454
|
|
455
|
+
This returns an Array which contains the response data, status code and headers.
|
252
456
|
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
457
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_cloudinstances_volumes_put_with_http_info(cloud_instance_id, volume_id, body)
|
458
|
+
|
459
|
+
```ruby
|
460
|
+
begin
|
461
|
+
# Update a cloud instance volume
|
462
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_put_with_http_info(cloud_instance_id, volume_id, body)
|
463
|
+
p status_code # => 2xx
|
464
|
+
p headers # => { ... }
|
465
|
+
p data # => <Volume>
|
466
|
+
rescue IbmCloudPower::ApiError => e
|
467
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_put_with_http_info: #{e}"
|
468
|
+
end
|
469
|
+
```
|
470
|
+
|
471
|
+
### Parameters
|
472
|
+
|
473
|
+
| Name | Type | Description | Notes |
|
474
|
+
| ---- | ---- | ----------- | ----- |
|
475
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
476
|
+
| **volume_id** | **String** | Volume ID | |
|
477
|
+
| **body** | [**UpdateVolume**](UpdateVolume.md) | Parameters to update a cloud instance volume | |
|
258
478
|
|
259
479
|
### Return type
|
260
480
|
|
@@ -270,16 +490,80 @@ No authorization required
|
|
270
490
|
- **Accept**: application/json
|
271
491
|
|
272
492
|
|
493
|
+
## pcloud_cloudinstances_volumes_remote_copy_relationship_get
|
494
|
+
|
495
|
+
> <VolumeRemoteCopyRelationship> pcloud_cloudinstances_volumes_remote_copy_relationship_get(cloud_instance_id, volume_id)
|
496
|
+
|
497
|
+
Get remote copy relationship of a volume
|
498
|
+
|
499
|
+
### Examples
|
500
|
+
|
501
|
+
```ruby
|
502
|
+
require 'time'
|
503
|
+
require 'ibm_cloud_power'
|
504
|
+
|
505
|
+
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
506
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
507
|
+
volume_id = 'volume_id_example' # String | Volume ID
|
508
|
+
|
509
|
+
begin
|
510
|
+
# Get remote copy relationship of a volume
|
511
|
+
result = api_instance.pcloud_cloudinstances_volumes_remote_copy_relationship_get(cloud_instance_id, volume_id)
|
512
|
+
p result
|
513
|
+
rescue IbmCloudPower::ApiError => e
|
514
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_remote_copy_relationship_get: #{e}"
|
515
|
+
end
|
516
|
+
```
|
517
|
+
|
518
|
+
#### Using the pcloud_cloudinstances_volumes_remote_copy_relationship_get_with_http_info variant
|
519
|
+
|
520
|
+
This returns an Array which contains the response data, status code and headers.
|
521
|
+
|
522
|
+
> <Array(<VolumeRemoteCopyRelationship>, Integer, Hash)> pcloud_cloudinstances_volumes_remote_copy_relationship_get_with_http_info(cloud_instance_id, volume_id)
|
523
|
+
|
524
|
+
```ruby
|
525
|
+
begin
|
526
|
+
# Get remote copy relationship of a volume
|
527
|
+
data, status_code, headers = api_instance.pcloud_cloudinstances_volumes_remote_copy_relationship_get_with_http_info(cloud_instance_id, volume_id)
|
528
|
+
p status_code # => 2xx
|
529
|
+
p headers # => { ... }
|
530
|
+
p data # => <VolumeRemoteCopyRelationship>
|
531
|
+
rescue IbmCloudPower::ApiError => e
|
532
|
+
puts "Error when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_remote_copy_relationship_get_with_http_info: #{e}"
|
533
|
+
end
|
534
|
+
```
|
535
|
+
|
536
|
+
### Parameters
|
537
|
+
|
538
|
+
| Name | Type | Description | Notes |
|
539
|
+
| ---- | ---- | ----------- | ----- |
|
540
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
541
|
+
| **volume_id** | **String** | Volume ID | |
|
542
|
+
|
543
|
+
### Return type
|
544
|
+
|
545
|
+
[**VolumeRemoteCopyRelationship**](VolumeRemoteCopyRelationship.md)
|
546
|
+
|
547
|
+
### Authorization
|
548
|
+
|
549
|
+
No authorization required
|
550
|
+
|
551
|
+
### HTTP request headers
|
552
|
+
|
553
|
+
- **Content-Type**: Not defined
|
554
|
+
- **Accept**: application/json
|
555
|
+
|
556
|
+
|
273
557
|
## pcloud_pvminstances_volumes_delete
|
274
558
|
|
275
559
|
> Object pcloud_pvminstances_volumes_delete(cloud_instance_id, pvm_instance_id, volume_id)
|
276
560
|
|
277
|
-
Detach a volume from a
|
561
|
+
Detach a volume from a PVMInstance
|
278
562
|
|
279
|
-
###
|
563
|
+
### Examples
|
280
564
|
|
281
565
|
```ruby
|
282
|
-
|
566
|
+
require 'time'
|
283
567
|
require 'ibm_cloud_power'
|
284
568
|
|
285
569
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -288,22 +572,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
288
572
|
volume_id = 'volume_id_example' # String | Volume ID
|
289
573
|
|
290
574
|
begin
|
291
|
-
#Detach a volume from a
|
575
|
+
# Detach a volume from a PVMInstance
|
292
576
|
result = api_instance.pcloud_pvminstances_volumes_delete(cloud_instance_id, pvm_instance_id, volume_id)
|
293
577
|
p result
|
294
578
|
rescue IbmCloudPower::ApiError => e
|
295
|
-
puts "
|
579
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_delete: #{e}"
|
296
580
|
end
|
297
581
|
```
|
298
582
|
|
299
|
-
|
583
|
+
#### Using the pcloud_pvminstances_volumes_delete_with_http_info variant
|
584
|
+
|
585
|
+
This returns an Array which contains the response data, status code and headers.
|
586
|
+
|
587
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_delete_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
588
|
+
|
589
|
+
```ruby
|
590
|
+
begin
|
591
|
+
# Detach a volume from a PVMInstance
|
592
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_delete_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
593
|
+
p status_code # => 2xx
|
594
|
+
p headers # => { ... }
|
595
|
+
p data # => Object
|
596
|
+
rescue IbmCloudPower::ApiError => e
|
597
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_delete_with_http_info: #{e}"
|
598
|
+
end
|
599
|
+
```
|
300
600
|
|
601
|
+
### Parameters
|
301
602
|
|
302
|
-
Name | Type | Description
|
303
|
-
|
304
|
-
**cloud_instance_id** | **String
|
305
|
-
**pvm_instance_id** | **String
|
306
|
-
**volume_id** | **String
|
603
|
+
| Name | Type | Description | Notes |
|
604
|
+
| ---- | ---- | ----------- | ----- |
|
605
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
606
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
607
|
+
| **volume_id** | **String** | Volume ID | |
|
307
608
|
|
308
609
|
### Return type
|
309
610
|
|
@@ -321,14 +622,14 @@ No authorization required
|
|
321
622
|
|
322
623
|
## pcloud_pvminstances_volumes_get
|
323
624
|
|
324
|
-
> Volume pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
625
|
+
> <Volume> pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
325
626
|
|
326
|
-
Detailed
|
627
|
+
Detailed info of a volume attached to a PVMInstance
|
327
628
|
|
328
|
-
###
|
629
|
+
### Examples
|
329
630
|
|
330
631
|
```ruby
|
331
|
-
|
632
|
+
require 'time'
|
332
633
|
require 'ibm_cloud_power'
|
333
634
|
|
334
635
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -337,22 +638,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
337
638
|
volume_id = 'volume_id_example' # String | Volume ID
|
338
639
|
|
339
640
|
begin
|
340
|
-
#Detailed
|
641
|
+
# Detailed info of a volume attached to a PVMInstance
|
341
642
|
result = api_instance.pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
|
342
643
|
p result
|
343
644
|
rescue IbmCloudPower::ApiError => e
|
344
|
-
puts "
|
645
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_get: #{e}"
|
345
646
|
end
|
346
647
|
```
|
347
648
|
|
348
|
-
|
649
|
+
#### Using the pcloud_pvminstances_volumes_get_with_http_info variant
|
650
|
+
|
651
|
+
This returns an Array which contains the response data, status code and headers.
|
652
|
+
|
653
|
+
> <Array(<Volume>, Integer, Hash)> pcloud_pvminstances_volumes_get_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
654
|
+
|
655
|
+
```ruby
|
656
|
+
begin
|
657
|
+
# Detailed info of a volume attached to a PVMInstance
|
658
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_get_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
659
|
+
p status_code # => 2xx
|
660
|
+
p headers # => { ... }
|
661
|
+
p data # => <Volume>
|
662
|
+
rescue IbmCloudPower::ApiError => e
|
663
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_get_with_http_info: #{e}"
|
664
|
+
end
|
665
|
+
```
|
349
666
|
|
667
|
+
### Parameters
|
350
668
|
|
351
|
-
Name | Type | Description
|
352
|
-
|
353
|
-
**cloud_instance_id** | **String
|
354
|
-
**pvm_instance_id** | **String
|
355
|
-
**volume_id** | **String
|
669
|
+
| Name | Type | Description | Notes |
|
670
|
+
| ---- | ---- | ----------- | ----- |
|
671
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
672
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
673
|
+
| **volume_id** | **String** | Volume ID | |
|
356
674
|
|
357
675
|
### Return type
|
358
676
|
|
@@ -370,14 +688,14 @@ No authorization required
|
|
370
688
|
|
371
689
|
## pcloud_pvminstances_volumes_getall
|
372
690
|
|
373
|
-
> Volumes pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
691
|
+
> <Volumes> pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
374
692
|
|
375
693
|
List all volumes attached to a PVM Instance
|
376
694
|
|
377
|
-
###
|
695
|
+
### Examples
|
378
696
|
|
379
697
|
```ruby
|
380
|
-
|
698
|
+
require 'time'
|
381
699
|
require 'ibm_cloud_power'
|
382
700
|
|
383
701
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -385,21 +703,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
385
703
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
386
704
|
|
387
705
|
begin
|
388
|
-
#List all volumes attached to a PVM Instance
|
706
|
+
# List all volumes attached to a PVM Instance
|
389
707
|
result = api_instance.pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
|
390
708
|
p result
|
391
709
|
rescue IbmCloudPower::ApiError => e
|
392
|
-
puts "
|
710
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_getall: #{e}"
|
393
711
|
end
|
394
712
|
```
|
395
713
|
|
396
|
-
|
714
|
+
#### Using the pcloud_pvminstances_volumes_getall_with_http_info variant
|
397
715
|
|
716
|
+
This returns an Array which contains the response data, status code and headers.
|
398
717
|
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
718
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_pvminstances_volumes_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
719
|
+
|
720
|
+
```ruby
|
721
|
+
begin
|
722
|
+
# List all volumes attached to a PVM Instance
|
723
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
724
|
+
p status_code # => 2xx
|
725
|
+
p headers # => { ... }
|
726
|
+
p data # => <Volumes>
|
727
|
+
rescue IbmCloudPower::ApiError => e
|
728
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_getall_with_http_info: #{e}"
|
729
|
+
end
|
730
|
+
```
|
731
|
+
|
732
|
+
### Parameters
|
733
|
+
|
734
|
+
| Name | Type | Description | Notes |
|
735
|
+
| ---- | ---- | ----------- | ----- |
|
736
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
737
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
403
738
|
|
404
739
|
### Return type
|
405
740
|
|
@@ -419,12 +754,12 @@ No authorization required
|
|
419
754
|
|
420
755
|
> Object pcloud_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, volume_id)
|
421
756
|
|
422
|
-
Attach a volume to a
|
757
|
+
Attach a volume to a PVMInstance
|
423
758
|
|
424
|
-
###
|
759
|
+
### Examples
|
425
760
|
|
426
761
|
```ruby
|
427
|
-
|
762
|
+
require 'time'
|
428
763
|
require 'ibm_cloud_power'
|
429
764
|
|
430
765
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -433,22 +768,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
433
768
|
volume_id = 'volume_id_example' # String | Volume ID
|
434
769
|
|
435
770
|
begin
|
436
|
-
#Attach a volume to a
|
771
|
+
# Attach a volume to a PVMInstance
|
437
772
|
result = api_instance.pcloud_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, volume_id)
|
438
773
|
p result
|
439
774
|
rescue IbmCloudPower::ApiError => e
|
440
|
-
puts "
|
775
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_post: #{e}"
|
441
776
|
end
|
442
777
|
```
|
443
778
|
|
444
|
-
|
779
|
+
#### Using the pcloud_pvminstances_volumes_post_with_http_info variant
|
780
|
+
|
781
|
+
This returns an Array which contains the response data, status code and headers.
|
782
|
+
|
783
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
445
784
|
|
785
|
+
```ruby
|
786
|
+
begin
|
787
|
+
# Attach a volume to a PVMInstance
|
788
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
789
|
+
p status_code # => 2xx
|
790
|
+
p headers # => { ... }
|
791
|
+
p data # => Object
|
792
|
+
rescue IbmCloudPower::ApiError => e
|
793
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_post_with_http_info: #{e}"
|
794
|
+
end
|
795
|
+
```
|
796
|
+
|
797
|
+
### Parameters
|
446
798
|
|
447
|
-
Name | Type | Description
|
448
|
-
|
449
|
-
**cloud_instance_id** | **String
|
450
|
-
**pvm_instance_id** | **String
|
451
|
-
**volume_id** | **String
|
799
|
+
| Name | Type | Description | Notes |
|
800
|
+
| ---- | ---- | ----------- | ----- |
|
801
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
802
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
803
|
+
| **volume_id** | **String** | Volume ID | |
|
452
804
|
|
453
805
|
### Return type
|
454
806
|
|
@@ -470,36 +822,53 @@ No authorization required
|
|
470
822
|
|
471
823
|
Update a volume attached to a PVMInstance
|
472
824
|
|
473
|
-
###
|
825
|
+
### Examples
|
474
826
|
|
475
827
|
```ruby
|
476
|
-
|
828
|
+
require 'time'
|
477
829
|
require 'ibm_cloud_power'
|
478
830
|
|
479
831
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
480
832
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
481
833
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
482
834
|
volume_id = 'volume_id_example' # String | Volume ID
|
483
|
-
body = IbmCloudPower::PVMInstanceVolumeUpdate.new # PVMInstanceVolumeUpdate | Parameters to update a volume attached to a PVMInstance
|
835
|
+
body = IbmCloudPower::PVMInstanceVolumeUpdate.new({delete_on_termination: false}) # PVMInstanceVolumeUpdate | Parameters to update a volume attached to a PVMInstance
|
484
836
|
|
485
837
|
begin
|
486
|
-
#Update a volume attached to a PVMInstance
|
838
|
+
# Update a volume attached to a PVMInstance
|
487
839
|
result = api_instance.pcloud_pvminstances_volumes_put(cloud_instance_id, pvm_instance_id, volume_id, body)
|
488
840
|
p result
|
489
841
|
rescue IbmCloudPower::ApiError => e
|
490
|
-
puts "
|
842
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_put: #{e}"
|
491
843
|
end
|
492
844
|
```
|
493
845
|
|
494
|
-
|
846
|
+
#### Using the pcloud_pvminstances_volumes_put_with_http_info variant
|
847
|
+
|
848
|
+
This returns an Array which contains the response data, status code and headers.
|
849
|
+
|
850
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id, body)
|
851
|
+
|
852
|
+
```ruby
|
853
|
+
begin
|
854
|
+
# Update a volume attached to a PVMInstance
|
855
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id, body)
|
856
|
+
p status_code # => 2xx
|
857
|
+
p headers # => { ... }
|
858
|
+
p data # => Object
|
859
|
+
rescue IbmCloudPower::ApiError => e
|
860
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_put_with_http_info: #{e}"
|
861
|
+
end
|
862
|
+
```
|
495
863
|
|
864
|
+
### Parameters
|
496
865
|
|
497
|
-
Name | Type | Description
|
498
|
-
|
499
|
-
**cloud_instance_id** | **String
|
500
|
-
**pvm_instance_id** | **String
|
501
|
-
**volume_id** | **String
|
502
|
-
**body** | [**PVMInstanceVolumeUpdate**](PVMInstanceVolumeUpdate.md)| Parameters to update a volume attached to a PVMInstance |
|
866
|
+
| Name | Type | Description | Notes |
|
867
|
+
| ---- | ---- | ----------- | ----- |
|
868
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
869
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
870
|
+
| **volume_id** | **String** | Volume ID | |
|
871
|
+
| **body** | [**PVMInstanceVolumeUpdate**](PVMInstanceVolumeUpdate.md) | Parameters to update a volume attached to a PVMInstance | |
|
503
872
|
|
504
873
|
### Return type
|
505
874
|
|
@@ -521,10 +890,10 @@ No authorization required
|
|
521
890
|
|
522
891
|
Set the PVMInstance volume as the boot volume
|
523
892
|
|
524
|
-
###
|
893
|
+
### Examples
|
525
894
|
|
526
895
|
```ruby
|
527
|
-
|
896
|
+
require 'time'
|
528
897
|
require 'ibm_cloud_power'
|
529
898
|
|
530
899
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -533,22 +902,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
533
902
|
volume_id = 'volume_id_example' # String | Volume ID
|
534
903
|
|
535
904
|
begin
|
536
|
-
#Set the PVMInstance volume as the boot volume
|
905
|
+
# Set the PVMInstance volume as the boot volume
|
537
906
|
result = api_instance.pcloud_pvminstances_volumes_setboot_put(cloud_instance_id, pvm_instance_id, volume_id)
|
538
907
|
p result
|
539
908
|
rescue IbmCloudPower::ApiError => e
|
540
|
-
puts "
|
909
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_setboot_put: #{e}"
|
541
910
|
end
|
542
911
|
```
|
543
912
|
|
544
|
-
|
913
|
+
#### Using the pcloud_pvminstances_volumes_setboot_put_with_http_info variant
|
914
|
+
|
915
|
+
This returns an Array which contains the response data, status code and headers.
|
916
|
+
|
917
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_volumes_setboot_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
918
|
+
|
919
|
+
```ruby
|
920
|
+
begin
|
921
|
+
# Set the PVMInstance volume as the boot volume
|
922
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_volumes_setboot_put_with_http_info(cloud_instance_id, pvm_instance_id, volume_id)
|
923
|
+
p status_code # => 2xx
|
924
|
+
p headers # => { ... }
|
925
|
+
p data # => Object
|
926
|
+
rescue IbmCloudPower::ApiError => e
|
927
|
+
puts "Error when calling PCloudVolumesApi->pcloud_pvminstances_volumes_setboot_put_with_http_info: #{e}"
|
928
|
+
end
|
929
|
+
```
|
545
930
|
|
931
|
+
### Parameters
|
546
932
|
|
547
|
-
Name | Type | Description
|
548
|
-
|
549
|
-
**cloud_instance_id** | **String
|
550
|
-
**pvm_instance_id** | **String
|
551
|
-
**volume_id** | **String
|
933
|
+
| Name | Type | Description | Notes |
|
934
|
+
| ---- | ---- | ----------- | ----- |
|
935
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
936
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
937
|
+
| **volume_id** | **String** | Volume ID | |
|
552
938
|
|
553
939
|
### Return type
|
554
940
|
|
@@ -564,38 +950,121 @@ No authorization required
|
|
564
950
|
- **Accept**: */*
|
565
951
|
|
566
952
|
|
953
|
+
## pcloud_v2_pvminstances_volumes_post
|
954
|
+
|
955
|
+
> <VolumesAttachmentResponse> pcloud_v2_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, body)
|
956
|
+
|
957
|
+
Attach all volumes to a PVMInstance
|
958
|
+
|
959
|
+
### Examples
|
960
|
+
|
961
|
+
```ruby
|
962
|
+
require 'time'
|
963
|
+
require 'ibm_cloud_power'
|
964
|
+
|
965
|
+
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
966
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
967
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
968
|
+
body = IbmCloudPower::VolumesAttach.new({volume_ids: ['volume_ids_example']}) # VolumesAttach | Parameter to attach volumes to a PVMInstance
|
969
|
+
|
970
|
+
begin
|
971
|
+
# Attach all volumes to a PVMInstance
|
972
|
+
result = api_instance.pcloud_v2_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, body)
|
973
|
+
p result
|
974
|
+
rescue IbmCloudPower::ApiError => e
|
975
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_pvminstances_volumes_post: #{e}"
|
976
|
+
end
|
977
|
+
```
|
978
|
+
|
979
|
+
#### Using the pcloud_v2_pvminstances_volumes_post_with_http_info variant
|
980
|
+
|
981
|
+
This returns an Array which contains the response data, status code and headers.
|
982
|
+
|
983
|
+
> <Array(<VolumesAttachmentResponse>, Integer, Hash)> pcloud_v2_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
984
|
+
|
985
|
+
```ruby
|
986
|
+
begin
|
987
|
+
# Attach all volumes to a PVMInstance
|
988
|
+
data, status_code, headers = api_instance.pcloud_v2_pvminstances_volumes_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
989
|
+
p status_code # => 2xx
|
990
|
+
p headers # => { ... }
|
991
|
+
p data # => <VolumesAttachmentResponse>
|
992
|
+
rescue IbmCloudPower::ApiError => e
|
993
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_pvminstances_volumes_post_with_http_info: #{e}"
|
994
|
+
end
|
995
|
+
```
|
996
|
+
|
997
|
+
### Parameters
|
998
|
+
|
999
|
+
| Name | Type | Description | Notes |
|
1000
|
+
| ---- | ---- | ----------- | ----- |
|
1001
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1002
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
1003
|
+
| **body** | [**VolumesAttach**](VolumesAttach.md) | Parameter to attach volumes to a PVMInstance | |
|
1004
|
+
|
1005
|
+
### Return type
|
1006
|
+
|
1007
|
+
[**VolumesAttachmentResponse**](VolumesAttachmentResponse.md)
|
1008
|
+
|
1009
|
+
### Authorization
|
1010
|
+
|
1011
|
+
No authorization required
|
1012
|
+
|
1013
|
+
### HTTP request headers
|
1014
|
+
|
1015
|
+
- **Content-Type**: application/json
|
1016
|
+
- **Accept**: application/json
|
1017
|
+
|
1018
|
+
|
567
1019
|
## pcloud_v2_volumes_clone_post
|
568
1020
|
|
569
|
-
> CloneTaskReference pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
1021
|
+
> <CloneTaskReference> pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
570
1022
|
|
571
|
-
Create a volume clone for specified volumes
|
1023
|
+
Create a volume clone for specified volumes
|
572
1024
|
|
573
|
-
###
|
1025
|
+
### Examples
|
574
1026
|
|
575
1027
|
```ruby
|
576
|
-
|
1028
|
+
require 'time'
|
577
1029
|
require 'ibm_cloud_power'
|
578
1030
|
|
579
1031
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
580
1032
|
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
|
1033
|
+
body = IbmCloudPower::VolumesCloneAsyncRequest.new({name: 'name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneAsyncRequest | Parameters for the cloning of volumes
|
582
1034
|
|
583
1035
|
begin
|
584
|
-
#Create a volume clone for specified volumes
|
1036
|
+
# Create a volume clone for specified volumes
|
585
1037
|
result = api_instance.pcloud_v2_volumes_clone_post(cloud_instance_id, body)
|
586
1038
|
p result
|
587
1039
|
rescue IbmCloudPower::ApiError => e
|
588
|
-
puts "
|
1040
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clone_post: #{e}"
|
589
1041
|
end
|
590
1042
|
```
|
591
1043
|
|
592
|
-
|
1044
|
+
#### Using the pcloud_v2_volumes_clone_post_with_http_info variant
|
1045
|
+
|
1046
|
+
This returns an Array which contains the response data, status code and headers.
|
1047
|
+
|
1048
|
+
> <Array(<CloneTaskReference>, Integer, Hash)> pcloud_v2_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
593
1049
|
|
1050
|
+
```ruby
|
1051
|
+
begin
|
1052
|
+
# Create a volume clone for specified volumes
|
1053
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
1054
|
+
p status_code # => 2xx
|
1055
|
+
p headers # => { ... }
|
1056
|
+
p data # => <CloneTaskReference>
|
1057
|
+
rescue IbmCloudPower::ApiError => e
|
1058
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clone_post_with_http_info: #{e}"
|
1059
|
+
end
|
1060
|
+
```
|
1061
|
+
|
1062
|
+
### Parameters
|
594
1063
|
|
595
|
-
Name | Type | Description
|
596
|
-
|
597
|
-
**cloud_instance_id** | **String
|
598
|
-
**body** | [**VolumesCloneAsyncRequest**](VolumesCloneAsyncRequest.md)| Parameters for the cloning of volumes |
|
1064
|
+
| Name | Type | Description | Notes |
|
1065
|
+
| ---- | ---- | ----------- | ----- |
|
1066
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1067
|
+
| **body** | [**VolumesCloneAsyncRequest**](VolumesCloneAsyncRequest.md) | Parameters for the cloning of volumes | |
|
599
1068
|
|
600
1069
|
### Return type
|
601
1070
|
|
@@ -613,14 +1082,14 @@ No authorization required
|
|
613
1082
|
|
614
1083
|
## pcloud_v2_volumes_clonetasks_get
|
615
1084
|
|
616
|
-
> CloneTaskStatus pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
1085
|
+
> <CloneTaskStatus> pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
617
1086
|
|
618
|
-
Get the status of a
|
1087
|
+
Get the status of a volumes clone request for the specified clone task ID
|
619
1088
|
|
620
|
-
###
|
1089
|
+
### Examples
|
621
1090
|
|
622
1091
|
```ruby
|
623
|
-
|
1092
|
+
require 'time'
|
624
1093
|
require 'ibm_cloud_power'
|
625
1094
|
|
626
1095
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
@@ -628,21 +1097,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
628
1097
|
clone_task_id = 'clone_task_id_example' # String | Volumes Clone Task ID
|
629
1098
|
|
630
1099
|
begin
|
631
|
-
#Get the status of a
|
1100
|
+
# Get the status of a volumes clone request for the specified clone task ID
|
632
1101
|
result = api_instance.pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
|
633
1102
|
p result
|
634
1103
|
rescue IbmCloudPower::ApiError => e
|
635
|
-
puts "
|
1104
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clonetasks_get: #{e}"
|
636
1105
|
end
|
637
1106
|
```
|
638
1107
|
|
639
|
-
|
1108
|
+
#### Using the pcloud_v2_volumes_clonetasks_get_with_http_info variant
|
1109
|
+
|
1110
|
+
This returns an Array which contains the response data, status code and headers.
|
1111
|
+
|
1112
|
+
> <Array(<CloneTaskStatus>, Integer, Hash)> pcloud_v2_volumes_clonetasks_get_with_http_info(cloud_instance_id, clone_task_id)
|
1113
|
+
|
1114
|
+
```ruby
|
1115
|
+
begin
|
1116
|
+
# Get the status of a volumes clone request for the specified clone task ID
|
1117
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_clonetasks_get_with_http_info(cloud_instance_id, clone_task_id)
|
1118
|
+
p status_code # => 2xx
|
1119
|
+
p headers # => { ... }
|
1120
|
+
p data # => <CloneTaskStatus>
|
1121
|
+
rescue IbmCloudPower::ApiError => e
|
1122
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_clonetasks_get_with_http_info: #{e}"
|
1123
|
+
end
|
1124
|
+
```
|
640
1125
|
|
1126
|
+
### Parameters
|
641
1127
|
|
642
|
-
Name | Type | Description
|
643
|
-
|
644
|
-
**cloud_instance_id** | **String
|
645
|
-
**clone_task_id** | **String
|
1128
|
+
| Name | Type | Description | Notes |
|
1129
|
+
| ---- | ---- | ----------- | ----- |
|
1130
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1131
|
+
| **clone_task_id** | **String** | Volumes Clone Task ID | |
|
646
1132
|
|
647
1133
|
### Return type
|
648
1134
|
|
@@ -655,41 +1141,58 @@ No authorization required
|
|
655
1141
|
### HTTP request headers
|
656
1142
|
|
657
1143
|
- **Content-Type**: Not defined
|
658
|
-
- **Accept**: application/json
|
1144
|
+
- **Accept**: application/json, percentComplete, status
|
659
1145
|
|
660
1146
|
|
661
1147
|
## pcloud_v2_volumes_post
|
662
1148
|
|
663
|
-
> Volumes pcloud_v2_volumes_post(cloud_instance_id, body)
|
1149
|
+
> <Volumes> pcloud_v2_volumes_post(cloud_instance_id, body)
|
664
1150
|
|
665
1151
|
Create multiple data volumes from a single definition
|
666
1152
|
|
667
|
-
###
|
1153
|
+
### Examples
|
668
1154
|
|
669
1155
|
```ruby
|
670
|
-
|
1156
|
+
require 'time'
|
671
1157
|
require 'ibm_cloud_power'
|
672
1158
|
|
673
1159
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
674
1160
|
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
|
1161
|
+
body = IbmCloudPower::MultiVolumesCreate.new({name: 'name_example', size: 37}) # MultiVolumesCreate | Parameters for creating multiple volumes
|
676
1162
|
|
677
1163
|
begin
|
678
|
-
#Create multiple data volumes from a single definition
|
1164
|
+
# Create multiple data volumes from a single definition
|
679
1165
|
result = api_instance.pcloud_v2_volumes_post(cloud_instance_id, body)
|
680
1166
|
p result
|
681
1167
|
rescue IbmCloudPower::ApiError => e
|
682
|
-
puts "
|
1168
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_post: #{e}"
|
683
1169
|
end
|
684
1170
|
```
|
685
1171
|
|
686
|
-
|
1172
|
+
#### Using the pcloud_v2_volumes_post_with_http_info variant
|
1173
|
+
|
1174
|
+
This returns an Array which contains the response data, status code and headers.
|
1175
|
+
|
1176
|
+
> <Array(<Volumes>, Integer, Hash)> pcloud_v2_volumes_post_with_http_info(cloud_instance_id, body)
|
1177
|
+
|
1178
|
+
```ruby
|
1179
|
+
begin
|
1180
|
+
# Create multiple data volumes from a single definition
|
1181
|
+
data, status_code, headers = api_instance.pcloud_v2_volumes_post_with_http_info(cloud_instance_id, body)
|
1182
|
+
p status_code # => 2xx
|
1183
|
+
p headers # => { ... }
|
1184
|
+
p data # => <Volumes>
|
1185
|
+
rescue IbmCloudPower::ApiError => e
|
1186
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumes_post_with_http_info: #{e}"
|
1187
|
+
end
|
1188
|
+
```
|
687
1189
|
|
1190
|
+
### Parameters
|
688
1191
|
|
689
|
-
Name | Type | Description
|
690
|
-
|
691
|
-
**cloud_instance_id** | **String
|
692
|
-
**body** | [**MultiVolumesCreate**](MultiVolumesCreate.md)| Parameters for creating multiple volumes |
|
1192
|
+
| Name | Type | Description | Notes |
|
1193
|
+
| ---- | ---- | ----------- | ----- |
|
1194
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1195
|
+
| **body** | [**MultiVolumesCreate**](MultiVolumesCreate.md) | Parameters for creating multiple volumes | |
|
693
1196
|
|
694
1197
|
### Return type
|
695
1198
|
|
@@ -707,40 +1210,57 @@ No authorization required
|
|
707
1210
|
|
708
1211
|
## pcloud_v2_volumesclone_cancel_post
|
709
1212
|
|
710
|
-
> VolumesClone pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
1213
|
+
> <VolumesClone> pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
711
1214
|
|
712
|
-
Cancel a
|
1215
|
+
Cancel a volumes-clone request, initiates the Cleanup action Cleanup action performs the cleanup of the preparatory clones and snapshot volumes
|
713
1216
|
|
714
|
-
###
|
1217
|
+
### Examples
|
715
1218
|
|
716
1219
|
```ruby
|
717
|
-
|
1220
|
+
require 'time'
|
718
1221
|
require 'ibm_cloud_power'
|
719
1222
|
|
720
1223
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
721
1224
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
722
|
-
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1225
|
+
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
723
1226
|
opts = {
|
724
1227
|
body: IbmCloudPower::VolumesCloneCancel.new # VolumesCloneCancel | Parameters for cancelling a volumes-clone request
|
725
1228
|
}
|
726
1229
|
|
727
1230
|
begin
|
728
|
-
#Cancel a
|
1231
|
+
# Cancel a volumes-clone request, initiates the Cleanup action Cleanup action performs the cleanup of the preparatory clones and snapshot volumes
|
729
1232
|
result = api_instance.pcloud_v2_volumesclone_cancel_post(cloud_instance_id, volumes_clone_id, opts)
|
730
1233
|
p result
|
731
1234
|
rescue IbmCloudPower::ApiError => e
|
732
|
-
puts "
|
1235
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_cancel_post: #{e}"
|
733
1236
|
end
|
734
1237
|
```
|
735
1238
|
|
736
|
-
|
1239
|
+
#### Using the pcloud_v2_volumesclone_cancel_post_with_http_info variant
|
1240
|
+
|
1241
|
+
This returns an Array which contains the response data, status code and headers.
|
1242
|
+
|
1243
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_cancel_post_with_http_info(cloud_instance_id, volumes_clone_id, opts)
|
1244
|
+
|
1245
|
+
```ruby
|
1246
|
+
begin
|
1247
|
+
# Cancel a volumes-clone request, initiates the Cleanup action Cleanup action performs the cleanup of the preparatory clones and snapshot volumes
|
1248
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_cancel_post_with_http_info(cloud_instance_id, volumes_clone_id, opts)
|
1249
|
+
p status_code # => 2xx
|
1250
|
+
p headers # => { ... }
|
1251
|
+
p data # => <VolumesClone>
|
1252
|
+
rescue IbmCloudPower::ApiError => e
|
1253
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_cancel_post_with_http_info: #{e}"
|
1254
|
+
end
|
1255
|
+
```
|
737
1256
|
|
1257
|
+
### Parameters
|
738
1258
|
|
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]
|
1259
|
+
| Name | Type | Description | Notes |
|
1260
|
+
| ---- | ---- | ----------- | ----- |
|
1261
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1262
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID | |
|
1263
|
+
| **body** | [**VolumesCloneCancel**](VolumesCloneCancel.md) | Parameters for cancelling a volumes-clone request | [optional] |
|
744
1264
|
|
745
1265
|
### Return type
|
746
1266
|
|
@@ -762,32 +1282,49 @@ No authorization required
|
|
762
1282
|
|
763
1283
|
Delete a volumes-clone request
|
764
1284
|
|
765
|
-
###
|
1285
|
+
### Examples
|
766
1286
|
|
767
1287
|
```ruby
|
768
|
-
|
1288
|
+
require 'time'
|
769
1289
|
require 'ibm_cloud_power'
|
770
1290
|
|
771
1291
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
772
1292
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
773
|
-
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1293
|
+
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
774
1294
|
|
775
1295
|
begin
|
776
|
-
#Delete a volumes-clone request
|
1296
|
+
# Delete a volumes-clone request
|
777
1297
|
result = api_instance.pcloud_v2_volumesclone_delete(cloud_instance_id, volumes_clone_id)
|
778
1298
|
p result
|
779
1299
|
rescue IbmCloudPower::ApiError => e
|
780
|
-
puts "
|
1300
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_delete: #{e}"
|
781
1301
|
end
|
782
1302
|
```
|
783
1303
|
|
784
|
-
|
1304
|
+
#### Using the pcloud_v2_volumesclone_delete_with_http_info variant
|
1305
|
+
|
1306
|
+
This returns an Array which contains the response data, status code and headers.
|
1307
|
+
|
1308
|
+
> <Array(Object, Integer, Hash)> pcloud_v2_volumesclone_delete_with_http_info(cloud_instance_id, volumes_clone_id)
|
1309
|
+
|
1310
|
+
```ruby
|
1311
|
+
begin
|
1312
|
+
# Delete a volumes-clone request
|
1313
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_delete_with_http_info(cloud_instance_id, volumes_clone_id)
|
1314
|
+
p status_code # => 2xx
|
1315
|
+
p headers # => { ... }
|
1316
|
+
p data # => Object
|
1317
|
+
rescue IbmCloudPower::ApiError => e
|
1318
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_delete_with_http_info: #{e}"
|
1319
|
+
end
|
1320
|
+
```
|
785
1321
|
|
1322
|
+
### Parameters
|
786
1323
|
|
787
|
-
Name | Type | Description
|
788
|
-
|
789
|
-
**cloud_instance_id** | **String
|
790
|
-
**volumes_clone_id** | **String
|
1324
|
+
| Name | Type | Description | Notes |
|
1325
|
+
| ---- | ---- | ----------- | ----- |
|
1326
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1327
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID | |
|
791
1328
|
|
792
1329
|
### Return type
|
793
1330
|
|
@@ -805,38 +1342,55 @@ No authorization required
|
|
805
1342
|
|
806
1343
|
## pcloud_v2_volumesclone_execute_post
|
807
1344
|
|
808
|
-
> VolumesClone pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
1345
|
+
> <VolumesClone> pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
809
1346
|
|
810
|
-
Initiate the Execute action for a volumes-clone request
|
1347
|
+
Initiate the Execute action for a volumes-clone request Execute action creates the cloned volumes using the volume snapshots
|
811
1348
|
|
812
|
-
###
|
1349
|
+
### Examples
|
813
1350
|
|
814
1351
|
```ruby
|
815
|
-
|
1352
|
+
require 'time'
|
816
1353
|
require 'ibm_cloud_power'
|
817
1354
|
|
818
1355
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
819
1356
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
820
|
-
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
821
|
-
body = IbmCloudPower::VolumesCloneExecute.new # VolumesCloneExecute | Parameters for the cloning of volumes
|
1357
|
+
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1358
|
+
body = IbmCloudPower::VolumesCloneExecute.new({name: 'name_example'}) # VolumesCloneExecute | Parameters for the cloning of volumes
|
822
1359
|
|
823
1360
|
begin
|
824
|
-
#Initiate the Execute action for a volumes-clone request
|
1361
|
+
# Initiate the Execute action for a volumes-clone request Execute action creates the cloned volumes using the volume snapshots
|
825
1362
|
result = api_instance.pcloud_v2_volumesclone_execute_post(cloud_instance_id, volumes_clone_id, body)
|
826
1363
|
p result
|
827
1364
|
rescue IbmCloudPower::ApiError => e
|
828
|
-
puts "
|
1365
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_execute_post: #{e}"
|
829
1366
|
end
|
830
1367
|
```
|
831
1368
|
|
832
|
-
|
1369
|
+
#### Using the pcloud_v2_volumesclone_execute_post_with_http_info variant
|
1370
|
+
|
1371
|
+
This returns an Array which contains the response data, status code and headers.
|
1372
|
+
|
1373
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_execute_post_with_http_info(cloud_instance_id, volumes_clone_id, body)
|
1374
|
+
|
1375
|
+
```ruby
|
1376
|
+
begin
|
1377
|
+
# Initiate the Execute action for a volumes-clone request Execute action creates the cloned volumes using the volume snapshots
|
1378
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_execute_post_with_http_info(cloud_instance_id, volumes_clone_id, body)
|
1379
|
+
p status_code # => 2xx
|
1380
|
+
p headers # => { ... }
|
1381
|
+
p data # => <VolumesClone>
|
1382
|
+
rescue IbmCloudPower::ApiError => e
|
1383
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_execute_post_with_http_info: #{e}"
|
1384
|
+
end
|
1385
|
+
```
|
833
1386
|
|
1387
|
+
### Parameters
|
834
1388
|
|
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 |
|
1389
|
+
| Name | Type | Description | Notes |
|
1390
|
+
| ---- | ---- | ----------- | ----- |
|
1391
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1392
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID | |
|
1393
|
+
| **body** | [**VolumesCloneExecute**](VolumesCloneExecute.md) | Parameters for the cloning of volumes | |
|
840
1394
|
|
841
1395
|
### Return type
|
842
1396
|
|
@@ -854,36 +1408,53 @@ No authorization required
|
|
854
1408
|
|
855
1409
|
## pcloud_v2_volumesclone_get
|
856
1410
|
|
857
|
-
> VolumesCloneDetail pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
1411
|
+
> <VolumesCloneDetail> pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
858
1412
|
|
859
1413
|
Get the details for a volumes-clone request
|
860
1414
|
|
861
|
-
###
|
1415
|
+
### Examples
|
862
1416
|
|
863
1417
|
```ruby
|
864
|
-
|
1418
|
+
require 'time'
|
865
1419
|
require 'ibm_cloud_power'
|
866
1420
|
|
867
1421
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
868
1422
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
869
|
-
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1423
|
+
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
870
1424
|
|
871
1425
|
begin
|
872
|
-
#Get the details for a volumes-clone request
|
1426
|
+
# Get the details for a volumes-clone request
|
873
1427
|
result = api_instance.pcloud_v2_volumesclone_get(cloud_instance_id, volumes_clone_id)
|
874
1428
|
p result
|
875
1429
|
rescue IbmCloudPower::ApiError => e
|
876
|
-
puts "
|
1430
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_get: #{e}"
|
877
1431
|
end
|
878
1432
|
```
|
879
1433
|
|
880
|
-
|
1434
|
+
#### Using the pcloud_v2_volumesclone_get_with_http_info variant
|
1435
|
+
|
1436
|
+
This returns an Array which contains the response data, status code and headers.
|
881
1437
|
|
1438
|
+
> <Array(<VolumesCloneDetail>, Integer, Hash)> pcloud_v2_volumesclone_get_with_http_info(cloud_instance_id, volumes_clone_id)
|
882
1439
|
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
|
1440
|
+
```ruby
|
1441
|
+
begin
|
1442
|
+
# Get the details for a volumes-clone request
|
1443
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_get_with_http_info(cloud_instance_id, volumes_clone_id)
|
1444
|
+
p status_code # => 2xx
|
1445
|
+
p headers # => { ... }
|
1446
|
+
p data # => <VolumesCloneDetail>
|
1447
|
+
rescue IbmCloudPower::ApiError => e
|
1448
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_get_with_http_info: #{e}"
|
1449
|
+
end
|
1450
|
+
```
|
1451
|
+
|
1452
|
+
### Parameters
|
1453
|
+
|
1454
|
+
| Name | Type | Description | Notes |
|
1455
|
+
| ---- | ---- | ----------- | ----- |
|
1456
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1457
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID | |
|
887
1458
|
|
888
1459
|
### Return type
|
889
1460
|
|
@@ -901,38 +1472,55 @@ No authorization required
|
|
901
1472
|
|
902
1473
|
## pcloud_v2_volumesclone_getall
|
903
1474
|
|
904
|
-
> VolumesClones pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
1475
|
+
> <VolumesClones> pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
905
1476
|
|
906
1477
|
Get the list of volumes-clone request for a cloud instance
|
907
1478
|
|
908
|
-
###
|
1479
|
+
### Examples
|
909
1480
|
|
910
1481
|
```ruby
|
911
|
-
|
1482
|
+
require 'time'
|
912
1483
|
require 'ibm_cloud_power'
|
913
1484
|
|
914
1485
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
915
1486
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
916
1487
|
opts = {
|
917
|
-
filter: '
|
1488
|
+
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
1489
|
}
|
919
1490
|
|
920
1491
|
begin
|
921
|
-
#Get the list of volumes-clone request for a cloud instance
|
1492
|
+
# Get the list of volumes-clone request for a cloud instance
|
922
1493
|
result = api_instance.pcloud_v2_volumesclone_getall(cloud_instance_id, opts)
|
923
1494
|
p result
|
924
1495
|
rescue IbmCloudPower::ApiError => e
|
925
|
-
puts "
|
1496
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_getall: #{e}"
|
926
1497
|
end
|
927
1498
|
```
|
928
1499
|
|
929
|
-
|
1500
|
+
#### Using the pcloud_v2_volumesclone_getall_with_http_info variant
|
1501
|
+
|
1502
|
+
This returns an Array which contains the response data, status code and headers.
|
1503
|
+
|
1504
|
+
> <Array(<VolumesClones>, Integer, Hash)> pcloud_v2_volumesclone_getall_with_http_info(cloud_instance_id, opts)
|
1505
|
+
|
1506
|
+
```ruby
|
1507
|
+
begin
|
1508
|
+
# Get the list of volumes-clone request for a cloud instance
|
1509
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_getall_with_http_info(cloud_instance_id, opts)
|
1510
|
+
p status_code # => 2xx
|
1511
|
+
p headers # => { ... }
|
1512
|
+
p data # => <VolumesClones>
|
1513
|
+
rescue IbmCloudPower::ApiError => e
|
1514
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_getall_with_http_info: #{e}"
|
1515
|
+
end
|
1516
|
+
```
|
930
1517
|
|
1518
|
+
### Parameters
|
931
1519
|
|
932
|
-
Name | Type | Description
|
933
|
-
|
934
|
-
**cloud_instance_id** | **String
|
935
|
-
**filter** | **String
|
1520
|
+
| Name | Type | Description | Notes |
|
1521
|
+
| ---- | ---- | ----------- | ----- |
|
1522
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1523
|
+
| **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
1524
|
|
937
1525
|
### Return type
|
938
1526
|
|
@@ -950,36 +1538,53 @@ No authorization required
|
|
950
1538
|
|
951
1539
|
## pcloud_v2_volumesclone_post
|
952
1540
|
|
953
|
-
> VolumesClone pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
1541
|
+
> <VolumesClone> pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
954
1542
|
|
955
|
-
Create a new volumes clone request and
|
1543
|
+
Create a new volumes clone request and initiates the Prepare action Requires a minimum of two volumes Requires a minimum of one volume to be in the 'in-use' state Requires a unique volumes clone name Prepare action does the preparatory work for creating the snapshot volumes
|
956
1544
|
|
957
|
-
###
|
1545
|
+
### Examples
|
958
1546
|
|
959
1547
|
```ruby
|
960
|
-
|
1548
|
+
require 'time'
|
961
1549
|
require 'ibm_cloud_power'
|
962
1550
|
|
963
1551
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
964
1552
|
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
|
1553
|
+
body = IbmCloudPower::VolumesCloneCreate.new({name: 'name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneCreate | Parameters for preparing a set of volumes to be cloned
|
966
1554
|
|
967
1555
|
begin
|
968
|
-
#Create a new volumes clone request and
|
1556
|
+
# Create a new volumes clone request and initiates the Prepare action Requires a minimum of two volumes Requires a minimum of one volume to be in the 'in-use' state Requires a unique volumes clone name Prepare action does the preparatory work for creating the snapshot volumes
|
969
1557
|
result = api_instance.pcloud_v2_volumesclone_post(cloud_instance_id, body)
|
970
1558
|
p result
|
971
1559
|
rescue IbmCloudPower::ApiError => e
|
972
|
-
puts "
|
1560
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_post: #{e}"
|
973
1561
|
end
|
974
1562
|
```
|
975
1563
|
|
976
|
-
|
1564
|
+
#### Using the pcloud_v2_volumesclone_post_with_http_info variant
|
1565
|
+
|
1566
|
+
This returns an Array which contains the response data, status code and headers.
|
1567
|
+
|
1568
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_post_with_http_info(cloud_instance_id, body)
|
1569
|
+
|
1570
|
+
```ruby
|
1571
|
+
begin
|
1572
|
+
# Create a new volumes clone request and initiates the Prepare action Requires a minimum of two volumes Requires a minimum of one volume to be in the 'in-use' state Requires a unique volumes clone name Prepare action does the preparatory work for creating the snapshot volumes
|
1573
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_post_with_http_info(cloud_instance_id, body)
|
1574
|
+
p status_code # => 2xx
|
1575
|
+
p headers # => { ... }
|
1576
|
+
p data # => <VolumesClone>
|
1577
|
+
rescue IbmCloudPower::ApiError => e
|
1578
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_post_with_http_info: #{e}"
|
1579
|
+
end
|
1580
|
+
```
|
977
1581
|
|
1582
|
+
### Parameters
|
978
1583
|
|
979
|
-
Name | Type | Description
|
980
|
-
|
981
|
-
**cloud_instance_id** | **String
|
982
|
-
**body** | [**VolumesCloneCreate**](VolumesCloneCreate.md)| Parameters for preparing a set of volumes to be cloned
|
1584
|
+
| Name | Type | Description | Notes |
|
1585
|
+
| ---- | ---- | ----------- | ----- |
|
1586
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1587
|
+
| **body** | [**VolumesCloneCreate**](VolumesCloneCreate.md) | Parameters for preparing a set of volumes to be cloned | |
|
983
1588
|
|
984
1589
|
### Return type
|
985
1590
|
|
@@ -997,36 +1602,53 @@ No authorization required
|
|
997
1602
|
|
998
1603
|
## pcloud_v2_volumesclone_start_post
|
999
1604
|
|
1000
|
-
> VolumesClone pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1605
|
+
> <VolumesClone> pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1001
1606
|
|
1002
|
-
Initiate the Start action for a
|
1607
|
+
Initiate the Start action for a volumes-clone request Start action starts the consistency group to initiate the flash copy
|
1003
1608
|
|
1004
|
-
###
|
1609
|
+
### Examples
|
1005
1610
|
|
1006
1611
|
```ruby
|
1007
|
-
|
1612
|
+
require 'time'
|
1008
1613
|
require 'ibm_cloud_power'
|
1009
1614
|
|
1010
1615
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
1011
1616
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
1012
|
-
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1617
|
+
volumes_clone_id = 'volumes_clone_id_example' # String | Volumes Clone ID
|
1013
1618
|
|
1014
1619
|
begin
|
1015
|
-
#Initiate the Start action for a
|
1620
|
+
# Initiate the Start action for a volumes-clone request Start action starts the consistency group to initiate the flash copy
|
1016
1621
|
result = api_instance.pcloud_v2_volumesclone_start_post(cloud_instance_id, volumes_clone_id)
|
1017
1622
|
p result
|
1018
1623
|
rescue IbmCloudPower::ApiError => e
|
1019
|
-
puts "
|
1624
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_start_post: #{e}"
|
1020
1625
|
end
|
1021
1626
|
```
|
1022
1627
|
|
1023
|
-
|
1628
|
+
#### Using the pcloud_v2_volumesclone_start_post_with_http_info variant
|
1629
|
+
|
1630
|
+
This returns an Array which contains the response data, status code and headers.
|
1631
|
+
|
1632
|
+
> <Array(<VolumesClone>, Integer, Hash)> pcloud_v2_volumesclone_start_post_with_http_info(cloud_instance_id, volumes_clone_id)
|
1633
|
+
|
1634
|
+
```ruby
|
1635
|
+
begin
|
1636
|
+
# Initiate the Start action for a volumes-clone request Start action starts the consistency group to initiate the flash copy
|
1637
|
+
data, status_code, headers = api_instance.pcloud_v2_volumesclone_start_post_with_http_info(cloud_instance_id, volumes_clone_id)
|
1638
|
+
p status_code # => 2xx
|
1639
|
+
p headers # => { ... }
|
1640
|
+
p data # => <VolumesClone>
|
1641
|
+
rescue IbmCloudPower::ApiError => e
|
1642
|
+
puts "Error when calling PCloudVolumesApi->pcloud_v2_volumesclone_start_post_with_http_info: #{e}"
|
1643
|
+
end
|
1644
|
+
```
|
1024
1645
|
|
1646
|
+
### Parameters
|
1025
1647
|
|
1026
|
-
Name | Type | Description
|
1027
|
-
|
1028
|
-
**cloud_instance_id** | **String
|
1029
|
-
**volumes_clone_id** | **String
|
1648
|
+
| Name | Type | Description | Notes |
|
1649
|
+
| ---- | ---- | ----------- | ----- |
|
1650
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1651
|
+
| **volumes_clone_id** | **String** | Volumes Clone ID | |
|
1030
1652
|
|
1031
1653
|
### Return type
|
1032
1654
|
|
@@ -1044,36 +1666,53 @@ No authorization required
|
|
1044
1666
|
|
1045
1667
|
## pcloud_volumes_clone_post
|
1046
1668
|
|
1047
|
-
> VolumesCloneResponse pcloud_volumes_clone_post(cloud_instance_id, body)
|
1669
|
+
> <VolumesCloneResponse> pcloud_volumes_clone_post(cloud_instance_id, body)
|
1048
1670
|
|
1049
|
-
Create a volume clone for specified volumes
|
1671
|
+
Create a volume clone for specified volumes
|
1050
1672
|
|
1051
|
-
###
|
1673
|
+
### Examples
|
1052
1674
|
|
1053
1675
|
```ruby
|
1054
|
-
|
1676
|
+
require 'time'
|
1055
1677
|
require 'ibm_cloud_power'
|
1056
1678
|
|
1057
1679
|
api_instance = IbmCloudPower::PCloudVolumesApi.new
|
1058
1680
|
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
|
1681
|
+
body = IbmCloudPower::VolumesCloneRequest.new({display_name: 'display_name_example', volume_ids: ['volume_ids_example']}) # VolumesCloneRequest | Parameters for the cloning of volumes
|
1060
1682
|
|
1061
1683
|
begin
|
1062
|
-
#Create a volume clone for specified volumes
|
1684
|
+
# Create a volume clone for specified volumes
|
1063
1685
|
result = api_instance.pcloud_volumes_clone_post(cloud_instance_id, body)
|
1064
1686
|
p result
|
1065
1687
|
rescue IbmCloudPower::ApiError => e
|
1066
|
-
puts "
|
1688
|
+
puts "Error when calling PCloudVolumesApi->pcloud_volumes_clone_post: #{e}"
|
1067
1689
|
end
|
1068
1690
|
```
|
1069
1691
|
|
1070
|
-
|
1692
|
+
#### Using the pcloud_volumes_clone_post_with_http_info variant
|
1693
|
+
|
1694
|
+
This returns an Array which contains the response data, status code and headers.
|
1695
|
+
|
1696
|
+
> <Array(<VolumesCloneResponse>, Integer, Hash)> pcloud_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
1697
|
+
|
1698
|
+
```ruby
|
1699
|
+
begin
|
1700
|
+
# Create a volume clone for specified volumes
|
1701
|
+
data, status_code, headers = api_instance.pcloud_volumes_clone_post_with_http_info(cloud_instance_id, body)
|
1702
|
+
p status_code # => 2xx
|
1703
|
+
p headers # => { ... }
|
1704
|
+
p data # => <VolumesCloneResponse>
|
1705
|
+
rescue IbmCloudPower::ApiError => e
|
1706
|
+
puts "Error when calling PCloudVolumesApi->pcloud_volumes_clone_post_with_http_info: #{e}"
|
1707
|
+
end
|
1708
|
+
```
|
1071
1709
|
|
1710
|
+
### Parameters
|
1072
1711
|
|
1073
|
-
Name | Type | Description
|
1074
|
-
|
1075
|
-
**cloud_instance_id** | **String
|
1076
|
-
**body** | [**VolumesCloneRequest**](VolumesCloneRequest.md)| Parameters for the cloning of volumes |
|
1712
|
+
| Name | Type | Description | Notes |
|
1713
|
+
| ---- | ---- | ----------- | ----- |
|
1714
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1715
|
+
| **body** | [**VolumesCloneRequest**](VolumesCloneRequest.md) | Parameters for the cloning of volumes | |
|
1077
1716
|
|
1078
1717
|
### Return type
|
1079
1718
|
|