ionoscloud 5.0.0 → 5.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 +4 -4
- data/docs/AttachedVolumes.md +30 -0
- data/docs/BackupUnit.md +26 -0
- data/docs/BackupUnitApi.md +595 -0
- data/docs/BackupUnitProperties.md +22 -0
- data/docs/BackupUnitSSO.md +18 -0
- data/docs/BackupUnits.md +24 -0
- data/docs/BalancedNics.md +30 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/Cdroms.md +30 -0
- data/docs/ConnectableDatacenter.md +22 -0
- data/docs/Contract.md +20 -0
- data/docs/ContractApi.md +89 -0
- data/docs/ContractProperties.md +26 -0
- data/docs/DataCenterApi.md +517 -0
- data/docs/DataCenterEntities.md +24 -0
- data/docs/Datacenter.md +28 -0
- data/docs/DatacenterElementMetadata.md +32 -0
- data/docs/DatacenterProperties.md +28 -0
- data/docs/Datacenters.md +30 -0
- data/docs/DefaultApi.md +84 -0
- data/docs/Error.md +20 -0
- data/docs/ErrorMessage.md +20 -0
- data/docs/FirewallRule.md +26 -0
- data/docs/FirewallRules.md +30 -0
- data/docs/FirewallruleProperties.md +34 -0
- data/docs/Group.md +26 -0
- data/docs/GroupEntities.md +20 -0
- data/docs/GroupMembers.md +24 -0
- data/docs/GroupProperties.md +36 -0
- data/docs/GroupShare.md +24 -0
- data/docs/GroupShareProperties.md +20 -0
- data/docs/GroupShares.md +24 -0
- data/docs/GroupUsers.md +24 -0
- data/docs/Groups.md +24 -0
- data/docs/IPBlocksApi.md +513 -0
- data/docs/IPFailover.md +20 -0
- data/docs/Image.md +26 -0
- data/docs/ImageApi.md +429 -0
- data/docs/ImageProperties.md +50 -0
- data/docs/Images.md +24 -0
- data/docs/Info.md +22 -0
- data/docs/IpBlock.md +26 -0
- data/docs/IpBlockProperties.md +26 -0
- data/docs/IpBlocks.md +24 -0
- data/docs/IpConsumer.md +30 -0
- data/docs/KubernetesApi.md +1513 -0
- data/docs/KubernetesAutoScaling.md +20 -0
- data/docs/KubernetesCluster.md +28 -0
- data/docs/KubernetesClusterEntities.md +18 -0
- data/docs/KubernetesClusterProperties.md +26 -0
- data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
- data/docs/KubernetesClusters.md +24 -0
- data/docs/KubernetesConfig.md +24 -0
- data/docs/KubernetesConfigProperties.md +18 -0
- data/docs/KubernetesMaintenanceWindow.md +20 -0
- data/docs/KubernetesNode.md +26 -0
- data/docs/KubernetesNodeMetadata.md +26 -0
- data/docs/KubernetesNodePool.md +26 -0
- data/docs/KubernetesNodePoolForPut.md +26 -0
- data/docs/KubernetesNodePoolLan.md +18 -0
- data/docs/KubernetesNodePoolProperties.md +50 -0
- data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
- data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
- data/docs/KubernetesNodePools.md +24 -0
- data/docs/KubernetesNodeProperties.md +22 -0
- data/docs/KubernetesNodes.md +24 -0
- data/docs/Label.md +26 -0
- data/docs/LabelApi.md +2355 -0
- data/docs/LabelProperties.md +26 -0
- data/docs/LabelResource.md +26 -0
- data/docs/LabelResourceProperties.md +20 -0
- data/docs/LabelResources.md +30 -0
- data/docs/Labels.md +24 -0
- data/docs/Lan.md +28 -0
- data/docs/LanApi.md +795 -0
- data/docs/LanEntities.md +18 -0
- data/docs/LanNics.md +30 -0
- data/docs/LanPost.md +28 -0
- data/docs/LanProperties.md +24 -0
- data/docs/LanPropertiesPost.md +24 -0
- data/docs/Lans.md +30 -0
- data/docs/LoadBalancerApi.md +883 -0
- data/docs/Loadbalancer.md +28 -0
- data/docs/LoadbalancerEntities.md +18 -0
- data/docs/LoadbalancerProperties.md +22 -0
- data/docs/Loadbalancers.md +30 -0
- data/docs/Location.md +26 -0
- data/docs/LocationApi.md +259 -0
- data/docs/LocationProperties.md +22 -0
- data/docs/Locations.md +24 -0
- data/docs/Nic.md +28 -0
- data/docs/NicApi.md +1087 -0
- data/docs/NicEntities.md +18 -0
- data/docs/NicProperties.md +30 -0
- data/docs/Nics.md +30 -0
- data/docs/NoStateMetaData.md +30 -0
- data/docs/PaginationLinks.md +22 -0
- data/docs/Peer.md +26 -0
- data/docs/PrivateCrossConnect.md +26 -0
- data/docs/PrivateCrossConnectApi.md +427 -0
- data/docs/PrivateCrossConnectProperties.md +24 -0
- data/docs/PrivateCrossConnects.md +24 -0
- data/docs/README.md +111 -0
- data/docs/Request.md +26 -0
- data/docs/RequestApi.md +267 -0
- data/docs/RequestMetadata.md +24 -0
- data/docs/RequestProperties.md +24 -0
- data/docs/RequestStatus.md +24 -0
- data/docs/RequestStatusMetadata.md +24 -0
- data/docs/RequestTarget.md +20 -0
- data/docs/Requests.md +30 -0
- data/docs/Resource.md +28 -0
- data/docs/ResourceEntities.md +18 -0
- data/docs/ResourceGroups.md +24 -0
- data/docs/ResourceLimits.md +50 -0
- data/docs/ResourceProperties.md +20 -0
- data/docs/ResourceReference.md +22 -0
- data/docs/Resources.md +24 -0
- data/docs/ResourcesUsers.md +24 -0
- data/docs/S3Key.md +26 -0
- data/docs/S3KeyMetadata.md +20 -0
- data/docs/S3KeyProperties.md +20 -0
- data/docs/S3Keys.md +24 -0
- data/docs/S3ObjectStorageSSO.md +18 -0
- data/docs/Server.md +28 -0
- data/docs/ServerApi.md +1573 -0
- data/docs/ServerEntities.md +22 -0
- data/docs/ServerProperties.md +32 -0
- data/docs/Servers.md +30 -0
- data/docs/Snapshot.md +26 -0
- data/docs/SnapshotApi.md +429 -0
- data/docs/SnapshotProperties.md +48 -0
- data/docs/Snapshots.md +24 -0
- data/docs/Type.md +15 -0
- data/docs/User.md +28 -0
- data/docs/UserManagementApi.md +2547 -0
- data/docs/UserMetadata.md +22 -0
- data/docs/UserProperties.md +34 -0
- data/docs/Users.md +24 -0
- data/docs/UsersEntities.md +20 -0
- data/docs/Volume.md +26 -0
- data/docs/VolumeApi.md +711 -0
- data/docs/VolumeProperties.md +54 -0
- data/docs/Volumes.md +30 -0
- data/docs/summary.md +295 -0
- data/gitbook.yaml +4 -0
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api_client.rb +1 -4
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
- data/lib/ionoscloud/models/type.rb +1 -0
- data/lib/ionoscloud/models/volume_properties.rb +14 -4
- data/lib/ionoscloud/version.rb +1 -1
- data/spec/models/backup_units_spec.rb +1 -1
- data/spec/models/datacenter_element_metadata_spec.rb +1 -1
- data/spec/models/firewallrule_properties_spec.rb +0 -12
- data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
- data/spec/models/kubernetes_node_spec.rb +1 -1
- data/spec/models/kubernetes_nodes_spec.rb +1 -1
- data/spec/models/label_resources_spec.rb +1 -1
- data/spec/models/labels_spec.rb +1 -1
- data/spec/models/loadbalancer_properties_spec.rb +0 -4
- data/spec/models/volume_properties_spec.rb +6 -0
- metadata +264 -120
- data/DOCS.md +0 -14618
- data/README.md +0 -55
@@ -0,0 +1,26 @@
|
|
1
|
+
# LabelProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | A Label Key | [optional] |
|
8
|
+
| **value** | **String** | A Label Value | [optional] |
|
9
|
+
| **resource_id** | **String** | The id of the resource | [optional] |
|
10
|
+
| **resource_type** | **String** | The type of the resource on which the label is applied. | [optional] |
|
11
|
+
| **resource_href** | **String** | URL to the Resource (absolute path) on which the label is applied. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::LabelProperties.new(
|
19
|
+
key: environment,
|
20
|
+
value: production,
|
21
|
+
resource_id: 700e1cab-99b2-4c30-ba8c-1d273ddba022,
|
22
|
+
resource_type: datacenter,
|
23
|
+
resource_href: https://<hostname>/datacenters/700e1cab-99b2-4c30-ba8c-1d273ddba022
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# LabelResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Label on a resource is identified using label key. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of object that has been created | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**NoStateMetaData**](NoStateMetaData.md) | | [optional] |
|
11
|
+
| **properties** | [**LabelResourceProperties**](LabelResourceProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::LabelResource.new(
|
19
|
+
id: environment,
|
20
|
+
type: null,
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# LabelResourceProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | A Label Key | [optional] |
|
8
|
+
| **value** | **String** | A Label Value | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::LabelResourceProperties.new(
|
16
|
+
key: environment,
|
17
|
+
value: production
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# LabelResources
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique representation for Label as a collection on a resource. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of resource within a collection | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the collection representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<LabelResource>**](LabelResource.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::LabelResources.new(
|
21
|
+
id: labels,
|
22
|
+
type: collection,
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
data/docs/Labels.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Labels
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique representation for Label as a collection of resource. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of resource within a collection | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the collection representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Label>**](Label.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Labels.new(
|
18
|
+
id: labels,
|
19
|
+
type: collection,
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Lan.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Lan
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**LanProperties**](LanProperties.md) | | |
|
12
|
+
| **entities** | [**LanEntities**](LanEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::Lan.new(
|
20
|
+
id: 5,
|
21
|
+
type: "lan",
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/LanApi.md
ADDED
@@ -0,0 +1,795 @@
|
|
1
|
+
# LanApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_lans_delete**](LanApi.md#datacenters_lans_delete) | **DELETE** /datacenters/{datacenterId}/lans/{lanId} | Delete a Lan. |
|
8
|
+
| [**datacenters_lans_find_by_id**](LanApi.md#datacenters_lans_find_by_id) | **GET** /datacenters/{datacenterId}/lans/{lanId} | Retrieve a Lan |
|
9
|
+
| [**datacenters_lans_get**](LanApi.md#datacenters_lans_get) | **GET** /datacenters/{datacenterId}/lans | List Lans |
|
10
|
+
| [**datacenters_lans_nics_find_by_id**](LanApi.md#datacenters_lans_nics_find_by_id) | **GET** /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId} | Retrieve a nic attached to lan |
|
11
|
+
| [**datacenters_lans_nics_get**](LanApi.md#datacenters_lans_nics_get) | **GET** /datacenters/{datacenterId}/lans/{lanId}/nics | List Lan Members |
|
12
|
+
| [**datacenters_lans_nics_post**](LanApi.md#datacenters_lans_nics_post) | **POST** /datacenters/{datacenterId}/lans/{lanId}/nics | Attach a nic |
|
13
|
+
| [**datacenters_lans_patch**](LanApi.md#datacenters_lans_patch) | **PATCH** /datacenters/{datacenterId}/lans/{lanId} | Partially modify a Lan |
|
14
|
+
| [**datacenters_lans_post**](LanApi.md#datacenters_lans_post) | **POST** /datacenters/{datacenterId}/lans | Create a Lan |
|
15
|
+
| [**datacenters_lans_put**](LanApi.md#datacenters_lans_put) | **PUT** /datacenters/{datacenterId}/lans/{lanId} | Modify a Lan |
|
16
|
+
|
17
|
+
|
18
|
+
## datacenters_lans_delete
|
19
|
+
|
20
|
+
> Object datacenters_lans_delete(datacenter_id, lan_id, opts)
|
21
|
+
|
22
|
+
Delete a Lan.
|
23
|
+
|
24
|
+
Removes the specific Lan
|
25
|
+
|
26
|
+
### Examples
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'time'
|
30
|
+
require 'ionoscloud'
|
31
|
+
# setup authorization
|
32
|
+
Ionoscloud.configure do |config|
|
33
|
+
# Configure HTTP basic authorization: Basic Authentication
|
34
|
+
config.username = 'YOUR USERNAME'
|
35
|
+
config.password = 'YOUR PASSWORD'
|
36
|
+
|
37
|
+
# Configure API key authorization: Token Authentication
|
38
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
39
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
40
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = Ionoscloud::LanApi.new
|
44
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
45
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
46
|
+
opts = {
|
47
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
48
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
49
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
50
|
+
}
|
51
|
+
|
52
|
+
begin
|
53
|
+
# Delete a Lan.
|
54
|
+
result = api_instance.datacenters_lans_delete(datacenter_id, lan_id, opts)
|
55
|
+
p result
|
56
|
+
rescue Ionoscloud::ApiError => e
|
57
|
+
puts "Error when calling LanApi->datacenters_lans_delete: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
#### Using the datacenters_lans_delete_with_http_info variant
|
62
|
+
|
63
|
+
This returns an Array which contains the response data, status code and headers.
|
64
|
+
|
65
|
+
> <Array(Object, Integer, Hash)> datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts)
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
begin
|
69
|
+
# Delete a Lan.
|
70
|
+
data, status_code, headers = api_instance.datacenters_lans_delete_with_http_info(datacenter_id, lan_id, opts)
|
71
|
+
p status_code # => 2xx
|
72
|
+
p headers # => { ... }
|
73
|
+
p data # => Object
|
74
|
+
rescue Ionoscloud::ApiError => e
|
75
|
+
puts "Error when calling LanApi->datacenters_lans_delete_with_http_info: #{e}"
|
76
|
+
end
|
77
|
+
```
|
78
|
+
|
79
|
+
### Parameters
|
80
|
+
|
81
|
+
| Name | Type | Description | Notes |
|
82
|
+
| ---- | ---- | ----------- | ----- |
|
83
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
84
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
85
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
86
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
87
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
**Object**
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
Basic Authentication, Token Authentication
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
103
|
+
## datacenters_lans_find_by_id
|
104
|
+
|
105
|
+
> <Lan> datacenters_lans_find_by_id(datacenter_id, lan_id, opts)
|
106
|
+
|
107
|
+
Retrieve a Lan
|
108
|
+
|
109
|
+
Retrieves the attributes of a given LAN
|
110
|
+
|
111
|
+
### Examples
|
112
|
+
|
113
|
+
```ruby
|
114
|
+
require 'time'
|
115
|
+
require 'ionoscloud'
|
116
|
+
# setup authorization
|
117
|
+
Ionoscloud.configure do |config|
|
118
|
+
# Configure HTTP basic authorization: Basic Authentication
|
119
|
+
config.username = 'YOUR USERNAME'
|
120
|
+
config.password = 'YOUR PASSWORD'
|
121
|
+
|
122
|
+
# Configure API key authorization: Token Authentication
|
123
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
125
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
126
|
+
end
|
127
|
+
|
128
|
+
api_instance = Ionoscloud::LanApi.new
|
129
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
130
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
131
|
+
opts = {
|
132
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
133
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
134
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
135
|
+
}
|
136
|
+
|
137
|
+
begin
|
138
|
+
# Retrieve a Lan
|
139
|
+
result = api_instance.datacenters_lans_find_by_id(datacenter_id, lan_id, opts)
|
140
|
+
p result
|
141
|
+
rescue Ionoscloud::ApiError => e
|
142
|
+
puts "Error when calling LanApi->datacenters_lans_find_by_id: #{e}"
|
143
|
+
end
|
144
|
+
```
|
145
|
+
|
146
|
+
#### Using the datacenters_lans_find_by_id_with_http_info variant
|
147
|
+
|
148
|
+
This returns an Array which contains the response data, status code and headers.
|
149
|
+
|
150
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts)
|
151
|
+
|
152
|
+
```ruby
|
153
|
+
begin
|
154
|
+
# Retrieve a Lan
|
155
|
+
data, status_code, headers = api_instance.datacenters_lans_find_by_id_with_http_info(datacenter_id, lan_id, opts)
|
156
|
+
p status_code # => 2xx
|
157
|
+
p headers # => { ... }
|
158
|
+
p data # => <Lan>
|
159
|
+
rescue Ionoscloud::ApiError => e
|
160
|
+
puts "Error when calling LanApi->datacenters_lans_find_by_id_with_http_info: #{e}"
|
161
|
+
end
|
162
|
+
```
|
163
|
+
|
164
|
+
### Parameters
|
165
|
+
|
166
|
+
| Name | Type | Description | Notes |
|
167
|
+
| ---- | ---- | ----------- | ----- |
|
168
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
169
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
170
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
171
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
172
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
173
|
+
|
174
|
+
### Return type
|
175
|
+
|
176
|
+
[**Lan**](Lan.md)
|
177
|
+
|
178
|
+
### Authorization
|
179
|
+
|
180
|
+
Basic Authentication, Token Authentication
|
181
|
+
|
182
|
+
### HTTP request headers
|
183
|
+
|
184
|
+
- **Content-Type**: Not defined
|
185
|
+
- **Accept**: application/json
|
186
|
+
|
187
|
+
|
188
|
+
## datacenters_lans_get
|
189
|
+
|
190
|
+
> <Lans> datacenters_lans_get(datacenter_id, opts)
|
191
|
+
|
192
|
+
List Lans
|
193
|
+
|
194
|
+
Retrieve a list of LANs within the datacenter
|
195
|
+
|
196
|
+
### Examples
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
require 'time'
|
200
|
+
require 'ionoscloud'
|
201
|
+
# setup authorization
|
202
|
+
Ionoscloud.configure do |config|
|
203
|
+
# Configure HTTP basic authorization: Basic Authentication
|
204
|
+
config.username = 'YOUR USERNAME'
|
205
|
+
config.password = 'YOUR PASSWORD'
|
206
|
+
|
207
|
+
# Configure API key authorization: Token Authentication
|
208
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
209
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
210
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
211
|
+
end
|
212
|
+
|
213
|
+
api_instance = Ionoscloud::LanApi.new
|
214
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
215
|
+
opts = {
|
216
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
217
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
218
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
219
|
+
offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
|
220
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
221
|
+
}
|
222
|
+
|
223
|
+
begin
|
224
|
+
# List Lans
|
225
|
+
result = api_instance.datacenters_lans_get(datacenter_id, opts)
|
226
|
+
p result
|
227
|
+
rescue Ionoscloud::ApiError => e
|
228
|
+
puts "Error when calling LanApi->datacenters_lans_get: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
#### Using the datacenters_lans_get_with_http_info variant
|
233
|
+
|
234
|
+
This returns an Array which contains the response data, status code and headers.
|
235
|
+
|
236
|
+
> <Array(<Lans>, Integer, Hash)> datacenters_lans_get_with_http_info(datacenter_id, opts)
|
237
|
+
|
238
|
+
```ruby
|
239
|
+
begin
|
240
|
+
# List Lans
|
241
|
+
data, status_code, headers = api_instance.datacenters_lans_get_with_http_info(datacenter_id, opts)
|
242
|
+
p status_code # => 2xx
|
243
|
+
p headers # => { ... }
|
244
|
+
p data # => <Lans>
|
245
|
+
rescue Ionoscloud::ApiError => e
|
246
|
+
puts "Error when calling LanApi->datacenters_lans_get_with_http_info: #{e}"
|
247
|
+
end
|
248
|
+
```
|
249
|
+
|
250
|
+
### Parameters
|
251
|
+
|
252
|
+
| Name | Type | Description | Notes |
|
253
|
+
| ---- | ---- | ----------- | ----- |
|
254
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
255
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
256
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
257
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
258
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
|
259
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
260
|
+
|
261
|
+
### Return type
|
262
|
+
|
263
|
+
[**Lans**](Lans.md)
|
264
|
+
|
265
|
+
### Authorization
|
266
|
+
|
267
|
+
Basic Authentication, Token Authentication
|
268
|
+
|
269
|
+
### HTTP request headers
|
270
|
+
|
271
|
+
- **Content-Type**: Not defined
|
272
|
+
- **Accept**: application/json
|
273
|
+
|
274
|
+
|
275
|
+
## datacenters_lans_nics_find_by_id
|
276
|
+
|
277
|
+
> <Nic> datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts)
|
278
|
+
|
279
|
+
Retrieve a nic attached to lan
|
280
|
+
|
281
|
+
This will retrieve the properties of an attached nic.
|
282
|
+
|
283
|
+
### Examples
|
284
|
+
|
285
|
+
```ruby
|
286
|
+
require 'time'
|
287
|
+
require 'ionoscloud'
|
288
|
+
# setup authorization
|
289
|
+
Ionoscloud.configure do |config|
|
290
|
+
# Configure HTTP basic authorization: Basic Authentication
|
291
|
+
config.username = 'YOUR USERNAME'
|
292
|
+
config.password = 'YOUR PASSWORD'
|
293
|
+
|
294
|
+
# Configure API key authorization: Token Authentication
|
295
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
296
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
297
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
298
|
+
end
|
299
|
+
|
300
|
+
api_instance = Ionoscloud::LanApi.new
|
301
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
302
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
303
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
304
|
+
opts = {
|
305
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
306
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
307
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
308
|
+
}
|
309
|
+
|
310
|
+
begin
|
311
|
+
# Retrieve a nic attached to lan
|
312
|
+
result = api_instance.datacenters_lans_nics_find_by_id(datacenter_id, lan_id, nic_id, opts)
|
313
|
+
p result
|
314
|
+
rescue Ionoscloud::ApiError => e
|
315
|
+
puts "Error when calling LanApi->datacenters_lans_nics_find_by_id: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
#### Using the datacenters_lans_nics_find_by_id_with_http_info variant
|
320
|
+
|
321
|
+
This returns an Array which contains the response data, status code and headers.
|
322
|
+
|
323
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts)
|
324
|
+
|
325
|
+
```ruby
|
326
|
+
begin
|
327
|
+
# Retrieve a nic attached to lan
|
328
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_find_by_id_with_http_info(datacenter_id, lan_id, nic_id, opts)
|
329
|
+
p status_code # => 2xx
|
330
|
+
p headers # => { ... }
|
331
|
+
p data # => <Nic>
|
332
|
+
rescue Ionoscloud::ApiError => e
|
333
|
+
puts "Error when calling LanApi->datacenters_lans_nics_find_by_id_with_http_info: #{e}"
|
334
|
+
end
|
335
|
+
```
|
336
|
+
|
337
|
+
### Parameters
|
338
|
+
|
339
|
+
| Name | Type | Description | Notes |
|
340
|
+
| ---- | ---- | ----------- | ----- |
|
341
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
342
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
343
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
344
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
345
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
346
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
347
|
+
|
348
|
+
### Return type
|
349
|
+
|
350
|
+
[**Nic**](Nic.md)
|
351
|
+
|
352
|
+
### Authorization
|
353
|
+
|
354
|
+
Basic Authentication, Token Authentication
|
355
|
+
|
356
|
+
### HTTP request headers
|
357
|
+
|
358
|
+
- **Content-Type**: Not defined
|
359
|
+
- **Accept**: application/json
|
360
|
+
|
361
|
+
|
362
|
+
## datacenters_lans_nics_get
|
363
|
+
|
364
|
+
> <LanNics> datacenters_lans_nics_get(datacenter_id, lan_id, opts)
|
365
|
+
|
366
|
+
List Lan Members
|
367
|
+
|
368
|
+
You can retrieve a list of nics attached to a lan
|
369
|
+
|
370
|
+
### Examples
|
371
|
+
|
372
|
+
```ruby
|
373
|
+
require 'time'
|
374
|
+
require 'ionoscloud'
|
375
|
+
# setup authorization
|
376
|
+
Ionoscloud.configure do |config|
|
377
|
+
# Configure HTTP basic authorization: Basic Authentication
|
378
|
+
config.username = 'YOUR USERNAME'
|
379
|
+
config.password = 'YOUR PASSWORD'
|
380
|
+
|
381
|
+
# Configure API key authorization: Token Authentication
|
382
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
383
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
384
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
385
|
+
end
|
386
|
+
|
387
|
+
api_instance = Ionoscloud::LanApi.new
|
388
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
389
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
390
|
+
opts = {
|
391
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
392
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
393
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
394
|
+
offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
|
395
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
396
|
+
}
|
397
|
+
|
398
|
+
begin
|
399
|
+
# List Lan Members
|
400
|
+
result = api_instance.datacenters_lans_nics_get(datacenter_id, lan_id, opts)
|
401
|
+
p result
|
402
|
+
rescue Ionoscloud::ApiError => e
|
403
|
+
puts "Error when calling LanApi->datacenters_lans_nics_get: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
#### Using the datacenters_lans_nics_get_with_http_info variant
|
408
|
+
|
409
|
+
This returns an Array which contains the response data, status code and headers.
|
410
|
+
|
411
|
+
> <Array(<LanNics>, Integer, Hash)> datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts)
|
412
|
+
|
413
|
+
```ruby
|
414
|
+
begin
|
415
|
+
# List Lan Members
|
416
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_get_with_http_info(datacenter_id, lan_id, opts)
|
417
|
+
p status_code # => 2xx
|
418
|
+
p headers # => { ... }
|
419
|
+
p data # => <LanNics>
|
420
|
+
rescue Ionoscloud::ApiError => e
|
421
|
+
puts "Error when calling LanApi->datacenters_lans_nics_get_with_http_info: #{e}"
|
422
|
+
end
|
423
|
+
```
|
424
|
+
|
425
|
+
### Parameters
|
426
|
+
|
427
|
+
| Name | Type | Description | Notes |
|
428
|
+
| ---- | ---- | ----------- | ----- |
|
429
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
430
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
431
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
432
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
433
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
434
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
|
435
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
436
|
+
|
437
|
+
### Return type
|
438
|
+
|
439
|
+
[**LanNics**](LanNics.md)
|
440
|
+
|
441
|
+
### Authorization
|
442
|
+
|
443
|
+
Basic Authentication, Token Authentication
|
444
|
+
|
445
|
+
### HTTP request headers
|
446
|
+
|
447
|
+
- **Content-Type**: Not defined
|
448
|
+
- **Accept**: application/json
|
449
|
+
|
450
|
+
|
451
|
+
## datacenters_lans_nics_post
|
452
|
+
|
453
|
+
> <Nic> datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts)
|
454
|
+
|
455
|
+
Attach a nic
|
456
|
+
|
457
|
+
This will attach a pre-existing nic to a lan.
|
458
|
+
|
459
|
+
### Examples
|
460
|
+
|
461
|
+
```ruby
|
462
|
+
require 'time'
|
463
|
+
require 'ionoscloud'
|
464
|
+
# setup authorization
|
465
|
+
Ionoscloud.configure do |config|
|
466
|
+
# Configure HTTP basic authorization: Basic Authentication
|
467
|
+
config.username = 'YOUR USERNAME'
|
468
|
+
config.password = 'YOUR PASSWORD'
|
469
|
+
|
470
|
+
# Configure API key authorization: Token Authentication
|
471
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
473
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
474
|
+
end
|
475
|
+
|
476
|
+
api_instance = Ionoscloud::LanApi.new
|
477
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
478
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
479
|
+
nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | Nic to be attached
|
480
|
+
opts = {
|
481
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
482
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
483
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
484
|
+
}
|
485
|
+
|
486
|
+
begin
|
487
|
+
# Attach a nic
|
488
|
+
result = api_instance.datacenters_lans_nics_post(datacenter_id, lan_id, nic, opts)
|
489
|
+
p result
|
490
|
+
rescue Ionoscloud::ApiError => e
|
491
|
+
puts "Error when calling LanApi->datacenters_lans_nics_post: #{e}"
|
492
|
+
end
|
493
|
+
```
|
494
|
+
|
495
|
+
#### Using the datacenters_lans_nics_post_with_http_info variant
|
496
|
+
|
497
|
+
This returns an Array which contains the response data, status code and headers.
|
498
|
+
|
499
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts)
|
500
|
+
|
501
|
+
```ruby
|
502
|
+
begin
|
503
|
+
# Attach a nic
|
504
|
+
data, status_code, headers = api_instance.datacenters_lans_nics_post_with_http_info(datacenter_id, lan_id, nic, opts)
|
505
|
+
p status_code # => 2xx
|
506
|
+
p headers # => { ... }
|
507
|
+
p data # => <Nic>
|
508
|
+
rescue Ionoscloud::ApiError => e
|
509
|
+
puts "Error when calling LanApi->datacenters_lans_nics_post_with_http_info: #{e}"
|
510
|
+
end
|
511
|
+
```
|
512
|
+
|
513
|
+
### Parameters
|
514
|
+
|
515
|
+
| Name | Type | Description | Notes |
|
516
|
+
| ---- | ---- | ----------- | ----- |
|
517
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
518
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
519
|
+
| **nic** | [**Nic**](Nic.md) | Nic to be attached | |
|
520
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
521
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
522
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
523
|
+
|
524
|
+
### Return type
|
525
|
+
|
526
|
+
[**Nic**](Nic.md)
|
527
|
+
|
528
|
+
### Authorization
|
529
|
+
|
530
|
+
Basic Authentication, Token Authentication
|
531
|
+
|
532
|
+
### HTTP request headers
|
533
|
+
|
534
|
+
- **Content-Type**: application/json
|
535
|
+
- **Accept**: application/json
|
536
|
+
|
537
|
+
|
538
|
+
## datacenters_lans_patch
|
539
|
+
|
540
|
+
> <Lan> datacenters_lans_patch(datacenter_id, lan_id, lan, opts)
|
541
|
+
|
542
|
+
Partially modify a Lan
|
543
|
+
|
544
|
+
You can use update attributes of a resource
|
545
|
+
|
546
|
+
### Examples
|
547
|
+
|
548
|
+
```ruby
|
549
|
+
require 'time'
|
550
|
+
require 'ionoscloud'
|
551
|
+
# setup authorization
|
552
|
+
Ionoscloud.configure do |config|
|
553
|
+
# Configure HTTP basic authorization: Basic Authentication
|
554
|
+
config.username = 'YOUR USERNAME'
|
555
|
+
config.password = 'YOUR PASSWORD'
|
556
|
+
|
557
|
+
# Configure API key authorization: Token Authentication
|
558
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
559
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
560
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
561
|
+
end
|
562
|
+
|
563
|
+
api_instance = Ionoscloud::LanApi.new
|
564
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
565
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
566
|
+
lan = Ionoscloud::LanProperties.new # LanProperties | Modified Lan
|
567
|
+
opts = {
|
568
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
569
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
570
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
571
|
+
}
|
572
|
+
|
573
|
+
begin
|
574
|
+
# Partially modify a Lan
|
575
|
+
result = api_instance.datacenters_lans_patch(datacenter_id, lan_id, lan, opts)
|
576
|
+
p result
|
577
|
+
rescue Ionoscloud::ApiError => e
|
578
|
+
puts "Error when calling LanApi->datacenters_lans_patch: #{e}"
|
579
|
+
end
|
580
|
+
```
|
581
|
+
|
582
|
+
#### Using the datacenters_lans_patch_with_http_info variant
|
583
|
+
|
584
|
+
This returns an Array which contains the response data, status code and headers.
|
585
|
+
|
586
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts)
|
587
|
+
|
588
|
+
```ruby
|
589
|
+
begin
|
590
|
+
# Partially modify a Lan
|
591
|
+
data, status_code, headers = api_instance.datacenters_lans_patch_with_http_info(datacenter_id, lan_id, lan, opts)
|
592
|
+
p status_code # => 2xx
|
593
|
+
p headers # => { ... }
|
594
|
+
p data # => <Lan>
|
595
|
+
rescue Ionoscloud::ApiError => e
|
596
|
+
puts "Error when calling LanApi->datacenters_lans_patch_with_http_info: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
### Parameters
|
601
|
+
|
602
|
+
| Name | Type | Description | Notes |
|
603
|
+
| ---- | ---- | ----------- | ----- |
|
604
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
605
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
606
|
+
| **lan** | [**LanProperties**](LanProperties.md) | Modified Lan | |
|
607
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
608
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
609
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
610
|
+
|
611
|
+
### Return type
|
612
|
+
|
613
|
+
[**Lan**](Lan.md)
|
614
|
+
|
615
|
+
### Authorization
|
616
|
+
|
617
|
+
Basic Authentication, Token Authentication
|
618
|
+
|
619
|
+
### HTTP request headers
|
620
|
+
|
621
|
+
- **Content-Type**: application/json
|
622
|
+
- **Accept**: application/json
|
623
|
+
|
624
|
+
|
625
|
+
## datacenters_lans_post
|
626
|
+
|
627
|
+
> <LanPost> datacenters_lans_post(datacenter_id, lan, opts)
|
628
|
+
|
629
|
+
Create a Lan
|
630
|
+
|
631
|
+
Creates a LAN within the datacenter
|
632
|
+
|
633
|
+
### Examples
|
634
|
+
|
635
|
+
```ruby
|
636
|
+
require 'time'
|
637
|
+
require 'ionoscloud'
|
638
|
+
# setup authorization
|
639
|
+
Ionoscloud.configure do |config|
|
640
|
+
# Configure HTTP basic authorization: Basic Authentication
|
641
|
+
config.username = 'YOUR USERNAME'
|
642
|
+
config.password = 'YOUR PASSWORD'
|
643
|
+
|
644
|
+
# Configure API key authorization: Token Authentication
|
645
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
646
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
647
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
648
|
+
end
|
649
|
+
|
650
|
+
api_instance = Ionoscloud::LanApi.new
|
651
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
652
|
+
lan = Ionoscloud::LanPost.new({properties: Ionoscloud::LanPropertiesPost.new}) # LanPost | Lan to be created
|
653
|
+
opts = {
|
654
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
655
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
656
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
657
|
+
}
|
658
|
+
|
659
|
+
begin
|
660
|
+
# Create a Lan
|
661
|
+
result = api_instance.datacenters_lans_post(datacenter_id, lan, opts)
|
662
|
+
p result
|
663
|
+
rescue Ionoscloud::ApiError => e
|
664
|
+
puts "Error when calling LanApi->datacenters_lans_post: #{e}"
|
665
|
+
end
|
666
|
+
```
|
667
|
+
|
668
|
+
#### Using the datacenters_lans_post_with_http_info variant
|
669
|
+
|
670
|
+
This returns an Array which contains the response data, status code and headers.
|
671
|
+
|
672
|
+
> <Array(<LanPost>, Integer, Hash)> datacenters_lans_post_with_http_info(datacenter_id, lan, opts)
|
673
|
+
|
674
|
+
```ruby
|
675
|
+
begin
|
676
|
+
# Create a Lan
|
677
|
+
data, status_code, headers = api_instance.datacenters_lans_post_with_http_info(datacenter_id, lan, opts)
|
678
|
+
p status_code # => 2xx
|
679
|
+
p headers # => { ... }
|
680
|
+
p data # => <LanPost>
|
681
|
+
rescue Ionoscloud::ApiError => e
|
682
|
+
puts "Error when calling LanApi->datacenters_lans_post_with_http_info: #{e}"
|
683
|
+
end
|
684
|
+
```
|
685
|
+
|
686
|
+
### Parameters
|
687
|
+
|
688
|
+
| Name | Type | Description | Notes |
|
689
|
+
| ---- | ---- | ----------- | ----- |
|
690
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
691
|
+
| **lan** | [**LanPost**](LanPost.md) | Lan to be created | |
|
692
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
693
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
694
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
695
|
+
|
696
|
+
### Return type
|
697
|
+
|
698
|
+
[**LanPost**](LanPost.md)
|
699
|
+
|
700
|
+
### Authorization
|
701
|
+
|
702
|
+
Basic Authentication, Token Authentication
|
703
|
+
|
704
|
+
### HTTP request headers
|
705
|
+
|
706
|
+
- **Content-Type**: application/json
|
707
|
+
- **Accept**: application/json
|
708
|
+
|
709
|
+
|
710
|
+
## datacenters_lans_put
|
711
|
+
|
712
|
+
> <Lan> datacenters_lans_put(datacenter_id, lan_id, lan, opts)
|
713
|
+
|
714
|
+
Modify a Lan
|
715
|
+
|
716
|
+
You can use update attributes of a resource
|
717
|
+
|
718
|
+
### Examples
|
719
|
+
|
720
|
+
```ruby
|
721
|
+
require 'time'
|
722
|
+
require 'ionoscloud'
|
723
|
+
# setup authorization
|
724
|
+
Ionoscloud.configure do |config|
|
725
|
+
# Configure HTTP basic authorization: Basic Authentication
|
726
|
+
config.username = 'YOUR USERNAME'
|
727
|
+
config.password = 'YOUR PASSWORD'
|
728
|
+
|
729
|
+
# Configure API key authorization: Token Authentication
|
730
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
731
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
732
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
733
|
+
end
|
734
|
+
|
735
|
+
api_instance = Ionoscloud::LanApi.new
|
736
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
737
|
+
lan_id = 'lan_id_example' # String | The unique ID of the LAN
|
738
|
+
lan = Ionoscloud::Lan.new({properties: Ionoscloud::LanProperties.new}) # Lan | Modified Lan
|
739
|
+
opts = {
|
740
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
741
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
742
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
743
|
+
}
|
744
|
+
|
745
|
+
begin
|
746
|
+
# Modify a Lan
|
747
|
+
result = api_instance.datacenters_lans_put(datacenter_id, lan_id, lan, opts)
|
748
|
+
p result
|
749
|
+
rescue Ionoscloud::ApiError => e
|
750
|
+
puts "Error when calling LanApi->datacenters_lans_put: #{e}"
|
751
|
+
end
|
752
|
+
```
|
753
|
+
|
754
|
+
#### Using the datacenters_lans_put_with_http_info variant
|
755
|
+
|
756
|
+
This returns an Array which contains the response data, status code and headers.
|
757
|
+
|
758
|
+
> <Array(<Lan>, Integer, Hash)> datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts)
|
759
|
+
|
760
|
+
```ruby
|
761
|
+
begin
|
762
|
+
# Modify a Lan
|
763
|
+
data, status_code, headers = api_instance.datacenters_lans_put_with_http_info(datacenter_id, lan_id, lan, opts)
|
764
|
+
p status_code # => 2xx
|
765
|
+
p headers # => { ... }
|
766
|
+
p data # => <Lan>
|
767
|
+
rescue Ionoscloud::ApiError => e
|
768
|
+
puts "Error when calling LanApi->datacenters_lans_put_with_http_info: #{e}"
|
769
|
+
end
|
770
|
+
```
|
771
|
+
|
772
|
+
### Parameters
|
773
|
+
|
774
|
+
| Name | Type | Description | Notes |
|
775
|
+
| ---- | ---- | ----------- | ----- |
|
776
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
777
|
+
| **lan_id** | **String** | The unique ID of the LAN | |
|
778
|
+
| **lan** | [**Lan**](Lan.md) | Modified Lan | |
|
779
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
780
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
781
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
782
|
+
|
783
|
+
### Return type
|
784
|
+
|
785
|
+
[**Lan**](Lan.md)
|
786
|
+
|
787
|
+
### Authorization
|
788
|
+
|
789
|
+
Basic Authentication, Token Authentication
|
790
|
+
|
791
|
+
### HTTP request headers
|
792
|
+
|
793
|
+
- **Content-Type**: application/json
|
794
|
+
- **Accept**: application/json
|
795
|
+
|