nautobot-openapi 0.3.1

# \VirtualizationApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**virtualization_cluster_groups_bulk_destroy**](VirtualizationApi.md#virtualization_cluster_groups_bulk_destroy) | **DELETE** /virtualization/cluster-groups/ | 
[**virtualization_cluster_groups_bulk_partial_update**](VirtualizationApi.md#virtualization_cluster_groups_bulk_partial_update) | **PATCH** /virtualization/cluster-groups/ | 
[**virtualization_cluster_groups_bulk_update**](VirtualizationApi.md#virtualization_cluster_groups_bulk_update) | **PUT** /virtualization/cluster-groups/ | 
[**virtualization_cluster_groups_create**](VirtualizationApi.md#virtualization_cluster_groups_create) | **POST** /virtualization/cluster-groups/ | 
[**virtualization_cluster_groups_destroy**](VirtualizationApi.md#virtualization_cluster_groups_destroy) | **DELETE** /virtualization/cluster-groups/{id}/ | 
[**virtualization_cluster_groups_list**](VirtualizationApi.md#virtualization_cluster_groups_list) | **GET** /virtualization/cluster-groups/ | 
[**virtualization_cluster_groups_notes_create**](VirtualizationApi.md#virtualization_cluster_groups_notes_create) | **POST** /virtualization/cluster-groups/{id}/notes/ | 
[**virtualization_cluster_groups_notes_list**](VirtualizationApi.md#virtualization_cluster_groups_notes_list) | **GET** /virtualization/cluster-groups/{id}/notes/ | 
[**virtualization_cluster_groups_partial_update**](VirtualizationApi.md#virtualization_cluster_groups_partial_update) | **PATCH** /virtualization/cluster-groups/{id}/ | 
[**virtualization_cluster_groups_retrieve**](VirtualizationApi.md#virtualization_cluster_groups_retrieve) | **GET** /virtualization/cluster-groups/{id}/ | 
[**virtualization_cluster_groups_update**](VirtualizationApi.md#virtualization_cluster_groups_update) | **PUT** /virtualization/cluster-groups/{id}/ | 
[**virtualization_cluster_types_bulk_destroy**](VirtualizationApi.md#virtualization_cluster_types_bulk_destroy) | **DELETE** /virtualization/cluster-types/ | 
[**virtualization_cluster_types_bulk_partial_update**](VirtualizationApi.md#virtualization_cluster_types_bulk_partial_update) | **PATCH** /virtualization/cluster-types/ | 
[**virtualization_cluster_types_bulk_update**](VirtualizationApi.md#virtualization_cluster_types_bulk_update) | **PUT** /virtualization/cluster-types/ | 
[**virtualization_cluster_types_create**](VirtualizationApi.md#virtualization_cluster_types_create) | **POST** /virtualization/cluster-types/ | 
[**virtualization_cluster_types_destroy**](VirtualizationApi.md#virtualization_cluster_types_destroy) | **DELETE** /virtualization/cluster-types/{id}/ | 
[**virtualization_cluster_types_list**](VirtualizationApi.md#virtualization_cluster_types_list) | **GET** /virtualization/cluster-types/ | 
[**virtualization_cluster_types_notes_create**](VirtualizationApi.md#virtualization_cluster_types_notes_create) | **POST** /virtualization/cluster-types/{id}/notes/ | 
[**virtualization_cluster_types_notes_list**](VirtualizationApi.md#virtualization_cluster_types_notes_list) | **GET** /virtualization/cluster-types/{id}/notes/ | 
[**virtualization_cluster_types_partial_update**](VirtualizationApi.md#virtualization_cluster_types_partial_update) | **PATCH** /virtualization/cluster-types/{id}/ | 
[**virtualization_cluster_types_retrieve**](VirtualizationApi.md#virtualization_cluster_types_retrieve) | **GET** /virtualization/cluster-types/{id}/ | 
[**virtualization_cluster_types_update**](VirtualizationApi.md#virtualization_cluster_types_update) | **PUT** /virtualization/cluster-types/{id}/ | 
[**virtualization_clusters_bulk_destroy**](VirtualizationApi.md#virtualization_clusters_bulk_destroy) | **DELETE** /virtualization/clusters/ | 
[**virtualization_clusters_bulk_partial_update**](VirtualizationApi.md#virtualization_clusters_bulk_partial_update) | **PATCH** /virtualization/clusters/ | 
[**virtualization_clusters_bulk_update**](VirtualizationApi.md#virtualization_clusters_bulk_update) | **PUT** /virtualization/clusters/ | 
[**virtualization_clusters_create**](VirtualizationApi.md#virtualization_clusters_create) | **POST** /virtualization/clusters/ | 
[**virtualization_clusters_destroy**](VirtualizationApi.md#virtualization_clusters_destroy) | **DELETE** /virtualization/clusters/{id}/ | 
[**virtualization_clusters_list**](VirtualizationApi.md#virtualization_clusters_list) | **GET** /virtualization/clusters/ | 
[**virtualization_clusters_notes_create**](VirtualizationApi.md#virtualization_clusters_notes_create) | **POST** /virtualization/clusters/{id}/notes/ | 
[**virtualization_clusters_notes_list**](VirtualizationApi.md#virtualization_clusters_notes_list) | **GET** /virtualization/clusters/{id}/notes/ | 
[**virtualization_clusters_partial_update**](VirtualizationApi.md#virtualization_clusters_partial_update) | **PATCH** /virtualization/clusters/{id}/ | 
[**virtualization_clusters_retrieve**](VirtualizationApi.md#virtualization_clusters_retrieve) | **GET** /virtualization/clusters/{id}/ | 
[**virtualization_clusters_update**](VirtualizationApi.md#virtualization_clusters_update) | **PUT** /virtualization/clusters/{id}/ | 
[**virtualization_interfaces_bulk_destroy**](VirtualizationApi.md#virtualization_interfaces_bulk_destroy) | **DELETE** /virtualization/interfaces/ | 
[**virtualization_interfaces_bulk_partial_update**](VirtualizationApi.md#virtualization_interfaces_bulk_partial_update) | **PATCH** /virtualization/interfaces/ | 
[**virtualization_interfaces_bulk_update**](VirtualizationApi.md#virtualization_interfaces_bulk_update) | **PUT** /virtualization/interfaces/ | 
[**virtualization_interfaces_create**](VirtualizationApi.md#virtualization_interfaces_create) | **POST** /virtualization/interfaces/ | 
[**virtualization_interfaces_destroy**](VirtualizationApi.md#virtualization_interfaces_destroy) | **DELETE** /virtualization/interfaces/{id}/ | 
[**virtualization_interfaces_list**](VirtualizationApi.md#virtualization_interfaces_list) | **GET** /virtualization/interfaces/ | 
[**virtualization_interfaces_notes_create**](VirtualizationApi.md#virtualization_interfaces_notes_create) | **POST** /virtualization/interfaces/{id}/notes/ | 
[**virtualization_interfaces_notes_list**](VirtualizationApi.md#virtualization_interfaces_notes_list) | **GET** /virtualization/interfaces/{id}/notes/ | 
[**virtualization_interfaces_partial_update**](VirtualizationApi.md#virtualization_interfaces_partial_update) | **PATCH** /virtualization/interfaces/{id}/ | 
[**virtualization_interfaces_retrieve**](VirtualizationApi.md#virtualization_interfaces_retrieve) | **GET** /virtualization/interfaces/{id}/ | 
[**virtualization_interfaces_update**](VirtualizationApi.md#virtualization_interfaces_update) | **PUT** /virtualization/interfaces/{id}/ | 
[**virtualization_virtual_machines_bulk_destroy**](VirtualizationApi.md#virtualization_virtual_machines_bulk_destroy) | **DELETE** /virtualization/virtual-machines/ | 
[**virtualization_virtual_machines_bulk_partial_update**](VirtualizationApi.md#virtualization_virtual_machines_bulk_partial_update) | **PATCH** /virtualization/virtual-machines/ | 
[**virtualization_virtual_machines_bulk_update**](VirtualizationApi.md#virtualization_virtual_machines_bulk_update) | **PUT** /virtualization/virtual-machines/ | 
[**virtualization_virtual_machines_create**](VirtualizationApi.md#virtualization_virtual_machines_create) | **POST** /virtualization/virtual-machines/ | 
[**virtualization_virtual_machines_destroy**](VirtualizationApi.md#virtualization_virtual_machines_destroy) | **DELETE** /virtualization/virtual-machines/{id}/ | 
[**virtualization_virtual_machines_list**](VirtualizationApi.md#virtualization_virtual_machines_list) | **GET** /virtualization/virtual-machines/ | 
[**virtualization_virtual_machines_notes_create**](VirtualizationApi.md#virtualization_virtual_machines_notes_create) | **POST** /virtualization/virtual-machines/{id}/notes/ | 
[**virtualization_virtual_machines_notes_list**](VirtualizationApi.md#virtualization_virtual_machines_notes_list) | **GET** /virtualization/virtual-machines/{id}/notes/ | 
[**virtualization_virtual_machines_partial_update**](VirtualizationApi.md#virtualization_virtual_machines_partial_update) | **PATCH** /virtualization/virtual-machines/{id}/ | 
[**virtualization_virtual_machines_retrieve**](VirtualizationApi.md#virtualization_virtual_machines_retrieve) | **GET** /virtualization/virtual-machines/{id}/ | 
[**virtualization_virtual_machines_update**](VirtualizationApi.md#virtualization_virtual_machines_update) | **PUT** /virtualization/virtual-machines/{id}/ | 



## virtualization_cluster_groups_bulk_destroy

> virtualization_cluster_groups_bulk_destroy(bulk_operation_request, format)


Destroy a list of cluster group objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[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)


## virtualization_cluster_groups_bulk_partial_update

> Vec<crate::models::ClusterGroup> virtualization_cluster_groups_bulk_partial_update(patched_bulk_writable_cluster_group_request, format)


Partial update a list of cluster group objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_cluster_group_request** | [**Vec<crate::models::PatchedBulkWritableClusterGroupRequest>**](PatchedBulkWritableClusterGroupRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ClusterGroup>**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_bulk_update

> Vec<crate::models::ClusterGroup> virtualization_cluster_groups_bulk_update(bulk_writable_cluster_group_request, format)


Update a list of cluster group objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_cluster_group_request** | [**Vec<crate::models::BulkWritableClusterGroupRequest>**](BulkWritableClusterGroupRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ClusterGroup>**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_create

> crate::models::ClusterGroup virtualization_cluster_groups_create(cluster_group_request, format)


Create one or more cluster group objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster_group_request** | [**ClusterGroupRequest**](ClusterGroupRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ClusterGroup**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_destroy

> virtualization_cluster_groups_destroy(id, format)


Destroy a cluster group object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## virtualization_cluster_groups_list

> crate::models::PaginatedClusterGroupList virtualization_cluster_groups_list(clusters, clusters__isnull, clusters__n, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_clusters, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)


Retrieve a list of cluster group objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**clusters** | Option<[**Vec<String>**](String.md)> |  |  |
**clusters__isnull** | Option<**bool**> | Clusters (name or ID) is null |  |
**clusters__n** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_clusters** | Option<**bool**> | Has clusters |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedClusterGroupList**](PaginatedClusterGroupList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_notes_create

> crate::models::Note virtualization_cluster_groups_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_notes_list

> crate::models::PaginatedNoteList virtualization_cluster_groups_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_partial_update

> crate::models::ClusterGroup virtualization_cluster_groups_partial_update(id, format, patched_cluster_group_request)


Partial update a cluster group object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**format** | Option<**String**> |  |  |
**patched_cluster_group_request** | Option<[**PatchedClusterGroupRequest**](PatchedClusterGroupRequest.md)> |  |  |

### Return type

[**crate::models::ClusterGroup**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_retrieve

> crate::models::ClusterGroup virtualization_cluster_groups_retrieve(id, format, depth, exclude_m2m)


Retrieve a cluster group object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::ClusterGroup**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_groups_update

> crate::models::ClusterGroup virtualization_cluster_groups_update(id, cluster_group_request, format)


Update a cluster group object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster group. | [required] |
**cluster_group_request** | [**ClusterGroupRequest**](ClusterGroupRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ClusterGroup**](ClusterGroup.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_bulk_destroy

> virtualization_cluster_types_bulk_destroy(bulk_operation_request, format)


Destroy a list of cluster type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[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)


## virtualization_cluster_types_bulk_partial_update

> Vec<crate::models::ClusterType> virtualization_cluster_types_bulk_partial_update(patched_bulk_writable_cluster_type_request, format)


Partial update a list of cluster type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_cluster_type_request** | [**Vec<crate::models::PatchedBulkWritableClusterTypeRequest>**](PatchedBulkWritableClusterTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ClusterType>**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_bulk_update

> Vec<crate::models::ClusterType> virtualization_cluster_types_bulk_update(bulk_writable_cluster_type_request, format)


Update a list of cluster type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_cluster_type_request** | [**Vec<crate::models::BulkWritableClusterTypeRequest>**](BulkWritableClusterTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::ClusterType>**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_create

> crate::models::ClusterType virtualization_cluster_types_create(cluster_type_request, format)


Create one or more cluster type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster_type_request** | [**ClusterTypeRequest**](ClusterTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ClusterType**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_destroy

> virtualization_cluster_types_destroy(id, format)


Destroy a cluster type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## virtualization_cluster_types_list

> crate::models::PaginatedClusterTypeList virtualization_cluster_types_list(clusters, clusters__isnull, clusters__n, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, format, has_clusters, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, teams, teams__isnull, teams__n, depth, exclude_m2m)


Retrieve a list of cluster type objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**clusters** | Option<[**Vec<String>**](String.md)> |  |  |
**clusters__isnull** | Option<**bool**> | Clusters (name or ID) is null |  |
**clusters__n** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_clusters** | Option<**bool**> | Has clusters |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedClusterTypeList**](PaginatedClusterTypeList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_notes_create

> crate::models::Note virtualization_cluster_types_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_notes_list

> crate::models::PaginatedNoteList virtualization_cluster_types_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_partial_update

> crate::models::ClusterType virtualization_cluster_types_partial_update(id, format, patched_cluster_type_request)


Partial update a cluster type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**format** | Option<**String**> |  |  |
**patched_cluster_type_request** | Option<[**PatchedClusterTypeRequest**](PatchedClusterTypeRequest.md)> |  |  |

### Return type

[**crate::models::ClusterType**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_retrieve

> crate::models::ClusterType virtualization_cluster_types_retrieve(id, format, depth, exclude_m2m)


Retrieve a cluster type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::ClusterType**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_cluster_types_update

> crate::models::ClusterType virtualization_cluster_types_update(id, cluster_type_request, format)


Update a cluster type object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster type. | [required] |
**cluster_type_request** | [**ClusterTypeRequest**](ClusterTypeRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::ClusterType**](ClusterType.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_bulk_destroy

> virtualization_clusters_bulk_destroy(bulk_operation_request, format)


Destroy a list of cluster objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[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)


## virtualization_clusters_bulk_partial_update

> Vec<crate::models::Cluster> virtualization_clusters_bulk_partial_update(patched_bulk_writable_cluster_request, format)


Partial update a list of cluster objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_cluster_request** | [**Vec<crate::models::PatchedBulkWritableClusterRequest>**](PatchedBulkWritableClusterRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Cluster>**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_bulk_update

> Vec<crate::models::Cluster> virtualization_clusters_bulk_update(bulk_writable_cluster_request, format)


Update a list of cluster objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_cluster_request** | [**Vec<crate::models::BulkWritableClusterRequest>**](BulkWritableClusterRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::Cluster>**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_create

> crate::models::Cluster virtualization_clusters_create(cluster_request, format)


Create one or more cluster objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster_request** | [**ClusterRequest**](ClusterRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Cluster**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_destroy

> virtualization_clusters_destroy(id, format)


Destroy a cluster object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## virtualization_clusters_list

> crate::models::PaginatedClusterList virtualization_clusters_list(cluster_group, cluster_group__isnull, cluster_group__n, cluster_group_id, cluster_group_id__isnull, cluster_group_id__n, cluster_type, cluster_type__n, cluster_type_id, cluster_type_id__n, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, devices, devices__isnull, devices__n, dynamic_groups, dynamic_groups__n, format, has_devices, has_virtual_machines, id, id__n, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, location, location__isnull, location__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, q, sort, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, tenant, tenant__isnull, tenant__n, tenant_group, tenant_group__isnull, tenant_group__n, tenant_id, tenant_id__isnull, tenant_id__n, virtual_machines, virtual_machines__isnull, virtual_machines__n, depth, exclude_m2m)


Retrieve a list of cluster objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster_group** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_group__isnull** | Option<**bool**> | Parent group (ID or name) is null |  |
**cluster_group__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_group_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Parent group (ID) - Deprecated (use group filter) |  |
**cluster_group_id__isnull** | Option<**bool**> | Parent group (ID) - Deprecated (use group filter) is null |  |
**cluster_group_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Parent group (ID) - Deprecated (use group filter) |  |
**cluster_type** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_type__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_type_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster type (ID) - Deprecated (use type filter) |  |
**cluster_type_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster type (ID) - Deprecated (use type filter) |  |
**comments** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__re** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**devices** | Option<[**Vec<String>**](String.md)> |  |  |
**devices__isnull** | Option<**bool**> | Devices (name or ID) is null |  |
**devices__n** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_devices** | Option<**bool**> | Has devices |  |
**has_virtual_machines** | Option<**bool**> | Has virtual machines |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**location** | Option<[**Vec<String>**](String.md)> |  |  |
**location__isnull** | Option<**bool**> | Location (name or ID) is null |  |
**location__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**q** | Option<**String**> | Search |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant__isnull** | Option<**bool**> | Tenant (name or ID) is null |  |
**tenant__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group__isnull** | Option<**bool**> | Tenant Group (name or ID) is null |  |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**tenant_id__isnull** | Option<**bool**> | Tenant (ID) (deprecated, use \"tenant\" filter instead) is null |  |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**virtual_machines** | Option<[**Vec<String>**](String.md)> |  |  |
**virtual_machines__isnull** | Option<**bool**> | Virtual machines (name or ID) is null |  |
**virtual_machines__n** | Option<[**Vec<String>**](String.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedClusterList**](PaginatedClusterList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_notes_create

> crate::models::Note virtualization_clusters_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_notes_list

> crate::models::PaginatedNoteList virtualization_clusters_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_partial_update

> crate::models::Cluster virtualization_clusters_partial_update(id, format, patched_cluster_request)


Partial update a cluster object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**format** | Option<**String**> |  |  |
**patched_cluster_request** | Option<[**PatchedClusterRequest**](PatchedClusterRequest.md)> |  |  |

### Return type

[**crate::models::Cluster**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_retrieve

> crate::models::Cluster virtualization_clusters_retrieve(id, format, depth, exclude_m2m)


Retrieve a cluster object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::Cluster**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_clusters_update

> crate::models::Cluster virtualization_clusters_update(id, cluster_request, format)


Update a cluster object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this cluster. | [required] |
**cluster_request** | [**ClusterRequest**](ClusterRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Cluster**](Cluster.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_bulk_destroy

> virtualization_interfaces_bulk_destroy(bulk_operation_request, format)


Destroy a list of VM interface objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[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)


## virtualization_interfaces_bulk_partial_update

> Vec<crate::models::VmInterface> virtualization_interfaces_bulk_partial_update(patched_bulk_writable_vm_interface_request, format)


Partial update a list of VM interface objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_vm_interface_request** | [**Vec<crate::models::PatchedBulkWritableVmInterfaceRequest>**](PatchedBulkWritableVMInterfaceRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::VmInterface>**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_bulk_update

> Vec<crate::models::VmInterface> virtualization_interfaces_bulk_update(bulk_writable_vm_interface_request, format)


Update a list of VM interface objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_vm_interface_request** | [**Vec<crate::models::BulkWritableVmInterfaceRequest>**](BulkWritableVMInterfaceRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::VmInterface>**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_create

> crate::models::VmInterface virtualization_interfaces_create(writable_vm_interface_request, format)


Create one or more VM interface objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**writable_vm_interface_request** | [**WritableVmInterfaceRequest**](WritableVmInterfaceRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::VmInterface**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_destroy

> virtualization_interfaces_destroy(id, format)


Destroy a VM interface object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## virtualization_interfaces_list

> crate::models::PaginatedVmInterfaceList virtualization_interfaces_list(bridge, bridge__isnull, bridge__n, bridged_interfaces, bridged_interfaces__isnull, bridged_interfaces__n, child_interfaces, child_interfaces__isnull, child_interfaces__n, cluster, cluster__n, cluster_id, cluster_id__n, contacts, contacts__isnull, contacts__n, description, description__ic, description__ie, description__iew, description__ire, description__isw, description__n, description__nic, description__nie, description__niew, description__nire, description__nisw, description__nre, description__re, dynamic_groups, dynamic_groups__n, enabled, format, has_bridged_interfaces, has_child_interfaces, has_ip_addresses, has_tagged_vlans, id, id__n, ip_addresses, limit, mac_address, mac_address__ic, mac_address__ie, mac_address__iew, mac_address__ire, mac_address__isw, mac_address__n, mac_address__nic, mac_address__nie, mac_address__niew, mac_address__nire, mac_address__nisw, mac_address__nre, mac_address__re, mode, mode__ic, mode__ie, mode__iew, mode__ire, mode__isw, mode__n, mode__nic, mode__nie, mode__niew, mode__nire, mode__nisw, mode__nre, mode__re, mtu, mtu__gt, mtu__gte, mtu__isnull, mtu__lt, mtu__lte, mtu__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, parent_interface, parent_interface__isnull, parent_interface__n, q, role, role__isnull, role__n, sort, status, status__n, tagged_vlans, tagged_vlans__n, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, untagged_vlan, untagged_vlan__isnull, untagged_vlan__n, virtual_machine, virtual_machine__n, virtual_machine_id, virtual_machine_id__n, vlan_id, depth, exclude_m2m)


Retrieve a list of VM interface objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bridge** | Option<[**Vec<String>**](String.md)> |  |  |
**bridge__isnull** | Option<**bool**> | Bridge interface (name or ID) is null |  |
**bridge__n** | Option<[**Vec<String>**](String.md)> |  |  |
**bridged_interfaces** | Option<[**Vec<String>**](String.md)> |  |  |
**bridged_interfaces__isnull** | Option<**bool**> | Bridged interfaces (name or ID) is null |  |
**bridged_interfaces__n** | Option<[**Vec<String>**](String.md)> |  |  |
**child_interfaces** | Option<[**Vec<String>**](String.md)> |  |  |
**child_interfaces__isnull** | Option<**bool**> | Child interfaces (name or ID) is null |  |
**child_interfaces__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster (ID) - Deprecated (use cluster filter) |  |
**cluster_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster (ID) - Deprecated (use cluster filter) |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__n** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**description__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**description__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**description__re** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**enabled** | Option<**bool**> |  |  |
**format** | Option<**String**> |  |  |
**has_bridged_interfaces** | Option<**bool**> | Has Bridged Interfaces |  |
**has_child_interfaces** | Option<**bool**> | Has child interfaces |  |
**has_ip_addresses** | Option<**bool**> | Has IP addresses |  |
**has_tagged_vlans** | Option<**bool**> | Has Tagged VLANs |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**ip_addresses** | Option<[**Vec<String>**](String.md)> | IP addresses (address or ID) |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**mac_address** | Option<[**Vec<String>**](String.md)> | MAC address |  |
**mac_address__ic** | Option<[**Vec<String>**](String.md)> | MAC address contains |  |
**mac_address__ie** | Option<[**Vec<String>**](String.md)> | MAC address |  |
**mac_address__iew** | Option<[**Vec<String>**](String.md)> | MAC address ends with |  |
**mac_address__ire** | Option<[**Vec<String>**](String.md)> | MAC address matches regex |  |
**mac_address__isw** | Option<[**Vec<String>**](String.md)> | MAC address starts with |  |
**mac_address__n** | Option<[**Vec<String>**](String.md)> | Exclude MAC address |  |
**mac_address__nic** | Option<[**Vec<String>**](String.md)> | Exclude MAC address contains |  |
**mac_address__nie** | Option<[**Vec<String>**](String.md)> | Exclude MAC address |  |
**mac_address__niew** | Option<[**Vec<String>**](String.md)> | Exclude MAC address ends with |  |
**mac_address__nire** | Option<[**Vec<String>**](String.md)> | Exclude MAC address matches regex |  |
**mac_address__nisw** | Option<[**Vec<String>**](String.md)> | Exclude MAC address starts with |  |
**mac_address__nre** | Option<[**Vec<String>**](String.md)> | Exclude MAC address matches regex |  |
**mac_address__re** | Option<[**Vec<String>**](String.md)> | MAC address matches regex |  |
**mode** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__n** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**mode__re** | Option<[**Vec<String>**](String.md)> |  |  |
**mtu** | Option<[**Vec<i32>**](i32.md)> |  |  |
**mtu__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**mtu__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**mtu__isnull** | Option<**bool**> |  |  |
**mtu__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**mtu__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**mtu__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**parent_interface** | Option<[**Vec<String>**](String.md)> |  |  |
**parent_interface__isnull** | Option<**bool**> | Parent interface (name or ID) is null |  |
**parent_interface__n** | Option<[**Vec<String>**](String.md)> |  |  |
**q** | Option<**String**> | Search |  |
**role** | Option<[**Vec<String>**](String.md)> |  |  |
**role__isnull** | Option<**bool**> | Role (name or ID) is null |  |
**role__n** | Option<[**Vec<String>**](String.md)> |  |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**status** | Option<[**Vec<String>**](String.md)> |  |  |
**status__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tagged_vlans** | Option<[**Vec<String>**](String.md)> |  |  |
**tagged_vlans__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**untagged_vlan** | Option<[**Vec<String>**](String.md)> |  |  |
**untagged_vlan__isnull** | Option<**bool**> | Untagged VLAN (VID or ID) is null |  |
**untagged_vlan__n** | Option<[**Vec<String>**](String.md)> |  |  |
**virtual_machine** | Option<[**Vec<String>**](String.md)> |  |  |
**virtual_machine__n** | Option<[**Vec<String>**](String.md)> |  |  |
**virtual_machine_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Virtual machine (ID) - Deprecated (use virtual_machine filter) |  |
**virtual_machine_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Virtual machine (ID) - Deprecated (use virtual_machine filter) |  |
**vlan_id** | Option<**String**> | Any assigned VLAN (tagged or untagged) |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedVmInterfaceList**](PaginatedVMInterfaceList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_notes_create

> crate::models::Note virtualization_interfaces_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_notes_list

> crate::models::PaginatedNoteList virtualization_interfaces_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_partial_update

> crate::models::VmInterface virtualization_interfaces_partial_update(id, format, patched_writable_vm_interface_request)


Partial update a VM interface object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**format** | Option<**String**> |  |  |
**patched_writable_vm_interface_request** | Option<[**PatchedWritableVmInterfaceRequest**](PatchedWritableVmInterfaceRequest.md)> |  |  |

### Return type

[**crate::models::VmInterface**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_retrieve

> crate::models::VmInterface virtualization_interfaces_retrieve(id, format, depth, exclude_m2m)


Retrieve a VM interface object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::VmInterface**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_interfaces_update

> crate::models::VmInterface virtualization_interfaces_update(id, writable_vm_interface_request, format)


Update a VM interface object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this VM interface. | [required] |
**writable_vm_interface_request** | [**WritableVmInterfaceRequest**](WritableVmInterfaceRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::VmInterface**](VMInterface.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_bulk_destroy

> virtualization_virtual_machines_bulk_destroy(bulk_operation_request, format)


Destroy a list of virtual machine objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_operation_request** | [**Vec<crate::models::BulkOperationRequest>**](BulkOperationRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: Not defined

[[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)


## virtualization_virtual_machines_bulk_partial_update

> Vec<crate::models::VirtualMachine> virtualization_virtual_machines_bulk_partial_update(patched_bulk_writable_virtual_machine_request, format)


Partial update a list of virtual machine objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patched_bulk_writable_virtual_machine_request** | [**Vec<crate::models::PatchedBulkWritableVirtualMachineRequest>**](PatchedBulkWritableVirtualMachineRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::VirtualMachine>**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_bulk_update

> Vec<crate::models::VirtualMachine> virtualization_virtual_machines_bulk_update(bulk_writable_virtual_machine_request, format)


Update a list of virtual machine objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_writable_virtual_machine_request** | [**Vec<crate::models::BulkWritableVirtualMachineRequest>**](BulkWritableVirtualMachineRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<crate::models::VirtualMachine>**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_create

> crate::models::VirtualMachine virtualization_virtual_machines_create(virtual_machine_request, format)


Create one or more virtual machine objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**virtual_machine_request** | [**VirtualMachineRequest**](VirtualMachineRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::VirtualMachine**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_destroy

> virtualization_virtual_machines_destroy(id, format)


Destroy a virtual machine object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**format** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## virtualization_virtual_machines_list

> crate::models::PaginatedVirtualMachineList virtualization_virtual_machines_list(cluster, cluster__n, cluster_group, cluster_group__isnull, cluster_group__n, cluster_group_id, cluster_group_id__isnull, cluster_group_id__n, cluster_id, cluster_id__n, cluster_type, cluster_type__n, cluster_type_id, cluster_type_id__n, comments, comments__ic, comments__ie, comments__iew, comments__ire, comments__isw, comments__n, comments__nic, comments__nie, comments__niew, comments__nire, comments__nisw, comments__nre, comments__re, contacts, contacts__isnull, contacts__n, created, created__gt, created__gte, created__isnull, created__lt, created__lte, created__n, disk, disk__gt, disk__gte, disk__isnull, disk__lt, disk__lte, disk__n, dynamic_groups, dynamic_groups__n, format, has_interfaces, has_ip_addresses, has_primary_ip, has_services, has_software_image_files, has_software_version, id, id__n, interfaces, interfaces__isnull, interfaces__n, ip_addresses, last_updated, last_updated__gt, last_updated__gte, last_updated__isnull, last_updated__lt, last_updated__lte, last_updated__n, limit, local_config_context_data, local_config_context_schema, local_config_context_schema__isnull, local_config_context_schema__n, local_config_context_schema_id, local_config_context_schema_id__isnull, local_config_context_schema_id__n, location, location__isnull, location__n, mac_address, mac_address__ic, mac_address__ie, mac_address__iew, mac_address__ire, mac_address__isw, mac_address__n, mac_address__nic, mac_address__nie, mac_address__niew, mac_address__nire, mac_address__nisw, mac_address__nre, mac_address__re, memory, memory__gt, memory__gte, memory__isnull, memory__lt, memory__lte, memory__n, name, name__ic, name__ie, name__iew, name__ire, name__isw, name__n, name__nic, name__nie, name__niew, name__nire, name__nisw, name__nre, name__re, offset, platform, platform__isnull, platform__n, platform_id, platform_id__isnull, platform_id__n, primary_ip4, primary_ip6, q, role, role__isnull, role__n, services, services__isnull, services__n, software_image_files, software_image_files__n, software_version, software_version__isnull, software_version__n, sort, status, status__n, tags, tags__isnull, tags__n, teams, teams__isnull, teams__n, tenant, tenant__isnull, tenant__n, tenant_group, tenant_group__isnull, tenant_group__n, tenant_id, tenant_id__isnull, tenant_id__n, vcpus, vcpus__gt, vcpus__gte, vcpus__isnull, vcpus__lt, vcpus__lte, vcpus__n, depth, exclude_m2m)


Retrieve a list of virtual machine objects.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cluster** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_group** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_group__isnull** | Option<**bool**> | Cluster group (ID or name) is null |  |
**cluster_group__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_group_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster group (ID) - Deprecated (use cluster_group filter) |  |
**cluster_group_id__isnull** | Option<**bool**> | Cluster group (ID) - Deprecated (use cluster_group filter) is null |  |
**cluster_group_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster group (ID) - Deprecated (use cluster_group filter) |  |
**cluster_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster (ID) - Deprecated (use cluster filter) |  |
**cluster_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster (ID) - Deprecated (use cluster filter) |  |
**cluster_type** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_type__n** | Option<[**Vec<String>**](String.md)> |  |  |
**cluster_type_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Cluster type (ID) - Deprecated (use cluster_type filter) |  |
**cluster_type_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Cluster type (ID) - Deprecated (use cluster_type filter) |  |
**comments** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__n** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**comments__re** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts** | Option<[**Vec<String>**](String.md)> |  |  |
**contacts__isnull** | Option<**bool**> | Contacts (name or ID) is null |  |
**contacts__n** | Option<[**Vec<String>**](String.md)> |  |  |
**created** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__isnull** | Option<**bool**> |  |  |
**created__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**created__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**created__n** | Option<[**Vec<String>**](String.md)> |  |  |
**disk** | Option<[**Vec<i32>**](i32.md)> |  |  |
**disk__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**disk__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**disk__isnull** | Option<**bool**> |  |  |
**disk__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**disk__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**disk__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**dynamic_groups** | Option<[**Vec<String>**](String.md)> |  |  |
**dynamic_groups__n** | Option<[**Vec<String>**](String.md)> |  |  |
**format** | Option<**String**> |  |  |
**has_interfaces** | Option<**bool**> | Has interfaces |  |
**has_ip_addresses** | Option<**bool**> | Has IP addresses |  |
**has_primary_ip** | Option<**bool**> | Has a primary IP |  |
**has_services** | Option<**bool**> | Has services |  |
**has_software_image_files** | Option<**bool**> | Has software image files |  |
**has_software_version** | Option<**bool**> | Has software version |  |
**id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Unique object identifier, either a UUID primary key or a composite key. |  |
**id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> |  |  |
**interfaces** | Option<[**Vec<String>**](String.md)> |  |  |
**interfaces__isnull** | Option<**bool**> | Interfaces (name or ID) is null |  |
**interfaces__n** | Option<[**Vec<String>**](String.md)> |  |  |
**ip_addresses** | Option<[**Vec<String>**](String.md)> | IP addresses (address or ID) |  |
**last_updated** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__gte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__isnull** | Option<**bool**> |  |  |
**last_updated__lt** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__lte** | Option<[**Vec<String>**](String.md)> |  |  |
**last_updated__n** | Option<[**Vec<String>**](String.md)> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**local_config_context_data** | Option<**bool**> | Has local config context data |  |
**local_config_context_schema** | Option<[**Vec<String>**](String.md)> |  |  |
**local_config_context_schema__isnull** | Option<**bool**> | Schema (ID or name) is null |  |
**local_config_context_schema__n** | Option<[**Vec<String>**](String.md)> |  |  |
**local_config_context_schema_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Schema (ID) - Deprecated (use local_context_schema filter) |  |
**local_config_context_schema_id__isnull** | Option<**bool**> | Schema (ID) - Deprecated (use local_context_schema filter) is null |  |
**local_config_context_schema_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Schema (ID) - Deprecated (use local_context_schema filter) |  |
**location** | Option<[**Vec<String>**](String.md)> |  |  |
**location__isnull** | Option<**bool**> | Location (name or ID) is null |  |
**location__n** | Option<[**Vec<String>**](String.md)> |  |  |
**mac_address** | Option<[**Vec<String>**](String.md)> | MAC address |  |
**mac_address__ic** | Option<[**Vec<String>**](String.md)> | MAC address contains |  |
**mac_address__ie** | Option<[**Vec<String>**](String.md)> | MAC address |  |
**mac_address__iew** | Option<[**Vec<String>**](String.md)> | MAC address ends with |  |
**mac_address__ire** | Option<[**Vec<String>**](String.md)> | MAC address matches regex |  |
**mac_address__isw** | Option<[**Vec<String>**](String.md)> | MAC address starts with |  |
**mac_address__n** | Option<[**Vec<String>**](String.md)> | Exclude MAC address |  |
**mac_address__nic** | Option<[**Vec<String>**](String.md)> | Exclude MAC address contains |  |
**mac_address__nie** | Option<[**Vec<String>**](String.md)> | Exclude MAC address |  |
**mac_address__niew** | Option<[**Vec<String>**](String.md)> | Exclude MAC address ends with |  |
**mac_address__nire** | Option<[**Vec<String>**](String.md)> | Exclude MAC address matches regex |  |
**mac_address__nisw** | Option<[**Vec<String>**](String.md)> | Exclude MAC address starts with |  |
**mac_address__nre** | Option<[**Vec<String>**](String.md)> | Exclude MAC address matches regex |  |
**mac_address__re** | Option<[**Vec<String>**](String.md)> | MAC address matches regex |  |
**memory** | Option<[**Vec<i32>**](i32.md)> |  |  |
**memory__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**memory__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**memory__isnull** | Option<**bool**> |  |  |
**memory__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**memory__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**memory__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**name** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__iew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__ire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__isw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__n** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nic** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nie** | Option<[**Vec<String>**](String.md)> |  |  |
**name__niew** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nire** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nisw** | Option<[**Vec<String>**](String.md)> |  |  |
**name__nre** | Option<[**Vec<String>**](String.md)> |  |  |
**name__re** | Option<[**Vec<String>**](String.md)> |  |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**platform** | Option<[**Vec<String>**](String.md)> |  |  |
**platform__isnull** | Option<**bool**> | Platform (ID or name) is null |  |
**platform__n** | Option<[**Vec<String>**](String.md)> |  |  |
**platform_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Platform (ID) - Deprecated (use platform filter) |  |
**platform_id__isnull** | Option<**bool**> | Platform (ID) - Deprecated (use platform filter) is null |  |
**platform_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Platform (ID) - Deprecated (use platform filter) |  |
**primary_ip4** | Option<[**Vec<String>**](String.md)> | Primary IPv4 Address (address or ID) |  |
**primary_ip6** | Option<[**Vec<String>**](String.md)> | Primary IPv6 Address (address or ID) |  |
**q** | Option<**String**> | Search |  |
**role** | Option<[**Vec<String>**](String.md)> |  |  |
**role__isnull** | Option<**bool**> | Role (name or ID) is null |  |
**role__n** | Option<[**Vec<String>**](String.md)> |  |  |
**services** | Option<[**Vec<String>**](String.md)> |  |  |
**services__isnull** | Option<**bool**> | Services (name or ID) is null |  |
**services__n** | Option<[**Vec<String>**](String.md)> |  |  |
**software_image_files** | Option<[**Vec<String>**](String.md)> |  |  |
**software_image_files__n** | Option<[**Vec<String>**](String.md)> |  |  |
**software_version** | Option<[**Vec<String>**](String.md)> |  |  |
**software_version__isnull** | Option<**bool**> | Software version (version or ID) is null |  |
**software_version__n** | Option<[**Vec<String>**](String.md)> |  |  |
**sort** | Option<**String**> | Which field to use when ordering the results. |  |
**status** | Option<[**Vec<String>**](String.md)> |  |  |
**status__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tags** | Option<[**Vec<String>**](String.md)> |  |  |
**tags__isnull** | Option<**bool**> |  |  |
**tags__n** | Option<[**Vec<String>**](String.md)> |  |  |
**teams** | Option<[**Vec<String>**](String.md)> |  |  |
**teams__isnull** | Option<**bool**> | Teams (name or ID) is null |  |
**teams__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant__isnull** | Option<**bool**> | Tenant (name or ID) is null |  |
**tenant__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_group__isnull** | Option<**bool**> | Tenant Group (name or ID) is null |  |
**tenant_group__n** | Option<[**Vec<String>**](String.md)> |  |  |
**tenant_id** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**tenant_id__isnull** | Option<**bool**> | Tenant (ID) (deprecated, use \"tenant\" filter instead) is null |  |
**tenant_id__n** | Option<[**Vec<uuid::Uuid>**](uuid::Uuid.md)> | Exclude Tenant (ID) (deprecated, use \"tenant\" filter instead) |  |
**vcpus** | Option<[**Vec<i32>**](i32.md)> |  |  |
**vcpus__gt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**vcpus__gte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**vcpus__isnull** | Option<**bool**> |  |  |
**vcpus__lt** | Option<[**Vec<i32>**](i32.md)> |  |  |
**vcpus__lte** | Option<[**Vec<i32>**](i32.md)> |  |  |
**vcpus__n** | Option<[**Vec<i32>**](i32.md)> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedVirtualMachineList**](PaginatedVirtualMachineList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_notes_create

> crate::models::Note virtualization_virtual_machines_notes_create(id, note_input_request, format)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**note_input_request** | [**NoteInputRequest**](NoteInputRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::Note**](Note.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_notes_list

> crate::models::PaginatedNoteList virtualization_virtual_machines_notes_list(id, format, limit, offset, depth, exclude_m2m)


API methods for returning or creating notes on an object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**format** | Option<**String**> |  |  |
**limit** | Option<**i32**> | Number of results to return per page. |  |
**offset** | Option<**i32**> | The initial index from which to return the results. |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::PaginatedNoteList**](PaginatedNoteList.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_partial_update

> crate::models::VirtualMachine virtualization_virtual_machines_partial_update(id, format, patched_virtual_machine_request)


Partial update a virtual machine object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**format** | Option<**String**> |  |  |
**patched_virtual_machine_request** | Option<[**PatchedVirtualMachineRequest**](PatchedVirtualMachineRequest.md)> |  |  |

### Return type

[**crate::models::VirtualMachine**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_retrieve

> crate::models::VirtualMachine virtualization_virtual_machines_retrieve(id, format, depth, exclude_m2m)


Retrieve a virtual machine object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**format** | Option<**String**> |  |  |
**depth** | Option<**i32**> | Serializer Depth |  |[default to 1]
**exclude_m2m** | Option<**bool**> | Exclude many-to-many fields from the response |  |[default to false]

### Return type

[**crate::models::VirtualMachine**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv

[[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)


## virtualization_virtual_machines_update

> crate::models::VirtualMachine virtualization_virtual_machines_update(id, virtual_machine_request, format)


Update a virtual machine object.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | A UUID string identifying this virtual machine. | [required] |
**virtual_machine_request** | [**VirtualMachineRequest**](VirtualMachineRequest.md) |  | [required] |
**format** | Option<**String**> |  |  |

### Return type

[**crate::models::VirtualMachine**](VirtualMachine.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)

### HTTP request headers

- **Content-Type**: application/json, text/csv
- **Accept**: application/json, text/csv

[[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)