ionoscloud 5.0.0 → 6.0.0.beta.3

data/docs/Resource.md

@@ -0,0 +1,28 @@
+# Resource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**ResourceProperties**](ResourceProperties.md) |  | [optional] |
+| **entities** | [**ResourceEntities**](ResourceEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Resource.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "group",
+  href: https://<API_HOST>/cloudapi/v6/um/resources/datacenter/15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/ResourceEntities.md

@@ -0,0 +1,18 @@
+# ResourceEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | [**ResourceGroups**](ResourceGroups.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceEntities.new(
+  groups: null
+)
+```
+

data/docs/ResourceGroups.md

@@ -0,0 +1,24 @@
+# ResourceGroups
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceGroups.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v6/um/groups/30740c22-1def-11e7-aac9-d7a3646ca7fd/resources,
+  items: null
+)
+```
+

data/docs/ResourceLimits.md

@@ -0,0 +1,60 @@
+# ResourceLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores_per_server** | **Integer** | maximum number of cores per server |  |
+| **cores_per_contract** | **Integer** | maximum cores per contract |  |
+| **cores_provisioned** | **Integer** | number of cores provisioned |  |
+| **ram_per_server** | **Integer** | maximum ram per server |  |
+| **ram_per_contract** | **Integer** | maximum ram per contract |  |
+| **ram_provisioned** | **Integer** | ram provisioned |  |
+| **hdd_limit_per_volume** | **Integer** | hdd limit per volume |  |
+| **hdd_limit_per_contract** | **Integer** | hdd limit per contract |  |
+| **hdd_volume_provisioned** | **Integer** | hdd volume provisioned |  |
+| **ssd_limit_per_volume** | **Integer** | ssd limit per volume |  |
+| **ssd_limit_per_contract** | **Integer** | ssd limit per contract |  |
+| **ssd_volume_provisioned** | **Integer** | ssd volume provisioned |  |
+| **das_volume_provisioned** | **Integer** | DAS (Direct Attached Storage) volume provisioned |  |
+| **reservable_ips** | **Integer** | total reservable ip limit of the customer |  |
+| **reserved_ips_on_contract** | **Integer** | reserved ips on a contract |  |
+| **reserved_ips_in_use** | **Integer** | reserved ips in use |  |
+| **k8s_cluster_limit_total** | **Integer** | k8s clusters total limit |  |
+| **k8s_clusters_provisioned** | **Integer** | k8s clusters provisioned |  |
+| **nlb_limit_total** | **Integer** | NLB total limit |  |
+| **nlb_provisioned** | **Integer** | NLBs provisioned |  |
+| **nat_gateway_limit_total** | **Integer** | NAT gateway total limit |  |
+| **nat_gateway_provisioned** | **Integer** | NAT gateways provisioned |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceLimits.new(
+  cores_per_server: null,
+  cores_per_contract: null,
+  cores_provisioned: null,
+  ram_per_server: null,
+  ram_per_contract: null,
+  ram_provisioned: null,
+  hdd_limit_per_volume: null,
+  hdd_limit_per_contract: null,
+  hdd_volume_provisioned: null,
+  ssd_limit_per_volume: null,
+  ssd_limit_per_contract: null,
+  ssd_volume_provisioned: null,
+  das_volume_provisioned: null,
+  reservable_ips: null,
+  reserved_ips_on_contract: null,
+  reserved_ips_in_use: null,
+  k8s_cluster_limit_total: null,
+  k8s_clusters_provisioned: null,
+  nlb_limit_total: null,
+  nlb_provisioned: null,
+  nat_gateway_limit_total: null,
+  nat_gateway_provisioned: null
+)
+```
+

data/docs/ResourceProperties.md

@@ -0,0 +1,20 @@
+# ResourceProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | name of the resource | [optional] |
+| **sec_auth_protection** | **Boolean** | Boolean value representing if the resource is multi factor protected or not e.g. using two factor protection. Currently only Data Centers and Snapshots are allowed to be multi factor protected, The value of attribute if null is intentional and it means that the resource doesn't support multi factor protection at all. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceProperties.new(
+  name: null,
+  sec_auth_protection: true
+)
+```
+

data/docs/ResourceReference.md

@@ -0,0 +1,22 @@
+# ResourceReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier |  |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourceReference.new(
+  id: null,
+  type: "resource",
+  href: <RESOURCE-URI>
+)
+```
+

data/docs/Resources.md

@@ -0,0 +1,24 @@
+# Resources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Resources.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v6/um/resources,
+  items: null
+)
+```
+

data/docs/ResourcesUsers.md

