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

# \VmTemplateApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_vm_template**](VmTemplateApi.md#create_vm_template) | **POST** /CreateVmTemplate | 
[**delete_vm_template**](VmTemplateApi.md#delete_vm_template) | **POST** /DeleteVmTemplate | 
[**read_vm_templates**](VmTemplateApi.md#read_vm_templates) | **POST** /ReadVmTemplates | 
[**update_vm_template**](VmTemplateApi.md#update_vm_template) | **POST** /UpdateVmTemplate | 



## create_vm_template

> crate::models::CreateVmTemplateResponse create_vm_template(create_vm_template_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Creates a virtual machine (VM) template. You can then use the VM template to create VM groups.<br /> You can create up to 50 VM templates in your account.

### Parameters


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

### Return type

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

> crate::models::DeleteVmTemplateResponse delete_vm_template(delete_vm_template_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Deletes a virtual machine (VM) template.<br /> You cannot delete a template currently used by a VM group.

### Parameters


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

### Return type

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

> crate::models::ReadVmTemplatesResponse read_vm_templates(read_vm_templates_request)


> [WARNING]<br /> > This feature is currently under development and may not function properly.<br />  Lists one or more virtual machine (VM) templates.

### Parameters


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

### Return type

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

> crate::models::UpdateVmTemplateResponse update_vm_template(update_vm_template_request)


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

### Parameters


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

### Return type

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