Skip to content

Latest commit

 

History

History
1694 lines (1065 loc) · 61.1 KB

VirtualizationApi.md

File metadata and controls

1694 lines (1065 loc) · 61.1 KB

\VirtualizationApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
virtualization_cluster_groups_bulk_delete DELETE /virtualization/cluster-groups/
virtualization_cluster_groups_bulk_partial_update PATCH /virtualization/cluster-groups/
virtualization_cluster_groups_bulk_update PUT /virtualization/cluster-groups/
virtualization_cluster_groups_create POST /virtualization/cluster-groups/
virtualization_cluster_groups_delete DELETE /virtualization/cluster-groups/{id}/
virtualization_cluster_groups_list GET /virtualization/cluster-groups/
virtualization_cluster_groups_partial_update PATCH /virtualization/cluster-groups/{id}/
virtualization_cluster_groups_read GET /virtualization/cluster-groups/{id}/
virtualization_cluster_groups_update PUT /virtualization/cluster-groups/{id}/
virtualization_cluster_types_bulk_delete DELETE /virtualization/cluster-types/
virtualization_cluster_types_bulk_partial_update PATCH /virtualization/cluster-types/
virtualization_cluster_types_bulk_update PUT /virtualization/cluster-types/
virtualization_cluster_types_create POST /virtualization/cluster-types/
virtualization_cluster_types_delete DELETE /virtualization/cluster-types/{id}/
virtualization_cluster_types_list GET /virtualization/cluster-types/
virtualization_cluster_types_partial_update PATCH /virtualization/cluster-types/{id}/
virtualization_cluster_types_read GET /virtualization/cluster-types/{id}/
virtualization_cluster_types_update PUT /virtualization/cluster-types/{id}/
virtualization_clusters_bulk_delete DELETE /virtualization/clusters/
virtualization_clusters_bulk_partial_update PATCH /virtualization/clusters/
virtualization_clusters_bulk_update PUT /virtualization/clusters/
virtualization_clusters_create POST /virtualization/clusters/
virtualization_clusters_delete DELETE /virtualization/clusters/{id}/
virtualization_clusters_list GET /virtualization/clusters/
virtualization_clusters_partial_update PATCH /virtualization/clusters/{id}/
virtualization_clusters_read GET /virtualization/clusters/{id}/
virtualization_clusters_update PUT /virtualization/clusters/{id}/
virtualization_interfaces_bulk_delete DELETE /virtualization/interfaces/
virtualization_interfaces_bulk_partial_update PATCH /virtualization/interfaces/
virtualization_interfaces_bulk_update PUT /virtualization/interfaces/
virtualization_interfaces_create POST /virtualization/interfaces/
virtualization_interfaces_delete DELETE /virtualization/interfaces/{id}/
virtualization_interfaces_list GET /virtualization/interfaces/
virtualization_interfaces_partial_update PATCH /virtualization/interfaces/{id}/
virtualization_interfaces_read GET /virtualization/interfaces/{id}/
virtualization_interfaces_update PUT /virtualization/interfaces/{id}/
virtualization_virtual_machines_bulk_delete DELETE /virtualization/virtual-machines/
virtualization_virtual_machines_bulk_partial_update PATCH /virtualization/virtual-machines/
virtualization_virtual_machines_bulk_update PUT /virtualization/virtual-machines/
virtualization_virtual_machines_create POST /virtualization/virtual-machines/
virtualization_virtual_machines_delete DELETE /virtualization/virtual-machines/{id}/
virtualization_virtual_machines_list GET /virtualization/virtual-machines/
virtualization_virtual_machines_partial_update PATCH /virtualization/virtual-machines/{id}/
virtualization_virtual_machines_read GET /virtualization/virtual-machines/{id}/
virtualization_virtual_machines_update PUT /virtualization/virtual-machines/{id}/

virtualization_cluster_groups_bulk_delete

virtualization_cluster_groups_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_bulk_partial_update

