ionoscloud 5.0.0 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/docs/NicApi.md
ADDED
@@ -0,0 +1,1087 @@
|
|
1
|
+
# NicApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_servers_nics_delete**](NicApi.md#datacenters_servers_nics_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Delete a Nic |
|
8
|
+
| [**datacenters_servers_nics_find_by_id**](NicApi.md#datacenters_servers_nics_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Retrieve a Nic |
|
9
|
+
| [**datacenters_servers_nics_firewallrules_delete**](NicApi.md#datacenters_servers_nics_firewallrules_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Delete a Firewall Rule |
|
10
|
+
| [**datacenters_servers_nics_firewallrules_find_by_id**](NicApi.md#datacenters_servers_nics_firewallrules_find_by_id) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Retrieve a Firewall Rule |
|
11
|
+
| [**datacenters_servers_nics_firewallrules_get**](NicApi.md#datacenters_servers_nics_firewallrules_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules | List Firewall Rules |
|
12
|
+
| [**datacenters_servers_nics_firewallrules_patch**](NicApi.md#datacenters_servers_nics_firewallrules_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Partially modify a Firewall Rule |
|
13
|
+
| [**datacenters_servers_nics_firewallrules_post**](NicApi.md#datacenters_servers_nics_firewallrules_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules | Create a Firewall Rule |
|
14
|
+
| [**datacenters_servers_nics_firewallrules_put**](NicApi.md#datacenters_servers_nics_firewallrules_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Modify a Firewall Rule |
|
15
|
+
| [**datacenters_servers_nics_get**](NicApi.md#datacenters_servers_nics_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/nics | List Nics |
|
16
|
+
| [**datacenters_servers_nics_patch**](NicApi.md#datacenters_servers_nics_patch) | **PATCH** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Partially modify a Nic |
|
17
|
+
| [**datacenters_servers_nics_post**](NicApi.md#datacenters_servers_nics_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/nics | Create a Nic |
|
18
|
+
| [**datacenters_servers_nics_put**](NicApi.md#datacenters_servers_nics_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId} | Modify a Nic |
|
19
|
+
|
20
|
+
|
21
|
+
## datacenters_servers_nics_delete
|
22
|
+
|
23
|
+
> Object datacenters_servers_nics_delete(datacenter_id, server_id, nic_id, opts)
|
24
|
+
|
25
|
+
Delete a Nic
|
26
|
+
|
27
|
+
Deletes the specified NIC.
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'time'
|
33
|
+
require 'ionoscloud'
|
34
|
+
# setup authorization
|
35
|
+
Ionoscloud.configure do |config|
|
36
|
+
# Configure HTTP basic authorization: Basic Authentication
|
37
|
+
config.username = 'YOUR USERNAME'
|
38
|
+
config.password = 'YOUR PASSWORD'
|
39
|
+
|
40
|
+
# Configure API key authorization: Token Authentication
|
41
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
42
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
43
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
44
|
+
end
|
45
|
+
|
46
|
+
api_instance = Ionoscloud::NicApi.new
|
47
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
48
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
49
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
50
|
+
opts = {
|
51
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
52
|
+
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
|
53
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
54
|
+
}
|
55
|
+
|
56
|
+
begin
|
57
|
+
# Delete a Nic
|
58
|
+
result = api_instance.datacenters_servers_nics_delete(datacenter_id, server_id, nic_id, opts)
|
59
|
+
p result
|
60
|
+
rescue Ionoscloud::ApiError => e
|
61
|
+
puts "Error when calling NicApi->datacenters_servers_nics_delete: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
#### Using the datacenters_servers_nics_delete_with_http_info variant
|
66
|
+
|
67
|
+
This returns an Array which contains the response data, status code and headers.
|
68
|
+
|
69
|
+
> <Array(Object, Integer, Hash)> datacenters_servers_nics_delete_with_http_info(datacenter_id, server_id, nic_id, opts)
|
70
|
+
|
71
|
+
```ruby
|
72
|
+
begin
|
73
|
+
# Delete a Nic
|
74
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_delete_with_http_info(datacenter_id, server_id, nic_id, opts)
|
75
|
+
p status_code # => 2xx
|
76
|
+
p headers # => { ... }
|
77
|
+
p data # => Object
|
78
|
+
rescue Ionoscloud::ApiError => e
|
79
|
+
puts "Error when calling NicApi->datacenters_servers_nics_delete_with_http_info: #{e}"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
### Parameters
|
84
|
+
|
85
|
+
| Name | Type | Description | Notes |
|
86
|
+
| ---- | ---- | ----------- | ----- |
|
87
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
88
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
89
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
90
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
91
|
+
| **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] |
|
92
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
93
|
+
|
94
|
+
### Return type
|
95
|
+
|
96
|
+
**Object**
|
97
|
+
|
98
|
+
### Authorization
|
99
|
+
|
100
|
+
Basic Authentication, Token Authentication
|
101
|
+
|
102
|
+
### HTTP request headers
|
103
|
+
|
104
|
+
- **Content-Type**: Not defined
|
105
|
+
- **Accept**: application/json
|
106
|
+
|
107
|
+
|
108
|
+
## datacenters_servers_nics_find_by_id
|
109
|
+
|
110
|
+
> <Nic> datacenters_servers_nics_find_by_id(datacenter_id, server_id, nic_id, opts)
|
111
|
+
|
112
|
+
Retrieve a Nic
|
113
|
+
|
114
|
+
Retrieves the attributes of a given NIC
|
115
|
+
|
116
|
+
### Examples
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
require 'time'
|
120
|
+
require 'ionoscloud'
|
121
|
+
# setup authorization
|
122
|
+
Ionoscloud.configure do |config|
|
123
|
+
# Configure HTTP basic authorization: Basic Authentication
|
124
|
+
config.username = 'YOUR USERNAME'
|
125
|
+
config.password = 'YOUR PASSWORD'
|
126
|
+
|
127
|
+
# Configure API key authorization: Token Authentication
|
128
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
129
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
130
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
131
|
+
end
|
132
|
+
|
133
|
+
api_instance = Ionoscloud::NicApi.new
|
134
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
135
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
136
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
137
|
+
opts = {
|
138
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
139
|
+
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
|
140
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
141
|
+
}
|
142
|
+
|
143
|
+
begin
|
144
|
+
# Retrieve a Nic
|
145
|
+
result = api_instance.datacenters_servers_nics_find_by_id(datacenter_id, server_id, nic_id, opts)
|
146
|
+
p result
|
147
|
+
rescue Ionoscloud::ApiError => e
|
148
|
+
puts "Error when calling NicApi->datacenters_servers_nics_find_by_id: #{e}"
|
149
|
+
end
|
150
|
+
```
|
151
|
+
|
152
|
+
#### Using the datacenters_servers_nics_find_by_id_with_http_info variant
|
153
|
+
|
154
|
+
This returns an Array which contains the response data, status code and headers.
|
155
|
+
|
156
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_servers_nics_find_by_id_with_http_info(datacenter_id, server_id, nic_id, opts)
|
157
|
+
|
158
|
+
```ruby
|
159
|
+
begin
|
160
|
+
# Retrieve a Nic
|
161
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_find_by_id_with_http_info(datacenter_id, server_id, nic_id, opts)
|
162
|
+
p status_code # => 2xx
|
163
|
+
p headers # => { ... }
|
164
|
+
p data # => <Nic>
|
165
|
+
rescue Ionoscloud::ApiError => e
|
166
|
+
puts "Error when calling NicApi->datacenters_servers_nics_find_by_id_with_http_info: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
| Name | Type | Description | Notes |
|
173
|
+
| ---- | ---- | ----------- | ----- |
|
174
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
175
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
176
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
177
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
178
|
+
| **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] |
|
179
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
[**Nic**](Nic.md)
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
Basic Authentication, Token Authentication
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: Not defined
|
192
|
+
- **Accept**: application/json
|
193
|
+
|
194
|
+
|
195
|
+
## datacenters_servers_nics_firewallrules_delete
|
196
|
+
|
197
|
+
> Object datacenters_servers_nics_firewallrules_delete(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
198
|
+
|
199
|
+
Delete a Firewall Rule
|
200
|
+
|
201
|
+
Removes the specific Firewall Rule
|
202
|
+
|
203
|
+
### Examples
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
require 'time'
|
207
|
+
require 'ionoscloud'
|
208
|
+
# setup authorization
|
209
|
+
Ionoscloud.configure do |config|
|
210
|
+
# Configure HTTP basic authorization: Basic Authentication
|
211
|
+
config.username = 'YOUR USERNAME'
|
212
|
+
config.password = 'YOUR PASSWORD'
|
213
|
+
|
214
|
+
# Configure API key authorization: Token Authentication
|
215
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
217
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
218
|
+
end
|
219
|
+
|
220
|
+
api_instance = Ionoscloud::NicApi.new
|
221
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
222
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
223
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
224
|
+
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the Firewall Rule
|
225
|
+
opts = {
|
226
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
227
|
+
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
|
228
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
229
|
+
}
|
230
|
+
|
231
|
+
begin
|
232
|
+
# Delete a Firewall Rule
|
233
|
+
result = api_instance.datacenters_servers_nics_firewallrules_delete(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
234
|
+
p result
|
235
|
+
rescue Ionoscloud::ApiError => e
|
236
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_delete: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
#### Using the datacenters_servers_nics_firewallrules_delete_with_http_info variant
|
241
|
+
|
242
|
+
This returns an Array which contains the response data, status code and headers.
|
243
|
+
|
244
|
+
> <Array(Object, Integer, Hash)> datacenters_servers_nics_firewallrules_delete_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
begin
|
248
|
+
# Delete a Firewall Rule
|
249
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_delete_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
250
|
+
p status_code # => 2xx
|
251
|
+
p headers # => { ... }
|
252
|
+
p data # => Object
|
253
|
+
rescue Ionoscloud::ApiError => e
|
254
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_delete_with_http_info: #{e}"
|
255
|
+
end
|
256
|
+
```
|
257
|
+
|
258
|
+
### Parameters
|
259
|
+
|
260
|
+
| Name | Type | Description | Notes |
|
261
|
+
| ---- | ---- | ----------- | ----- |
|
262
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
263
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
264
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
265
|
+
| **firewallrule_id** | **String** | The unique ID of the Firewall Rule | |
|
266
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
267
|
+
| **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] |
|
268
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
269
|
+
|
270
|
+
### Return type
|
271
|
+
|
272
|
+
**Object**
|
273
|
+
|
274
|
+
### Authorization
|
275
|
+
|
276
|
+
Basic Authentication, Token Authentication
|
277
|
+
|
278
|
+
### HTTP request headers
|
279
|
+
|
280
|
+
- **Content-Type**: Not defined
|
281
|
+
- **Accept**: application/json
|
282
|
+
|
283
|
+
|
284
|
+
## datacenters_servers_nics_firewallrules_find_by_id
|
285
|
+
|
286
|
+
> <FirewallRule> datacenters_servers_nics_firewallrules_find_by_id(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
287
|
+
|
288
|
+
Retrieve a Firewall Rule
|
289
|
+
|
290
|
+
Retrieves the attributes of a given Firewall Rule.
|
291
|
+
|
292
|
+
### Examples
|
293
|
+
|
294
|
+
```ruby
|
295
|
+
require 'time'
|
296
|
+
require 'ionoscloud'
|
297
|
+
# setup authorization
|
298
|
+
Ionoscloud.configure do |config|
|
299
|
+
# Configure HTTP basic authorization: Basic Authentication
|
300
|
+
config.username = 'YOUR USERNAME'
|
301
|
+
config.password = 'YOUR PASSWORD'
|
302
|
+
|
303
|
+
# Configure API key authorization: Token Authentication
|
304
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
305
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
306
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
307
|
+
end
|
308
|
+
|
309
|
+
api_instance = Ionoscloud::NicApi.new
|
310
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
311
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
312
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
313
|
+
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the Firewall Rule
|
314
|
+
opts = {
|
315
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
316
|
+
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
|
317
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
318
|
+
}
|
319
|
+
|
320
|
+
begin
|
321
|
+
# Retrieve a Firewall Rule
|
322
|
+
result = api_instance.datacenters_servers_nics_firewallrules_find_by_id(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
323
|
+
p result
|
324
|
+
rescue Ionoscloud::ApiError => e
|
325
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_find_by_id: #{e}"
|
326
|
+
end
|
327
|
+
```
|
328
|
+
|
329
|
+
#### Using the datacenters_servers_nics_firewallrules_find_by_id_with_http_info variant
|
330
|
+
|
331
|
+
This returns an Array which contains the response data, status code and headers.
|
332
|
+
|
333
|
+
> <Array(<FirewallRule>, Integer, Hash)> datacenters_servers_nics_firewallrules_find_by_id_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
334
|
+
|
335
|
+
```ruby
|
336
|
+
begin
|
337
|
+
# Retrieve a Firewall Rule
|
338
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_find_by_id_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
|
339
|
+
p status_code # => 2xx
|
340
|
+
p headers # => { ... }
|
341
|
+
p data # => <FirewallRule>
|
342
|
+
rescue Ionoscloud::ApiError => e
|
343
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_find_by_id_with_http_info: #{e}"
|
344
|
+
end
|
345
|
+
```
|
346
|
+
|
347
|
+
### Parameters
|
348
|
+
|
349
|
+
| Name | Type | Description | Notes |
|
350
|
+
| ---- | ---- | ----------- | ----- |
|
351
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
352
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
353
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
354
|
+
| **firewallrule_id** | **String** | The unique ID of the Firewall Rule | |
|
355
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
356
|
+
| **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] |
|
357
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
358
|
+
|
359
|
+
### Return type
|
360
|
+
|
361
|
+
[**FirewallRule**](FirewallRule.md)
|
362
|
+
|
363
|
+
### Authorization
|
364
|
+
|
365
|
+
Basic Authentication, Token Authentication
|
366
|
+
|
367
|
+
### HTTP request headers
|
368
|
+
|
369
|
+
- **Content-Type**: Not defined
|
370
|
+
- **Accept**: application/json
|
371
|
+
|
372
|
+
|
373
|
+
## datacenters_servers_nics_firewallrules_get
|
374
|
+
|
375
|
+
> <FirewallRules> datacenters_servers_nics_firewallrules_get(datacenter_id, server_id, nic_id, opts)
|
376
|
+
|
377
|
+
List Firewall Rules
|
378
|
+
|
379
|
+
Retrieves a list of firewall rules associated with a particular NIC
|
380
|
+
|
381
|
+
### Examples
|
382
|
+
|
383
|
+
```ruby
|
384
|
+
require 'time'
|
385
|
+
require 'ionoscloud'
|
386
|
+
# setup authorization
|
387
|
+
Ionoscloud.configure do |config|
|
388
|
+
# Configure HTTP basic authorization: Basic Authentication
|
389
|
+
config.username = 'YOUR USERNAME'
|
390
|
+
config.password = 'YOUR PASSWORD'
|
391
|
+
|
392
|
+
# Configure API key authorization: Token Authentication
|
393
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
394
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
395
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
396
|
+
end
|
397
|
+
|
398
|
+
api_instance = Ionoscloud::NicApi.new
|
399
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
400
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
401
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
402
|
+
opts = {
|
403
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
404
|
+
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
|
405
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
406
|
+
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)
|
407
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
408
|
+
}
|
409
|
+
|
410
|
+
begin
|
411
|
+
# List Firewall Rules
|
412
|
+
result = api_instance.datacenters_servers_nics_firewallrules_get(datacenter_id, server_id, nic_id, opts)
|
413
|
+
p result
|
414
|
+
rescue Ionoscloud::ApiError => e
|
415
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_get: #{e}"
|
416
|
+
end
|
417
|
+
```
|
418
|
+
|
419
|
+
#### Using the datacenters_servers_nics_firewallrules_get_with_http_info variant
|
420
|
+
|
421
|
+
This returns an Array which contains the response data, status code and headers.
|
422
|
+
|
423
|
+
> <Array(<FirewallRules>, Integer, Hash)> datacenters_servers_nics_firewallrules_get_with_http_info(datacenter_id, server_id, nic_id, opts)
|
424
|
+
|
425
|
+
```ruby
|
426
|
+
begin
|
427
|
+
# List Firewall Rules
|
428
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_get_with_http_info(datacenter_id, server_id, nic_id, opts)
|
429
|
+
p status_code # => 2xx
|
430
|
+
p headers # => { ... }
|
431
|
+
p data # => <FirewallRules>
|
432
|
+
rescue Ionoscloud::ApiError => e
|
433
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_get_with_http_info: #{e}"
|
434
|
+
end
|
435
|
+
```
|
436
|
+
|
437
|
+
### Parameters
|
438
|
+
|
439
|
+
| Name | Type | Description | Notes |
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
441
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
442
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
443
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
444
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
445
|
+
| **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] |
|
446
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
447
|
+
| **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] |
|
448
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
449
|
+
|
450
|
+
### Return type
|
451
|
+
|
452
|
+
[**FirewallRules**](FirewallRules.md)
|
453
|
+
|
454
|
+
### Authorization
|
455
|
+
|
456
|
+
Basic Authentication, Token Authentication
|
457
|
+
|
458
|
+
### HTTP request headers
|
459
|
+
|
460
|
+
- **Content-Type**: Not defined
|
461
|
+
- **Accept**: application/json
|
462
|
+
|
463
|
+
|
464
|
+
## datacenters_servers_nics_firewallrules_patch
|
465
|
+
|
466
|
+
> <FirewallRule> datacenters_servers_nics_firewallrules_patch(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
467
|
+
|
468
|
+
Partially modify a Firewall Rule
|
469
|
+
|
470
|
+
You can use update attributes of a resource
|
471
|
+
|
472
|
+
### Examples
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
require 'time'
|
476
|
+
require 'ionoscloud'
|
477
|
+
# setup authorization
|
478
|
+
Ionoscloud.configure do |config|
|
479
|
+
# Configure HTTP basic authorization: Basic Authentication
|
480
|
+
config.username = 'YOUR USERNAME'
|
481
|
+
config.password = 'YOUR PASSWORD'
|
482
|
+
|
483
|
+
# Configure API key authorization: Token Authentication
|
484
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
485
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
486
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
487
|
+
end
|
488
|
+
|
489
|
+
api_instance = Ionoscloud::NicApi.new
|
490
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
491
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
492
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
493
|
+
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the Firewall Rule
|
494
|
+
firewallrule = Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'}) # FirewallruleProperties | Modified Firewall Rule
|
495
|
+
opts = {
|
496
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
497
|
+
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
|
498
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
499
|
+
}
|
500
|
+
|
501
|
+
begin
|
502
|
+
# Partially modify a Firewall Rule
|
503
|
+
result = api_instance.datacenters_servers_nics_firewallrules_patch(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
504
|
+
p result
|
505
|
+
rescue Ionoscloud::ApiError => e
|
506
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_patch: #{e}"
|
507
|
+
end
|
508
|
+
```
|
509
|
+
|
510
|
+
#### Using the datacenters_servers_nics_firewallrules_patch_with_http_info variant
|
511
|
+
|
512
|
+
This returns an Array which contains the response data, status code and headers.
|
513
|
+
|
514
|
+
> <Array(<FirewallRule>, Integer, Hash)> datacenters_servers_nics_firewallrules_patch_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
515
|
+
|
516
|
+
```ruby
|
517
|
+
begin
|
518
|
+
# Partially modify a Firewall Rule
|
519
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_patch_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
520
|
+
p status_code # => 2xx
|
521
|
+
p headers # => { ... }
|
522
|
+
p data # => <FirewallRule>
|
523
|
+
rescue Ionoscloud::ApiError => e
|
524
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_patch_with_http_info: #{e}"
|
525
|
+
end
|
526
|
+
```
|
527
|
+
|
528
|
+
### Parameters
|
529
|
+
|
530
|
+
| Name | Type | Description | Notes |
|
531
|
+
| ---- | ---- | ----------- | ----- |
|
532
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
533
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
534
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
535
|
+
| **firewallrule_id** | **String** | The unique ID of the Firewall Rule | |
|
536
|
+
| **firewallrule** | [**FirewallruleProperties**](FirewallruleProperties.md) | Modified Firewall Rule | |
|
537
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
538
|
+
| **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] |
|
539
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
540
|
+
|
541
|
+
### Return type
|
542
|
+
|
543
|
+
[**FirewallRule**](FirewallRule.md)
|
544
|
+
|
545
|
+
### Authorization
|
546
|
+
|
547
|
+
Basic Authentication, Token Authentication
|
548
|
+
|
549
|
+
### HTTP request headers
|
550
|
+
|
551
|
+
- **Content-Type**: application/json
|
552
|
+
- **Accept**: application/json
|
553
|
+
|
554
|
+
|
555
|
+
## datacenters_servers_nics_firewallrules_post
|
556
|
+
|
557
|
+
> <FirewallRule> datacenters_servers_nics_firewallrules_post(datacenter_id, server_id, nic_id, firewallrule, opts)
|
558
|
+
|
559
|
+
Create a Firewall Rule
|
560
|
+
|
561
|
+
This will add a Firewall Rule to the NIC
|
562
|
+
|
563
|
+
### Examples
|
564
|
+
|
565
|
+
```ruby
|
566
|
+
require 'time'
|
567
|
+
require 'ionoscloud'
|
568
|
+
# setup authorization
|
569
|
+
Ionoscloud.configure do |config|
|
570
|
+
# Configure HTTP basic authorization: Basic Authentication
|
571
|
+
config.username = 'YOUR USERNAME'
|
572
|
+
config.password = 'YOUR PASSWORD'
|
573
|
+
|
574
|
+
# Configure API key authorization: Token Authentication
|
575
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
577
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
578
|
+
end
|
579
|
+
|
580
|
+
api_instance = Ionoscloud::NicApi.new
|
581
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
582
|
+
server_id = 'server_id_example' # String | The unique ID of the server
|
583
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
584
|
+
firewallrule = Ionoscloud::FirewallRule.new({properties: Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'})}) # FirewallRule | Firewall Rule to be created
|
585
|
+
opts = {
|
586
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
587
|
+
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
|
588
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
589
|
+
}
|
590
|
+
|
591
|
+
begin
|
592
|
+
# Create a Firewall Rule
|
593
|
+
result = api_instance.datacenters_servers_nics_firewallrules_post(datacenter_id, server_id, nic_id, firewallrule, opts)
|
594
|
+
p result
|
595
|
+
rescue Ionoscloud::ApiError => e
|
596
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_post: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
#### Using the datacenters_servers_nics_firewallrules_post_with_http_info variant
|
601
|
+
|
602
|
+
This returns an Array which contains the response data, status code and headers.
|
603
|
+
|
604
|
+
> <Array(<FirewallRule>, Integer, Hash)> datacenters_servers_nics_firewallrules_post_with_http_info(datacenter_id, server_id, nic_id, firewallrule, opts)
|
605
|
+
|
606
|
+
```ruby
|
607
|
+
begin
|
608
|
+
# Create a Firewall Rule
|
609
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_post_with_http_info(datacenter_id, server_id, nic_id, firewallrule, opts)
|
610
|
+
p status_code # => 2xx
|
611
|
+
p headers # => { ... }
|
612
|
+
p data # => <FirewallRule>
|
613
|
+
rescue Ionoscloud::ApiError => e
|
614
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_post_with_http_info: #{e}"
|
615
|
+
end
|
616
|
+
```
|
617
|
+
|
618
|
+
### Parameters
|
619
|
+
|
620
|
+
| Name | Type | Description | Notes |
|
621
|
+
| ---- | ---- | ----------- | ----- |
|
622
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
623
|
+
| **server_id** | **String** | The unique ID of the server | |
|
624
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
625
|
+
| **firewallrule** | [**FirewallRule**](FirewallRule.md) | Firewall Rule to be created | |
|
626
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
627
|
+
| **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] |
|
628
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
629
|
+
|
630
|
+
### Return type
|
631
|
+
|
632
|
+
[**FirewallRule**](FirewallRule.md)
|
633
|
+
|
634
|
+
### Authorization
|
635
|
+
|
636
|
+
Basic Authentication, Token Authentication
|
637
|
+
|
638
|
+
### HTTP request headers
|
639
|
+
|
640
|
+
- **Content-Type**: application/json
|
641
|
+
- **Accept**: application/json
|
642
|
+
|
643
|
+
|
644
|
+
## datacenters_servers_nics_firewallrules_put
|
645
|
+
|
646
|
+
> <FirewallRule> datacenters_servers_nics_firewallrules_put(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
647
|
+
|
648
|
+
Modify a Firewall Rule
|
649
|
+
|
650
|
+
You can use update attributes of a resource
|
651
|
+
|
652
|
+
### Examples
|
653
|
+
|
654
|
+
```ruby
|
655
|
+
require 'time'
|
656
|
+
require 'ionoscloud'
|
657
|
+
# setup authorization
|
658
|
+
Ionoscloud.configure do |config|
|
659
|
+
# Configure HTTP basic authorization: Basic Authentication
|
660
|
+
config.username = 'YOUR USERNAME'
|
661
|
+
config.password = 'YOUR PASSWORD'
|
662
|
+
|
663
|
+
# Configure API key authorization: Token Authentication
|
664
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
665
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
666
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
667
|
+
end
|
668
|
+
|
669
|
+
api_instance = Ionoscloud::NicApi.new
|
670
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
671
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
672
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
673
|
+
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the Firewall Rule
|
674
|
+
firewallrule = Ionoscloud::FirewallRule.new({properties: Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'})}) # FirewallRule | Modified Firewall Rule
|
675
|
+
opts = {
|
676
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
677
|
+
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
|
678
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
679
|
+
}
|
680
|
+
|
681
|
+
begin
|
682
|
+
# Modify a Firewall Rule
|
683
|
+
result = api_instance.datacenters_servers_nics_firewallrules_put(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
684
|
+
p result
|
685
|
+
rescue Ionoscloud::ApiError => e
|
686
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_put: #{e}"
|
687
|
+
end
|
688
|
+
```
|
689
|
+
|
690
|
+
#### Using the datacenters_servers_nics_firewallrules_put_with_http_info variant
|
691
|
+
|
692
|
+
This returns an Array which contains the response data, status code and headers.
|
693
|
+
|
694
|
+
> <Array(<FirewallRule>, Integer, Hash)> datacenters_servers_nics_firewallrules_put_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
695
|
+
|
696
|
+
```ruby
|
697
|
+
begin
|
698
|
+
# Modify a Firewall Rule
|
699
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_put_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
|
700
|
+
p status_code # => 2xx
|
701
|
+
p headers # => { ... }
|
702
|
+
p data # => <FirewallRule>
|
703
|
+
rescue Ionoscloud::ApiError => e
|
704
|
+
puts "Error when calling NicApi->datacenters_servers_nics_firewallrules_put_with_http_info: #{e}"
|
705
|
+
end
|
706
|
+
```
|
707
|
+
|
708
|
+
### Parameters
|
709
|
+
|
710
|
+
| Name | Type | Description | Notes |
|
711
|
+
| ---- | ---- | ----------- | ----- |
|
712
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
713
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
714
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
715
|
+
| **firewallrule_id** | **String** | The unique ID of the Firewall Rule | |
|
716
|
+
| **firewallrule** | [**FirewallRule**](FirewallRule.md) | Modified Firewall Rule | |
|
717
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
718
|
+
| **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] |
|
719
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
720
|
+
|
721
|
+
### Return type
|
722
|
+
|
723
|
+
[**FirewallRule**](FirewallRule.md)
|
724
|
+
|
725
|
+
### Authorization
|
726
|
+
|
727
|
+
Basic Authentication, Token Authentication
|
728
|
+
|
729
|
+
### HTTP request headers
|
730
|
+
|
731
|
+
- **Content-Type**: application/json
|
732
|
+
- **Accept**: application/json
|
733
|
+
|
734
|
+
|
735
|
+
## datacenters_servers_nics_get
|
736
|
+
|
737
|
+
> <Nics> datacenters_servers_nics_get(datacenter_id, server_id, opts)
|
738
|
+
|
739
|
+
List Nics
|
740
|
+
|
741
|
+
Retrieves a list of NICs.
|
742
|
+
|
743
|
+
### Examples
|
744
|
+
|
745
|
+
```ruby
|
746
|
+
require 'time'
|
747
|
+
require 'ionoscloud'
|
748
|
+
# setup authorization
|
749
|
+
Ionoscloud.configure do |config|
|
750
|
+
# Configure HTTP basic authorization: Basic Authentication
|
751
|
+
config.username = 'YOUR USERNAME'
|
752
|
+
config.password = 'YOUR PASSWORD'
|
753
|
+
|
754
|
+
# Configure API key authorization: Token Authentication
|
755
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
756
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
757
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
758
|
+
end
|
759
|
+
|
760
|
+
api_instance = Ionoscloud::NicApi.new
|
761
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
762
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
763
|
+
opts = {
|
764
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
765
|
+
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
|
766
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
767
|
+
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)
|
768
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
769
|
+
}
|
770
|
+
|
771
|
+
begin
|
772
|
+
# List Nics
|
773
|
+
result = api_instance.datacenters_servers_nics_get(datacenter_id, server_id, opts)
|
774
|
+
p result
|
775
|
+
rescue Ionoscloud::ApiError => e
|
776
|
+
puts "Error when calling NicApi->datacenters_servers_nics_get: #{e}"
|
777
|
+
end
|
778
|
+
```
|
779
|
+
|
780
|
+
#### Using the datacenters_servers_nics_get_with_http_info variant
|
781
|
+
|
782
|
+
This returns an Array which contains the response data, status code and headers.
|
783
|
+
|
784
|
+
> <Array(<Nics>, Integer, Hash)> datacenters_servers_nics_get_with_http_info(datacenter_id, server_id, opts)
|
785
|
+
|
786
|
+
```ruby
|
787
|
+
begin
|
788
|
+
# List Nics
|
789
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_get_with_http_info(datacenter_id, server_id, opts)
|
790
|
+
p status_code # => 2xx
|
791
|
+
p headers # => { ... }
|
792
|
+
p data # => <Nics>
|
793
|
+
rescue Ionoscloud::ApiError => e
|
794
|
+
puts "Error when calling NicApi->datacenters_servers_nics_get_with_http_info: #{e}"
|
795
|
+
end
|
796
|
+
```
|
797
|
+
|
798
|
+
### Parameters
|
799
|
+
|
800
|
+
| Name | Type | Description | Notes |
|
801
|
+
| ---- | ---- | ----------- | ----- |
|
802
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
803
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
804
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
805
|
+
| **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] |
|
806
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
807
|
+
| **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] |
|
808
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
809
|
+
|
810
|
+
### Return type
|
811
|
+
|
812
|
+
[**Nics**](Nics.md)
|
813
|
+
|
814
|
+
### Authorization
|
815
|
+
|
816
|
+
Basic Authentication, Token Authentication
|
817
|
+
|
818
|
+
### HTTP request headers
|
819
|
+
|
820
|
+
- **Content-Type**: Not defined
|
821
|
+
- **Accept**: application/json
|
822
|
+
|
823
|
+
|
824
|
+
## datacenters_servers_nics_patch
|
825
|
+
|
826
|
+
> <Nic> datacenters_servers_nics_patch(datacenter_id, server_id, nic_id, nic, opts)
|
827
|
+
|
828
|
+
Partially modify a Nic
|
829
|
+
|
830
|
+
You can use update attributes of a Nic
|
831
|
+
|
832
|
+
### Examples
|
833
|
+
|
834
|
+
```ruby
|
835
|
+
require 'time'
|
836
|
+
require 'ionoscloud'
|
837
|
+
# setup authorization
|
838
|
+
Ionoscloud.configure do |config|
|
839
|
+
# Configure HTTP basic authorization: Basic Authentication
|
840
|
+
config.username = 'YOUR USERNAME'
|
841
|
+
config.password = 'YOUR PASSWORD'
|
842
|
+
|
843
|
+
# Configure API key authorization: Token Authentication
|
844
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
845
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
846
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
847
|
+
end
|
848
|
+
|
849
|
+
api_instance = Ionoscloud::NicApi.new
|
850
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
851
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
852
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
853
|
+
nic = Ionoscloud::NicProperties.new({lan: 2}) # NicProperties | Modified properties of Nic
|
854
|
+
opts = {
|
855
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
856
|
+
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
|
857
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
858
|
+
}
|
859
|
+
|
860
|
+
begin
|
861
|
+
# Partially modify a Nic
|
862
|
+
result = api_instance.datacenters_servers_nics_patch(datacenter_id, server_id, nic_id, nic, opts)
|
863
|
+
p result
|
864
|
+
rescue Ionoscloud::ApiError => e
|
865
|
+
puts "Error when calling NicApi->datacenters_servers_nics_patch: #{e}"
|
866
|
+
end
|
867
|
+
```
|
868
|
+
|
869
|
+
#### Using the datacenters_servers_nics_patch_with_http_info variant
|
870
|
+
|
871
|
+
This returns an Array which contains the response data, status code and headers.
|
872
|
+
|
873
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_servers_nics_patch_with_http_info(datacenter_id, server_id, nic_id, nic, opts)
|
874
|
+
|
875
|
+
```ruby
|
876
|
+
begin
|
877
|
+
# Partially modify a Nic
|
878
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_patch_with_http_info(datacenter_id, server_id, nic_id, nic, opts)
|
879
|
+
p status_code # => 2xx
|
880
|
+
p headers # => { ... }
|
881
|
+
p data # => <Nic>
|
882
|
+
rescue Ionoscloud::ApiError => e
|
883
|
+
puts "Error when calling NicApi->datacenters_servers_nics_patch_with_http_info: #{e}"
|
884
|
+
end
|
885
|
+
```
|
886
|
+
|
887
|
+
### Parameters
|
888
|
+
|
889
|
+
| Name | Type | Description | Notes |
|
890
|
+
| ---- | ---- | ----------- | ----- |
|
891
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
892
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
893
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
894
|
+
| **nic** | [**NicProperties**](NicProperties.md) | Modified properties of Nic | |
|
895
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
896
|
+
| **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] |
|
897
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
898
|
+
|
899
|
+
### Return type
|
900
|
+
|
901
|
+
[**Nic**](Nic.md)
|
902
|
+
|
903
|
+
### Authorization
|
904
|
+
|
905
|
+
Basic Authentication, Token Authentication
|
906
|
+
|
907
|
+
### HTTP request headers
|
908
|
+
|
909
|
+
- **Content-Type**: application/json
|
910
|
+
- **Accept**: application/json
|
911
|
+
|
912
|
+
|
913
|
+
## datacenters_servers_nics_post
|
914
|
+
|
915
|
+
> <Nic> datacenters_servers_nics_post(datacenter_id, server_id, nic, opts)
|
916
|
+
|
917
|
+
Create a Nic
|
918
|
+
|
919
|
+
Adds a NIC to the target server. Combine count of Nics and volumes attached to the server should not exceed size 24.
|
920
|
+
|
921
|
+
### Examples
|
922
|
+
|
923
|
+
```ruby
|
924
|
+
require 'time'
|
925
|
+
require 'ionoscloud'
|
926
|
+
# setup authorization
|
927
|
+
Ionoscloud.configure do |config|
|
928
|
+
# Configure HTTP basic authorization: Basic Authentication
|
929
|
+
config.username = 'YOUR USERNAME'
|
930
|
+
config.password = 'YOUR PASSWORD'
|
931
|
+
|
932
|
+
# Configure API key authorization: Token Authentication
|
933
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
934
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
935
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
936
|
+
end
|
937
|
+
|
938
|
+
api_instance = Ionoscloud::NicApi.new
|
939
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
940
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
941
|
+
nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | Nic to be created
|
942
|
+
opts = {
|
943
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
944
|
+
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
|
945
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
946
|
+
}
|
947
|
+
|
948
|
+
begin
|
949
|
+
# Create a Nic
|
950
|
+
result = api_instance.datacenters_servers_nics_post(datacenter_id, server_id, nic, opts)
|
951
|
+
p result
|
952
|
+
rescue Ionoscloud::ApiError => e
|
953
|
+
puts "Error when calling NicApi->datacenters_servers_nics_post: #{e}"
|
954
|
+
end
|
955
|
+
```
|
956
|
+
|
957
|
+
#### Using the datacenters_servers_nics_post_with_http_info variant
|
958
|
+
|
959
|
+
This returns an Array which contains the response data, status code and headers.
|
960
|
+
|
961
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_servers_nics_post_with_http_info(datacenter_id, server_id, nic, opts)
|
962
|
+
|
963
|
+
```ruby
|
964
|
+
begin
|
965
|
+
# Create a Nic
|
966
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_post_with_http_info(datacenter_id, server_id, nic, opts)
|
967
|
+
p status_code # => 2xx
|
968
|
+
p headers # => { ... }
|
969
|
+
p data # => <Nic>
|
970
|
+
rescue Ionoscloud::ApiError => e
|
971
|
+
puts "Error when calling NicApi->datacenters_servers_nics_post_with_http_info: #{e}"
|
972
|
+
end
|
973
|
+
```
|
974
|
+
|
975
|
+
### Parameters
|
976
|
+
|
977
|
+
| Name | Type | Description | Notes |
|
978
|
+
| ---- | ---- | ----------- | ----- |
|
979
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
980
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
981
|
+
| **nic** | [**Nic**](Nic.md) | Nic to be created | |
|
982
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
983
|
+
| **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] |
|
984
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
985
|
+
|
986
|
+
### Return type
|
987
|
+
|
988
|
+
[**Nic**](Nic.md)
|
989
|
+
|
990
|
+
### Authorization
|
991
|
+
|
992
|
+
Basic Authentication, Token Authentication
|
993
|
+
|
994
|
+
### HTTP request headers
|
995
|
+
|
996
|
+
- **Content-Type**: application/json
|
997
|
+
- **Accept**: application/json
|
998
|
+
|
999
|
+
|
1000
|
+
## datacenters_servers_nics_put
|
1001
|
+
|
1002
|
+
> <Nic> datacenters_servers_nics_put(datacenter_id, server_id, nic_id, nic, opts)
|
1003
|
+
|
1004
|
+
Modify a Nic
|
1005
|
+
|
1006
|
+
You can use update attributes of a Nic
|
1007
|
+
|
1008
|
+
### Examples
|
1009
|
+
|
1010
|
+
```ruby
|
1011
|
+
require 'time'
|
1012
|
+
require 'ionoscloud'
|
1013
|
+
# setup authorization
|
1014
|
+
Ionoscloud.configure do |config|
|
1015
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1016
|
+
config.username = 'YOUR USERNAME'
|
1017
|
+
config.password = 'YOUR PASSWORD'
|
1018
|
+
|
1019
|
+
# Configure API key authorization: Token Authentication
|
1020
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1021
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1022
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
api_instance = Ionoscloud::NicApi.new
|
1026
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
1027
|
+
server_id = 'server_id_example' # String | The unique ID of the Server
|
1028
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
1029
|
+
nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | Modified Nic
|
1030
|
+
opts = {
|
1031
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1032
|
+
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
|
1033
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
1034
|
+
}
|
1035
|
+
|
1036
|
+
begin
|
1037
|
+
# Modify a Nic
|
1038
|
+
result = api_instance.datacenters_servers_nics_put(datacenter_id, server_id, nic_id, nic, opts)
|
1039
|
+
p result
|
1040
|
+
rescue Ionoscloud::ApiError => e
|
1041
|
+
puts "Error when calling NicApi->datacenters_servers_nics_put: #{e}"
|
1042
|
+
end
|
1043
|
+
```
|
1044
|
+
|
1045
|
+
#### Using the datacenters_servers_nics_put_with_http_info variant
|
1046
|
+
|
1047
|
+
This returns an Array which contains the response data, status code and headers.
|
1048
|
+
|
1049
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_servers_nics_put_with_http_info(datacenter_id, server_id, nic_id, nic, opts)
|
1050
|
+
|
1051
|
+
```ruby
|
1052
|
+
begin
|
1053
|
+
# Modify a Nic
|
1054
|
+
data, status_code, headers = api_instance.datacenters_servers_nics_put_with_http_info(datacenter_id, server_id, nic_id, nic, opts)
|
1055
|
+
p status_code # => 2xx
|
1056
|
+
p headers # => { ... }
|
1057
|
+
p data # => <Nic>
|
1058
|
+
rescue Ionoscloud::ApiError => e
|
1059
|
+
puts "Error when calling NicApi->datacenters_servers_nics_put_with_http_info: #{e}"
|
1060
|
+
end
|
1061
|
+
```
|
1062
|
+
|
1063
|
+
### Parameters
|
1064
|
+
|
1065
|
+
| Name | Type | Description | Notes |
|
1066
|
+
| ---- | ---- | ----------- | ----- |
|
1067
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
1068
|
+
| **server_id** | **String** | The unique ID of the Server | |
|
1069
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
1070
|
+
| **nic** | [**Nic**](Nic.md) | Modified Nic | |
|
1071
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1072
|
+
| **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] |
|
1073
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1074
|
+
|
1075
|
+
### Return type
|
1076
|
+
|
1077
|
+
[**Nic**](Nic.md)
|
1078
|
+
|
1079
|
+
### Authorization
|
1080
|
+
|
1081
|
+
Basic Authentication, Token Authentication
|
1082
|
+
|
1083
|
+
### HTTP request headers
|
1084
|
+
|
1085
|
+
- **Content-Type**: application/json
|
1086
|
+
- **Accept**: application/json
|
1087
|
+
|