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

# \NetApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_net**](NetApi.md#create_net) | **POST** /CreateNet | 
[**delete_net**](NetApi.md#delete_net) | **POST** /DeleteNet | 
[**read_nets**](NetApi.md#read_nets) | **POST** /ReadNets | 
[**update_net**](NetApi.md#update_net) | **POST** /UpdateNet | 



## create_net

> crate::models::CreateNetResponse create_net(create_net_request)


Creates a Net with a specified IP range.<br /> The IP range (network range) of your Net must be between a /28 netmask (16 IPs) and a /16 netmask (65536 IPs).<br /><br /> For more information, see [About Nets](https://docs.outscale.com/en/userguide/About-Nets.html).

### Parameters


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

### Return type

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

> crate::models::DeleteNetResponse delete_net(delete_net_request)


Deletes a specified Net.<br /> Before deleting the Net, you need to delete or detach all the resources associated with the Net:<br /><br />  * Virtual machines (VMs)<br /> * Net peerings<br /> * Custom route tables<br /> * Public IPs allocated to resources in the Net<br /> * Network Interface Cards (NICs) created in the Subnets<br /> * Virtual gateways, internet services and NAT services<br /> * Load balancers<br /> * Security groups<br /> * Subnets

### Parameters


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

### Return type

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

> crate::models::ReadNetsResponse read_nets(read_nets_request)


Lists one or more Nets.

### Parameters


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

### Return type

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

> crate::models::UpdateNetResponse update_net(update_net_request)


Associates a DHCP options set with a specified Net.

### Parameters


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

### Return type

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