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

# \VpnConnectionApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_vpn_connection**](VpnConnectionApi.md#create_vpn_connection) | **POST** /CreateVpnConnection | 
[**create_vpn_connection_route**](VpnConnectionApi.md#create_vpn_connection_route) | **POST** /CreateVpnConnectionRoute | 
[**delete_vpn_connection**](VpnConnectionApi.md#delete_vpn_connection) | **POST** /DeleteVpnConnection | 
[**delete_vpn_connection_route**](VpnConnectionApi.md#delete_vpn_connection_route) | **POST** /DeleteVpnConnectionRoute | 
[**read_vpn_connections**](VpnConnectionApi.md#read_vpn_connections) | **POST** /ReadVpnConnections | 
[**update_vpn_connection**](VpnConnectionApi.md#update_vpn_connection) | **POST** /UpdateVpnConnection | 



## create_vpn_connection

> crate::models::CreateVpnConnectionResponse create_vpn_connection(create_vpn_connection_request)


Creates a VPN connection between a specified virtual gateway and a specified client gateway.<br /> You can create only one VPN connection between a virtual gateway and a client gateway.<br /><br />  **[IMPORTANT]**<br /> This action can be done only if the virtual gateway is in the `available` state.<br /><br /> For more information, see [About VPN Connections](https://docs.outscale.com/en/userguide/About-VPN-Connections.html).

### Parameters


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

### Return type

[**crate::models::CreateVpnConnectionResponse**](CreateVpnConnectionResponse.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)


## create_vpn_connection_route

> crate::models::CreateVpnConnectionRouteResponse create_vpn_connection_route(create_vpn_connection_route_request)


Creates a static route to a VPN connection.<br /> This enables you to select the network flows sent by the virtual gateway to the target VPN connection.<br /><br /> For more information, see [About Routing Configuration for VPN Connections](https://docs.outscale.com/en/userguide/About-Routing-Configuration-for-VPN-Connections.html).

### Parameters


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

### Return type

[**crate::models::CreateVpnConnectionRouteResponse**](CreateVpnConnectionRouteResponse.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_vpn_connection

> crate::models::DeleteVpnConnectionResponse delete_vpn_connection(delete_vpn_connection_request)


Deletes a specified VPN connection.<br /> If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted.

### Parameters


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

### Return type

[**crate::models::DeleteVpnConnectionResponse**](DeleteVpnConnectionResponse.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_vpn_connection_route

> crate::models::DeleteVpnConnectionRouteResponse delete_vpn_connection_route(delete_vpn_connection_route_request)


Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method.

### Parameters


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

### Return type

[**crate::models::DeleteVpnConnectionRouteResponse**](DeleteVpnConnectionRouteResponse.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_vpn_connections

> crate::models::ReadVpnConnectionsResponse read_vpn_connections(read_vpn_connections_request)


Lists one or more VPN connections.

### Parameters


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

### Return type

[**crate::models::ReadVpnConnectionsResponse**](ReadVpnConnectionsResponse.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_vpn_connection

> crate::models::UpdateVpnConnectionResponse update_vpn_connection(update_vpn_connection_request)


Modifies the specified attributes of a VPN connection.

### Parameters


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

### Return type

[**crate::models::UpdateVpnConnectionResponse**](UpdateVpnConnectionResponse.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)