crate::models::ClusterGroup virtualization_cluster_groups_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data ClusterGroup [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_bulk_update

crate::models::ClusterGroup virtualization_cluster_groups_bulk_update(data)

Parameters

Name Type Description Required Notes
data ClusterGroup [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_create

crate::models::ClusterGroup virtualization_cluster_groups_create(data)

Parameters

Name Type Description Required Notes
data ClusterGroup [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_delete

virtualization_cluster_groups_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster group. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_list

crate::models::VirtualizationClusterGroupsList200Response virtualization_cluster_groups_list(id, name, slug, description, created, last_updated, q, tag, contact, contact_role, contact_group, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, contact__n, contact_role__n, contact_group__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::VirtualizationClusterGroupsList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_partial_update

crate::models::ClusterGroup virtualization_cluster_groups_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster group. [required]
data ClusterGroup [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_read

crate::models::ClusterGroup virtualization_cluster_groups_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster group. [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_groups_update

crate::models::ClusterGroup virtualization_cluster_groups_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster group. [required]
data ClusterGroup [required]

Return type

crate::models::ClusterGroup

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_bulk_delete

virtualization_cluster_types_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_bulk_partial_update

crate::models::ClusterType virtualization_cluster_types_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data ClusterType [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_bulk_update

crate::models::ClusterType virtualization_cluster_types_bulk_update(data)

Parameters

Name Type Description Required Notes
data ClusterType [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_create

crate::models::ClusterType virtualization_cluster_types_create(data)

Parameters

Name Type Description Required Notes
data ClusterType [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_delete

virtualization_cluster_types_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster type. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_list

crate::models::VirtualizationClusterTypesList200Response virtualization_cluster_types_list(id, name, slug, description, created, last_updated, q, tag, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, slug__n, slug__ic, slug__nic, slug__iew, slug__niew, slug__isw, slug__nisw, slug__ie, slug__nie, slug__empty, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
slug Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
slug__n Option<String>
slug__ic Option<String>
slug__nic Option<String>
slug__iew Option<String>
slug__niew Option<String>
slug__isw Option<String>
slug__nisw Option<String>
slug__ie Option<String>
slug__nie Option<String>
slug__empty Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::VirtualizationClusterTypesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_partial_update

crate::models::ClusterType virtualization_cluster_types_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster type. [required]
data ClusterType [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_read

crate::models::ClusterType virtualization_cluster_types_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster type. [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_cluster_types_update

crate::models::ClusterType virtualization_cluster_types_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster type. [required]
data ClusterType [required]

Return type

crate::models::ClusterType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_bulk_delete

virtualization_clusters_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_bulk_partial_update

crate::models::Cluster virtualization_clusters_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableCluster [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_bulk_update

crate::models::Cluster virtualization_clusters_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableCluster [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_create

crate::models::Cluster virtualization_clusters_create(data)

Parameters

Name Type Description Required Notes
data WritableCluster [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_delete

virtualization_clusters_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_list

crate::models::VirtualizationClustersList200Response virtualization_clusters_list(id, name, created, last_updated, q, tag, tenant_group_id, tenant_group, tenant_id, tenant, contact, contact_role, contact_group, region_id, region, site_group_id, site_group, site_id, site, group_id, group, type_id, r#type, status, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, tenant_group_id__n, tenant_group__n, tenant_id__n, tenant__n, contact__n, contact_role__n, contact_group__n, region_id__n, region__n, site_group_id__n, site_group__n, site_id__n, site__n, group_id__n, group__n, type_id__n, type__n, status__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
tenant_group_id Option<String>
tenant_group Option<String>
tenant_id Option<String>
tenant Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
region_id Option<String>
region Option<String>
site_group_id Option<String>
site_group Option<String>
site_id Option<String>
site Option<String>
group_id Option<String>
group Option<String>
type_id Option<String>
r#type Option<String>
status Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
tenant_group_id__n Option<String>
tenant_group__n Option<String>
tenant_id__n Option<String>
tenant__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
region_id__n Option<String>
region__n Option<String>
site_group_id__n Option<String>
site_group__n Option<String>
site_id__n Option<String>
site__n Option<String>
group_id__n Option<String>
group__n Option<String>
type_id__n Option<String>
type__n Option<String>
status__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::VirtualizationClustersList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_partial_update

crate::models::Cluster virtualization_clusters_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster. [required]
data WritableCluster [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_read

crate::models::Cluster virtualization_clusters_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster. [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_clusters_update

crate::models::Cluster virtualization_clusters_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this cluster. [required]
data WritableCluster [required]

Return type

crate::models::Cluster

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_bulk_delete

virtualization_interfaces_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_bulk_partial_update

crate::models::VmInterface virtualization_interfaces_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableVmInterface [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_bulk_update

crate::models::VmInterface virtualization_interfaces_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableVmInterface [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_create

crate::models::VmInterface virtualization_interfaces_create(data)

Parameters

Name Type Description Required Notes
data WritableVmInterface [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_delete

virtualization_interfaces_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this interface. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_list

crate::models::VirtualizationInterfacesList200Response virtualization_interfaces_list(id, name, enabled, mtu, description, created, last_updated, q, tag, cluster_id, cluster, virtual_machine_id, virtual_machine, parent_id, bridge_id, mac_address, vrf_id, vrf, l2vpn_id, l2vpn, id__n, id__lte, id__lt, id__gte, id__gt, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, mtu__n, mtu__lte, mtu__lt, mtu__gte, mtu__gt, description__n, description__ic, description__nic, description__iew, description__niew, description__isw, description__nisw, description__ie, description__nie, description__empty, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, cluster_id__n, cluster__n, virtual_machine_id__n, virtual_machine__n, parent_id__n, bridge_id__n, mac_address__n, mac_address__ic, mac_address__nic, mac_address__iew, mac_address__niew, mac_address__isw, mac_address__nisw, mac_address__ie, mac_address__nie, vrf_id__n, vrf__n, l2vpn_id__n, l2vpn__n, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
name Option<String>
enabled Option<String>
mtu Option<String>
description Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
cluster_id Option<String>
cluster Option<String>
virtual_machine_id Option<String>
virtual_machine Option<String>
parent_id Option<String>
bridge_id Option<String>
mac_address Option<String>
vrf_id Option<String>
vrf Option<String>
l2vpn_id Option<String>
l2vpn Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
mtu__n Option<String>
mtu__lte Option<String>
mtu__lt Option<String>
mtu__gte Option<String>
mtu__gt Option<String>
description__n Option<String>
description__ic Option<String>
description__nic Option<String>
description__iew Option<String>
description__niew Option<String>
description__isw Option<String>
description__nisw Option<String>
description__ie Option<String>
description__nie Option<String>
description__empty Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
cluster_id__n Option<String>
cluster__n Option<String>
virtual_machine_id__n Option<String>
virtual_machine__n Option<String>
parent_id__n Option<String>
bridge_id__n Option<String>
mac_address__n Option<String>
mac_address__ic Option<String>
mac_address__nic Option<String>
mac_address__iew Option<String>
mac_address__niew Option<String>
mac_address__isw Option<String>
mac_address__nisw Option<String>
mac_address__ie Option<String>
mac_address__nie Option<String>
vrf_id__n Option<String>
vrf__n Option<String>
l2vpn_id__n Option<String>
l2vpn__n Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::VirtualizationInterfacesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_partial_update

crate::models::VmInterface virtualization_interfaces_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this interface. [required]
data WritableVmInterface [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_read

crate::models::VmInterface virtualization_interfaces_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this interface. [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_interfaces_update

crate::models::VmInterface virtualization_interfaces_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this interface. [required]
data WritableVmInterface [required]

Return type

crate::models::VmInterface

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_bulk_delete

virtualization_virtual_machines_bulk_delete()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_bulk_partial_update

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_bulk_partial_update(data)

Parameters

Name Type Description Required Notes
data WritableVirtualMachineWithConfigContext [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_bulk_update

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_bulk_update(data)

Parameters

Name Type Description Required Notes
data WritableVirtualMachineWithConfigContext [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_create

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_create(data)

Parameters

Name Type Description Required Notes
data WritableVirtualMachineWithConfigContext [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_delete

virtualization_virtual_machines_delete(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this virtual machine. [required]

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_list

crate::models::VirtualizationVirtualMachinesList200Response virtualization_virtual_machines_list(id, cluster, vcpus, memory, disk, created, last_updated, q, tag, tenant_group_id, tenant_group, tenant_id, tenant, contact, contact_role, contact_group, local_context_data, status, cluster_group_id, cluster_group, cluster_type_id, cluster_type, cluster_id, device_id, device, region_id, region, site_group_id, site_group, site_id, site, name, role_id, role, platform_id, platform, mac_address, has_primary_ip, id__n, id__lte, id__lt, id__gte, id__gt, cluster__n, vcpus__n, vcpus__lte, vcpus__lt, vcpus__gte, vcpus__gt, memory__n, memory__lte, memory__lt, memory__gte, memory__gt, disk__n, disk__lte, disk__lt, disk__gte, disk__gt, created__n, created__lte, created__lt, created__gte, created__gt, last_updated__n, last_updated__lte, last_updated__lt, last_updated__gte, last_updated__gt, tag__n, tenant_group_id__n, tenant_group__n, tenant_id__n, tenant__n, contact__n, contact_role__n, contact_group__n, status__n, cluster_group_id__n, cluster_group__n, cluster_type_id__n, cluster_type__n, cluster_id__n, device_id__n, device__n, region_id__n, region__n, site_group_id__n, site_group__n, site_id__n, site__n, name__n, name__ic, name__nic, name__iew, name__niew, name__isw, name__nisw, name__ie, name__nie, name__empty, role_id__n, role__n, platform_id__n, platform__n, mac_address__n, mac_address__ic, mac_address__nic, mac_address__iew, mac_address__niew, mac_address__isw, mac_address__nisw, mac_address__ie, mac_address__nie, ordering, limit, offset)

Parameters

Name Type Description Required Notes
id Option<String>
cluster Option<String>
vcpus Option<String>
memory Option<String>
disk Option<String>
created Option<String>
last_updated Option<String>
q Option<String>
tag Option<String>
tenant_group_id Option<String>
tenant_group Option<String>
tenant_id Option<String>
tenant Option<String>
contact Option<String>
contact_role Option<String>
contact_group Option<String>
local_context_data Option<String>
status Option<String>
cluster_group_id Option<String>
cluster_group Option<String>
cluster_type_id Option<String>
cluster_type Option<String>
cluster_id Option<String>
device_id Option<String>
device Option<String>
region_id Option<String>
region Option<String>
site_group_id Option<String>
site_group Option<String>
site_id Option<String>
site Option<String>
name Option<String>
role_id Option<String>
role Option<String>
platform_id Option<String>
platform Option<String>
mac_address Option<String>
has_primary_ip Option<String>
id__n Option<String>
id__lte Option<String>
id__lt Option<String>
id__gte Option<String>
id__gt Option<String>
cluster__n Option<String>
vcpus__n Option<String>
vcpus__lte Option<String>
vcpus__lt Option<String>
vcpus__gte Option<String>
vcpus__gt Option<String>
memory__n Option<String>
memory__lte Option<String>
memory__lt Option<String>
memory__gte Option<String>
memory__gt Option<String>
disk__n Option<String>
disk__lte Option<String>
disk__lt Option<String>
disk__gte Option<String>
disk__gt Option<String>
created__n Option<String>
created__lte Option<String>
created__lt Option<String>
created__gte Option<String>
created__gt Option<String>
last_updated__n Option<String>
last_updated__lte Option<String>
last_updated__lt Option<String>
last_updated__gte Option<String>
last_updated__gt Option<String>
tag__n Option<String>
tenant_group_id__n Option<String>
tenant_group__n Option<String>
tenant_id__n Option<String>
tenant__n Option<String>
contact__n Option<String>
contact_role__n Option<String>
contact_group__n Option<String>
status__n Option<String>
cluster_group_id__n Option<String>
cluster_group__n Option<String>
cluster_type_id__n Option<String>
cluster_type__n Option<String>
cluster_id__n Option<String>
device_id__n Option<String>
device__n Option<String>
region_id__n Option<String>
region__n Option<String>
site_group_id__n Option<String>
site_group__n Option<String>
site_id__n Option<String>
site__n Option<String>
name__n Option<String>
name__ic Option<String>
name__nic Option<String>
name__iew Option<String>
name__niew Option<String>
name__isw Option<String>
name__nisw Option<String>
name__ie Option<String>
name__nie Option<String>
name__empty Option<String>
role_id__n Option<String>
role__n Option<String>
platform_id__n Option<String>
platform__n Option<String>
mac_address__n Option<String>
mac_address__ic Option<String>
mac_address__nic Option<String>
mac_address__iew Option<String>
mac_address__niew Option<String>
mac_address__isw Option<String>
mac_address__nisw Option<String>
mac_address__ie Option<String>
mac_address__nie Option<String>
ordering Option<String> Which field to use when ordering the results.
limit Option<i32> Number of results to return per page.
offset Option<i32> The initial index from which to return the results.

Return type

crate::models::VirtualizationVirtualMachinesList200Response

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_partial_update

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_partial_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this virtual machine. [required]
data WritableVirtualMachineWithConfigContext [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_read

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_read(id)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this virtual machine. [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

virtualization_virtual_machines_update

crate::models::VirtualMachineWithConfigContext virtualization_virtual_machines_update(id, data)

Parameters

Name Type Description Required Notes
id i32 A unique integer value identifying this virtual machine. [required]
data WritableVirtualMachineWithConfigContext [required]

Return type

crate::models::VirtualMachineWithConfigContext

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]