ibm_cloud_power 1.0.1
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 +7 -0
- data/Gemfile +9 -0
- data/README.md +255 -0
- data/Rakefile +10 -0
- data/docs/CloneTaskReference.md +19 -0
- data/docs/CloneTaskStatus.md +23 -0
- data/docs/ClonedVolume.md +19 -0
- data/docs/ClonedVolumeDetail.md +19 -0
- data/docs/CloudInstance.md +37 -0
- data/docs/CloudInstanceCreate.md +29 -0
- data/docs/CloudInstanceReference.md +31 -0
- data/docs/CloudInstanceUpdate.md +25 -0
- data/docs/CloudInstanceUsageLimits.md +37 -0
- data/docs/CreateDataVolume.md +29 -0
- data/docs/CreateImage.md +37 -0
- data/docs/Error.md +19 -0
- data/docs/Event.md +33 -0
- data/docs/EventUser.md +21 -0
- data/docs/Events.md +17 -0
- data/docs/ExportImage.md +23 -0
- data/docs/IPAddressRange.md +19 -0
- data/docs/Image.md +39 -0
- data/docs/ImageReference.md +33 -0
- data/docs/ImageSpecifications.md +29 -0
- data/docs/ImageVolume.md +23 -0
- data/docs/Images.md +17 -0
- data/docs/MinMaxDefault.md +21 -0
- data/docs/MultiVolumesCreate.md +29 -0
- data/docs/Network.md +37 -0
- data/docs/NetworkCreate.md +29 -0
- data/docs/NetworkIpAddressMetrics.md +23 -0
- data/docs/NetworkPort.md +29 -0
- data/docs/NetworkPortCreate.md +19 -0
- data/docs/NetworkPortPvmInstance.md +19 -0
- data/docs/NetworkPortUpdate.md +19 -0
- data/docs/NetworkPorts.md +17 -0
- data/docs/NetworkReference.md +27 -0
- data/docs/NetworkUpdate.md +23 -0
- data/docs/Networks.md +17 -0
- data/docs/Operations.md +21 -0
- data/docs/PCloudEventsApi.md +114 -0
- data/docs/PCloudImagesApi.md +342 -0
- data/docs/PCloudInstancesApi.md +148 -0
- data/docs/PCloudNetworksApi.md +504 -0
- data/docs/PCloudPVMInstancesApi.md +809 -0
- data/docs/PCloudSAPApi.md +150 -0
- data/docs/PCloudSnapshotsApi.md +200 -0
- data/docs/PCloudSystemPoolsApi.md +54 -0
- data/docs/PCloudTasksApi.md +100 -0
- data/docs/PCloudTenantsApi.md +102 -0
- data/docs/PCloudTenantsSSHKeysApi.md +248 -0
- data/docs/PCloudVolumesApi.md +746 -0
- data/docs/PVMInstance.md +77 -0
- data/docs/PVMInstanceAction.md +17 -0
- data/docs/PVMInstanceAddNetwork.md +19 -0
- data/docs/PVMInstanceCapture.md +29 -0
- data/docs/PVMInstanceClone.md +31 -0
- data/docs/PVMInstanceConsole.md +17 -0
- data/docs/PVMInstanceCreate.md +53 -0
- data/docs/PVMInstanceFault.md +23 -0
- data/docs/PVMInstanceHealth.md +21 -0
- data/docs/PVMInstanceMultiCreate.md +21 -0
- data/docs/PVMInstanceNetwork.md +33 -0
- data/docs/PVMInstanceNetworks.md +17 -0
- data/docs/PVMInstanceOperation.md +19 -0
- data/docs/PVMInstanceReference.md +71 -0
- data/docs/PVMInstanceRemoveNetwork.md +17 -0
- data/docs/PVMInstanceUpdate.md +33 -0
- data/docs/PVMInstanceUpdateResponse.md +27 -0
- data/docs/PVMInstanceVolumeUpdate.md +17 -0
- data/docs/PVMInstances.md +17 -0
- data/docs/PeeringNetwork.md +21 -0
- data/docs/PinPolicy.md +16 -0
- data/docs/SAPCreate.md +33 -0
- data/docs/SAPProfile.md +25 -0
- data/docs/SAPProfileReference.md +19 -0
- data/docs/SAPProfiles.md +17 -0
- data/docs/SRC.md +19 -0
- data/docs/SSHKey.md +21 -0
- data/docs/SSHKeys.md +17 -0
- data/docs/Snapshot.md +35 -0
- data/docs/SnapshotCreate.md +21 -0
- data/docs/SnapshotCreateResponse.md +17 -0
- data/docs/SnapshotRestore.md +17 -0
- data/docs/SnapshotUpdate.md +19 -0
- data/docs/Snapshots.md +17 -0
- data/docs/SoftwareLicenses.md +25 -0
- data/docs/StockImage.md +21 -0
- data/docs/System.md +21 -0
- data/docs/SystemPool.md +31 -0
- data/docs/Task.md +33 -0
- data/docs/TaskReference.md +19 -0
- data/docs/Tenant.md +29 -0
- data/docs/TenantUpdate.md +19 -0
- data/docs/UpdateVolume.md +23 -0
- data/docs/VirtualCores.md +21 -0
- data/docs/Volume.md +41 -0
- data/docs/VolumeInfo.md +19 -0
- data/docs/VolumeReference.md +43 -0
- data/docs/Volumes.md +17 -0
- data/docs/VolumesClone.md +31 -0
- data/docs/VolumesCloneAsyncRequest.md +19 -0
- data/docs/VolumesCloneCancel.md +17 -0
- data/docs/VolumesCloneCreate.md +19 -0
- data/docs/VolumesCloneDetail.md +33 -0
- data/docs/VolumesCloneExecute.md +19 -0
- data/docs/VolumesCloneRequest.md +19 -0
- data/docs/VolumesCloneResponse.md +17 -0
- data/docs/VolumesClones.md +17 -0
- data/git_push.sh +58 -0
- data/ibm_cloud_power.gemspec +38 -0
- data/lib/ibm_cloud_power.rb +144 -0
- data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +163 -0
- data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +473 -0
- data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +210 -0
- data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +719 -0
- data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +1166 -0
- data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +216 -0
- data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +288 -0
- data/lib/ibm_cloud_power/api/p_cloud_system_pools_api.rb +82 -0
- data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +142 -0
- data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +150 -0
- data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +356 -0
- data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +1065 -0
- data/lib/ibm_cloud_power/api_client.rb +387 -0
- data/lib/ibm_cloud_power/api_error.rb +57 -0
- data/lib/ibm_cloud_power/configuration.rb +241 -0
- data/lib/ibm_cloud_power/models/clone_task_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/clone_task_status.rb +285 -0
- data/lib/ibm_cloud_power/models/cloned_volume.rb +219 -0
- data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +227 -0
- data/lib/ibm_cloud_power/models/cloud_instance.rb +361 -0
- data/lib/ibm_cloud_power/models/cloud_instance_create.rb +294 -0
- data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +315 -0
- data/lib/ibm_cloud_power/models/cloud_instance_update.rb +249 -0
- data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +334 -0
- data/lib/ibm_cloud_power/models/create_data_volume.rb +313 -0
- data/lib/ibm_cloud_power/models/create_image.rb +360 -0
- data/lib/ibm_cloud_power/models/error.rb +217 -0
- data/lib/ibm_cloud_power/models/event.rb +357 -0
- data/lib/ibm_cloud_power/models/event_user.rb +234 -0
- data/lib/ibm_cloud_power/models/events.rb +216 -0
- data/lib/ibm_cloud_power/models/export_image.rb +249 -0
- data/lib/ibm_cloud_power/models/image.rb +351 -0
- data/lib/ibm_cloud_power/models/image_reference.rb +333 -0
- data/lib/ibm_cloud_power/models/image_specifications.rb +269 -0
- data/lib/ibm_cloud_power/models/image_volume.rb +259 -0
- data/lib/ibm_cloud_power/models/images.rb +216 -0
- data/lib/ibm_cloud_power/models/ip_address_range.rb +229 -0
- data/lib/ibm_cloud_power/models/min_max_default.rb +244 -0
- data/lib/ibm_cloud_power/models/multi_volumes_create.rb +313 -0
- data/lib/ibm_cloud_power/models/network.rb +395 -0
- data/lib/ibm_cloud_power/models/network_create.rb +314 -0
- data/lib/ibm_cloud_power/models/network_ip_address_metrics.rb +260 -0
- data/lib/ibm_cloud_power/models/network_port.rb +293 -0
- data/lib/ibm_cloud_power/models/network_port_create.rb +219 -0
- data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +220 -0
- data/lib/ibm_cloud_power/models/network_port_update.rb +219 -0
- data/lib/ibm_cloud_power/models/network_ports.rb +216 -0
- data/lib/ibm_cloud_power/models/network_reference.rb +325 -0
- data/lib/ibm_cloud_power/models/network_update.rb +243 -0
- data/lib/ibm_cloud_power/models/networks.rb +216 -0
- data/lib/ibm_cloud_power/models/operations.rb +287 -0
- data/lib/ibm_cloud_power/models/peering_network.rb +241 -0
- data/lib/ibm_cloud_power/models/pin_policy.rb +37 -0
- data/lib/ibm_cloud_power/models/pvm_instance.rb +612 -0
- data/lib/ibm_cloud_power/models/pvm_instance_action.rb +248 -0
- data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +224 -0
- data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +317 -0
- data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +328 -0
- data/lib/ibm_cloud_power/models/pvm_instance_console.rb +214 -0
- data/lib/ibm_cloud_power/models/pvm_instance_create.rb +483 -0
- data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +240 -0
- data/lib/ibm_cloud_power/models/pvm_instance_health.rb +230 -0
- data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +279 -0
- data/lib/ibm_cloud_power/models/pvm_instance_network.rb +290 -0
- data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +216 -0
- data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +262 -0
- data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +566 -0
- data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +209 -0
- data/lib/ibm_cloud_power/models/pvm_instance_update.rb +322 -0
- data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +292 -0
- data/lib/ibm_cloud_power/models/pvm_instance_volume_update.rb +214 -0
- data/lib/ibm_cloud_power/models/pvm_instances.rb +216 -0
- data/lib/ibm_cloud_power/models/sap_create.rb +311 -0
- data/lib/ibm_cloud_power/models/sap_profile.rb +310 -0
- data/lib/ibm_cloud_power/models/sap_profile_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/sap_profiles.rb +216 -0
- data/lib/ibm_cloud_power/models/snapshot.rb +321 -0
- data/lib/ibm_cloud_power/models/snapshot_create.rb +236 -0
- data/lib/ibm_cloud_power/models/snapshot_create_response.rb +214 -0
- data/lib/ibm_cloud_power/models/snapshot_restore.rb +211 -0
- data/lib/ibm_cloud_power/models/snapshot_update.rb +219 -0
- data/lib/ibm_cloud_power/models/snapshots.rb +216 -0
- data/lib/ibm_cloud_power/models/software_licenses.rb +257 -0
- data/lib/ibm_cloud_power/models/src.rb +219 -0
- data/lib/ibm_cloud_power/models/ssh_key.rb +239 -0
- data/lib/ibm_cloud_power/models/ssh_keys.rb +216 -0
- data/lib/ibm_cloud_power/models/stock_image.rb +230 -0
- data/lib/ibm_cloud_power/models/system.rb +239 -0
- data/lib/ibm_cloud_power/models/system_pool.rb +277 -0
- data/lib/ibm_cloud_power/models/task.rb +334 -0
- data/lib/ibm_cloud_power/models/task_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/tenant.rb +295 -0
- data/lib/ibm_cloud_power/models/tenant_update.rb +221 -0
- data/lib/ibm_cloud_power/models/update_volume.rb +239 -0
- data/lib/ibm_cloud_power/models/virtual_cores.rb +253 -0
- data/lib/ibm_cloud_power/models/volume.rb +356 -0
- data/lib/ibm_cloud_power/models/volume_info.rb +219 -0
- data/lib/ibm_cloud_power/models/volume_reference.rb +396 -0
- data/lib/ibm_cloud_power/models/volumes.rb +216 -0
- data/lib/ibm_cloud_power/models/volumes_clone.rb +284 -0
- data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_cancel.rb +209 -0
- data/lib/ibm_cloud_power/models/volumes_clone_create.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_detail.rb +296 -0
- data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +224 -0
- data/lib/ibm_cloud_power/models/volumes_clone_request.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_response.rb +211 -0
- data/lib/ibm_cloud_power/models/volumes_clones.rb +211 -0
- data/lib/ibm_cloud_power/version.rb +15 -0
- data/spec/api/p_cloud_events_api_spec.rb +62 -0
- data/spec/api/p_cloud_images_api_spec.rb +117 -0
- data/spec/api/p_cloud_instances_api_spec.rb +69 -0
- data/spec/api/p_cloud_networks_api_spec.rb +161 -0
- data/spec/api/p_cloud_pvm_instances_api_spec.rb +240 -0
- data/spec/api/p_cloud_sap_api_spec.rb +70 -0
- data/spec/api/p_cloud_snapshots_api_spec.rb +83 -0
- data/spec/api/p_cloud_system_pools_api_spec.rb +46 -0
- data/spec/api/p_cloud_tasks_api_spec.rb +57 -0
- data/spec/api/p_cloud_tenants_api_spec.rb +58 -0
- data/spec/api/p_cloud_tenants_ssh_keys_api_spec.rb +95 -0
- data/spec/api/p_cloud_volumes_api_spec.rb +223 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/clone_task_reference_spec.rb +47 -0
- data/spec/models/clone_task_status_spec.rb +63 -0
- data/spec/models/cloned_volume_detail_spec.rb +47 -0
- data/spec/models/cloned_volume_spec.rb +47 -0
- data/spec/models/cloud_instance_create_spec.rb +77 -0
- data/spec/models/cloud_instance_reference_spec.rb +83 -0
- data/spec/models/cloud_instance_spec.rb +101 -0
- data/spec/models/cloud_instance_update_spec.rb +65 -0
- data/spec/models/cloud_instance_usage_limits_spec.rb +101 -0
- data/spec/models/create_data_volume_spec.rb +81 -0
- data/spec/models/create_image_spec.rb +109 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/event_spec.rb +93 -0
- data/spec/models/event_user_spec.rb +53 -0
- data/spec/models/events_spec.rb +41 -0
- data/spec/models/export_image_spec.rb +59 -0
- data/spec/models/image_reference_spec.rb +89 -0
- data/spec/models/image_spec.rb +107 -0
- data/spec/models/image_specifications_spec.rb +77 -0
- data/spec/models/image_volume_spec.rb +59 -0
- data/spec/models/images_spec.rb +41 -0
- data/spec/models/ip_address_range_spec.rb +47 -0
- data/spec/models/min_max_default_spec.rb +53 -0
- data/spec/models/multi_volumes_create_spec.rb +81 -0
- data/spec/models/network_create_spec.rb +81 -0
- data/spec/models/network_ip_address_metrics_spec.rb +59 -0
- data/spec/models/network_port_create_spec.rb +47 -0
- data/spec/models/network_port_pvm_instance_spec.rb +47 -0
- data/spec/models/network_port_spec.rb +77 -0
- data/spec/models/network_port_update_spec.rb +47 -0
- data/spec/models/network_ports_spec.rb +41 -0
- data/spec/models/network_reference_spec.rb +75 -0
- data/spec/models/network_spec.rb +105 -0
- data/spec/models/network_update_spec.rb +59 -0
- data/spec/models/networks_spec.rb +41 -0
- data/spec/models/operations_spec.rb +65 -0
- data/spec/models/peering_network_spec.rb +53 -0
- data/spec/models/pin_policy_spec.rb +35 -0
- data/spec/models/pvm_instance_action_spec.rb +45 -0
- data/spec/models/pvm_instance_add_network_spec.rb +47 -0
- data/spec/models/pvm_instance_capture_spec.rb +81 -0
- data/spec/models/pvm_instance_clone_spec.rb +87 -0
- data/spec/models/pvm_instance_console_spec.rb +41 -0
- data/spec/models/pvm_instance_create_spec.rb +161 -0
- data/spec/models/pvm_instance_fault_spec.rb +59 -0
- data/spec/models/pvm_instance_health_spec.rb +53 -0
- data/spec/models/pvm_instance_multi_create_spec.rb +61 -0
- data/spec/models/pvm_instance_network_spec.rb +89 -0
- data/spec/models/pvm_instance_networks_spec.rb +41 -0
- data/spec/models/pvm_instance_operation_spec.rb +51 -0
- data/spec/models/pvm_instance_reference_spec.rb +207 -0
- data/spec/models/pvm_instance_remove_network_spec.rb +41 -0
- data/spec/models/pvm_instance_spec.rb +225 -0
- data/spec/models/pvm_instance_update_response_spec.rb +75 -0
- data/spec/models/pvm_instance_update_spec.rb +93 -0
- data/spec/models/pvm_instance_volume_update_spec.rb +41 -0
- data/spec/models/pvm_instances_spec.rb +41 -0
- data/spec/models/sap_create_spec.rb +89 -0
- data/spec/models/sap_profile_reference_spec.rb +47 -0
- data/spec/models/sap_profile_spec.rb +69 -0
- data/spec/models/sap_profiles_spec.rb +41 -0
- data/spec/models/snapshot_create_response_spec.rb +41 -0
- data/spec/models/snapshot_create_spec.rb +53 -0
- data/spec/models/snapshot_restore_spec.rb +41 -0
- data/spec/models/snapshot_spec.rb +95 -0
- data/spec/models/snapshot_update_spec.rb +47 -0
- data/spec/models/snapshots_spec.rb +41 -0
- data/spec/models/software_licenses_spec.rb +65 -0
- data/spec/models/src_spec.rb +47 -0
- data/spec/models/ssh_key_spec.rb +53 -0
- data/spec/models/ssh_keys_spec.rb +41 -0
- data/spec/models/stock_image_spec.rb +53 -0
- data/spec/models/system_pool_spec.rb +83 -0
- data/spec/models/system_spec.rb +53 -0
- data/spec/models/task_reference_spec.rb +47 -0
- data/spec/models/task_spec.rb +89 -0
- data/spec/models/tenant_spec.rb +77 -0
- data/spec/models/tenant_update_spec.rb +47 -0
- data/spec/models/update_volume_spec.rb +59 -0
- data/spec/models/virtual_cores_spec.rb +53 -0
- data/spec/models/volume_info_spec.rb +47 -0
- data/spec/models/volume_reference_spec.rb +119 -0
- data/spec/models/volume_spec.rb +113 -0
- data/spec/models/volumes_clone_async_request_spec.rb +47 -0
- data/spec/models/volumes_clone_cancel_spec.rb +41 -0
- data/spec/models/volumes_clone_create_spec.rb +47 -0
- data/spec/models/volumes_clone_detail_spec.rb +89 -0
- data/spec/models/volumes_clone_execute_spec.rb +47 -0
- data/spec/models/volumes_clone_request_spec.rb +47 -0
- data/spec/models/volumes_clone_response_spec.rb +47 -0
- data/spec/models/volumes_clone_spec.rb +83 -0
- data/spec/models/volumes_clones_spec.rb +41 -0
- data/spec/models/volumes_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +519 -0
@@ -0,0 +1,29 @@
|
|
1
|
+
# IbmCloudPower::MultiVolumesCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Base name of the volume(s) |
|
8
|
+
**size** | **Integer** | Volume Size (GB) |
|
9
|
+
**count** | **Integer** | Number of volumes to create | [optional]
|
10
|
+
**shareable** | **Boolean** | Indicates if the volume is shareable between VMs | [optional]
|
11
|
+
**disk_type** | **String** | Type of Disk, required if affinityPolicy not used | [optional]
|
12
|
+
**affinity_policy** | **String** | Affinity policy for data volume being created; requires affinityVolume to be specified | [optional]
|
13
|
+
**affinity_volume** | **String** | Volume (ID or Name)to base volume affinity policy against; required if affinityPolicy provided | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'IbmCloudPower'
|
19
|
+
|
20
|
+
instance = IbmCloudPower::MultiVolumesCreate.new(name: null,
|
21
|
+
size: null,
|
22
|
+
count: null,
|
23
|
+
shareable: null,
|
24
|
+
disk_type: null,
|
25
|
+
affinity_policy: null,
|
26
|
+
affinity_volume: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
data/docs/Network.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# IbmCloudPower::Network
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**network_id** | **String** | Unique Network ID |
|
8
|
+
**name** | **String** | Network Name |
|
9
|
+
**type** | **String** | Type of Network {vlan, vxlan} | [default to 'vlan']
|
10
|
+
**vlan_id** | **Float** | VLAN ID |
|
11
|
+
**cidr** | **String** | Network in CIDR notation (192.168.0.0/24) |
|
12
|
+
**gateway** | **String** | Gateway IP Address | [optional]
|
13
|
+
**dns_servers** | **Array<String>** | DNS Servers |
|
14
|
+
**ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges |
|
15
|
+
**ip_address_metrics** | [**NetworkIpAddressMetrics**](NetworkIpAddressMetrics.md) | |
|
16
|
+
**public_ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | Public IP Address Ranges (for pub-vlan networks) | [optional]
|
17
|
+
**jumbo** | **Boolean** | MTU Jumbo Network enabled |
|
18
|
+
|
19
|
+
## Code Sample
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'IbmCloudPower'
|
23
|
+
|
24
|
+
instance = IbmCloudPower::Network.new(network_id: null,
|
25
|
+
name: null,
|
26
|
+
type: null,
|
27
|
+
vlan_id: null,
|
28
|
+
cidr: null,
|
29
|
+
gateway: null,
|
30
|
+
dns_servers: null,
|
31
|
+
ip_address_ranges: null,
|
32
|
+
ip_address_metrics: null,
|
33
|
+
public_ip_address_ranges: null,
|
34
|
+
jumbo: null)
|
35
|
+
```
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# IbmCloudPower::NetworkCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Network Name | [optional]
|
8
|
+
**type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) | [default to 'vlan']
|
9
|
+
**cidr** | **String** | Network in CIDR notation (192.168.0.0/24) | [optional]
|
10
|
+
**gateway** | **String** | Gateway IP Address | [optional]
|
11
|
+
**dns_servers** | **Array<String>** | DNS Servers | [optional]
|
12
|
+
**ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges | [optional]
|
13
|
+
**jumbo** | **Boolean** | Enable MTU Jumbo Network | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'IbmCloudPower'
|
19
|
+
|
20
|
+
instance = IbmCloudPower::NetworkCreate.new(name: null,
|
21
|
+
type: null,
|
22
|
+
cidr: null,
|
23
|
+
gateway: null,
|
24
|
+
dns_servers: null,
|
25
|
+
ip_address_ranges: null,
|
26
|
+
jumbo: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# IbmCloudPower::NetworkIpAddressMetrics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**available** | **Float** | Number of available IP addresses |
|
8
|
+
**used** | **Float** | Number of IP addresses currently in use |
|
9
|
+
**total** | **Float** | Total number of all IP addresses in all ipAddressRanges |
|
10
|
+
**utilization** | **Float** | Utilization of IP addresses in percent form (used / total) [0 - 100] |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'IbmCloudPower'
|
16
|
+
|
17
|
+
instance = IbmCloudPower::NetworkIpAddressMetrics.new(available: null,
|
18
|
+
used: null,
|
19
|
+
total: null,
|
20
|
+
utilization: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/NetworkPort.md
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# IbmCloudPower::NetworkPort
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**port_id** | **String** | The unique Port ID |
|
8
|
+
**description** | **String** | The description of the port (not unique or indexable) |
|
9
|
+
**status** | **String** | Te |
|
10
|
+
**mac_address** | **String** | The mac address of the network interface |
|
11
|
+
**ip_address** | **String** | The ip address of this port |
|
12
|
+
**pvm_instance** | [**NetworkPortPvmInstance**](NetworkPortPvmInstance.md) | | [optional]
|
13
|
+
**href** | **String** | Link to port resource | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'IbmCloudPower'
|
19
|
+
|
20
|
+
instance = IbmCloudPower::NetworkPort.new(port_id: null,
|
21
|
+
description: null,
|
22
|
+
status: null,
|
23
|
+
mac_address: null,
|
24
|
+
ip_address: null,
|
25
|
+
pvm_instance: null,
|
26
|
+
href: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::NetworkPortCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**description** | **String** | Description of the port (not unique or indexable) | [optional]
|
8
|
+
**ip_address** | **String** | The requested ip address of this port | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::NetworkPortCreate.new(description: null,
|
16
|
+
ip_address: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::NetworkPortPvmInstance
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**pvm_instance_id** | **String** | The attahed pvm-instance ID | [optional]
|
8
|
+
**href** | **String** | Link to pvm-instance resource | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::NetworkPortPvmInstance.new(pvm_instance_id: null,
|
16
|
+
href: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::NetworkPortUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**description** | **String** | Description of the port (not unique or indexable) | [optional]
|
8
|
+
**pvm_instance_id** | **String** | If supplied populated it attaches to the PVMInstanceID, if empty detaches from PVMInstanceID | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::NetworkPortUpdate.new(description: null,
|
16
|
+
pvm_instance_id: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# IbmCloudPower::NetworkPorts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**ports** | [**Array<NetworkPort>**](NetworkPort.md) | Network Ports |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'IbmCloudPower'
|
13
|
+
|
14
|
+
instance = IbmCloudPower::NetworkPorts.new(ports: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# IbmCloudPower::NetworkReference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**network_id** | **String** | Unique Network ID |
|
8
|
+
**name** | **String** | Network Name |
|
9
|
+
**vlan_id** | **Float** | VLAN ID |
|
10
|
+
**type** | **String** | Type of Network {pub-vlan, vlan, vxlan} | [default to 'vlan']
|
11
|
+
**jumbo** | **Boolean** | MTU Jumbo Network enabled |
|
12
|
+
**href** | **String** | Link to Network resource |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'IbmCloudPower'
|
18
|
+
|
19
|
+
instance = IbmCloudPower::NetworkReference.new(network_id: null,
|
20
|
+
name: null,
|
21
|
+
vlan_id: null,
|
22
|
+
type: null,
|
23
|
+
jumbo: null,
|
24
|
+
href: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# IbmCloudPower::NetworkUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Replaces the current Network Name | [optional]
|
8
|
+
**gateway** | **String** | Replaces the current Gateway IP Address | [optional]
|
9
|
+
**dns_servers** | **Array<String>** | Replaces the current DNS Servers | [optional]
|
10
|
+
**ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | Replaces the current IP Address Ranges | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'IbmCloudPower'
|
16
|
+
|
17
|
+
instance = IbmCloudPower::NetworkUpdate.new(name: null,
|
18
|
+
gateway: null,
|
19
|
+
dns_servers: null,
|
20
|
+
ip_address_ranges: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/Networks.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# IbmCloudPower::Networks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**networks** | [**Array<NetworkReference>**](NetworkReference.md) | Network References |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'IbmCloudPower'
|
13
|
+
|
14
|
+
instance = IbmCloudPower::Networks.new(networks: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/Operations.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# IbmCloudPower::Operations
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**boot_mode** | **String** | Name of the server boot mode a(Boot from disk using copy A), b(Boot from disk using copy B), c(Reserved for IBM lab use only), d(Boot from media/drives) | [optional]
|
8
|
+
**operating_mode** | **String** | Name of the server operating mode | [optional]
|
9
|
+
**task** | **String** | Name of the job task to execute | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'IbmCloudPower'
|
15
|
+
|
16
|
+
instance = IbmCloudPower::Operations.new(boot_mode: null,
|
17
|
+
operating_mode: null,
|
18
|
+
task: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,114 @@
|
|
1
|
+
# IbmCloudPower::PCloudEventsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**pcloud_events_get**](PCloudEventsApi.md#pcloud_events_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id} | Get a single event
|
8
|
+
[**pcloud_events_getsince**](PCloudEventsApi.md#pcloud_events_getsince) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events | Get events from this cloud instance since a specific timestamp
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
## pcloud_events_get
|
13
|
+
|
14
|
+
> Event pcloud_events_get(cloud_instance_id, event_id, opts)
|
15
|
+
|
16
|
+
Get a single event
|
17
|
+
|
18
|
+
### Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'ibm_cloud_power'
|
23
|
+
|
24
|
+
api_instance = IbmCloudPower::PCloudEventsApi.new
|
25
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
26
|
+
event_id = 'event_id_example' # String | Event ID
|
27
|
+
opts = {
|
28
|
+
accept_language: 'accept_language_example' # String | The language requested for the return document
|
29
|
+
}
|
30
|
+
|
31
|
+
begin
|
32
|
+
#Get a single event
|
33
|
+
result = api_instance.pcloud_events_get(cloud_instance_id, event_id, opts)
|
34
|
+
p result
|
35
|
+
rescue IbmCloudPower::ApiError => e
|
36
|
+
puts "Exception when calling PCloudEventsApi->pcloud_events_get: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
46
|
+
**event_id** | **String**| Event ID |
|
47
|
+
**accept_language** | **String**| The language requested for the return document | [optional]
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**Event**](Event.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
No authorization required
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: Not defined
|
60
|
+
- **Accept**: application/json
|
61
|
+
|
62
|
+
|
63
|
+
## pcloud_events_getsince
|
64
|
+
|
65
|
+
> Events pcloud_events_getsince(cloud_instance_id, time, opts)
|
66
|
+
|
67
|
+
Get events from this cloud instance since a specific timestamp
|
68
|
+
|
69
|
+
You must append the '?time=' query parameter to the cURL URL to get a list of events.
|
70
|
+
|
71
|
+
### Example
|
72
|
+
|
73
|
+
```ruby
|
74
|
+
# load the gem
|
75
|
+
require 'ibm_cloud_power'
|
76
|
+
|
77
|
+
api_instance = IbmCloudPower::PCloudEventsApi.new
|
78
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
79
|
+
time = 'time_example' # String | A time in either ISO 8601 or unix epoch format
|
80
|
+
opts = {
|
81
|
+
accept_language: 'accept_language_example' # String | The language requested for the return document
|
82
|
+
}
|
83
|
+
|
84
|
+
begin
|
85
|
+
#Get events from this cloud instance since a specific timestamp
|
86
|
+
result = api_instance.pcloud_events_getsince(cloud_instance_id, time, opts)
|
87
|
+
p result
|
88
|
+
rescue IbmCloudPower::ApiError => e
|
89
|
+
puts "Exception when calling PCloudEventsApi->pcloud_events_getsince: #{e}"
|
90
|
+
end
|
91
|
+
```
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
|
96
|
+
Name | Type | Description | Notes
|
97
|
+
------------- | ------------- | ------------- | -------------
|
98
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
99
|
+
**time** | **String**| A time in either ISO 8601 or unix epoch format |
|
100
|
+
**accept_language** | **String**| The language requested for the return document | [optional]
|
101
|
+
|
102
|
+
### Return type
|
103
|
+
|
104
|
+
[**Events**](Events.md)
|
105
|
+
|
106
|
+
### Authorization
|
107
|
+
|
108
|
+
No authorization required
|
109
|
+
|
110
|
+
### HTTP request headers
|
111
|
+
|
112
|
+
- **Content-Type**: Not defined
|
113
|
+
- **Accept**: application/json
|
114
|
+
|
@@ -0,0 +1,342 @@
|
|
1
|
+
# IbmCloudPower::PCloudImagesApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**pcloud_cloudinstances_images_delete**](PCloudImagesApi.md#pcloud_cloudinstances_images_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id} | Delete an image from a cloud instance
|
8
|
+
[**pcloud_cloudinstances_images_export_post**](PCloudImagesApi.md#pcloud_cloudinstances_images_export_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}/export | Export an image
|
9
|
+
[**pcloud_cloudinstances_images_get**](PCloudImagesApi.md#pcloud_cloudinstances_images_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id} | Detailed information of an image
|
10
|
+
[**pcloud_cloudinstances_images_getall**](PCloudImagesApi.md#pcloud_cloudinstances_images_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | List all of the images for this cloud instance
|
11
|
+
[**pcloud_cloudinstances_images_post**](PCloudImagesApi.md#pcloud_cloudinstances_images_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | Create a new image from available images
|
12
|
+
[**pcloud_images_get**](PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Detailed information of an available image
|
13
|
+
[**pcloud_images_getall**](PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | List all images available for copying into cloud instances
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
## pcloud_cloudinstances_images_delete
|
18
|
+
|
19
|
+
> Object pcloud_cloudinstances_images_delete(cloud_instance_id, image_id)
|
20
|
+
|
21
|
+
Delete an image from a cloud instance
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'ibm_cloud_power'
|
28
|
+
|
29
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
30
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
31
|
+
image_id = 'image_id_example' # String | Image ID of a image
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Delete an image from a cloud instance
|
35
|
+
result = api_instance.pcloud_cloudinstances_images_delete(cloud_instance_id, image_id)
|
36
|
+
p result
|
37
|
+
rescue IbmCloudPower::ApiError => e
|
38
|
+
puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_images_delete: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
48
|
+
**image_id** | **String**| Image ID of a image |
|
49
|
+
|
50
|
+
### Return type
|
51
|
+
|
52
|
+
**Object**
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
No authorization required
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: Not defined
|
61
|
+
- **Accept**: */*
|
62
|
+
|
63
|
+
|
64
|
+
## pcloud_cloudinstances_images_export_post
|
65
|
+
|
66
|
+
> Object pcloud_cloudinstances_images_export_post(cloud_instance_id, image_id, body)
|
67
|
+
|
68
|
+
Export an image
|
69
|
+
|
70
|
+
### Example
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'ibm_cloud_power'
|
75
|
+
|
76
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
77
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
78
|
+
image_id = 'image_id_example' # String | Image ID of a image
|
79
|
+
body = IbmCloudPower::ExportImage.new # ExportImage | Parameters for exporting an image
|
80
|
+
|
81
|
+
begin
|
82
|
+
#Export an image
|
83
|
+
result = api_instance.pcloud_cloudinstances_images_export_post(cloud_instance_id, image_id, body)
|
84
|
+
p result
|
85
|
+
rescue IbmCloudPower::ApiError => e
|
86
|
+
puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_images_export_post: #{e}"
|
87
|
+
end
|
88
|
+
```
|
89
|
+
|
90
|
+
### Parameters
|
91
|
+
|
92
|
+
|
93
|
+
Name | Type | Description | Notes
|
94
|
+
------------- | ------------- | ------------- | -------------
|
95
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
96
|
+
**image_id** | **String**| Image ID of a image |
|
97
|
+
**body** | [**ExportImage**](ExportImage.md)| Parameters for exporting an image |
|
98
|
+
|
99
|
+
### Return type
|
100
|
+
|
101
|
+
**Object**
|
102
|
+
|
103
|
+
### Authorization
|
104
|
+
|
105
|
+
No authorization required
|
106
|
+
|
107
|
+
### HTTP request headers
|
108
|
+
|
109
|
+
- **Content-Type**: application/json
|
110
|
+
- **Accept**: application/json
|
111
|
+
|
112
|
+
|
113
|
+
## pcloud_cloudinstances_images_get
|
114
|
+
|
115
|
+
> Image pcloud_cloudinstances_images_get(cloud_instance_id, image_id)
|
116
|
+
|
117
|
+
Detailed information of an image
|
118
|
+
|
119
|
+
### Example
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
# load the gem
|
123
|
+
require 'ibm_cloud_power'
|
124
|
+
|
125
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
126
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
127
|
+
image_id = 'image_id_example' # String | Image ID of a image
|
128
|
+
|
129
|
+
begin
|
130
|
+
#Detailed information of an image
|
131
|
+
result = api_instance.pcloud_cloudinstances_images_get(cloud_instance_id, image_id)
|
132
|
+
p result
|
133
|
+
rescue IbmCloudPower::ApiError => e
|
134
|
+
puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_images_get: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
### Parameters
|
139
|
+
|
140
|
+
|
141
|
+
Name | Type | Description | Notes
|
142
|
+
------------- | ------------- | ------------- | -------------
|
143
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
144
|
+
**image_id** | **String**| Image ID of a image |
|
145
|
+
|
146
|
+
### Return type
|
147
|
+
|
148
|
+
[**Image**](Image.md)
|
149
|
+
|
150
|
+
### Authorization
|
151
|
+
|
152
|
+
No authorization required
|
153
|
+
|
154
|
+
### HTTP request headers
|
155
|
+
|
156
|
+
- **Content-Type**: Not defined
|
157
|
+
- **Accept**: application/json
|
158
|
+
|
159
|
+
|
160
|
+
## pcloud_cloudinstances_images_getall
|
161
|
+
|
162
|
+
> Images pcloud_cloudinstances_images_getall(cloud_instance_id)
|
163
|
+
|
164
|
+
List all of the images for this cloud instance
|
165
|
+
|
166
|
+
### Example
|
167
|
+
|
168
|
+
```ruby
|
169
|
+
# load the gem
|
170
|
+
require 'ibm_cloud_power'
|
171
|
+
|
172
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
173
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
174
|
+
|
175
|
+
begin
|
176
|
+
#List all of the images for this cloud instance
|
177
|
+
result = api_instance.pcloud_cloudinstances_images_getall(cloud_instance_id)
|
178
|
+
p result
|
179
|
+
rescue IbmCloudPower::ApiError => e
|
180
|
+
puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_images_getall: #{e}"
|
181
|
+
end
|
182
|
+
```
|
183
|
+
|
184
|
+
### Parameters
|
185
|
+
|
186
|
+
|
187
|
+
Name | Type | Description | Notes
|
188
|
+
------------- | ------------- | ------------- | -------------
|
189
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
190
|
+
|
191
|
+
### Return type
|
192
|
+
|
193
|
+
[**Images**](Images.md)
|
194
|
+
|
195
|
+
### Authorization
|
196
|
+
|
197
|
+
No authorization required
|
198
|
+
|
199
|
+
### HTTP request headers
|
200
|
+
|
201
|
+
- **Content-Type**: Not defined
|
202
|
+
- **Accept**: application/json
|
203
|
+
|
204
|
+
|
205
|
+
## pcloud_cloudinstances_images_post
|
206
|
+
|
207
|
+
> Image pcloud_cloudinstances_images_post(cloud_instance_id, body)
|
208
|
+
|
209
|
+
Create a new image from available images
|
210
|
+
|
211
|
+
### Example
|
212
|
+
|
213
|
+
```ruby
|
214
|
+
# load the gem
|
215
|
+
require 'ibm_cloud_power'
|
216
|
+
|
217
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
218
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
219
|
+
body = IbmCloudPower::CreateImage.new # CreateImage | Parameters for the creation of a new image from available images
|
220
|
+
|
221
|
+
begin
|
222
|
+
#Create a new image from available images
|
223
|
+
result = api_instance.pcloud_cloudinstances_images_post(cloud_instance_id, body)
|
224
|
+
p result
|
225
|
+
rescue IbmCloudPower::ApiError => e
|
226
|
+
puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_images_post: #{e}"
|
227
|
+
end
|
228
|
+
```
|
229
|
+
|
230
|
+
### Parameters
|
231
|
+
|
232
|
+
|
233
|
+
Name | Type | Description | Notes
|
234
|
+
------------- | ------------- | ------------- | -------------
|
235
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
236
|
+
**body** | [**CreateImage**](CreateImage.md)| Parameters for the creation of a new image from available images |
|
237
|
+
|
238
|
+
### Return type
|
239
|
+
|
240
|
+
[**Image**](Image.md)
|
241
|
+
|
242
|
+
### Authorization
|
243
|
+
|
244
|
+
No authorization required
|
245
|
+
|
246
|
+
### HTTP request headers
|
247
|
+
|
248
|
+
- **Content-Type**: application/json
|
249
|
+
- **Accept**: application/json
|
250
|
+
|
251
|
+
|
252
|
+
## pcloud_images_get
|
253
|
+
|
254
|
+
> Images pcloud_images_get(image_id)
|
255
|
+
|
256
|
+
Detailed information of an available image
|
257
|
+
|
258
|
+
### Example
|
259
|
+
|
260
|
+
```ruby
|
261
|
+
# load the gem
|
262
|
+
require 'ibm_cloud_power'
|
263
|
+
|
264
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
265
|
+
image_id = 'image_id_example' # String | Image ID of a image
|
266
|
+
|
267
|
+
begin
|
268
|
+
#Detailed information of an available image
|
269
|
+
result = api_instance.pcloud_images_get(image_id)
|
270
|
+
p result
|
271
|
+
rescue IbmCloudPower::ApiError => e
|
272
|
+
puts "Exception when calling PCloudImagesApi->pcloud_images_get: #{e}"
|
273
|
+
end
|
274
|
+
```
|
275
|
+
|
276
|
+
### Parameters
|
277
|
+
|
278
|
+
|
279
|
+
Name | Type | Description | Notes
|
280
|
+
------------- | ------------- | ------------- | -------------
|
281
|
+
**image_id** | **String**| Image ID of a image |
|
282
|
+
|
283
|
+
### Return type
|
284
|
+
|
285
|
+
[**Images**](Images.md)
|
286
|
+
|
287
|
+
### Authorization
|
288
|
+
|
289
|
+
No authorization required
|
290
|
+
|
291
|
+
### HTTP request headers
|
292
|
+
|
293
|
+
- **Content-Type**: Not defined
|
294
|
+
- **Accept**: application/json
|
295
|
+
|
296
|
+
|
297
|
+
## pcloud_images_getall
|
298
|
+
|
299
|
+
> Images pcloud_images_getall(opts)
|
300
|
+
|
301
|
+
List all images available for copying into cloud instances
|
302
|
+
|
303
|
+
### Example
|
304
|
+
|
305
|
+
```ruby
|
306
|
+
# load the gem
|
307
|
+
require 'ibm_cloud_power'
|
308
|
+
|
309
|
+
api_instance = IbmCloudPower::PCloudImagesApi.new
|
310
|
+
opts = {
|
311
|
+
sap: true # Boolean | Include SAP images with get available stock images
|
312
|
+
}
|
313
|
+
|
314
|
+
begin
|
315
|
+
#List all images available for copying into cloud instances
|
316
|
+
result = api_instance.pcloud_images_getall(opts)
|
317
|
+
p result
|
318
|
+
rescue IbmCloudPower::ApiError => e
|
319
|
+
puts "Exception when calling PCloudImagesApi->pcloud_images_getall: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
|
326
|
+
Name | Type | Description | Notes
|
327
|
+
------------- | ------------- | ------------- | -------------
|
328
|
+
**sap** | **Boolean**| Include SAP images with get available stock images | [optional]
|
329
|
+
|
330
|
+
### Return type
|
331
|
+
|
332
|
+
[**Images**](Images.md)
|
333
|
+
|
334
|
+
### Authorization
|
335
|
+
|
336
|
+
No authorization required
|
337
|
+
|
338
|
+
### HTTP request headers
|
339
|
+
|
340
|
+
- **Content-Type**: Not defined
|
341
|
+
- **Accept**: application/json
|
342
|
+
|