@@ -0,0 +1,24 @@
+# ResourcesUsers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Resource>**](Resource.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ResourcesUsers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/owns,
+  items: null
+)
+```
+

data/docs/S3Key.md

@@ -0,0 +1,26 @@
+# S3Key
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**S3KeyMetadata**](S3KeyMetadata.md) |  | [optional] |
+| **properties** | [**S3KeyProperties**](S3KeyProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3Key.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "group",
+  href: https://<API_HOST>/cloudapi/v6/um/users/15f67991-0f51-4efc-a8ad-ef1fb31a480c/s3keys/78fa888e106456c1482d,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/S3KeyMetadata.md

@@ -0,0 +1,20 @@
+# S3KeyMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.  | [optional][readonly] |
+| **created_date** | **Time** | The time the S3 key was created | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3KeyMetadata.new(
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  created_date: 2015-12-04T14:34:09.809Z
+)
+```
+

data/docs/S3KeyProperties.md

@@ -0,0 +1,20 @@
+# S3KeyProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **secret_key** | **String** | secret of the S3 key | [optional][readonly] |
+| **active** | **Boolean** | denotes if the S3 key is active or not | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3KeyProperties.new(
+  secret_key: tFVkUARsoeCdntQs2jVSyGG6TMPfPZ+ghnsWj/gG,
+  active: null
+)
+```
+

data/docs/S3Keys.md

@@ -0,0 +1,24 @@
+# S3Keys
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<S3Key>**](S3Key.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3Keys.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: https://<API_HOST>/cloudapi/v6/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/s3keys,
+  items: null
+)
+```
+

data/docs/S3ObjectStorageSSO.md

@@ -0,0 +1,18 @@
+# S3ObjectStorageSSO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sso_url** | **String** | The S3 object storage single sign on url | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::S3ObjectStorageSSO.new(
+  sso_url: https://<hostname>:port/ssosecurelogin.htm?user=dcf5702f-9353-47AN5-_x7E.....htm
+)
+```
+

data/docs/Server.md

@@ -0,0 +1,28 @@
+# Server
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**ServerProperties**](ServerProperties.md) |  |  |
+| **entities** | [**ServerEntities**](ServerEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Server.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "server",
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/ServerEntities.md

@@ -0,0 +1,22 @@
+# ServerEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cdroms** | [**Cdroms**](Cdroms.md) |  | [optional] |
+| **volumes** | [**AttachedVolumes**](AttachedVolumes.md) |  | [optional] |
+| **nics** | [**Nics**](Nics.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ServerEntities.new(
+  cdroms: null,
+  volumes: null,
+  nics: null
+)
+```
+

data/docs/ServerProperties.md

@@ -0,0 +1,36 @@
+# ServerProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_uuid** | **String** | The UUID of the template for creating a CUBE server; the available templates for CUBE servers can be found on the templates resource | [optional] |
+| **name** | **String** | A name of that resource | [optional] |
+| **cores** | **Integer** | The total number of cores for the server |  |
+| **ram** | **Integer** | The amount of memory for the server in MB, e.g. 2048. Size must be specified in multiples of 256 MB with a minimum of 256 MB; however, if you set ramHotPlug to TRUE then you must use a minimum of 1024 MB. If you set the RAM size more than 240GB, then ramHotPlug will be set to FALSE and can not be set to TRUE unless RAM size not set to less than 240GB. |  |
+| **availability_zone** | **String** | The availability zone in which the server should exist | [optional] |
+| **vm_state** | **String** | Status of the virtual Machine | [optional][readonly] |
+| **boot_cdrom** | [**ResourceReference**](ResourceReference.md) |  | [optional] |
+| **boot_volume** | [**ResourceReference**](ResourceReference.md) |  | [optional] |
+| **cpu_family** | **String** | CPU architecture on which server gets provisioned; not all CPU architectures are available in all datacenter regions; available CPU architectures can be retrieved from the datacenter resource | [optional] |
+| **type** | **String** | server usages: ENTERPRISE or CUBE | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::ServerProperties.new(
+  template_uuid: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  name: My resource,
+  cores: 4,
+  ram: 4096,
+  availability_zone: AUTO,
+  vm_state: RUNNING,
+  boot_cdrom: null,
+  boot_volume: null,
+  cpu_family: AMD_OPTERON,
+  type: CUBE
+)
+```
+

data/docs/Servers.md

@@ -0,0 +1,30 @@
+# Servers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier | [optional][readonly] |
+| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<Server>**](Server.md) | Array of items in that collection | [optional][readonly] |
+| **offset** | **Float** | the offset (if specified in the request) | [optional] |
+| **limit** | **Float** | the limit (if specified in the request) | [optional] |
+| **_links** | [**PaginationLinks**](PaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::Servers.new(
+  id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
+  type: "collection",
+  href: <RESOURCE-URI>,
+  items: null,
+  offset: 0,
+  limit: 1000,
+  _links: null
+)
+```
+