ibm_cloud_power 1.1.1 → 2.1.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/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
@@ -2,26 +2,29 @@
|
|
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
|
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
|
-
[**
|
11
|
-
[**
|
12
|
-
[**
|
13
|
-
[**
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**
|
17
|
-
[**
|
18
|
-
[**
|
19
|
-
[**
|
20
|
-
[**
|
21
|
-
[**
|
22
|
-
[**
|
23
|
-
[**
|
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 PVMInstance 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_get**](PCloudPVMInstancesApi.md#pcloud_pvminstances_console_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console | List all console languages |
|
11
|
+
| [**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 |
|
12
|
+
| [**pcloud_pvminstances_console_put**](PCloudPVMInstancesApi.md#pcloud_pvminstances_console_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console | Update PVMInstance console laguage code |
|
13
|
+
| [**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 |
|
14
|
+
| [**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 |
|
15
|
+
| [**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 |
|
16
|
+
| [**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 Address of Network from a PVM Instance |
|
17
|
+
| [**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 |
|
18
|
+
| [**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 |
|
19
|
+
| [**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 |
|
20
|
+
| [**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 |
|
21
|
+
| [**pcloud_pvminstances_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Create a new Power VM Instance |
|
22
|
+
| [**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 |
|
23
|
+
| [**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 |
|
24
|
+
| [**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 |
|
25
|
+
| [**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 |
|
26
|
+
| [**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 detail of last capture job |
|
27
|
+
| [**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 | Add a capture pvm-instance to the jobs queue |
|
25
28
|
|
26
29
|
|
27
30
|
## pcloud_pvminstances_action_post
|
@@ -30,34 +33,51 @@ Method | HTTP request | Description
|
|
30
33
|
|
31
34
|
Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
32
35
|
|
33
|
-
###
|
36
|
+
### Examples
|
34
37
|
|
35
38
|
```ruby
|
36
|
-
|
39
|
+
require 'time'
|
37
40
|
require 'ibm_cloud_power'
|
38
41
|
|
39
42
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
40
43
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
41
44
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
42
|
-
body = IbmCloudPower::PVMInstanceAction.new # PVMInstanceAction | Parameters for the desired action
|
45
|
+
body = IbmCloudPower::PVMInstanceAction.new({action: 'start'}) # PVMInstanceAction | Parameters for the desired action
|
43
46
|
|
44
47
|
begin
|
45
|
-
#Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
48
|
+
# Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
46
49
|
result = api_instance.pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body)
|
47
50
|
p result
|
48
51
|
rescue IbmCloudPower::ApiError => e
|
49
|
-
puts "
|
52
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_action_post: #{e}"
|
50
53
|
end
|
51
54
|
```
|
52
55
|
|
53
|
-
|
56
|
+
#### Using the pcloud_pvminstances_action_post_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
54
59
|
|
60
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
# Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
65
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_action_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => Object
|
69
|
+
rescue IbmCloudPower::ApiError => e
|
70
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_action_post_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
55
75
|
|
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 |
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
79
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
80
|
+
| **body** | [**PVMInstanceAction**](PVMInstanceAction.md) | Parameters for the desired action | |
|
61
81
|
|
62
82
|
### Return type
|
63
83
|
|
@@ -77,36 +97,53 @@ No authorization required
|
|
77
97
|
|
78
98
|
> Object pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
79
99
|
|
80
|
-
Capture a
|
100
|
+
Capture a PVMInstance and create a deployable image
|
81
101
|
|
82
|
-
###
|
102
|
+
### Examples
|
83
103
|
|
84
104
|
```ruby
|
85
|
-
|
105
|
+
require 'time'
|
86
106
|
require 'ibm_cloud_power'
|
87
107
|
|
88
108
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
89
109
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
90
110
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
91
|
-
body = IbmCloudPower::PVMInstanceCapture.new # PVMInstanceCapture | Parameters for the capture PVMInstance
|
111
|
+
body = IbmCloudPower::PVMInstanceCapture.new({capture_destination: 'image-catalog', capture_name: 'capture_name_example'}) # PVMInstanceCapture | Parameters for the capture PVMInstance
|
92
112
|
|
93
113
|
begin
|
94
|
-
#Capture a
|
114
|
+
# Capture a PVMInstance and create a deployable image
|
95
115
|
result = api_instance.pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
96
116
|
p result
|
97
117
|
rescue IbmCloudPower::ApiError => e
|
98
|
-
puts "
|
118
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_capture_post: #{e}"
|
99
119
|
end
|
100
120
|
```
|
101
121
|
|
102
|
-
|
122
|
+
#### Using the pcloud_pvminstances_capture_post_with_http_info variant
|
103
123
|
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
104
125
|
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
126
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
# Capture a PVMInstance and create a deployable image
|
131
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => Object
|
135
|
+
rescue IbmCloudPower::ApiError => e
|
136
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_capture_post_with_http_info: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
145
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
146
|
+
| **body** | [**PVMInstanceCapture**](PVMInstanceCapture.md) | Parameters for the capture PVMInstance | |
|
110
147
|
|
111
148
|
### Return type
|
112
149
|
|
@@ -124,38 +161,55 @@ No authorization required
|
|
124
161
|
|
125
162
|
## pcloud_pvminstances_clone_post
|
126
163
|
|
127
|
-
> PVMInstance pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
164
|
+
> <PVMInstance> pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
128
165
|
|
129
166
|
Clone a PVMInstance
|
130
167
|
|
131
|
-
###
|
168
|
+
### Examples
|
132
169
|
|
133
170
|
```ruby
|
134
|
-
|
171
|
+
require 'time'
|
135
172
|
require 'ibm_cloud_power'
|
136
173
|
|
137
174
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
138
175
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
139
176
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
140
|
-
body = IbmCloudPower::PVMInstanceClone.new # PVMInstanceClone | Clone PVM Instance parameters
|
177
|
+
body = IbmCloudPower::PVMInstanceClone.new({name: 'name_example', networks: [IbmCloudPower::PVMInstanceAddNetwork.new({network_id: 'network_id_example'})]}) # PVMInstanceClone | Clone PVM Instance parameters
|
141
178
|
|
142
179
|
begin
|
143
|
-
#Clone a PVMInstance
|
180
|
+
# Clone a PVMInstance
|
144
181
|
result = api_instance.pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
|
145
182
|
p result
|
146
183
|
rescue IbmCloudPower::ApiError => e
|
147
|
-
puts "
|
184
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_clone_post: #{e}"
|
148
185
|
end
|
149
186
|
```
|
150
187
|
|
151
|
-
|
188
|
+
#### Using the pcloud_pvminstances_clone_post_with_http_info variant
|
152
189
|
|
190
|
+
This returns an Array which contains the response data, status code and headers.
|
153
191
|
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
192
|
+
> <Array(<PVMInstance>, Integer, Hash)> pcloud_pvminstances_clone_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
193
|
+
|
194
|
+
```ruby
|
195
|
+
begin
|
196
|
+
# Clone a PVMInstance
|
197
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_clone_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
198
|
+
p status_code # => 2xx
|
199
|
+
p headers # => { ... }
|
200
|
+
p data # => <PVMInstance>
|
201
|
+
rescue IbmCloudPower::ApiError => e
|
202
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_clone_post_with_http_info: #{e}"
|
203
|
+
end
|
204
|
+
```
|
205
|
+
|
206
|
+
### Parameters
|
207
|
+
|
208
|
+
| Name | Type | Description | Notes |
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
210
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
211
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
212
|
+
| **body** | [**PVMInstanceClone**](PVMInstanceClone.md) | Clone PVM Instance parameters | |
|
159
213
|
|
160
214
|
### Return type
|
161
215
|
|
@@ -171,16 +225,80 @@ No authorization required
|
|
171
225
|
- **Accept**: application/json
|
172
226
|
|
173
227
|
|
228
|
+
## pcloud_pvminstances_console_get
|
229
|
+
|
230
|
+
> <ConsoleLanguages> pcloud_pvminstances_console_get(cloud_instance_id, pvm_instance_id)
|
231
|
+
|
232
|
+
List all console languages
|
233
|
+
|
234
|
+
### Examples
|
235
|
+
|
236
|
+
```ruby
|
237
|
+
require 'time'
|
238
|
+
require 'ibm_cloud_power'
|
239
|
+
|
240
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
241
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
242
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
243
|
+
|
244
|
+
begin
|
245
|
+
# List all console languages
|
246
|
+
result = api_instance.pcloud_pvminstances_console_get(cloud_instance_id, pvm_instance_id)
|
247
|
+
p result
|
248
|
+
rescue IbmCloudPower::ApiError => e
|
249
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_get: #{e}"
|
250
|
+
end
|
251
|
+
```
|
252
|
+
|
253
|
+
#### Using the pcloud_pvminstances_console_get_with_http_info variant
|
254
|
+
|
255
|
+
This returns an Array which contains the response data, status code and headers.
|
256
|
+
|
257
|
+
> <Array(<ConsoleLanguages>, Integer, Hash)> pcloud_pvminstances_console_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
begin
|
261
|
+
# List all console languages
|
262
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_console_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
263
|
+
p status_code # => 2xx
|
264
|
+
p headers # => { ... }
|
265
|
+
p data # => <ConsoleLanguages>
|
266
|
+
rescue IbmCloudPower::ApiError => e
|
267
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_get_with_http_info: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
### Parameters
|
272
|
+
|
273
|
+
| Name | Type | Description | Notes |
|
274
|
+
| ---- | ---- | ----------- | ----- |
|
275
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
276
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
277
|
+
|
278
|
+
### Return type
|
279
|
+
|
280
|
+
[**ConsoleLanguages**](ConsoleLanguages.md)
|
281
|
+
|
282
|
+
### Authorization
|
283
|
+
|
284
|
+
No authorization required
|
285
|
+
|
286
|
+
### HTTP request headers
|
287
|
+
|
288
|
+
- **Content-Type**: Not defined
|
289
|
+
- **Accept**: application/json
|
290
|
+
|
291
|
+
|
174
292
|
## pcloud_pvminstances_console_post
|
175
293
|
|
176
|
-
> PVMInstanceConsole pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
294
|
+
> <PVMInstanceConsole> pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
177
295
|
|
178
|
-
Generate the noVNC
|
296
|
+
Generate the noVNC Console URL
|
179
297
|
|
180
|
-
###
|
298
|
+
### Examples
|
181
299
|
|
182
300
|
```ruby
|
183
|
-
|
301
|
+
require 'time'
|
184
302
|
require 'ibm_cloud_power'
|
185
303
|
|
186
304
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -188,21 +306,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
188
306
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
189
307
|
|
190
308
|
begin
|
191
|
-
#Generate the noVNC
|
309
|
+
# Generate the noVNC Console URL
|
192
310
|
result = api_instance.pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
193
311
|
p result
|
194
312
|
rescue IbmCloudPower::ApiError => e
|
195
|
-
puts "
|
313
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_post: #{e}"
|
196
314
|
end
|
197
315
|
```
|
198
316
|
|
199
|
-
|
317
|
+
#### Using the pcloud_pvminstances_console_post_with_http_info variant
|
200
318
|
|
319
|
+
This returns an Array which contains the response data, status code and headers.
|
201
320
|
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
321
|
+
> <Array(<PVMInstanceConsole>, Integer, Hash)> pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id)
|
322
|
+
|
323
|
+
```ruby
|
324
|
+
begin
|
325
|
+
# Generate the noVNC Console URL
|
326
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_console_post_with_http_info(cloud_instance_id, pvm_instance_id)
|
327
|
+
p status_code # => 2xx
|
328
|
+
p headers # => { ... }
|
329
|
+
p data # => <PVMInstanceConsole>
|
330
|
+
rescue IbmCloudPower::ApiError => e
|
331
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_post_with_http_info: #{e}"
|
332
|
+
end
|
333
|
+
```
|
334
|
+
|
335
|
+
### Parameters
|
336
|
+
|
337
|
+
| Name | Type | Description | Notes |
|
338
|
+
| ---- | ---- | ----------- | ----- |
|
339
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
340
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
206
341
|
|
207
342
|
### Return type
|
208
343
|
|
@@ -218,42 +353,125 @@ No authorization required
|
|
218
353
|
- **Accept**: application/json
|
219
354
|
|
220
355
|
|
356
|
+
## pcloud_pvminstances_console_put
|
357
|
+
|
358
|
+
> <ConsoleLanguage> pcloud_pvminstances_console_put(cloud_instance_id, pvm_instance_id, body)
|
359
|
+
|
360
|
+
Update PVMInstance console laguage code
|
361
|
+
|
362
|
+
### Examples
|
363
|
+
|
364
|
+
```ruby
|
365
|
+
require 'time'
|
366
|
+
require 'ibm_cloud_power'
|
367
|
+
|
368
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
369
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
370
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
371
|
+
body = IbmCloudPower::ConsoleLanguage.new({code: 'code_example'}) # ConsoleLanguage | Parameters to update a PVMInstance console required codepage
|
372
|
+
|
373
|
+
begin
|
374
|
+
# Update PVMInstance console laguage code
|
375
|
+
result = api_instance.pcloud_pvminstances_console_put(cloud_instance_id, pvm_instance_id, body)
|
376
|
+
p result
|
377
|
+
rescue IbmCloudPower::ApiError => e
|
378
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_put: #{e}"
|
379
|
+
end
|
380
|
+
```
|
381
|
+
|
382
|
+
#### Using the pcloud_pvminstances_console_put_with_http_info variant
|
383
|
+
|
384
|
+
This returns an Array which contains the response data, status code and headers.
|
385
|
+
|
386
|
+
> <Array(<ConsoleLanguage>, Integer, Hash)> pcloud_pvminstances_console_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
387
|
+
|
388
|
+
```ruby
|
389
|
+
begin
|
390
|
+
# Update PVMInstance console laguage code
|
391
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_console_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
392
|
+
p status_code # => 2xx
|
393
|
+
p headers # => { ... }
|
394
|
+
p data # => <ConsoleLanguage>
|
395
|
+
rescue IbmCloudPower::ApiError => e
|
396
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_put_with_http_info: #{e}"
|
397
|
+
end
|
398
|
+
```
|
399
|
+
|
400
|
+
### Parameters
|
401
|
+
|
402
|
+
| Name | Type | Description | Notes |
|
403
|
+
| ---- | ---- | ----------- | ----- |
|
404
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
405
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
406
|
+
| **body** | [**ConsoleLanguage**](ConsoleLanguage.md) | Parameters to update a PVMInstance console required codepage | |
|
407
|
+
|
408
|
+
### Return type
|
409
|
+
|
410
|
+
[**ConsoleLanguage**](ConsoleLanguage.md)
|
411
|
+
|
412
|
+
### Authorization
|
413
|
+
|
414
|
+
No authorization required
|
415
|
+
|
416
|
+
### HTTP request headers
|
417
|
+
|
418
|
+
- **Content-Type**: application/json
|
419
|
+
- **Accept**: application/json
|
420
|
+
|
421
|
+
|
221
422
|
## pcloud_pvminstances_delete
|
222
423
|
|
223
424
|
> Object pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts)
|
224
425
|
|
225
|
-
Delete a PCloud PVM
|
426
|
+
Delete a PCloud PVM Instance
|
226
427
|
|
227
|
-
###
|
428
|
+
### Examples
|
228
429
|
|
229
430
|
```ruby
|
230
|
-
|
431
|
+
require 'time'
|
231
432
|
require 'ibm_cloud_power'
|
232
433
|
|
233
434
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
234
435
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
235
436
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
236
437
|
opts = {
|
237
|
-
delete_data_volumes: true # Boolean | Indicates
|
438
|
+
delete_data_volumes: true # Boolean | Indicates if all data volumes attached to the PVMInstance should be deleted when deleting the PVMInstance. Shared data volumes will be deleted if there are no other PVMInstances attached.
|
238
439
|
}
|
239
440
|
|
240
441
|
begin
|
241
|
-
#Delete a PCloud PVM
|
442
|
+
# Delete a PCloud PVM Instance
|
242
443
|
result = api_instance.pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts)
|
243
444
|
p result
|
244
445
|
rescue IbmCloudPower::ApiError => e
|
245
|
-
puts "
|
446
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete: #{e}"
|
246
447
|
end
|
247
448
|
```
|
248
449
|
|
249
|
-
|
450
|
+
#### Using the pcloud_pvminstances_delete_with_http_info variant
|
250
451
|
|
452
|
+
This returns an Array which contains the response data, status code and headers.
|
251
453
|
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
454
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
|
455
|
+
|
456
|
+
```ruby
|
457
|
+
begin
|
458
|
+
# Delete a PCloud PVM Instance
|
459
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_delete_with_http_info(cloud_instance_id, pvm_instance_id, opts)
|
460
|
+
p status_code # => 2xx
|
461
|
+
p headers # => { ... }
|
462
|
+
p data # => Object
|
463
|
+
rescue IbmCloudPower::ApiError => e
|
464
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete_with_http_info: #{e}"
|
465
|
+
end
|
466
|
+
```
|
467
|
+
|
468
|
+
### Parameters
|
469
|
+
|
470
|
+
| Name | Type | Description | Notes |
|
471
|
+
| ---- | ---- | ----------- | ----- |
|
472
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
473
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
474
|
+
| **delete_data_volumes** | **Boolean** | Indicates if all data volumes attached to the PVMInstance should be deleted when deleting the PVMInstance. Shared data volumes will be deleted if there are no other PVMInstances attached. | [optional] |
|
257
475
|
|
258
476
|
### Return type
|
259
477
|
|
@@ -271,14 +489,14 @@ No authorization required
|
|
271
489
|
|
272
490
|
## pcloud_pvminstances_get
|
273
491
|
|
274
|
-
> PVMInstance pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
492
|
+
> <PVMInstance> pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
275
493
|
|
276
|
-
Get a PVM
|
494
|
+
Get a PVM Instance's current state or information
|
277
495
|
|
278
|
-
###
|
496
|
+
### Examples
|
279
497
|
|
280
498
|
```ruby
|
281
|
-
|
499
|
+
require 'time'
|
282
500
|
require 'ibm_cloud_power'
|
283
501
|
|
284
502
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -286,21 +504,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
286
504
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
287
505
|
|
288
506
|
begin
|
289
|
-
#Get a PVM
|
507
|
+
# Get a PVM Instance's current state or information
|
290
508
|
result = api_instance.pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
291
509
|
p result
|
292
510
|
rescue IbmCloudPower::ApiError => e
|
293
|
-
puts "
|
511
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_get: #{e}"
|
294
512
|
end
|
295
513
|
```
|
296
514
|
|
297
|
-
|
515
|
+
#### Using the pcloud_pvminstances_get_with_http_info variant
|
298
516
|
|
517
|
+
This returns an Array which contains the response data, status code and headers.
|
299
518
|
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
519
|
+
> <Array(<PVMInstance>, Integer, Hash)> pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
520
|
+
|
521
|
+
```ruby
|
522
|
+
begin
|
523
|
+
# Get a PVM Instance's current state or information
|
524
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
525
|
+
p status_code # => 2xx
|
526
|
+
p headers # => { ... }
|
527
|
+
p data # => <PVMInstance>
|
528
|
+
rescue IbmCloudPower::ApiError => e
|
529
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_get_with_http_info: #{e}"
|
530
|
+
end
|
531
|
+
```
|
532
|
+
|
533
|
+
### Parameters
|
534
|
+
|
535
|
+
| Name | Type | Description | Notes |
|
536
|
+
| ---- | ---- | ----------- | ----- |
|
537
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
538
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
304
539
|
|
305
540
|
### Return type
|
306
541
|
|
@@ -318,34 +553,51 @@ No authorization required
|
|
318
553
|
|
319
554
|
## pcloud_pvminstances_getall
|
320
555
|
|
321
|
-
> PVMInstances pcloud_pvminstances_getall(cloud_instance_id)
|
556
|
+
> <PVMInstances> pcloud_pvminstances_getall(cloud_instance_id)
|
322
557
|
|
323
|
-
Get all the
|
558
|
+
Get all the pvm instances for this cloud instance
|
324
559
|
|
325
|
-
###
|
560
|
+
### Examples
|
326
561
|
|
327
562
|
```ruby
|
328
|
-
|
563
|
+
require 'time'
|
329
564
|
require 'ibm_cloud_power'
|
330
565
|
|
331
566
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
332
567
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
333
568
|
|
334
569
|
begin
|
335
|
-
#Get all the
|
570
|
+
# Get all the pvm instances for this cloud instance
|
336
571
|
result = api_instance.pcloud_pvminstances_getall(cloud_instance_id)
|
337
572
|
p result
|
338
573
|
rescue IbmCloudPower::ApiError => e
|
339
|
-
puts "
|
574
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_getall: #{e}"
|
340
575
|
end
|
341
576
|
```
|
342
577
|
|
343
|
-
|
578
|
+
#### Using the pcloud_pvminstances_getall_with_http_info variant
|
579
|
+
|
580
|
+
This returns an Array which contains the response data, status code and headers.
|
581
|
+
|
582
|
+
> <Array(<PVMInstances>, Integer, Hash)> pcloud_pvminstances_getall_with_http_info(cloud_instance_id)
|
583
|
+
|
584
|
+
```ruby
|
585
|
+
begin
|
586
|
+
# Get all the pvm instances for this cloud instance
|
587
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_getall_with_http_info(cloud_instance_id)
|
588
|
+
p status_code # => 2xx
|
589
|
+
p headers # => { ... }
|
590
|
+
p data # => <PVMInstances>
|
591
|
+
rescue IbmCloudPower::ApiError => e
|
592
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_getall_with_http_info: #{e}"
|
593
|
+
end
|
594
|
+
```
|
344
595
|
|
596
|
+
### Parameters
|
345
597
|
|
346
|
-
Name | Type | Description
|
347
|
-
|
348
|
-
**cloud_instance_id** | **String
|
598
|
+
| Name | Type | Description | Notes |
|
599
|
+
| ---- | ---- | ----------- | ----- |
|
600
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
349
601
|
|
350
602
|
### Return type
|
351
603
|
|
@@ -365,12 +617,12 @@ No authorization required
|
|
365
617
|
|
366
618
|
> Object pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts)
|
367
619
|
|
368
|
-
Remove all
|
620
|
+
Remove all Address of Network from a PVM Instance
|
369
621
|
|
370
|
-
###
|
622
|
+
### Examples
|
371
623
|
|
372
624
|
```ruby
|
373
|
-
|
625
|
+
require 'time'
|
374
626
|
require 'ibm_cloud_power'
|
375
627
|
|
376
628
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -382,23 +634,40 @@ opts = {
|
|
382
634
|
}
|
383
635
|
|
384
636
|
begin
|
385
|
-
#Remove all
|
637
|
+
# Remove all Address of Network from a PVM Instance
|
386
638
|
result = api_instance.pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts)
|
387
639
|
p result
|
388
640
|
rescue IbmCloudPower::ApiError => e
|
389
|
-
puts "
|
641
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_delete: #{e}"
|
390
642
|
end
|
391
643
|
```
|
392
644
|
|
393
|
-
|
645
|
+
#### Using the pcloud_pvminstances_networks_delete_with_http_info variant
|
394
646
|
|
647
|
+
This returns an Array which contains the response data, status code and headers.
|
395
648
|
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
649
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
|
650
|
+
|
651
|
+
```ruby
|
652
|
+
begin
|
653
|
+
# Remove all Address of Network from a PVM Instance
|
654
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_delete_with_http_info(cloud_instance_id, pvm_instance_id, network_id, opts)
|
655
|
+
p status_code # => 2xx
|
656
|
+
p headers # => { ... }
|
657
|
+
p data # => Object
|
658
|
+
rescue IbmCloudPower::ApiError => e
|
659
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_delete_with_http_info: #{e}"
|
660
|
+
end
|
661
|
+
```
|
662
|
+
|
663
|
+
### Parameters
|
664
|
+
|
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 | |
|
669
|
+
| **network_id** | **String** | Network ID | |
|
670
|
+
| **body** | [**PVMInstanceRemoveNetwork**](PVMInstanceRemoveNetwork.md) | Remove a network from PVM Instance parameters | [optional] |
|
402
671
|
|
403
672
|
### Return type
|
404
673
|
|
@@ -416,14 +685,14 @@ No authorization required
|
|
416
685
|
|
417
686
|
## pcloud_pvminstances_networks_get
|
418
687
|
|
419
|
-
> PVMInstanceNetworks pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
688
|
+
> <PVMInstanceNetworks> pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
420
689
|
|
421
|
-
Get a PVM
|
690
|
+
Get a PVM Instance's network information
|
422
691
|
|
423
|
-
###
|
692
|
+
### Examples
|
424
693
|
|
425
694
|
```ruby
|
426
|
-
|
695
|
+
require 'time'
|
427
696
|
require 'ibm_cloud_power'
|
428
697
|
|
429
698
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -432,22 +701,39 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
432
701
|
network_id = 'network_id_example' # String | Network ID
|
433
702
|
|
434
703
|
begin
|
435
|
-
#Get a PVM
|
704
|
+
# Get a PVM Instance's network information
|
436
705
|
result = api_instance.pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
437
706
|
p result
|
438
707
|
rescue IbmCloudPower::ApiError => e
|
439
|
-
puts "
|
708
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_get: #{e}"
|
440
709
|
end
|
441
710
|
```
|
442
711
|
|
443
|
-
|
712
|
+
#### Using the pcloud_pvminstances_networks_get_with_http_info variant
|
444
713
|
|
714
|
+
This returns an Array which contains the response data, status code and headers.
|
445
715
|
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
716
|
+
> <Array(<PVMInstanceNetworks>, Integer, Hash)> pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id)
|
717
|
+
|
718
|
+
```ruby
|
719
|
+
begin
|
720
|
+
# Get a PVM Instance's network information
|
721
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_get_with_http_info(cloud_instance_id, pvm_instance_id, network_id)
|
722
|
+
p status_code # => 2xx
|
723
|
+
p headers # => { ... }
|
724
|
+
p data # => <PVMInstanceNetworks>
|
725
|
+
rescue IbmCloudPower::ApiError => e
|
726
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_get_with_http_info: #{e}"
|
727
|
+
end
|
728
|
+
```
|
729
|
+
|
730
|
+
### Parameters
|
731
|
+
|
732
|
+
| Name | Type | Description | Notes |
|
733
|
+
| ---- | ---- | ----------- | ----- |
|
734
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
735
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
736
|
+
| **network_id** | **String** | Network ID | |
|
451
737
|
|
452
738
|
### Return type
|
453
739
|
|
@@ -465,14 +751,14 @@ No authorization required
|
|
465
751
|
|
466
752
|
## pcloud_pvminstances_networks_getall
|
467
753
|
|
468
|
-
> PVMInstanceNetworks pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
754
|
+
> <PVMInstanceNetworks> pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
469
755
|
|
470
|
-
Get all networks for this PVM
|
756
|
+
Get all networks for this PVM Instance
|
471
757
|
|
472
|
-
###
|
758
|
+
### Examples
|
473
759
|
|
474
760
|
```ruby
|
475
|
-
|
761
|
+
require 'time'
|
476
762
|
require 'ibm_cloud_power'
|
477
763
|
|
478
764
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -480,21 +766,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
480
766
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
481
767
|
|
482
768
|
begin
|
483
|
-
#Get all networks for this PVM
|
769
|
+
# Get all networks for this PVM Instance
|
484
770
|
result = api_instance.pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
485
771
|
p result
|
486
772
|
rescue IbmCloudPower::ApiError => e
|
487
|
-
puts "
|
773
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_getall: #{e}"
|
488
774
|
end
|
489
775
|
```
|
490
776
|
|
491
|
-
|
777
|
+
#### Using the pcloud_pvminstances_networks_getall_with_http_info variant
|
778
|
+
|
779
|
+
This returns an Array which contains the response data, status code and headers.
|
780
|
+
|
781
|
+
> <Array(<PVMInstanceNetworks>, Integer, Hash)> pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
782
|
+
|
783
|
+
```ruby
|
784
|
+
begin
|
785
|
+
# Get all networks for this PVM Instance
|
786
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
787
|
+
p status_code # => 2xx
|
788
|
+
p headers # => { ... }
|
789
|
+
p data # => <PVMInstanceNetworks>
|
790
|
+
rescue IbmCloudPower::ApiError => e
|
791
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_getall_with_http_info: #{e}"
|
792
|
+
end
|
793
|
+
```
|
492
794
|
|
795
|
+
### Parameters
|
493
796
|
|
494
|
-
Name | Type | Description
|
495
|
-
|
496
|
-
**cloud_instance_id** | **String
|
497
|
-
**pvm_instance_id** | **String
|
797
|
+
| Name | Type | Description | Notes |
|
798
|
+
| ---- | ---- | ----------- | ----- |
|
799
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
800
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
498
801
|
|
499
802
|
### Return type
|
500
803
|
|
@@ -512,38 +815,55 @@ No authorization required
|
|
512
815
|
|
513
816
|
## pcloud_pvminstances_networks_post
|
514
817
|
|
515
|
-
> PVMInstanceNetwork pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
818
|
+
> <PVMInstanceNetwork> pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
516
819
|
|
517
|
-
Perform network addition
|
820
|
+
Perform network addition
|
518
821
|
|
519
|
-
###
|
822
|
+
### Examples
|
520
823
|
|
521
824
|
```ruby
|
522
|
-
|
825
|
+
require 'time'
|
523
826
|
require 'ibm_cloud_power'
|
524
827
|
|
525
828
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
526
829
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
527
830
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
528
|
-
body = IbmCloudPower::PVMInstanceAddNetwork.new # PVMInstanceAddNetwork | Add network to PVM Instance parameters
|
831
|
+
body = IbmCloudPower::PVMInstanceAddNetwork.new({network_id: 'network_id_example'}) # PVMInstanceAddNetwork | Add network to PVM Instance parameters
|
529
832
|
|
530
833
|
begin
|
531
|
-
#Perform network addition
|
834
|
+
# Perform network addition
|
532
835
|
result = api_instance.pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
533
836
|
p result
|
534
837
|
rescue IbmCloudPower::ApiError => e
|
535
|
-
puts "
|
838
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_post: #{e}"
|
536
839
|
end
|
537
840
|
```
|
538
841
|
|
539
|
-
|
842
|
+
#### Using the pcloud_pvminstances_networks_post_with_http_info variant
|
540
843
|
|
844
|
+
This returns an Array which contains the response data, status code and headers.
|
541
845
|
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
846
|
+
> <Array(<PVMInstanceNetwork>, Integer, Hash)> pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
847
|
+
|
848
|
+
```ruby
|
849
|
+
begin
|
850
|
+
# Perform network addition
|
851
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_networks_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
852
|
+
p status_code # => 2xx
|
853
|
+
p headers # => { ... }
|
854
|
+
p data # => <PVMInstanceNetwork>
|
855
|
+
rescue IbmCloudPower::ApiError => e
|
856
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_post_with_http_info: #{e}"
|
857
|
+
end
|
858
|
+
```
|
859
|
+
|
860
|
+
### Parameters
|
861
|
+
|
862
|
+
| Name | Type | Description | Notes |
|
863
|
+
| ---- | ---- | ----------- | ----- |
|
864
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
865
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
866
|
+
| **body** | [**PVMInstanceAddNetwork**](PVMInstanceAddNetwork.md) | Add network to PVM Instance parameters | |
|
547
867
|
|
548
868
|
### Return type
|
549
869
|
|
@@ -565,34 +885,51 @@ No authorization required
|
|
565
885
|
|
566
886
|
Perform an operation on a PVMInstance
|
567
887
|
|
568
|
-
###
|
888
|
+
### Examples
|
569
889
|
|
570
890
|
```ruby
|
571
|
-
|
891
|
+
require 'time'
|
572
892
|
require 'ibm_cloud_power'
|
573
893
|
|
574
894
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
575
895
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
576
896
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
577
|
-
body = IbmCloudPower::PVMInstanceOperation.new # PVMInstanceOperation | Parameters for the desired operations
|
897
|
+
body = IbmCloudPower::PVMInstanceOperation.new({operation: IbmCloudPower::Operations.new, operation_type: 'job'}) # PVMInstanceOperation | Parameters for the desired operations
|
578
898
|
|
579
899
|
begin
|
580
|
-
#Perform an operation on a PVMInstance
|
900
|
+
# Perform an operation on a PVMInstance
|
581
901
|
result = api_instance.pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body)
|
582
902
|
p result
|
583
903
|
rescue IbmCloudPower::ApiError => e
|
584
|
-
puts "
|
904
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_operations_post: #{e}"
|
585
905
|
end
|
586
906
|
```
|
587
907
|
|
588
|
-
|
908
|
+
#### Using the pcloud_pvminstances_operations_post_with_http_info variant
|
589
909
|
|
910
|
+
This returns an Array which contains the response data, status code and headers.
|
590
911
|
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
912
|
+
> <Array(Object, Integer, Hash)> pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
913
|
+
|
914
|
+
```ruby
|
915
|
+
begin
|
916
|
+
# Perform an operation on a PVMInstance
|
917
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_operations_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
918
|
+
p status_code # => 2xx
|
919
|
+
p headers # => { ... }
|
920
|
+
p data # => Object
|
921
|
+
rescue IbmCloudPower::ApiError => e
|
922
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_operations_post_with_http_info: #{e}"
|
923
|
+
end
|
924
|
+
```
|
925
|
+
|
926
|
+
### Parameters
|
927
|
+
|
928
|
+
| Name | Type | Description | Notes |
|
929
|
+
| ---- | ---- | ----------- | ----- |
|
930
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
931
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
932
|
+
| **body** | [**PVMInstanceOperation**](PVMInstanceOperation.md) | Parameters for the desired operations | |
|
596
933
|
|
597
934
|
### Return type
|
598
935
|
|
@@ -610,42 +947,57 @@ No authorization required
|
|
610
947
|
|
611
948
|
## pcloud_pvminstances_post
|
612
949
|
|
613
|
-
> Array
|
614
|
-
|
615
|
-
Create a new PVM instance
|
950
|
+
> <Array<PVMInstance>> pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
616
951
|
|
617
|
-
|
952
|
+
Create a new Power VM Instance
|
618
953
|
|
619
|
-
###
|
954
|
+
### Examples
|
620
955
|
|
621
956
|
```ruby
|
622
|
-
|
957
|
+
require 'time'
|
623
958
|
require 'ibm_cloud_power'
|
624
959
|
|
625
960
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
626
961
|
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
|
962
|
+
body = IbmCloudPower::PVMInstanceCreate.new({image_id: 'image_id_example', memory: 3.56, proc_type: 'dedicated', processors: 3.56, server_name: 'server_name_example'}) # PVMInstanceCreate | Parameters for the creation of a new Power VM Instance
|
628
963
|
opts = {
|
629
964
|
skip_host_validation: true # Boolean | Option to skip host validation on PVMInstance Create API
|
630
965
|
}
|
631
966
|
|
632
967
|
begin
|
633
|
-
#Create a new
|
968
|
+
# Create a new Power VM Instance
|
634
969
|
result = api_instance.pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
635
970
|
p result
|
636
971
|
rescue IbmCloudPower::ApiError => e
|
637
|
-
puts "
|
972
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_post: #{e}"
|
638
973
|
end
|
639
974
|
```
|
640
975
|
|
641
|
-
|
976
|
+
#### Using the pcloud_pvminstances_post_with_http_info variant
|
642
977
|
|
978
|
+
This returns an Array which contains the response data, status code and headers.
|
643
979
|
|
644
|
-
|
645
|
-
|
646
|
-
|
647
|
-
|
648
|
-
|
980
|
+
> <Array(<Array<PVMInstance>>, Integer, Hash)> pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts)
|
981
|
+
|
982
|
+
```ruby
|
983
|
+
begin
|
984
|
+
# Create a new Power VM Instance
|
985
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_post_with_http_info(cloud_instance_id, body, opts)
|
986
|
+
p status_code # => 2xx
|
987
|
+
p headers # => { ... }
|
988
|
+
p data # => <Array<PVMInstance>>
|
989
|
+
rescue IbmCloudPower::ApiError => e
|
990
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_post_with_http_info: #{e}"
|
991
|
+
end
|
992
|
+
```
|
993
|
+
|
994
|
+
### Parameters
|
995
|
+
|
996
|
+
| Name | Type | Description | Notes |
|
997
|
+
| ---- | ---- | ----------- | ----- |
|
998
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
999
|
+
| **body** | [**PVMInstanceCreate**](PVMInstanceCreate.md) | Parameters for the creation of a new Power VM Instance | |
|
1000
|
+
| **skip_host_validation** | **Boolean** | Option to skip host validation on PVMInstance Create API | [optional] |
|
649
1001
|
|
650
1002
|
### Return type
|
651
1003
|
|
@@ -663,38 +1015,55 @@ No authorization required
|
|
663
1015
|
|
664
1016
|
## pcloud_pvminstances_put
|
665
1017
|
|
666
|
-
> PVMInstanceUpdateResponse pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
1018
|
+
> <PVMInstanceUpdateResponse> pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
667
1019
|
|
668
|
-
Update a PCloud PVM
|
1020
|
+
Update a PCloud PVM Instance
|
669
1021
|
|
670
|
-
###
|
1022
|
+
### Examples
|
671
1023
|
|
672
1024
|
```ruby
|
673
|
-
|
1025
|
+
require 'time'
|
674
1026
|
require 'ibm_cloud_power'
|
675
1027
|
|
676
1028
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
677
1029
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
678
1030
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
679
|
-
body = IbmCloudPower::PVMInstanceUpdate.new # PVMInstanceUpdate | Parameters to update a PCloud PVM
|
1031
|
+
body = IbmCloudPower::PVMInstanceUpdate.new # PVMInstanceUpdate | Parameters to update a PCloud PVM Instance
|
680
1032
|
|
681
1033
|
begin
|
682
|
-
#Update a PCloud PVM
|
1034
|
+
# Update a PCloud PVM Instance
|
683
1035
|
result = api_instance.pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
684
1036
|
p result
|
685
1037
|
rescue IbmCloudPower::ApiError => e
|
686
|
-
puts "
|
1038
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_put: #{e}"
|
687
1039
|
end
|
688
1040
|
```
|
689
1041
|
|
690
|
-
|
1042
|
+
#### Using the pcloud_pvminstances_put_with_http_info variant
|
691
1043
|
|
1044
|
+
This returns an Array which contains the response data, status code and headers.
|
692
1045
|
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
1046
|
+
> <Array(<PVMInstanceUpdateResponse>, Integer, Hash)> pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1047
|
+
|
1048
|
+
```ruby
|
1049
|
+
begin
|
1050
|
+
# Update a PCloud PVM Instance
|
1051
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_put_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1052
|
+
p status_code # => 2xx
|
1053
|
+
p headers # => { ... }
|
1054
|
+
p data # => <PVMInstanceUpdateResponse>
|
1055
|
+
rescue IbmCloudPower::ApiError => e
|
1056
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_put_with_http_info: #{e}"
|
1057
|
+
end
|
1058
|
+
```
|
1059
|
+
|
1060
|
+
### Parameters
|
1061
|
+
|
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** | [**PVMInstanceUpdate**](PVMInstanceUpdate.md) | Parameters to update a PCloud PVM Instance | |
|
698
1067
|
|
699
1068
|
### Return type
|
700
1069
|
|
@@ -712,14 +1081,14 @@ No authorization required
|
|
712
1081
|
|
713
1082
|
## pcloud_pvminstances_snapshots_getall
|
714
1083
|
|
715
|
-
> Snapshots pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
1084
|
+
> <Snapshots> pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
716
1085
|
|
717
|
-
Get all snapshots for this PVM
|
1086
|
+
Get all snapshots for this PVM Instance
|
718
1087
|
|
719
|
-
###
|
1088
|
+
### Examples
|
720
1089
|
|
721
1090
|
```ruby
|
722
|
-
|
1091
|
+
require 'time'
|
723
1092
|
require 'ibm_cloud_power'
|
724
1093
|
|
725
1094
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -727,21 +1096,38 @@ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of
|
|
727
1096
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
728
1097
|
|
729
1098
|
begin
|
730
|
-
#Get all snapshots for this PVM
|
1099
|
+
# Get all snapshots for this PVM Instance
|
731
1100
|
result = api_instance.pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
732
1101
|
p result
|
733
1102
|
rescue IbmCloudPower::ApiError => e
|
734
|
-
puts "
|
1103
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_getall: #{e}"
|
735
1104
|
end
|
736
1105
|
```
|
737
1106
|
|
738
|
-
|
1107
|
+
#### Using the pcloud_pvminstances_snapshots_getall_with_http_info variant
|
1108
|
+
|
1109
|
+
This returns an Array which contains the response data, status code and headers.
|
1110
|
+
|
1111
|
+
> <Array(<Snapshots>, Integer, Hash)> pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
1112
|
+
|
1113
|
+
```ruby
|
1114
|
+
begin
|
1115
|
+
# Get all snapshots for this PVM Instance
|
1116
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_getall_with_http_info(cloud_instance_id, pvm_instance_id)
|
1117
|
+
p status_code # => 2xx
|
1118
|
+
p headers # => { ... }
|
1119
|
+
p data # => <Snapshots>
|
1120
|
+
rescue IbmCloudPower::ApiError => e
|
1121
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_getall_with_http_info: #{e}"
|
1122
|
+
end
|
1123
|
+
```
|
739
1124
|
|
1125
|
+
### Parameters
|
740
1126
|
|
741
|
-
Name | Type | Description
|
742
|
-
|
743
|
-
**cloud_instance_id** | **String
|
744
|
-
**pvm_instance_id** | **String
|
1127
|
+
| Name | Type | Description | Notes |
|
1128
|
+
| ---- | ---- | ----------- | ----- |
|
1129
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1130
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
745
1131
|
|
746
1132
|
### Return type
|
747
1133
|
|
@@ -759,38 +1145,55 @@ No authorization required
|
|
759
1145
|
|
760
1146
|
## pcloud_pvminstances_snapshots_post
|
761
1147
|
|
762
|
-
> SnapshotCreateResponse pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
1148
|
+
> <SnapshotCreateResponse> pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
763
1149
|
|
764
|
-
Create a PVM
|
1150
|
+
Create a PVM Instance snapshot
|
765
1151
|
|
766
|
-
###
|
1152
|
+
### Examples
|
767
1153
|
|
768
1154
|
```ruby
|
769
|
-
|
1155
|
+
require 'time'
|
770
1156
|
require 'ibm_cloud_power'
|
771
1157
|
|
772
1158
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
773
1159
|
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
774
1160
|
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
775
|
-
body = IbmCloudPower::SnapshotCreate.new # SnapshotCreate | PVM Instance snapshot create parameters
|
1161
|
+
body = IbmCloudPower::SnapshotCreate.new({name: 'name_example'}) # SnapshotCreate | PVM Instance snapshot create parameters
|
776
1162
|
|
777
1163
|
begin
|
778
|
-
#Create a PVM
|
1164
|
+
# Create a PVM Instance snapshot
|
779
1165
|
result = api_instance.pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
780
1166
|
p result
|
781
1167
|
rescue IbmCloudPower::ApiError => e
|
782
|
-
puts "
|
1168
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_post: #{e}"
|
783
1169
|
end
|
784
1170
|
```
|
785
1171
|
|
786
|
-
|
1172
|
+
#### Using the pcloud_pvminstances_snapshots_post_with_http_info variant
|
1173
|
+
|
1174
|
+
This returns an Array which contains the response data, status code and headers.
|
787
1175
|
|
1176
|
+
> <Array(<SnapshotCreateResponse>, Integer, Hash)> pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1177
|
+
|
1178
|
+
```ruby
|
1179
|
+
begin
|
1180
|
+
# Create a PVM Instance snapshot
|
1181
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1182
|
+
p status_code # => 2xx
|
1183
|
+
p headers # => { ... }
|
1184
|
+
p data # => <SnapshotCreateResponse>
|
1185
|
+
rescue IbmCloudPower::ApiError => e
|
1186
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_post_with_http_info: #{e}"
|
1187
|
+
end
|
1188
|
+
```
|
1189
|
+
|
1190
|
+
### Parameters
|
788
1191
|
|
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 |
|
1192
|
+
| Name | Type | Description | Notes |
|
1193
|
+
| ---- | ---- | ----------- | ----- |
|
1194
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1195
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
1196
|
+
| **body** | [**SnapshotCreate**](SnapshotCreate.md) | PVM Instance snapshot create parameters | |
|
794
1197
|
|
795
1198
|
### Return type
|
796
1199
|
|
@@ -808,16 +1211,14 @@ No authorization required
|
|
808
1211
|
|
809
1212
|
## pcloud_pvminstances_snapshots_restore_post
|
810
1213
|
|
811
|
-
> Snapshot pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
1214
|
+
> <Snapshot> pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
812
1215
|
|
813
1216
|
Restore a PVM Instance snapshot
|
814
1217
|
|
815
|
-
|
816
|
-
|
817
|
-
### Example
|
1218
|
+
### Examples
|
818
1219
|
|
819
1220
|
```ruby
|
820
|
-
|
1221
|
+
require 'time'
|
821
1222
|
require 'ibm_cloud_power'
|
822
1223
|
|
823
1224
|
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
@@ -826,28 +1227,45 @@ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
|
826
1227
|
snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
|
827
1228
|
body = IbmCloudPower::SnapshotRestore.new # SnapshotRestore | PVM Instance snapshot restore parameters
|
828
1229
|
opts = {
|
829
|
-
restore_fail_action: '
|
1230
|
+
restore_fail_action: 'retry' # String | Action to take on a failed snapshot restore
|
830
1231
|
}
|
831
1232
|
|
832
1233
|
begin
|
833
|
-
#Restore a PVM Instance snapshot
|
1234
|
+
# Restore a PVM Instance snapshot
|
834
1235
|
result = api_instance.pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
835
1236
|
p result
|
836
1237
|
rescue IbmCloudPower::ApiError => e
|
837
|
-
puts "
|
1238
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post: #{e}"
|
838
1239
|
end
|
839
1240
|
```
|
840
1241
|
|
841
|
-
|
1242
|
+
#### Using the pcloud_pvminstances_snapshots_restore_post_with_http_info variant
|
1243
|
+
|
1244
|
+
This returns an Array which contains the response data, status code and headers.
|
1245
|
+
|
1246
|
+
> <Array(<Snapshot>, Integer, Hash)> pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
1247
|
+
|
1248
|
+
```ruby
|
1249
|
+
begin
|
1250
|
+
# Restore a PVM Instance snapshot
|
1251
|
+
data, status_code, headers = api_instance.pcloud_pvminstances_snapshots_restore_post_with_http_info(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
1252
|
+
p status_code # => 2xx
|
1253
|
+
p headers # => { ... }
|
1254
|
+
p data # => <Snapshot>
|
1255
|
+
rescue IbmCloudPower::ApiError => e
|
1256
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post_with_http_info: #{e}"
|
1257
|
+
end
|
1258
|
+
```
|
842
1259
|
|
1260
|
+
### Parameters
|
843
1261
|
|
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
|
1262
|
+
| Name | Type | Description | Notes |
|
1263
|
+
| ---- | ---- | ----------- | ----- |
|
1264
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1265
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
1266
|
+
| **snapshot_id** | **String** | PVM Instance snapshot id | |
|
1267
|
+
| **body** | [**SnapshotRestore**](SnapshotRestore.md) | PVM Instance snapshot restore parameters | |
|
1268
|
+
| **restore_fail_action** | **String** | Action to take on a failed snapshot restore | [optional] |
|
851
1269
|
|
852
1270
|
### Return type
|
853
1271
|
|
@@ -862,3 +1280,133 @@ No authorization required
|
|
862
1280
|
- **Content-Type**: application/json
|
863
1281
|
- **Accept**: application/json
|
864
1282
|
|
1283
|
+
|
1284
|
+
## pcloud_v2_pvminstances_capture_get
|
1285
|
+
|
1286
|
+
> <Job> pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id)
|
1287
|
+
|
1288
|
+
Get detail of last capture job
|
1289
|
+
|
1290
|
+
### Examples
|
1291
|
+
|
1292
|
+
```ruby
|
1293
|
+
require 'time'
|
1294
|
+
require 'ibm_cloud_power'
|
1295
|
+
|
1296
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
1297
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
1298
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
1299
|
+
|
1300
|
+
begin
|
1301
|
+
# Get detail of last capture job
|
1302
|
+
result = api_instance.pcloud_v2_pvminstances_capture_get(cloud_instance_id, pvm_instance_id)
|
1303
|
+
p result
|
1304
|
+
rescue IbmCloudPower::ApiError => e
|
1305
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_get: #{e}"
|
1306
|
+
end
|
1307
|
+
```
|
1308
|
+
|
1309
|
+
#### Using the pcloud_v2_pvminstances_capture_get_with_http_info variant
|
1310
|
+
|
1311
|
+
This returns an Array which contains the response data, status code and headers.
|
1312
|
+
|
1313
|
+
> <Array(<Job>, Integer, Hash)> pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
1314
|
+
|
1315
|
+
```ruby
|
1316
|
+
begin
|
1317
|
+
# Get detail of last capture job
|
1318
|
+
data, status_code, headers = api_instance.pcloud_v2_pvminstances_capture_get_with_http_info(cloud_instance_id, pvm_instance_id)
|
1319
|
+
p status_code # => 2xx
|
1320
|
+
p headers # => { ... }
|
1321
|
+
p data # => <Job>
|
1322
|
+
rescue IbmCloudPower::ApiError => e
|
1323
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_get_with_http_info: #{e}"
|
1324
|
+
end
|
1325
|
+
```
|
1326
|
+
|
1327
|
+
### Parameters
|
1328
|
+
|
1329
|
+
| Name | Type | Description | Notes |
|
1330
|
+
| ---- | ---- | ----------- | ----- |
|
1331
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1332
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
1333
|
+
|
1334
|
+
### Return type
|
1335
|
+
|
1336
|
+
[**Job**](Job.md)
|
1337
|
+
|
1338
|
+
### Authorization
|
1339
|
+
|
1340
|
+
No authorization required
|
1341
|
+
|
1342
|
+
### HTTP request headers
|
1343
|
+
|
1344
|
+
- **Content-Type**: Not defined
|
1345
|
+
- **Accept**: application/json
|
1346
|
+
|
1347
|
+
|
1348
|
+
## pcloud_v2_pvminstances_capture_post
|
1349
|
+
|
1350
|
+
> <JobReference> pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
1351
|
+
|
1352
|
+
Add a capture pvm-instance to the jobs queue
|
1353
|
+
|
1354
|
+
### Examples
|
1355
|
+
|
1356
|
+
```ruby
|
1357
|
+
require 'time'
|
1358
|
+
require 'ibm_cloud_power'
|
1359
|
+
|
1360
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
1361
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
1362
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
1363
|
+
body = IbmCloudPower::PVMInstanceCapture.new({capture_destination: 'image-catalog', capture_name: 'capture_name_example'}) # PVMInstanceCapture | Parameters for the capture
|
1364
|
+
|
1365
|
+
begin
|
1366
|
+
# Add a capture pvm-instance to the jobs queue
|
1367
|
+
result = api_instance.pcloud_v2_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
1368
|
+
p result
|
1369
|
+
rescue IbmCloudPower::ApiError => e
|
1370
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_post: #{e}"
|
1371
|
+
end
|
1372
|
+
```
|
1373
|
+
|
1374
|
+
#### Using the pcloud_v2_pvminstances_capture_post_with_http_info variant
|
1375
|
+
|
1376
|
+
This returns an Array which contains the response data, status code and headers.
|
1377
|
+
|
1378
|
+
> <Array(<JobReference>, Integer, Hash)> pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1379
|
+
|
1380
|
+
```ruby
|
1381
|
+
begin
|
1382
|
+
# Add a capture pvm-instance to the jobs queue
|
1383
|
+
data, status_code, headers = api_instance.pcloud_v2_pvminstances_capture_post_with_http_info(cloud_instance_id, pvm_instance_id, body)
|
1384
|
+
p status_code # => 2xx
|
1385
|
+
p headers # => { ... }
|
1386
|
+
p data # => <JobReference>
|
1387
|
+
rescue IbmCloudPower::ApiError => e
|
1388
|
+
puts "Error when calling PCloudPVMInstancesApi->pcloud_v2_pvminstances_capture_post_with_http_info: #{e}"
|
1389
|
+
end
|
1390
|
+
```
|
1391
|
+
|
1392
|
+
### Parameters
|
1393
|
+
|
1394
|
+
| Name | Type | Description | Notes |
|
1395
|
+
| ---- | ---- | ----------- | ----- |
|
1396
|
+
| **cloud_instance_id** | **String** | Cloud Instance ID of a PCloud Instance | |
|
1397
|
+
| **pvm_instance_id** | **String** | PCloud PVM Instance ID | |
|
1398
|
+
| **body** | [**PVMInstanceCapture**](PVMInstanceCapture.md) | Parameters for the capture | |
|
1399
|
+
|
1400
|
+
### Return type
|
1401
|
+
|
1402
|
+
[**JobReference**](JobReference.md)
|
1403
|
+
|
1404
|
+
### Authorization
|
1405
|
+
|
1406
|
+
No authorization required
|
1407
|
+
|
1408
|
+
### HTTP request headers
|
1409
|
+
|
1410
|
+
- **Content-Type**: application/json
|
1411
|
+
- **Accept**: application/json
|
1412
|
+
|