outscale_api 1.17.0

Outscale API SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

# \NicApi

All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_nic**](NicApi.md#create_nic) | **POST** /CreateNic | 
[**delete_nic**](NicApi.md#delete_nic) | **POST** /DeleteNic | 
[**link_nic**](NicApi.md#link_nic) | **POST** /LinkNic | 
[**link_private_ips**](NicApi.md#link_private_ips) | **POST** /LinkPrivateIps | 
[**read_nics**](NicApi.md#read_nics) | **POST** /ReadNics | 
[**unlink_nic**](NicApi.md#unlink_nic) | **POST** /UnlinkNic | 
[**unlink_private_ips**](NicApi.md#unlink_private_ips) | **POST** /UnlinkPrivateIps | 
[**update_nic**](NicApi.md#update_nic) | **POST** /UpdateNic | 



## create_nic

> crate::models::CreateNicResponse create_nic(create_nic_request)


Creates a network interface card (NIC) in the specified Subnet.<br /><br /> For more information, see [About NICs](https://docs.outscale.com/en/userguide/About-NICs.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_nic_request** | Option<[**CreateNicRequest**](CreateNicRequest.md)> |  |  |

### Return type

[**crate::models::CreateNicResponse**](CreateNicResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_nic

> crate::models::DeleteNicResponse delete_nic(delete_nic_request)


Deletes the specified network interface card (NIC).<br /> The network interface must not be attached to any virtual machine (VM).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**delete_nic_request** | Option<[**DeleteNicRequest**](DeleteNicRequest.md)> |  |  |

### Return type

[**crate::models::DeleteNicResponse**](DeleteNicResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## link_nic

> crate::models::LinkNicResponse link_nic(link_nic_request)


Attaches a network interface card (NIC) to a virtual machine (VM).<br /> The interface and the VM must be in the same Subregion. The VM can be either `running` or `stopped`. The NIC must be in the `available` state. For more information, see [Attaching a NIC to a VM](https://docs.outscale.com/en/userguide/Attaching-a-NIC-to-a-VM.html).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**link_nic_request** | Option<[**LinkNicRequest**](LinkNicRequest.md)> |  |  |

### Return type

[**crate::models::LinkNicResponse**](LinkNicResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## link_private_ips

> crate::models::LinkPrivateIpsResponse link_private_ips(link_private_ips_request)


Assigns one or more secondary private IPs to a specified network interface card (NIC). This action is only available in a Net. The private IPs to be assigned can be added individually using the `PrivateIps` parameter, or you can specify the number of private IPs to be automatically chosen within the Subnet range using the `SecondaryPrivateIpCount` parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP is chosen within the Subnet range.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**link_private_ips_request** | Option<[**LinkPrivateIpsRequest**](LinkPrivateIpsRequest.md)> |  |  |

### Return type

[**crate::models::LinkPrivateIpsResponse**](LinkPrivateIpsResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## read_nics

> crate::models::ReadNicsResponse read_nics(read_nics_request)


Lists one or more network interface cards (NICs).<br /> A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**read_nics_request** | Option<[**ReadNicsRequest**](ReadNicsRequest.md)> |  |  |

### Return type

[**crate::models::ReadNicsResponse**](ReadNicsResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unlink_nic

> crate::models::UnlinkNicResponse unlink_nic(unlink_nic_request)


Detaches a network interface card (NIC) from a virtual machine (VM).<br /> The primary NIC cannot be detached.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**unlink_nic_request** | Option<[**UnlinkNicRequest**](UnlinkNicRequest.md)> |  |  |

### Return type

[**crate::models::UnlinkNicResponse**](UnlinkNicResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unlink_private_ips

> crate::models::UnlinkPrivateIpsResponse unlink_private_ips(unlink_private_ips_request)


Unassigns one or more secondary private IPs from a network interface card (NIC).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**unlink_private_ips_request** | Option<[**UnlinkPrivateIpsRequest**](UnlinkPrivateIpsRequest.md)> |  |  |

### Return type

[**crate::models::UnlinkPrivateIpsResponse**](UnlinkPrivateIpsResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_nic

> crate::models::UpdateNicResponse update_nic(update_nic_request)


Modifies the specified network interface card (NIC). You can specify only one attribute at a time.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_nic_request** | Option<[**UpdateNicRequest**](UpdateNicRequest.md)> |  |  |

### Return type

[**crate::models::UpdateNicResponse**](UpdateNicResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)