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

# \VmGroupApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_vm_group**](VmGroupApi.md#create_vm_group) | **POST** /CreateVmGroup | 
[**delete_vm_group**](VmGroupApi.md#delete_vm_group) | **POST** /DeleteVmGroup | 
[**read_vm_groups**](VmGroupApi.md#read_vm_groups) | **POST** /ReadVmGroups | 
[**scale_down_vm_group**](VmGroupApi.md#scale_down_vm_group) | **POST** /ScaleDownVmGroup | 
[**scale_up_vm_group**](VmGroupApi.md#scale_up_vm_group) | **POST** /ScaleUpVmGroup | 
[**update_vm_group**](VmGroupApi.md#update_vm_group) | **POST** /UpdateVmGroup | 



## create_vm_group

> crate::models::CreateVmGroupResponse create_vm_group(create_vm_group_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Creates a group of virtual machines (VMs) containing the same characteristics as a specified VM template, and then launches them.<br /> You can create up to 100 VM groups in your account.

### Parameters


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

### Return type

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

> crate::models::DeleteVmGroupResponse delete_vm_group(delete_vm_group_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Deletes a specified VM group.

### Parameters


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

### Return type

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

> crate::models::ReadVmGroupsResponse read_vm_groups(read_vm_groups_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Lists one or more group of virtual machines (VMs).

### Parameters


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

### Return type

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


## scale_down_vm_group

> crate::models::ScaleDownVmGroupResponse scale_down_vm_group(scale_down_vm_group_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Deletes virtual machines (VMs) from a VM group.<br /> The oldest VMs are the first to be deleted.

### Parameters


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

### Return type

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


## scale_up_vm_group

> crate::models::ScaleUpVmGroupResponse scale_up_vm_group(scale_up_vm_group_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Creates additional virtual machines (VMs) in a VM group.<br /> The new VMs use the current version of the VM template.

### Parameters


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

### Return type

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

> crate::models::UpdateVmGroupResponse update_vm_group(update_vm_group_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Modifies the specified attributes of a group of virtual machines (VMs).

### Parameters


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

### Return type

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