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

# \DedicatedGroupApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_dedicated_group**](DedicatedGroupApi.md#create_dedicated_group) | **POST** /CreateDedicatedGroup | 
[**delete_dedicated_group**](DedicatedGroupApi.md#delete_dedicated_group) | **POST** /DeleteDedicatedGroup | 
[**read_dedicated_groups**](DedicatedGroupApi.md#read_dedicated_groups) | **POST** /ReadDedicatedGroups | 
[**update_dedicated_group**](DedicatedGroupApi.md#update_dedicated_group) | **POST** /UpdateDedicatedGroup | 



## create_dedicated_group

> crate::models::CreateDedicatedGroupResponse create_dedicated_group(create_dedicated_group_request)


> [WARNING]<br /> > This feature is currently in beta.<br />  Creates a dedicated group for virtual machines (VMs).<br /><br /> For more information, see [About Dedicated Groups](https://docs.outscale.com/en/userguide/About-Dedicated-Groups.html).

### Parameters


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

### Return type

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

> crate::models::DeleteDedicatedGroupResponse delete_dedicated_group(delete_dedicated_group_request)


> [WARNING]<br /> > This feature is currently in beta.<br />  Deletes a specified dedicated group of virtual machines (VMs).<br />  **[WARNING]**<br /> A dedicated group can be deleted only if no VM or Net is in the dedicated group. Otherwise, you need to force the deletion.<br /> If you force the deletion:<br /> - all VMs are terminated.<br /> - all Nets are deleted, and all resources associated with Nets are detached.

### Parameters


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

### Return type

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

> crate::models::ReadDedicatedGroupsResponse read_dedicated_groups(read_dedicated_groups_request)


> [WARNING]<br /> > This feature is currently in beta.<br />  List one or more dedicated groups of virtual machines (VMs).

### Parameters


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

### Return type

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

> crate::models::UpdateDedicatedGroupResponse update_dedicated_group(update_dedicated_group_request)


> [WARNING]<br /> > This feature is currently in beta.<br />  Modifies the name of a specified dedicated group.<br />

### Parameters


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

### Return type

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