ibm_cloud_power 1.1.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +68 -3
- data/docs/CloneTaskReference.md +10 -9
- data/docs/CloneTaskStatus.md +14 -13
- data/docs/ClonedVolume.md +10 -9
- data/docs/ClonedVolumeDetail.md +10 -9
- data/docs/CloudConnection.md +32 -31
- data/docs/CloudConnectionCreate.md +14 -13
- data/docs/CloudConnectionCreateResponse.md +44 -0
- data/docs/CloudConnectionEndpointClassic.md +10 -9
- data/docs/CloudConnectionEndpointGRE.md +10 -9
- data/docs/CloudConnectionEndpointVPC.md +10 -9
- data/docs/CloudConnectionGRETunnel.md +12 -11
- data/docs/CloudConnectionSpeed.md +4 -5
- data/docs/CloudConnectionUpdate.md +18 -17
- data/docs/CloudConnectionVPC.md +10 -9
- data/docs/CloudConnectionVirtualPrivateClouds.md +8 -7
- data/docs/CloudConnectionVirtualPrivateCloudsVirtualPrivateCloudsInner.md +24 -0
- data/docs/CloudConnections.md +8 -7
- data/docs/CloudInstance.md +28 -27
- data/docs/CloudInstanceCreate.md +20 -19
- data/docs/CloudInstanceReference.md +22 -21
- data/docs/CloudInstanceUpdate.md +16 -15
- data/docs/CloudInstanceUsageLimits.md +28 -27
- data/docs/CreateCosImageImportJob.md +38 -0
- data/docs/CreateDataVolume.md +26 -19
- data/docs/CreateImage.md +32 -27
- data/docs/DeadPeerDetection.md +22 -0
- data/docs/Error.md +10 -9
- data/docs/Event.md +24 -23
- data/docs/EventUser.md +12 -11
- data/docs/Events.md +8 -7
- data/docs/ExportImage.md +14 -13
- data/docs/IKEPolicies.md +18 -0
- data/docs/IKEPolicy.md +30 -0
- data/docs/IKEPolicyCreate.md +30 -0
- data/docs/IKEPolicyOptions.md +24 -0
- data/docs/IKEPolicyRef.md +20 -0
- data/docs/IKEPolicyTemplate.md +26 -0
- data/docs/IKEPolicyUpdate.md +30 -0
- data/docs/IPAddressRange.md +10 -9
- data/docs/IPSecPolicies.md +18 -0
- data/docs/IPSecPolicy.md +30 -0
- data/docs/IPSecPolicyCreate.md +28 -0
- data/docs/IPSecPolicyOptions.md +22 -0
- data/docs/IPSecPolicyRef.md +20 -0
- data/docs/IPSecPolicyTemplate.md +24 -0
- data/docs/IPSecPolicyUpdate.md +28 -0
- data/docs/Image.md +32 -31
- data/docs/ImageReference.md +26 -25
- data/docs/ImageSpecifications.md +20 -19
- data/docs/ImageVolume.md +14 -13
- data/docs/Images.md +8 -7
- data/docs/Job.md +24 -0
- data/docs/JobReference.md +20 -0
- data/docs/Jobs.md +18 -0
- data/docs/MaximumStorageAllocation.md +12 -11
- data/docs/MinMaxDefault.md +12 -11
- data/docs/MultiVolumesCreate.md +28 -21
- data/docs/Network.md +28 -27
- data/docs/NetworkCreate.md +20 -19
- data/docs/NetworkID.md +18 -0
- data/docs/NetworkIDs.md +18 -0
- data/docs/NetworkIpAddressMetrics.md +14 -13
- data/docs/NetworkPort.md +22 -21
- data/docs/NetworkPortCreate.md +10 -9
- data/docs/NetworkPortPvmInstance.md +10 -9
- data/docs/NetworkPortUpdate.md +10 -9
- data/docs/NetworkPorts.md +8 -7
- data/docs/NetworkReference.md +18 -17
- data/docs/NetworkUpdate.md +14 -13
- data/docs/Networks.md +8 -7
- data/docs/Operation.md +22 -0
- data/docs/Operations.md +12 -11
- data/docs/Options.md +18 -0
- data/docs/PCloudCloudConnectionsApi.md +229 -94
- data/docs/PCloudEventsApi.md +60 -27
- data/docs/PCloudImagesApi.md +513 -101
- data/docs/PCloudInstancesApi.md +83 -33
- data/docs/PCloudJobsApi.md +208 -0
- data/docs/PCloudNetworksApi.md +287 -118
- data/docs/PCloudPVMInstancesApi.md +628 -208
- data/docs/PCloudPlacementGroupsApi.md +177 -76
- data/docs/PCloudSAPApi.md +86 -36
- data/docs/PCloudSnapshotsApi.md +112 -45
- data/docs/PCloudStorageCapacityApi.md +112 -45
- data/docs/PCloudSystemPoolsApi.md +29 -13
- data/docs/PCloudTasksApi.md +55 -22
- data/docs/PCloudTenantsApi.md +57 -24
- data/docs/PCloudTenantsSSHKeysApi.md +143 -59
- data/docs/PCloudVPNConnectionsApi.md +817 -0
- data/docs/PCloudVPNPoliciesApi.md +677 -0
- data/docs/PCloudVolumesApi.md +629 -256
- data/docs/PVMInstance.md +72 -69
- data/docs/PVMInstanceAction.md +8 -7
- data/docs/PVMInstanceAddNetwork.md +10 -9
- data/docs/PVMInstanceCapture.md +20 -19
- data/docs/PVMInstanceClone.md +22 -21
- data/docs/PVMInstanceConsole.md +8 -7
- data/docs/PVMInstanceCreate.md +50 -45
- data/docs/PVMInstanceFault.md +14 -13
- data/docs/PVMInstanceHealth.md +12 -11
- data/docs/PVMInstanceMultiCreate.md +12 -11
- data/docs/PVMInstanceNetwork.md +24 -23
- data/docs/PVMInstanceNetworks.md +8 -7
- data/docs/PVMInstanceOperation.md +10 -9
- data/docs/PVMInstanceReference.md +68 -61
- data/docs/PVMInstanceRemoveNetwork.md +8 -7
- data/docs/PVMInstanceUpdate.md +26 -23
- data/docs/PVMInstanceUpdateResponse.md +18 -17
- data/docs/PVMInstanceVolumeUpdate.md +8 -7
- data/docs/PVMInstances.md +8 -7
- data/docs/PeerSubnetUpdate.md +18 -0
- data/docs/PeerSubnets.md +18 -0
- data/docs/PeeringNetwork.md +12 -11
- data/docs/PinPolicy.md +4 -5
- data/docs/PlacementGroup.md +14 -13
- data/docs/PlacementGroupCreate.md +10 -9
- data/docs/PlacementGroupServer.md +8 -7
- data/docs/PlacementGroups.md +8 -7
- data/docs/SAPCreate.md +30 -23
- data/docs/SAPProfile.md +16 -15
- data/docs/SAPProfileReference.md +10 -9
- data/docs/SAPProfiles.md +8 -7
- data/docs/SRC.md +10 -9
- data/docs/SSHKey.md +12 -11
- data/docs/SSHKeys.md +8 -7
- data/docs/Snapshot.md +26 -25
- data/docs/SnapshotCreate.md +12 -11
- data/docs/SnapshotCreateResponse.md +8 -7
- data/docs/SnapshotRestore.md +8 -7
- data/docs/SnapshotUpdate.md +10 -9
- data/docs/Snapshots.md +8 -7
- data/docs/SoftwareLicenses.md +16 -15
- data/docs/Status.md +22 -0
- data/docs/StockImage.md +12 -11
- data/docs/StorageAffinity.md +26 -0
- data/docs/StoragePoolCapacity.md +14 -13
- data/docs/StoragePoolsCapacity.md +10 -9
- data/docs/StorageTypeCapacity.md +12 -11
- data/docs/StorageTypesCapacity.md +10 -9
- data/docs/System.md +12 -11
- data/docs/SystemPool.md +22 -21
- data/docs/Task.md +24 -23
- data/docs/TaskReference.md +10 -9
- data/docs/Tenant.md +20 -19
- data/docs/TenantUpdate.md +10 -9
- data/docs/UpdateVolume.md +14 -13
- data/docs/VPNConnection.md +40 -0
- data/docs/VPNConnectionCreate.md +30 -0
- data/docs/VPNConnectionCreateResponse.md +42 -0
- data/docs/VPNConnectionUpdate.md +24 -0
- data/docs/VPNConnections.md +18 -0
- data/docs/VPNaaSOptions.md +26 -0
- data/docs/VirtualCores.md +12 -11
- data/docs/Volume.md +36 -33
- data/docs/VolumeInfo.md +10 -9
- data/docs/VolumeReference.md +38 -35
- data/docs/Volumes.md +8 -7
- data/docs/VolumesClone.md +22 -21
- data/docs/VolumesCloneAsyncRequest.md +10 -9
- data/docs/VolumesCloneCancel.md +8 -7
- data/docs/VolumesCloneCreate.md +10 -9
- data/docs/VolumesCloneDetail.md +24 -23
- data/docs/VolumesCloneExecute.md +10 -9
- data/docs/VolumesCloneRequest.md +10 -9
- data/docs/VolumesCloneResponse.md +8 -7
- data/docs/VolumesClones.md +8 -7
- data/git_push.sh +3 -4
- data/ibm_cloud_power.gemspec +3 -3
- data/lib/ibm_cloud_power/api/p_cloud_cloud_connections_api.rb +43 -29
- data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +9 -7
- data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +325 -32
- data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +17 -11
- data/lib/ibm_cloud_power/api/p_cloud_jobs_api.rb +234 -0
- data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +57 -35
- data/lib/ibm_cloud_power/api/p_cloud_placement_groups_api.rb +45 -30
- data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +256 -64
- data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +17 -11
- data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +21 -14
- data/lib/ibm_cloud_power/api/p_cloud_storage_capacity_api.rb +17 -13
- data/lib/ibm_cloud_power/api/p_cloud_system_pools_api.rb +5 -4
- data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +9 -7
- data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +13 -8
- data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +29 -18
- data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +125 -76
- data/lib/ibm_cloud_power/api/p_cloud_vpn_connections_api.rb +898 -0
- data/lib/ibm_cloud_power/api/p_cloud_vpn_policies_api.rb +732 -0
- data/lib/ibm_cloud_power/api_client.rb +56 -52
- data/lib/ibm_cloud_power/api_error.rb +1 -1
- data/lib/ibm_cloud_power/configuration.rb +43 -12
- data/lib/ibm_cloud_power/models/clone_task_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/clone_task_status.rb +19 -8
- data/lib/ibm_cloud_power/models/cloned_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection.rb +20 -9
- data/lib/ibm_cloud_power/models/cloud_connection_create.rb +53 -8
- data/lib/ibm_cloud_power/models/cloud_connection_create_response.rb +406 -0
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_classic.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_gre.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_endpoint_vpc.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_gre_tunnel.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connection_speed.rb +2 -1
- data/lib/ibm_cloud_power/models/cloud_connection_update.rb +53 -8
- data/lib/ibm_cloud_power/models/cloud_connection_virtual_private_clouds.rb +20 -9
- data/lib/ibm_cloud_power/models/cloud_connection_virtual_private_clouds_virtual_private_clouds_inner.rb +270 -0
- data/lib/ibm_cloud_power/models/cloud_connection_vpc.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_connections.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_create.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_update.rb +19 -8
- data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +19 -8
- data/lib/ibm_cloud_power/models/create_cos_image_import_job.rb +387 -0
- data/lib/ibm_cloud_power/models/create_data_volume.rb +59 -14
- data/lib/ibm_cloud_power/models/create_image.rb +39 -9
- data/lib/ibm_cloud_power/models/dead_peer_detection.rb +350 -0
- data/lib/ibm_cloud_power/models/error.rb +32 -21
- data/lib/ibm_cloud_power/models/event.rb +20 -9
- data/lib/ibm_cloud_power/models/event_user.rb +19 -8
- data/lib/ibm_cloud_power/models/events.rb +19 -8
- data/lib/ibm_cloud_power/models/export_image.rb +19 -8
- data/lib/ibm_cloud_power/models/ike_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ike_policy.rb +414 -0
- data/lib/ibm_cloud_power/models/ike_policy_create.rb +414 -0
- data/lib/ibm_cloud_power/models/ike_policy_options.rb +274 -0
- data/lib/ibm_cloud_power/models/ike_policy_ref.rb +241 -0
- data/lib/ibm_cloud_power/models/ike_policy_template.rb +313 -0
- data/lib/ibm_cloud_power/models/ike_policy_update.rb +375 -0
- data/lib/ibm_cloud_power/models/image.rb +21 -10
- data/lib/ibm_cloud_power/models/image_reference.rb +21 -10
- data/lib/ibm_cloud_power/models/image_specifications.rb +19 -8
- data/lib/ibm_cloud_power/models/image_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/images.rb +19 -8
- data/lib/ibm_cloud_power/models/ip_address_range.rb +19 -8
- data/lib/ibm_cloud_power/models/ip_sec_policies.rb +227 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy.rb +402 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_create.rb +387 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_options.rb +258 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_ref.rb +241 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_template.rb +298 -0
- data/lib/ibm_cloud_power/models/ip_sec_policy_update.rb +353 -0
- data/lib/ibm_cloud_power/models/job.rb +263 -0
- data/lib/ibm_cloud_power/models/job_reference.rb +240 -0
- data/lib/ibm_cloud_power/models/jobs.rb +227 -0
- data/lib/ibm_cloud_power/models/maximum_storage_allocation.rb +20 -9
- data/lib/ibm_cloud_power/models/min_max_default.rb +19 -8
- data/lib/ibm_cloud_power/models/multi_volumes_create.rb +57 -12
- data/lib/ibm_cloud_power/models/network.rb +19 -8
- data/lib/ibm_cloud_power/models/network_create.rb +19 -8
- data/lib/ibm_cloud_power/models/network_id.rb +225 -0
- data/lib/ibm_cloud_power/models/network_ids.rb +222 -0
- data/lib/ibm_cloud_power/models/network_ip_address_metrics.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_create.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +19 -8
- data/lib/ibm_cloud_power/models/network_port_update.rb +19 -8
- data/lib/ibm_cloud_power/models/network_ports.rb +19 -8
- data/lib/ibm_cloud_power/models/network_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/network_update.rb +19 -8
- data/lib/ibm_cloud_power/models/networks.rb +19 -8
- data/lib/ibm_cloud_power/models/operation.rb +255 -0
- data/lib/ibm_cloud_power/models/operations.rb +19 -8
- data/lib/ibm_cloud_power/models/options.rb +224 -0
- data/lib/ibm_cloud_power/models/peer_subnet_update.rb +225 -0
- data/lib/ibm_cloud_power/models/peer_subnets.rb +222 -0
- data/lib/ibm_cloud_power/models/peering_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pin_policy.rb +2 -1
- data/lib/ibm_cloud_power/models/placement_group.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_group_create.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_group_server.rb +19 -8
- data/lib/ibm_cloud_power/models/placement_groups.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance.rb +57 -34
- data/lib/ibm_cloud_power/models/pvm_instance_action.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +27 -16
- data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +28 -17
- data/lib/ibm_cloud_power/models/pvm_instance_console.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_create.rb +54 -24
- data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +20 -9
- data/lib/ibm_cloud_power/models/pvm_instance_health.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +55 -12
- data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_update.rb +32 -9
- data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instance_volume_update.rb +19 -8
- data/lib/ibm_cloud_power/models/pvm_instances.rb +19 -8
- data/lib/ibm_cloud_power/models/sap_create.rb +56 -16
- data/lib/ibm_cloud_power/models/sap_profile.rb +18 -7
- data/lib/ibm_cloud_power/models/sap_profile_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/sap_profiles.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot.rb +21 -10
- data/lib/ibm_cloud_power/models/snapshot_create.rb +27 -16
- data/lib/ibm_cloud_power/models/snapshot_create_response.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot_restore.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshot_update.rb +19 -8
- data/lib/ibm_cloud_power/models/snapshots.rb +19 -8
- data/lib/ibm_cloud_power/models/software_licenses.rb +19 -8
- data/lib/ibm_cloud_power/models/src.rb +19 -8
- data/lib/ibm_cloud_power/models/ssh_key.rb +20 -9
- data/lib/ibm_cloud_power/models/ssh_keys.rb +19 -8
- data/lib/ibm_cloud_power/models/status.rb +250 -0
- data/lib/ibm_cloud_power/models/stock_image.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_affinity.rb +298 -0
- data/lib/ibm_cloud_power/models/storage_pool_capacity.rb +20 -9
- data/lib/ibm_cloud_power/models/storage_pools_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_type_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/storage_types_capacity.rb +19 -8
- data/lib/ibm_cloud_power/models/system.rb +19 -8
- data/lib/ibm_cloud_power/models/system_pool.rb +19 -8
- data/lib/ibm_cloud_power/models/task.rb +21 -10
- data/lib/ibm_cloud_power/models/task_reference.rb +19 -8
- data/lib/ibm_cloud_power/models/tenant.rb +20 -9
- data/lib/ibm_cloud_power/models/tenant_update.rb +19 -8
- data/lib/ibm_cloud_power/models/update_volume.rb +19 -8
- data/lib/ibm_cloud_power/models/virtual_cores.rb +19 -8
- data/lib/ibm_cloud_power/models/volume.rb +39 -18
- data/lib/ibm_cloud_power/models/volume_info.rb +19 -8
- data/lib/ibm_cloud_power/models/volume_reference.rb +39 -18
- data/lib/ibm_cloud_power/models/volumes.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone.rb +21 -10
- data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_cancel.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone_create.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_detail.rb +21 -10
- data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clone_request.rb +30 -19
- data/lib/ibm_cloud_power/models/volumes_clone_response.rb +19 -8
- data/lib/ibm_cloud_power/models/volumes_clones.rb +19 -8
- data/lib/ibm_cloud_power/models/vp_naa_s_options.rb +280 -0
- data/lib/ibm_cloud_power/models/vpn_connection.rb +437 -0
- data/lib/ibm_cloud_power/models/vpn_connection_create.rb +353 -0
- data/lib/ibm_cloud_power/models/vpn_connection_create_response.rb +453 -0
- data/lib/ibm_cloud_power/models/vpn_connection_update.rb +251 -0
- data/lib/ibm_cloud_power/models/vpn_connections.rb +222 -0
- data/lib/ibm_cloud_power/version.rb +2 -2
- data/lib/ibm_cloud_power.rb +39 -2
- data/spec/api/p_cloud_jobs_api_spec.rb +73 -0
- data/spec/api/p_cloud_vpn_connections_api_spec.rb +194 -0
- data/spec/api/p_cloud_vpn_policies_api_spec.rb +165 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/cloud_connection_create_response_spec.rb +112 -0
- data/spec/models/cloud_connection_virtual_private_clouds_virtual_private_clouds_inner_spec.rb +52 -0
- data/spec/models/create_cos_image_import_job_spec.rb +102 -0
- data/spec/models/dead_peer_detection_spec.rb +50 -0
- data/spec/models/ike_policies_spec.rb +34 -0
- data/spec/models/ike_policy_create_spec.rb +86 -0
- data/spec/models/ike_policy_options_spec.rb +52 -0
- data/spec/models/ike_policy_ref_spec.rb +40 -0
- data/spec/models/ike_policy_spec.rb +86 -0
- data/spec/models/ike_policy_template_spec.rb +58 -0
- data/spec/models/ike_policy_update_spec.rb +86 -0
- data/spec/models/ip_sec_policies_spec.rb +34 -0
- data/spec/models/ip_sec_policy_create_spec.rb +76 -0
- data/spec/models/ip_sec_policy_options_spec.rb +46 -0
- data/spec/models/ip_sec_policy_ref_spec.rb +40 -0
- data/spec/models/ip_sec_policy_spec.rb +82 -0
- data/spec/models/ip_sec_policy_template_spec.rb +52 -0
- data/spec/models/ip_sec_policy_update_spec.rb +76 -0
- data/spec/models/job_reference_spec.rb +40 -0
- data/spec/models/job_spec.rb +52 -0
- data/spec/models/jobs_spec.rb +34 -0
- data/spec/models/network_id_spec.rb +34 -0
- data/spec/models/network_ids_spec.rb +34 -0
- data/spec/models/operation_spec.rb +46 -0
- data/spec/models/options_spec.rb +34 -0
- data/spec/models/peer_subnet_update_spec.rb +34 -0
- data/spec/models/peer_subnets_spec.rb +34 -0
- data/spec/models/status_spec.rb +46 -0
- data/spec/models/storage_affinity_spec.rb +62 -0
- data/spec/models/vp_naa_s_options_spec.rb +58 -0
- data/spec/models/vpn_connection_create_response_spec.rb +114 -0
- data/spec/models/vpn_connection_create_spec.rb +74 -0
- data/spec/models/vpn_connection_spec.rb +108 -0
- data/spec/models/vpn_connection_update_spec.rb +52 -0
- data/spec/models/vpn_connections_spec.rb +34 -0
- data/spec/spec_helper.rb +1 -1
- metadata +259 -107
|
@@ -2,26 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**pcloud_pvminstances_action_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_action_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action | Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
|
8
|
-
[**pcloud_pvminstances_capture_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_capture_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture | Capture a PVM instance and create a deployable image
|
|
9
|
-
[**pcloud_pvminstances_clone_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/clone | Clone a PVMInstance
|
|
10
|
-
[**pcloud_pvminstances_console_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_console_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console | Generate the noVNC console URL
|
|
11
|
-
[**pcloud_pvminstances_delete**](PCloudPVMInstancesApi.md#pcloud_pvminstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Delete a PCloud PVM instance
|
|
12
|
-
[**pcloud_pvminstances_get**](PCloudPVMInstancesApi.md#pcloud_pvminstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Get a PVM instance's current state or information
|
|
13
|
-
[**pcloud_pvminstances_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Get all the PVM instances for this cloud instance
|
|
14
|
-
[**pcloud_pvminstances_networks_delete**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Remove all addresses of network from a PVM instance
|
|
15
|
-
[**pcloud_pvminstances_networks_get**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Get a PVM instance's network information
|
|
16
|
-
[**pcloud_pvminstances_networks_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Get all networks for this PVM instance
|
|
17
|
-
[**pcloud_pvminstances_networks_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Perform network addition, deletion, and listing
|
|
18
|
-
[**pcloud_pvminstances_operations_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_operations_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations | Perform an operation on a PVMInstance
|
|
19
|
-
[**pcloud_pvminstances_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Create a new PVM instance
|
|
20
|
-
[**pcloud_pvminstances_put**](PCloudPVMInstancesApi.md#pcloud_pvminstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Update a PCloud PVM instance
|
|
21
|
-
[**pcloud_pvminstances_snapshots_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Get all snapshots for this PVM instance
|
|
22
|
-
[**pcloud_pvminstances_snapshots_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Create a PVM instance snapshot
|
|
23
|
-
[**pcloud_pvminstances_snapshots_restore_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_restore_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore | Restore a PVM Instance snapshot
|
|
24
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**pcloud_pvminstances_action_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_action_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action | Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance |
|
|
8
|
+
| [**pcloud_pvminstances_capture_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_capture_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture | Capture a PVM instance and create a deployable image (version 1) |
|
|
9
|
+
| [**pcloud_pvminstances_clone_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/clone | Clone a PVMInstance |
|
|
10
|
+
| [**pcloud_pvminstances_console_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_console_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console | Generate the noVNC console URL |
|
|
11
|
+
| [**pcloud_pvminstances_delete**](PCloudPVMInstancesApi.md#pcloud_pvminstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Delete a PCloud PVM instance |
|
|
12
|
+
| [**pcloud_pvminstances_get**](PCloudPVMInstancesApi.md#pcloud_pvminstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Get a PVM instance's current state or information |
|
|
13
|
+
| [**pcloud_pvminstances_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Get all the PVM instances for this cloud instance |
|
|
14
|
+
| [**pcloud_pvminstances_networks_delete**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Remove all addresses of network from a PVM instance |
|
|
15
|
+
| [**pcloud_pvminstances_networks_get**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Get a PVM instance's network information |
|
|
16
|
+
| [**pcloud_pvminstances_networks_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Get all networks for this PVM instance |
|
|
17
|
+
| [**pcloud_pvminstances_networks_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Perform network addition, deletion, and listing |
|
|
18
|
+
| [**pcloud_pvminstances_operations_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_operations_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations | Perform an operation on a PVMInstance |
|
|
19
|
+
| [**pcloud_pvminstances_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Create a new PVM instance |
|
|
20
|
+
| [**pcloud_pvminstances_put**](PCloudPVMInstancesApi.md#pcloud_pvminstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Update a PCloud PVM instance |
|
|
21
|
+
| [**pcloud_pvminstances_snapshots_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Get all snapshots for this PVM instance |
|
|
22
|
+
| [**pcloud_pvminstances_snapshots_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Create a PVM instance snapshot |
|
|
23
|
+
| [**pcloud_pvminstances_snapshots_restore_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_restore_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore | Restore a PVM Instance snapshot |
|
|
24
|
+
| [**pcloud_v2_pvminstances_capture_get**](PCloudPVMInstancesApi.md#pcloud_v2_pvminstances_capture_get) | **GET** /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture | Get a PVM Instance’s last capture job details |
|
|
25
|
+
| [**pcloud_v2_pvminstances_capture_post**](PCloudPVMInstancesApi.md#pcloud_v2_pvminstances_capture_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture | Capture a PVM instance and create a deployable image (version 2) |
|
|
25
26
|
|
|
26
27
|
|
|
27
28
|
## pcloud_pvminstances_action_post
|
|
@@ -30,34 +31,51 @@ Method | HTTP request | Description
|
|
|
30
31
|
|
|
31
32
|
Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
|
32
33
|
|
|
33
|
-
###
|
|
34
|
+
### Examples
|
|
34
35
|
|
|
35
36
|
```ruby
|
|
36
|
-
|
|
37
|
+
require 'time'
|
|
37
38
|
require 'ibm_cloud_power'
|
|
38
39
|
|
|
39
40
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
40
41
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
41
42
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
42
|
-
body = IbmCloudPower::PVMInstanceAction.new # PVMInstanceAction | Parameters for the desired action
|
|
43
|
+
body = IbmCloudPower::PVMInstanceAction.new({action: 'start'}) # PVMInstanceAction | Parameters for the desired action
|
|
43
44
|
|
|
44
45
|
begin
|
|
45
|
-
#Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
|
46
|
+
# Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
|
46
47
|
result = api_instance.pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body)
|
|
47
48
|
p result
|
|
48
49
|
rescue IbmCloudPower::ApiError => e
|
|
49
|
-
puts "
|
|
50
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_action_post: #{e}"
|
|
50
51
|
end
|
|
51
52
|
```
|
|
52
53
|
|
|
53
|
-
|
|
54
|
+
#### Using the pcloud_pvminstances_action_post_with_http_info variant
|
|
55
|
+
|
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
|
57
|
+
|
|
58
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
59
|
+
|
|
60
|
+
```ruby
|
|
61
|
+
begin
|
|
62
|
+
# Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
|
63
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
64
|
+
p status_code # => 2xx
|
|
65
|
+
p headers # => { ... }
|
|
66
|
+
p data # => Object
|
|
67
|
+
rescue IbmCloudPower::ApiError => e
|
|
68
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_action_post_with_http_info: #{e}"
|
|
69
|
+
end
|
|
70
|
+
```
|
|
54
71
|
|
|
72
|
+
### Parameters
|
|
55
73
|
|
|
56
|
-
Name | Type | Description
|
|
57
|
-
|
|
58
|
-
**cloud_instance_id** | **String
|
|
59
|
-
**pvm_instance_id** | **String
|
|
60
|
-
**body** | [**PVMInstanceAction**](PVMInstanceAction.md)| Parameters for the desired action |
|
|
74
|
+
| Name | Type | Description | Notes |
|
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
|
76
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
77
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
78
|
+
| **body** | [**PVMInstanceAction**](PVMInstanceAction.md) | Parameters for the desired action | |
|
|
61
79
|
|
|
62
80
|
### Return type
|
|
63
81
|
|
|
@@ -77,36 +95,53 @@ No authorization required
|
|
|
77
95
|
|
|
78
96
|
> Object pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
|
79
97
|
|
|
80
|
-
Capture a PVM instance and create a deployable image
|
|
98
|
+
Capture a PVM instance and create a deployable image (version 1)
|
|
81
99
|
|
|
82
|
-
###
|
|
100
|
+
### Examples
|
|
83
101
|
|
|
84
102
|
```ruby
|
|
85
|
-
|
|
103
|
+
require 'time'
|
|
86
104
|
require 'ibm_cloud_power'
|
|
87
105
|
|
|
88
106
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
89
107
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
90
108
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
91
|
-
body = IbmCloudPower::PVMInstanceCapture.new # PVMInstanceCapture | Parameters for the capture PVMInstance
|
|
109
|
+
body = IbmCloudPower::PVMInstanceCapture.new({capture_name: 'capture_name_example', capture_destination: 'image-catalog'}) # PVMInstanceCapture | Parameters for the capture PVMInstance
|
|
92
110
|
|
|
93
111
|
begin
|
|
94
|
-
#Capture a PVM instance and create a deployable image
|
|
112
|
+
# Capture a PVM instance and create a deployable image (version 1)
|
|
95
113
|
result = api_instance.pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
|
96
114
|
p result
|
|
97
115
|
rescue IbmCloudPower::ApiError => e
|
|
98
|
-
puts "
|
|
116
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_capture_post: #{e}"
|
|
99
117
|
end
|
|
100
118
|
```
|
|
101
119
|
|
|
102
|
-
|
|
120
|
+
#### Using the pcloud_pvminstances_capture_post_with_http_info variant
|
|
121
|
+
|
|
122
|
+
This returns an Array which contains the response data, status code and headers.
|
|
123
|
+
|
|
124
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
125
|
+
|
|
126
|
+
```ruby
|
|
127
|
+
begin
|
|
128
|
+
# Capture a PVM instance and create a deployable image (version 1)
|
|
129
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
130
|
+
p status_code # => 2xx
|
|
131
|
+
p headers # => { ... }
|
|
132
|
+
p data # => Object
|
|
133
|
+
rescue IbmCloudPower::ApiError => e
|
|
134
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_capture_post_with_http_info: #{e}"
|
|
135
|
+
end
|
|
136
|
+
```
|
|
103
137
|
|
|
138
|
+
### Parameters
|
|
104
139
|
|
|
105
|
-
Name | Type | Description
|
|
106
|
-
|
|
107
|
-
**cloud_instance_id** | **String
|
|
108
|
-
**pvm_instance_id** | **String
|
|
109
|
-
**body** | [**PVMInstanceCapture**](PVMInstanceCapture.md)| Parameters for the capture PVMInstance |
|
|
140
|
+
| Name | Type | Description | Notes |
|
|
141
|
+
| ---- | ---- | ----------- | ----- |
|
|
142
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
143
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
144
|
+
| **body** | [**PVMInstanceCapture**](PVMInstanceCapture.md) | Parameters for the capture PVMInstance | |
|
|
110
145
|
|
|
111
146
|
### Return type
|
|
112
147
|
|
|
@@ -124,38 +159,55 @@ No authorization required
|
|
|
124
159
|
|
|
125
160
|
## pcloud_pvminstances_clone_post
|
|
126
161
|
|
|
127
|
-
> PVMInstance pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
|
162
|
+
> <PVMInstance> pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
|
128
163
|
|
|
129
164
|
Clone a PVMInstance
|
|
130
165
|
|
|
131
|
-
###
|
|
166
|
+
### Examples
|
|
132
167
|
|
|
133
168
|
```ruby
|
|
134
|
-
|
|
169
|
+
require 'time'
|
|
135
170
|
require 'ibm_cloud_power'
|
|
136
171
|
|
|
137
172
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
138
173
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
139
174
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
140
|
-
body = IbmCloudPower::PVMInstanceClone.new # PVMInstanceClone | Clone PVM Instance parameters
|
|
175
|
+
body = IbmCloudPower::PVMInstanceClone.new({name: 'name_example', networks: [IbmCloudPower::PVMInstanceAddNetwork.new({network_id: 'network_id_example'})]}) # PVMInstanceClone | Clone PVM Instance parameters
|
|
141
176
|
|
|
142
177
|
begin
|
|
143
|
-
#Clone a PVMInstance
|
|
178
|
+
# Clone a PVMInstance
|
|
144
179
|
result = api_instance.pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
|
145
180
|
p result
|
|
146
181
|
rescue IbmCloudPower::ApiError => e
|
|
147
|
-
puts "
|
|
182
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_clone_post: #{e}"
|
|
148
183
|
end
|
|
149
184
|
```
|
|
150
185
|
|
|
151
|
-
|
|
186
|
+
#### Using the pcloud_pvminstances_clone_post_with_http_info variant
|
|
187
|
+
|
|
188
|
+
This returns an Array which contains the response data, status code and headers.
|
|
189
|
+
|
|
190
|
+
> <Array(<PVMInstance>, Integer, Hash)> pcloud_pvminstances_clone_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
152
191
|
|
|
192
|
+
```ruby
|
|
193
|
+
begin
|
|
194
|
+
# Clone a PVMInstance
|
|
195
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_clone_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
196
|
+
p status_code # => 2xx
|
|
197
|
+
p headers # => { ... }
|
|
198
|
+
p data # => <PVMInstance>
|
|
199
|
+
rescue IbmCloudPower::ApiError => e
|
|
200
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_clone_post_with_http_info: #{e}"
|
|
201
|
+
end
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
153
205
|
|
|
154
|
-
Name | Type | Description
|
|
155
|
-
|
|
156
|
-
**cloud_instance_id** | **String
|
|
157
|
-
**pvm_instance_id** | **String
|
|
158
|
-
**body** | [**PVMInstanceClone**](PVMInstanceClone.md)| Clone PVM Instance parameters |
|
|
206
|
+
| Name | Type | Description | Notes |
|
|
207
|
+
| ---- | ---- | ----------- | ----- |
|
|
208
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
209
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
210
|
+
| **body** | [**PVMInstanceClone**](PVMInstanceClone.md) | Clone PVM Instance parameters | |
|
|
159
211
|
|
|
160
212
|
### Return type
|
|
161
213
|
|
|
@@ -173,14 +225,14 @@ No authorization required
|
|
|
173
225
|
|
|
174
226
|
## pcloud_pvminstances_console_post
|
|
175
227
|
|
|
176
|
-
> PVMInstanceConsole pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
|
228
|
+
> <PVMInstanceConsole> pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
|
177
229
|
|
|
178
230
|
Generate the noVNC console URL
|
|
179
231
|
|
|
180
|
-
###
|
|
232
|
+
### Examples
|
|
181
233
|
|
|
182
234
|
```ruby
|
|
183
|
-
|
|
235
|
+
require 'time'
|
|
184
236
|
require 'ibm_cloud_power'
|
|
185
237
|
|
|
186
238
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -188,21 +240,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
|
188
240
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
189
241
|
|
|
190
242
|
begin
|
|
191
|
-
#Generate the noVNC console URL
|
|
243
|
+
# Generate the noVNC console URL
|
|
192
244
|
result = api_instance.pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
|
193
245
|
p result
|
|
194
246
|
rescue IbmCloudPower::ApiError => e
|
|
195
|
-
puts "
|
|
247
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_post: #{e}"
|
|
196
248
|
end
|
|
197
249
|
```
|
|
198
250
|
|
|
199
|
-
|
|
251
|
+
#### Using the pcloud_pvminstances_console_post_with_http_info variant
|
|
200
252
|
|
|
253
|
+
This returns an Array which contains the response data, status code and headers.
|
|
201
254
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
255
|
+
> <Array(<PVMInstanceConsole>, Integer, Hash)> pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
begin
|
|
259
|
+
# Generate the noVNC console URL
|
|
260
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
261
|
+
p status_code # => 2xx
|
|
262
|
+
p headers # => { ... }
|
|
263
|
+
p data # => <PVMInstanceConsole>
|
|
264
|
+
rescue IbmCloudPower::ApiError => e
|
|
265
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_post_with_http_info: #{e}"
|
|
266
|
+
end
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Parameters
|
|
270
|
+
|
|
271
|
+
| Name | Type | Description | Notes |
|
|
272
|
+
| ---- | ---- | ----------- | ----- |
|
|
273
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
274
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
206
275
|
|
|
207
276
|
### Return type
|
|
208
277
|
|
|
@@ -224,10 +293,10 @@ No authorization required
|
|
|
224
293
|
|
|
225
294
|
Delete a PCloud PVM instance
|
|
226
295
|
|
|
227
|
-
###
|
|
296
|
+
### Examples
|
|
228
297
|
|
|
229
298
|
```ruby
|
|
230
|
-
|
|
299
|
+
require 'time'
|
|
231
300
|
require 'ibm_cloud_power'
|
|
232
301
|
|
|
233
302
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -238,22 +307,39 @@ opts = {
|
|
|
238
307
|
}
|
|
239
308
|
|
|
240
309
|
begin
|
|
241
|
-
#Delete a PCloud PVM instance
|
|
310
|
+
# Delete a PCloud PVM instance
|
|
242
311
|
result = api_instance.pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts)
|
|
243
312
|
p result
|
|
244
313
|
rescue IbmCloudPower::ApiError => e
|
|
245
|
-
puts "
|
|
314
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete: #{e}"
|
|
246
315
|
end
|
|
247
316
|
```
|
|
248
317
|
|
|
249
|
-
|
|
318
|
+
#### Using the pcloud_pvminstances_delete_with_http_info variant
|
|
319
|
+
|
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
|
321
|
+
|
|
322
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
|
|
323
|
+
|
|
324
|
+
```ruby
|
|
325
|
+
begin
|
|
326
|
+
# Delete a PCloud PVM instance
|
|
327
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
|
|
328
|
+
p status_code # => 2xx
|
|
329
|
+
p headers # => { ... }
|
|
330
|
+
p data # => Object
|
|
331
|
+
rescue IbmCloudPower::ApiError => e
|
|
332
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete_with_http_info: #{e}"
|
|
333
|
+
end
|
|
334
|
+
```
|
|
250
335
|
|
|
336
|
+
### Parameters
|
|
251
337
|
|
|
252
|
-
Name | Type | Description
|
|
253
|
-
|
|
254
|
-
**cloud_instance_id** | **String
|
|
255
|
-
**pvm_instance_id** | **String
|
|
256
|
-
**delete_data_volumes** | **Boolean
|
|
338
|
+
| Name | Type | Description | Notes |
|
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
|
340
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
341
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
342
|
+
| **delete_data_volumes** | **Boolean** | Indicates whether all data volumes attached to the PVMInstance must be deleted when deleting the PVMInstance. Shared data volumes will be deleted if no other PVMInstances are attached. | [optional] |
|
|
257
343
|
|
|
258
344
|
### Return type
|
|
259
345
|
|
|
@@ -271,14 +357,14 @@ No authorization required
|
|
|
271
357
|
|
|
272
358
|
## pcloud_pvminstances_get
|
|
273
359
|
|
|
274
|
-
> PVMInstance pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
|
360
|
+
> <PVMInstance> pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
|
275
361
|
|
|
276
362
|
Get a PVM instance's current state or information
|
|
277
363
|
|
|
278
|
-
###
|
|
364
|
+
### Examples
|
|
279
365
|
|
|
280
366
|
```ruby
|
|
281
|
-
|
|
367
|
+
require 'time'
|
|
282
368
|
require 'ibm_cloud_power'
|
|
283
369
|
|
|
284
370
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -286,21 +372,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
|
286
372
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
287
373
|
|
|
288
374
|
begin
|
|
289
|
-
#Get a PVM instance's current state or information
|
|
375
|
+
# Get a PVM instance's current state or information
|
|
290
376
|
result = api_instance.pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
|
291
377
|
p result
|
|
292
378
|
rescue IbmCloudPower::ApiError => e
|
|
293
|
-
puts "
|
|
379
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_get: #{e}"
|
|
294
380
|
end
|
|
295
381
|
```
|
|
296
382
|
|
|
297
|
-
|
|
383
|
+
#### Using the pcloud_pvminstances_get_with_http_info variant
|
|
384
|
+
|
|
385
|
+
This returns an Array which contains the response data, status code and headers.
|
|
386
|
+
|
|
387
|
+
> <Array(<PVMInstance>, Integer, Hash)> pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
388
|
+
|
|
389
|
+
```ruby
|
|
390
|
+
begin
|
|
391
|
+
# Get a PVM instance's current state or information
|
|
392
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
393
|
+
p status_code # => 2xx
|
|
394
|
+
p headers # => { ... }
|
|
395
|
+
p data # => <PVMInstance>
|
|
396
|
+
rescue IbmCloudPower::ApiError => e
|
|
397
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_get_with_http_info: #{e}"
|
|
398
|
+
end
|
|
399
|
+
```
|
|
298
400
|
|
|
401
|
+
### Parameters
|
|
299
402
|
|
|
300
|
-
Name | Type | Description
|
|
301
|
-
|
|
302
|
-
**cloud_instance_id** | **String
|
|
303
|
-
**pvm_instance_id** | **String
|
|
403
|
+
| Name | Type | Description | Notes |
|
|
404
|
+
| ---- | ---- | ----------- | ----- |
|
|
405
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
406
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
304
407
|
|
|
305
408
|
### Return type
|
|
306
409
|
|
|
@@ -318,34 +421,51 @@ No authorization required
|
|
|
318
421
|
|
|
319
422
|
## pcloud_pvminstances_getall
|
|
320
423
|
|
|
321
|
-
> PVMInstances pcloud_pvminstances_getall(cloud_instance_id)
|
|
424
|
+
> <PVMInstances> pcloud_pvminstances_getall(cloud_instance_id)
|
|
322
425
|
|
|
323
426
|
Get all the PVM instances for this cloud instance
|
|
324
427
|
|
|
325
|
-
###
|
|
428
|
+
### Examples
|
|
326
429
|
|
|
327
430
|
```ruby
|
|
328
|
-
|
|
431
|
+
require 'time'
|
|
329
432
|
require 'ibm_cloud_power'
|
|
330
433
|
|
|
331
434
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
332
435
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
333
436
|
|
|
334
437
|
begin
|
|
335
|
-
#Get all the PVM instances for this cloud instance
|
|
438
|
+
# Get all the PVM instances for this cloud instance
|
|
336
439
|
result = api_instance.pcloud_pvminstances_getall(cloud_instance_id)
|
|
337
440
|
p result
|
|
338
441
|
rescue IbmCloudPower::ApiError => e
|
|
339
|
-
puts "
|
|
442
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_getall: #{e}"
|
|
340
443
|
end
|
|
341
444
|
```
|
|
342
445
|
|
|
343
|
-
|
|
446
|
+
#### Using the pcloud_pvminstances_getall_with_http_info variant
|
|
447
|
+
|
|
448
|
+
This returns an Array which contains the response data, status code and headers.
|
|
449
|
+
|
|
450
|
+
> <Array(<PVMInstances>, Integer, Hash)> pcloud_pvminstances_getall_with_http_info(cloud_instance_id)
|
|
344
451
|
|
|
452
|
+
```ruby
|
|
453
|
+
begin
|
|
454
|
+
# Get all the PVM instances for this cloud instance
|
|
455
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_getall_with_http_info(cloud_instance_id)
|
|
456
|
+
p status_code # => 2xx
|
|
457
|
+
p headers # => { ... }
|
|
458
|
+
p data # => <PVMInstances>
|
|
459
|
+
rescue IbmCloudPower::ApiError => e
|
|
460
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_getall_with_http_info: #{e}"
|
|
461
|
+
end
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
### Parameters
|
|
345
465
|
|
|
346
|
-
Name | Type | Description
|
|
347
|
-
|
|
348
|
-
**cloud_instance_id** | **String
|
|
466
|
+
| Name | Type | Description | Notes |
|
|
467
|
+
| ---- | ---- | ----------- | ----- |
|
|
468
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
349
469
|
|
|
350
470
|
### Return type
|
|
351
471
|
|
|
@@ -367,10 +487,10 @@ No authorization required
|
|
|
367
487
|
|
|
368
488
|
Remove all addresses of network from a PVM instance
|
|
369
489
|
|
|
370
|
-
###
|
|
490
|
+
### Examples
|
|
371
491
|
|
|
372
492
|
```ruby
|
|
373
|
-
|
|
493
|
+
require 'time'
|
|
374
494
|
require 'ibm_cloud_power'
|
|
375
495
|
|
|
376
496
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -382,23 +502,40 @@ opts = {
|
|
|
382
502
|
}
|
|
383
503
|
|
|
384
504
|
begin
|
|
385
|
-
#Remove all addresses of network from a PVM instance
|
|
505
|
+
# Remove all addresses of network from a PVM instance
|
|
386
506
|
result = api_instance.pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts)
|
|
387
507
|
p result
|
|
388
508
|
rescue IbmCloudPower::ApiError => e
|
|
389
|
-
puts "
|
|
509
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_delete: #{e}"
|
|
390
510
|
end
|
|
391
511
|
```
|
|
392
512
|
|
|
393
|
-
|
|
513
|
+
#### Using the pcloud_pvminstances_networks_delete_with_http_info variant
|
|
514
|
+
|
|
515
|
+
This returns an Array which contains the response data, status code and headers.
|
|
516
|
+
|
|
517
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
|
|
518
|
+
|
|
519
|
+
```ruby
|
|
520
|
+
begin
|
|
521
|
+
# Remove all addresses of network from a PVM instance
|
|
522
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
|
|
523
|
+
p status_code # => 2xx
|
|
524
|
+
p headers # => { ... }
|
|
525
|
+
p data # => Object
|
|
526
|
+
rescue IbmCloudPower::ApiError => e
|
|
527
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_delete_with_http_info: #{e}"
|
|
528
|
+
end
|
|
529
|
+
```
|
|
394
530
|
|
|
531
|
+
### Parameters
|
|
395
532
|
|
|
396
|
-
Name | Type | Description
|
|
397
|
-
|
|
398
|
-
**cloud_instance_id** | **String
|
|
399
|
-
**pvm_instance_id** | **String
|
|
400
|
-
**network_id** | **String
|
|
401
|
-
**body** | [**PVMInstanceRemoveNetwork**](PVMInstanceRemoveNetwork.md)| Remove a network from PVM Instance parameters | [optional]
|
|
533
|
+
| Name | Type | Description | Notes |
|
|
534
|
+
| ---- | ---- | ----------- | ----- |
|
|
535
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
536
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
537
|
+
| **network_id** | **String** | Network ID | |
|
|
538
|
+
| **body** | [**PVMInstanceRemoveNetwork**](PVMInstanceRemoveNetwork.md) | Remove a network from PVM Instance parameters | [optional] |
|
|
402
539
|
|
|
403
540
|
### Return type
|
|
404
541
|
|
|
@@ -416,14 +553,14 @@ No authorization required
|
|
|
416
553
|
|
|
417
554
|
## pcloud_pvminstances_networks_get
|
|
418
555
|
|
|
419
|
-
> PVMInstanceNetworks pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
|
556
|
+
> <PVMInstanceNetworks> pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
|
420
557
|
|
|
421
558
|
Get a PVM instance's network information
|
|
422
559
|
|
|
423
|
-
###
|
|
560
|
+
### Examples
|
|
424
561
|
|
|
425
562
|
```ruby
|
|
426
|
-
|
|
563
|
+
require 'time'
|
|
427
564
|
require 'ibm_cloud_power'
|
|
428
565
|
|
|
429
566
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -432,22 +569,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
|
432
569
|
network_id = 'network_id_example' # String | Network ID
|
|
433
570
|
|
|
434
571
|
begin
|
|
435
|
-
#Get a PVM instance's network information
|
|
572
|
+
# Get a PVM instance's network information
|
|
436
573
|
result = api_instance.pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
|
437
574
|
p result
|
|
438
575
|
rescue IbmCloudPower::ApiError => e
|
|
439
|
-
puts "
|
|
576
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_get: #{e}"
|
|
440
577
|
end
|
|
441
578
|
```
|
|
442
579
|
|
|
443
|
-
|
|
580
|
+
#### Using the pcloud_pvminstances_networks_get_with_http_info variant
|
|
581
|
+
|
|
582
|
+
This returns an Array which contains the response data, status code and headers.
|
|
583
|
+
|
|
584
|
+
> <Array(<PVMInstanceNetworks>, Integer, Hash)> pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id)
|
|
585
|
+
|
|
586
|
+
```ruby
|
|
587
|
+
begin
|
|
588
|
+
# Get a PVM instance's network information
|
|
589
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id)
|
|
590
|
+
p status_code # => 2xx
|
|
591
|
+
p headers # => { ... }
|
|
592
|
+
p data # => <PVMInstanceNetworks>
|
|
593
|
+
rescue IbmCloudPower::ApiError => e
|
|
594
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_get_with_http_info: #{e}"
|
|
595
|
+
end
|
|
596
|
+
```
|
|
444
597
|
|
|
598
|
+
### Parameters
|
|
445
599
|
|
|
446
|
-
Name | Type | Description
|
|
447
|
-
|
|
448
|
-
**cloud_instance_id** | **String
|
|
449
|
-
**pvm_instance_id** | **String
|
|
450
|
-
**network_id** | **String
|
|
600
|
+
| Name | Type | Description | Notes |
|
|
601
|
+
| ---- | ---- | ----------- | ----- |
|
|
602
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
603
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
604
|
+
| **network_id** | **String** | Network ID | |
|
|
451
605
|
|
|
452
606
|
### Return type
|
|
453
607
|
|
|
@@ -465,14 +619,14 @@ No authorization required
|
|
|
465
619
|
|
|
466
620
|
## pcloud_pvminstances_networks_getall
|
|
467
621
|
|
|
468
|
-
> PVMInstanceNetworks pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
|
622
|
+
> <PVMInstanceNetworks> pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
|
469
623
|
|
|
470
624
|
Get all networks for this PVM instance
|
|
471
625
|
|
|
472
|
-
###
|
|
626
|
+
### Examples
|
|
473
627
|
|
|
474
628
|
```ruby
|
|
475
|
-
|
|
629
|
+
require 'time'
|
|
476
630
|
require 'ibm_cloud_power'
|
|
477
631
|
|
|
478
632
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -480,21 +634,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
|
480
634
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
481
635
|
|
|
482
636
|
begin
|
|
483
|
-
#Get all networks for this PVM instance
|
|
637
|
+
# Get all networks for this PVM instance
|
|
484
638
|
result = api_instance.pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
|
485
639
|
p result
|
|
486
640
|
rescue IbmCloudPower::ApiError => e
|
|
487
|
-
puts "
|
|
641
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_getall: #{e}"
|
|
488
642
|
end
|
|
489
643
|
```
|
|
490
644
|
|
|
491
|
-
|
|
645
|
+
#### Using the pcloud_pvminstances_networks_getall_with_http_info variant
|
|
646
|
+
|
|
647
|
+
This returns an Array which contains the response data, status code and headers.
|
|
648
|
+
|
|
649
|
+
> <Array(<PVMInstanceNetworks>, Integer, Hash)> pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
650
|
+
|
|
651
|
+
```ruby
|
|
652
|
+
begin
|
|
653
|
+
# Get all networks for this PVM instance
|
|
654
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
655
|
+
p status_code # => 2xx
|
|
656
|
+
p headers # => { ... }
|
|
657
|
+
p data # => <PVMInstanceNetworks>
|
|
658
|
+
rescue IbmCloudPower::ApiError => e
|
|
659
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_getall_with_http_info: #{e}"
|
|
660
|
+
end
|
|
661
|
+
```
|
|
492
662
|
|
|
663
|
+
### Parameters
|
|
493
664
|
|
|
494
|
-
Name | Type | Description
|
|
495
|
-
|
|
496
|
-
**cloud_instance_id** | **String
|
|
497
|
-
**pvm_instance_id** | **String
|
|
665
|
+
| Name | Type | Description | Notes |
|
|
666
|
+
| ---- | ---- | ----------- | ----- |
|
|
667
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
668
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
498
669
|
|
|
499
670
|
### Return type
|
|
500
671
|
|
|
@@ -512,38 +683,55 @@ No authorization required
|
|
|
512
683
|
|
|
513
684
|
## pcloud_pvminstances_networks_post
|
|
514
685
|
|
|
515
|
-
> PVMInstanceNetwork pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
|
686
|
+
> <PVMInstanceNetwork> pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
|
516
687
|
|
|
517
688
|
Perform network addition, deletion, and listing
|
|
518
689
|
|
|
519
|
-
###
|
|
690
|
+
### Examples
|
|
520
691
|
|
|
521
692
|
```ruby
|
|
522
|
-
|
|
693
|
+
require 'time'
|
|
523
694
|
require 'ibm_cloud_power'
|
|
524
695
|
|
|
525
696
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
526
697
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
527
698
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
528
|
-
body = IbmCloudPower::PVMInstanceAddNetwork.new # PVMInstanceAddNetwork | Add network to PVM Instance parameters
|
|
699
|
+
body = IbmCloudPower::PVMInstanceAddNetwork.new({network_id: 'network_id_example'}) # PVMInstanceAddNetwork | Add network to PVM Instance parameters
|
|
529
700
|
|
|
530
701
|
begin
|
|
531
|
-
#Perform network addition, deletion, and listing
|
|
702
|
+
# Perform network addition, deletion, and listing
|
|
532
703
|
result = api_instance.pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
|
533
704
|
p result
|
|
534
705
|
rescue IbmCloudPower::ApiError => e
|
|
535
|
-
puts "
|
|
706
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_post: #{e}"
|
|
536
707
|
end
|
|
537
708
|
```
|
|
538
709
|
|
|
539
|
-
|
|
710
|
+
#### Using the pcloud_pvminstances_networks_post_with_http_info variant
|
|
711
|
+
|
|
712
|
+
This returns an Array which contains the response data, status code and headers.
|
|
713
|
+
|
|
714
|
+
> <Array(<PVMInstanceNetwork>, Integer, Hash)> pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
540
715
|
|
|
716
|
+
```ruby
|
|
717
|
+
begin
|
|
718
|
+
# Perform network addition, deletion, and listing
|
|
719
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
720
|
+
p status_code # => 2xx
|
|
721
|
+
p headers # => { ... }
|
|
722
|
+
p data # => <PVMInstanceNetwork>
|
|
723
|
+
rescue IbmCloudPower::ApiError => e
|
|
724
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_post_with_http_info: #{e}"
|
|
725
|
+
end
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
### Parameters
|
|
541
729
|
|
|
542
|
-
Name | Type | Description
|
|
543
|
-
|
|
544
|
-
**cloud_instance_id** | **String
|
|
545
|
-
**pvm_instance_id** | **String
|
|
546
|
-
**body** | [**PVMInstanceAddNetwork**](PVMInstanceAddNetwork.md)| Add network to PVM Instance parameters |
|
|
730
|
+
| Name | Type | Description | Notes |
|
|
731
|
+
| ---- | ---- | ----------- | ----- |
|
|
732
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
733
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
734
|
+
| **body** | [**PVMInstanceAddNetwork**](PVMInstanceAddNetwork.md) | Add network to PVM Instance parameters | |
|
|
547
735
|
|
|
548
736
|
### Return type
|
|
549
737
|
|
|
@@ -565,34 +753,51 @@ No authorization required
|
|
|
565
753
|
|
|
566
754
|
Perform an operation on a PVMInstance
|
|
567
755
|
|
|
568
|
-
###
|
|
756
|
+
### Examples
|
|
569
757
|
|
|
570
758
|
```ruby
|
|
571
|
-
|
|
759
|
+
require 'time'
|
|
572
760
|
require 'ibm_cloud_power'
|
|
573
761
|
|
|
574
762
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
575
763
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
576
764
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
577
|
-
body = IbmCloudPower::PVMInstanceOperation.new # PVMInstanceOperation | Parameters for the desired operations
|
|
765
|
+
body = IbmCloudPower::PVMInstanceOperation.new({operation_type: 'job', operation: IbmCloudPower::Operations.new}) # PVMInstanceOperation | Parameters for the desired operations
|
|
578
766
|
|
|
579
767
|
begin
|
|
580
|
-
#Perform an operation on a PVMInstance
|
|
768
|
+
# Perform an operation on a PVMInstance
|
|
581
769
|
result = api_instance.pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body)
|
|
582
770
|
p result
|
|
583
771
|
rescue IbmCloudPower::ApiError => e
|
|
584
|
-
puts "
|
|
772
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_operations_post: #{e}"
|
|
585
773
|
end
|
|
586
774
|
```
|
|
587
775
|
|
|
588
|
-
|
|
776
|
+
#### Using the pcloud_pvminstances_operations_post_with_http_info variant
|
|
589
777
|
|
|
778
|
+
This returns an Array which contains the response data, status code and headers.
|
|
590
779
|
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
780
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
781
|
+
|
|
782
|
+
```ruby
|
|
783
|
+
begin
|
|
784
|
+
# Perform an operation on a PVMInstance
|
|
785
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
786
|
+
p status_code # => 2xx
|
|
787
|
+
p headers # => { ... }
|
|
788
|
+
p data # => Object
|
|
789
|
+
rescue IbmCloudPower::ApiError => e
|
|
790
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_operations_post_with_http_info: #{e}"
|
|
791
|
+
end
|
|
792
|
+
```
|
|
793
|
+
|
|
794
|
+
### Parameters
|
|
795
|
+
|
|
796
|
+
| Name | Type | Description | Notes |
|
|
797
|
+
| ---- | ---- | ----------- | ----- |
|
|
798
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
799
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
800
|
+
| **body** | [**PVMInstanceOperation**](PVMInstanceOperation.md) | Parameters for the desired operations | |
|
|
596
801
|
|
|
597
802
|
### Return type
|
|
598
803
|
|
|
@@ -610,42 +815,59 @@ No authorization required
|
|
|
610
815
|
|
|
611
816
|
## pcloud_pvminstances_post
|
|
612
817
|
|
|
613
|
-
> Array
|
|
818
|
+
> <Array<PVMInstance>> pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
|
614
819
|
|
|
615
820
|
Create a new PVM instance
|
|
616
821
|
|
|
617
822
|
The order of network IDs passed in will be the order of interfaces defined to the VM.
|
|
618
823
|
|
|
619
|
-
###
|
|
824
|
+
### Examples
|
|
620
825
|
|
|
621
826
|
```ruby
|
|
622
|
-
|
|
827
|
+
require 'time'
|
|
623
828
|
require 'ibm_cloud_power'
|
|
624
829
|
|
|
625
830
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
626
831
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
627
|
-
body = IbmCloudPower::PVMInstanceCreate.new # PVMInstanceCreate | Parameters for the creation of a new tenant
|
|
832
|
+
body = IbmCloudPower::PVMInstanceCreate.new({server_name: 'server_name_example', image_id: 'image_id_example', processors: 3.56, proc_type: 'dedicated', memory: 3.56}) # PVMInstanceCreate | Parameters for the creation of a new tenant
|
|
628
833
|
opts = {
|
|
629
834
|
skip_host_validation: true # Boolean | Option to skip host validation on PVMInstance Create API
|
|
630
835
|
}
|
|
631
836
|
|
|
632
837
|
begin
|
|
633
|
-
#Create a new PVM instance
|
|
838
|
+
# Create a new PVM instance
|
|
634
839
|
result = api_instance.pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
|
635
840
|
p result
|
|
636
841
|
rescue IbmCloudPower::ApiError => e
|
|
637
|
-
puts "
|
|
842
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_post: #{e}"
|
|
638
843
|
end
|
|
639
844
|
```
|
|
640
845
|
|
|
641
|
-
|
|
846
|
+
#### Using the pcloud_pvminstances_post_with_http_info variant
|
|
642
847
|
|
|
848
|
+
This returns an Array which contains the response data, status code and headers.
|
|
643
849
|
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
850
|
+
> <Array(<Array<PVMInstance>>, Integer, Hash)> pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts)
|
|
851
|
+
|
|
852
|
+
```ruby
|
|
853
|
+
begin
|
|
854
|
+
# Create a new PVM instance
|
|
855
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts)
|
|
856
|
+
p status_code # => 2xx
|
|
857
|
+
p headers # => { ... }
|
|
858
|
+
p data # => <Array<PVMInstance>>
|
|
859
|
+
rescue IbmCloudPower::ApiError => e
|
|
860
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_post_with_http_info: #{e}"
|
|
861
|
+
end
|
|
862
|
+
```
|
|
863
|
+
|
|
864
|
+
### Parameters
|
|
865
|
+
|
|
866
|
+
| Name | Type | Description | Notes |
|
|
867
|
+
| ---- | ---- | ----------- | ----- |
|
|
868
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
869
|
+
| **body** | [**PVMInstanceCreate**](PVMInstanceCreate.md) | Parameters for the creation of a new tenant | |
|
|
870
|
+
| **skip_host_validation** | **Boolean** | Option to skip host validation on PVMInstance Create API | [optional] |
|
|
649
871
|
|
|
650
872
|
### Return type
|
|
651
873
|
|
|
@@ -663,14 +885,14 @@ No authorization required
|
|
|
663
885
|
|
|
664
886
|
## pcloud_pvminstances_put
|
|
665
887
|
|
|
666
|
-
> PVMInstanceUpdateResponse pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
|
888
|
+
> <PVMInstanceUpdateResponse> pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
|
667
889
|
|
|
668
890
|
Update a PCloud PVM instance
|
|
669
891
|
|
|
670
|
-
###
|
|
892
|
+
### Examples
|
|
671
893
|
|
|
672
894
|
```ruby
|
|
673
|
-
|
|
895
|
+
require 'time'
|
|
674
896
|
require 'ibm_cloud_power'
|
|
675
897
|
|
|
676
898
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -679,22 +901,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
|
679
901
|
body = IbmCloudPower::PVMInstanceUpdate.new # PVMInstanceUpdate | Parameters to update a PCloud PVM instance
|
|
680
902
|
|
|
681
903
|
begin
|
|
682
|
-
#Update a PCloud PVM instance
|
|
904
|
+
# Update a PCloud PVM instance
|
|
683
905
|
result = api_instance.pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
|
684
906
|
p result
|
|
685
907
|
rescue IbmCloudPower::ApiError => e
|
|
686
|
-
puts "
|
|
908
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_put: #{e}"
|
|
687
909
|
end
|
|
688
910
|
```
|
|
689
911
|
|
|
690
|
-
|
|
912
|
+
#### Using the pcloud_pvminstances_put_with_http_info variant
|
|
913
|
+
|
|
914
|
+
This returns an Array which contains the response data, status code and headers.
|
|
915
|
+
|
|
916
|
+
> <Array(<PVMInstanceUpdateResponse>, Integer, Hash)> pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
917
|
+
|
|
918
|
+
```ruby
|
|
919
|
+
begin
|
|
920
|
+
# Update a PCloud PVM instance
|
|
921
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
922
|
+
p status_code # => 2xx
|
|
923
|
+
p headers # => { ... }
|
|
924
|
+
p data # => <PVMInstanceUpdateResponse>
|
|
925
|
+
rescue IbmCloudPower::ApiError => e
|
|
926
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_put_with_http_info: #{e}"
|
|
927
|
+
end
|
|
928
|
+
```
|
|
691
929
|
|
|
930
|
+
### Parameters
|
|
692
931
|
|
|
693
|
-
Name | Type | Description
|
|
694
|
-
|
|
695
|
-
**cloud_instance_id** | **String
|
|
696
|
-
**pvm_instance_id** | **String
|
|
697
|
-
**body** | [**PVMInstanceUpdate**](PVMInstanceUpdate.md)| Parameters to update a PCloud PVM instance |
|
|
932
|
+
| Name | Type | Description | Notes |
|
|
933
|
+
| ---- | ---- | ----------- | ----- |
|
|
934
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
935
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
936
|
+
| **body** | [**PVMInstanceUpdate**](PVMInstanceUpdate.md) | Parameters to update a PCloud PVM instance | |
|
|
698
937
|
|
|
699
938
|
### Return type
|
|
700
939
|
|
|
@@ -712,14 +951,14 @@ No authorization required
|
|
|
712
951
|
|
|
713
952
|
## pcloud_pvminstances_snapshots_getall
|
|
714
953
|
|
|
715
|
-
> Snapshots pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
|
954
|
+
> <Snapshots> pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
|
716
955
|
|
|
717
956
|
Get all snapshots for this PVM instance
|
|
718
957
|
|
|
719
|
-
###
|
|
958
|
+
### Examples
|
|
720
959
|
|
|
721
960
|
```ruby
|
|
722
|
-
|
|
961
|
+
require 'time'
|
|
723
962
|
require 'ibm_cloud_power'
|
|
724
963
|
|
|
725
964
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -727,21 +966,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
|
727
966
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
728
967
|
|
|
729
968
|
begin
|
|
730
|
-
#Get all snapshots for this PVM instance
|
|
969
|
+
# Get all snapshots for this PVM instance
|
|
731
970
|
result = api_instance.pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
|
732
971
|
p result
|
|
733
972
|
rescue IbmCloudPower::ApiError => e
|
|
734
|
-
puts "
|
|
973
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_getall: #{e}"
|
|
735
974
|
end
|
|
736
975
|
```
|
|
737
976
|
|
|
738
|
-
|
|
977
|
+
#### Using the pcloud_pvminstances_snapshots_getall_with_http_info variant
|
|
978
|
+
|
|
979
|
+
This returns an Array which contains the response data, status code and headers.
|
|
980
|
+
|
|
981
|
+
> <Array(<Snapshots>, Integer, Hash)> pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
739
982
|
|
|
983
|
+
```ruby
|
|
984
|
+
begin
|
|
985
|
+
# Get all snapshots for this PVM instance
|
|
986
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
987
|
+
p status_code # => 2xx
|
|
988
|
+
p headers # => { ... }
|
|
989
|
+
p data # => <Snapshots>
|
|
990
|
+
rescue IbmCloudPower::ApiError => e
|
|
991
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_getall_with_http_info: #{e}"
|
|
992
|
+
end
|
|
993
|
+
```
|
|
994
|
+
|
|
995
|
+
### Parameters
|
|
740
996
|
|
|
741
|
-
Name | Type | Description
|
|
742
|
-
|
|
743
|
-
**cloud_instance_id** | **String
|
|
744
|
-
**pvm_instance_id** | **String
|
|
997
|
+
| Name | Type | Description | Notes |
|
|
998
|
+
| ---- | ---- | ----------- | ----- |
|
|
999
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
1000
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
745
1001
|
|
|
746
1002
|
### Return type
|
|
747
1003
|
|
|
@@ -759,38 +1015,55 @@ No authorization required
|
|
|
759
1015
|
|
|
760
1016
|
## pcloud_pvminstances_snapshots_post
|
|
761
1017
|
|
|
762
|
-
> SnapshotCreateResponse pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
|
1018
|
+
> <SnapshotCreateResponse> pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
|
763
1019
|
|
|
764
1020
|
Create a PVM instance snapshot
|
|
765
1021
|
|
|
766
|
-
###
|
|
1022
|
+
### Examples
|
|
767
1023
|
|
|
768
1024
|
```ruby
|
|
769
|
-
|
|
1025
|
+
require 'time'
|
|
770
1026
|
require 'ibm_cloud_power'
|
|
771
1027
|
|
|
772
1028
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
773
1029
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
774
1030
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
775
|
-
body = IbmCloudPower::SnapshotCreate.new # SnapshotCreate | PVM Instance snapshot create parameters
|
|
1031
|
+
body = IbmCloudPower::SnapshotCreate.new({name: 'name_example'}) # SnapshotCreate | PVM Instance snapshot create parameters
|
|
776
1032
|
|
|
777
1033
|
begin
|
|
778
|
-
#Create a PVM instance snapshot
|
|
1034
|
+
# Create a PVM instance snapshot
|
|
779
1035
|
result = api_instance.pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
|
780
1036
|
p result
|
|
781
1037
|
rescue IbmCloudPower::ApiError => e
|
|
782
|
-
puts "
|
|
1038
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_post: #{e}"
|
|
783
1039
|
end
|
|
784
1040
|
```
|
|
785
1041
|
|
|
786
|
-
|
|
1042
|
+
#### Using the pcloud_pvminstances_snapshots_post_with_http_info variant
|
|
1043
|
+
|
|
1044
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1045
|
+
|
|
1046
|
+
> <Array(<SnapshotCreateResponse>, Integer, Hash)> pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
1047
|
+
|
|
1048
|
+
```ruby
|
|
1049
|
+
begin
|
|
1050
|
+
# Create a PVM instance snapshot
|
|
1051
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
1052
|
+
p status_code # => 2xx
|
|
1053
|
+
p headers # => { ... }
|
|
1054
|
+
p data # => <SnapshotCreateResponse>
|
|
1055
|
+
rescue IbmCloudPower::ApiError => e
|
|
1056
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_post_with_http_info: #{e}"
|
|
1057
|
+
end
|
|
1058
|
+
```
|
|
787
1059
|
|
|
1060
|
+
### Parameters
|
|
788
1061
|
|
|
789
|
-
Name | Type | Description
|
|
790
|
-
|
|
791
|
-
**cloud_instance_id** | **String
|
|
792
|
-
**pvm_instance_id** | **String
|
|
793
|
-
**body** | [**SnapshotCreate**](SnapshotCreate.md)| PVM Instance snapshot create parameters |
|
|
1062
|
+
| Name | Type | Description | Notes |
|
|
1063
|
+
| ---- | ---- | ----------- | ----- |
|
|
1064
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
1065
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
1066
|
+
| **body** | [**SnapshotCreate**](SnapshotCreate.md) | PVM Instance snapshot create parameters | |
|
|
794
1067
|
|
|
795
1068
|
### Return type
|
|
796
1069
|
|
|
@@ -808,16 +1081,16 @@ No authorization required
|
|
|
808
1081
|
|
|
809
1082
|
## pcloud_pvminstances_snapshots_restore_post
|
|
810
1083
|
|
|
811
|
-
> Snapshot pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
|
1084
|
+
> <Snapshot> pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
|
812
1085
|
|
|
813
1086
|
Restore a PVM Instance snapshot
|
|
814
1087
|
|
|
815
1088
|
To roll back the clone operation, append '?restore_fail_action=rollback' to the cURL URL. If you'd like to try the clone operation again, append '?restore_fail_action=retry' to the cURL URL.
|
|
816
1089
|
|
|
817
|
-
###
|
|
1090
|
+
### Examples
|
|
818
1091
|
|
|
819
1092
|
```ruby
|
|
820
|
-
|
|
1093
|
+
require 'time'
|
|
821
1094
|
require 'ibm_cloud_power'
|
|
822
1095
|
|
|
823
1096
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
@@ -826,28 +1099,45 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
|
826
1099
|
snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
|
|
827
1100
|
body = IbmCloudPower::SnapshotRestore.new # SnapshotRestore | PVM Instance snapshot restore parameters
|
|
828
1101
|
opts = {
|
|
829
|
-
restore_fail_action: '
|
|
1102
|
+
restore_fail_action: 'retry' # String | Action to take on a failed snapshot restore
|
|
830
1103
|
}
|
|
831
1104
|
|
|
832
1105
|
begin
|
|
833
|
-
#Restore a PVM Instance snapshot
|
|
1106
|
+
# Restore a PVM Instance snapshot
|
|
834
1107
|
result = api_instance.pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
|
835
1108
|
p result
|
|
836
1109
|
rescue IbmCloudPower::ApiError => e
|
|
837
|
-
puts "
|
|
1110
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post: #{e}"
|
|
838
1111
|
end
|
|
839
1112
|
```
|
|
840
1113
|
|
|
841
|
-
|
|
1114
|
+
#### Using the pcloud_pvminstances_snapshots_restore_post_with_http_info variant
|
|
1115
|
+
|
|
1116
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1117
|
+
|
|
1118
|
+
> <Array(<Snapshot>, Integer, Hash)> pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
|
1119
|
+
|
|
1120
|
+
```ruby
|
|
1121
|
+
begin
|
|
1122
|
+
# Restore a PVM Instance snapshot
|
|
1123
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
|
1124
|
+
p status_code # => 2xx
|
|
1125
|
+
p headers # => { ... }
|
|
1126
|
+
p data # => <Snapshot>
|
|
1127
|
+
rescue IbmCloudPower::ApiError => e
|
|
1128
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post_with_http_info: #{e}"
|
|
1129
|
+
end
|
|
1130
|
+
```
|
|
842
1131
|
|
|
1132
|
+
### Parameters
|
|
843
1133
|
|
|
844
|
-
Name | Type | Description
|
|
845
|
-
|
|
846
|
-
**cloud_instance_id** | **String
|
|
847
|
-
**pvm_instance_id** | **String
|
|
848
|
-
**snapshot_id** | **String
|
|
849
|
-
**body** | [**SnapshotRestore**](SnapshotRestore.md)| PVM Instance snapshot restore parameters |
|
|
850
|
-
**restore_fail_action** | **String
|
|
1134
|
+
| Name | Type | Description | Notes |
|
|
1135
|
+
| ---- | ---- | ----------- | ----- |
|
|
1136
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
1137
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
1138
|
+
| **snapshot_id** | **String** | PVM Instance snapshot id | |
|
|
1139
|
+
| **body** | [**SnapshotRestore**](SnapshotRestore.md) | PVM Instance snapshot restore parameters | |
|
|
1140
|
+
| **restore_fail_action** | **String** | Action to take on a failed snapshot restore | [optional] |
|
|
851
1141
|
|
|
852
1142
|
### Return type
|
|
853
1143
|
|
|
@@ -862,3 +1152,133 @@ No authorization required
|
|
|
862
1152
|
- **Content-Type**: application/json
|
|
863
1153
|
- **Accept**: application/json
|
|
864
1154
|
|
|
1155
|
+
|
|
1156
|
+
## pcloud_v2_pvminstances_capture_get
|
|
1157
|
+
|
|
1158
|
+
> <Job> pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id)
|
|
1159
|
+
|
|
1160
|
+
Get a PVM Instance’s last capture job details
|
|
1161
|
+
|
|
1162
|
+
### Examples
|
|
1163
|
+
|
|
1164
|
+
```ruby
|
|
1165
|
+
require 'time'
|
|
1166
|
+
require 'ibm_cloud_power'
|
|
1167
|
+
|
|
1168
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
1169
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
1170
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
1171
|
+
|
|
1172
|
+
begin
|
|
1173
|
+
# Get a PVM Instance’s last capture job details
|
|
1174
|
+
result = api_instance.pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id)
|
|
1175
|
+
p result
|
|
1176
|
+
rescue IbmCloudPower::ApiError => e
|
|
1177
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_get: #{e}"
|
|
1178
|
+
end
|
|
1179
|
+
```
|
|
1180
|
+
|
|
1181
|
+
#### Using the pcloud_v2_pvminstances_capture_get_with_http_info variant
|
|
1182
|
+
|
|
1183
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1184
|
+
|
|
1185
|
+
> <Array(<Job>, Integer, Hash)> pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
1186
|
+
|
|
1187
|
+
```ruby
|
|
1188
|
+
begin
|
|
1189
|
+
# Get a PVM Instance’s last capture job details
|
|
1190
|
+
data, status_code, headers = api_instance.pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
|
1191
|
+
p status_code # => 2xx
|
|
1192
|
+
p headers # => { ... }
|
|
1193
|
+
p data # => <Job>
|
|
1194
|
+
rescue IbmCloudPower::ApiError => e
|
|
1195
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_get_with_http_info: #{e}"
|
|
1196
|
+
end
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
### Parameters
|
|
1200
|
+
|
|
1201
|
+
| Name | Type | Description | Notes |
|
|
1202
|
+
| ---- | ---- | ----------- | ----- |
|
|
1203
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
1204
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
1205
|
+
|
|
1206
|
+
### Return type
|
|
1207
|
+
|
|
1208
|
+
[**Job**](Job.md)
|
|
1209
|
+
|
|
1210
|
+
### Authorization
|
|
1211
|
+
|
|
1212
|
+
No authorization required
|
|
1213
|
+
|
|
1214
|
+
### HTTP request headers
|
|
1215
|
+
|
|
1216
|
+
- **Content-Type**: Not defined
|
|
1217
|
+
- **Accept**: application/json
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
## pcloud_v2_pvminstances_capture_post
|
|
1221
|
+
|
|
1222
|
+
> <JobReference> pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
|
1223
|
+
|
|
1224
|
+
Capture a PVM instance and create a deployable image (version 2)
|
|
1225
|
+
|
|
1226
|
+
### Examples
|
|
1227
|
+
|
|
1228
|
+
```ruby
|
|
1229
|
+
require 'time'
|
|
1230
|
+
require 'ibm_cloud_power'
|
|
1231
|
+
|
|
1232
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
|
1233
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
|
1234
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
1235
|
+
body = IbmCloudPower::PVMInstanceCapture.new({capture_name: 'capture_name_example', capture_destination: 'image-catalog'}) # PVMInstanceCapture | Parameters for the capture
|
|
1236
|
+
|
|
1237
|
+
begin
|
|
1238
|
+
# Capture a PVM instance and create a deployable image (version 2)
|
|
1239
|
+
result = api_instance.pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
|
1240
|
+
p result
|
|
1241
|
+
rescue IbmCloudPower::ApiError => e
|
|
1242
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_post: #{e}"
|
|
1243
|
+
end
|
|
1244
|
+
```
|
|
1245
|
+
|
|
1246
|
+
#### Using the pcloud_v2_pvminstances_capture_post_with_http_info variant
|
|
1247
|
+
|
|
1248
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1249
|
+
|
|
1250
|
+
> <Array(<JobReference>, Integer, Hash)> pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
1251
|
+
|
|
1252
|
+
```ruby
|
|
1253
|
+
begin
|
|
1254
|
+
# Capture a PVM instance and create a deployable image (version 2)
|
|
1255
|
+
data, status_code, headers = api_instance.pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
|
1256
|
+
p status_code # => 2xx
|
|
1257
|
+
p headers # => { ... }
|
|
1258
|
+
p data # => <JobReference>
|
|
1259
|
+
rescue IbmCloudPower::ApiError => e
|
|
1260
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_post_with_http_info: #{e}"
|
|
1261
|
+
end
|
|
1262
|
+
```
|
|
1263
|
+
|
|
1264
|
+
### Parameters
|
|
1265
|
+
|
|
1266
|
+
| Name | Type | Description | Notes |
|
|
1267
|
+
| ---- | ---- | ----------- | ----- |
|
|
1268
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
|
1269
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
|
1270
|
+
| **body** | [**PVMInstanceCapture**](PVMInstanceCapture.md) | Parameters for the capture | |
|
|
1271
|
+
|
|
1272
|
+
### Return type
|
|
1273
|
+
|
|
1274
|
+
[**JobReference**](JobReference.md)
|
|
1275
|
+
|
|
1276
|
+
### Authorization
|
|
1277
|
+
|
|
1278
|
+
No authorization required
|
|
1279
|
+
|
|
1280
|
+
### HTTP request headers
|
|
1281
|
+
|
|
1282
|
+
- **Content-Type**: application/json
|
|
1283
|
+
- **Accept**: application/json
|
|
1284
|
+
|