/*
* 3DS OUTSCALE API
*
* Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.<br /> Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of this API is also available for download: <button>[GitHub repository](https://github.com/outscale/osc-api)</button><br /> # Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.<br /> The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).<br /><br /> In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.<br /> > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html). See the code samples in each section of this documentation for specific examples in different programming languages.<br /> For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html). > If you try to sign requests with an invalid access key four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes. ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.<br /> This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.<br /> In most cases, however, you can use the Cockpit web interface to retrieve them.<br /> > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`""`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands. See the code samples in each section of this documentation for specific examples in different programming languages. > If you try to sign requests with an invalid password four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes. ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.<br /> ### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.<br /> For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). # Pagination Tutorial You can learn more about the pagination methods for read calls in the dedicated [pagination tutorial](https://docs.outscale.com/en/userguide/Tutorial-Paginating-an-API-Request.html). # Error Codes Reference You can learn more about errors returned by the API in the dedicated [errors page](api-errors.html).
*
* The version of the OpenAPI document: 1.36.3
* Contact: support@outscale.com
* Generated by: https://openapi-generator.tech
*/
/// Vm : Information about the VM.
#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Vm {
#[serde(rename = "ActionsOnNextBoot", skip_serializing_if = "Option::is_none")]
pub actions_on_next_boot: Option<Box<crate::models::ActionsOnNextBoot>>,
/// The architecture of the VM (`i386` \\| `x86_64`).
#[serde(rename = "Architecture", skip_serializing_if = "Option::is_none")]
pub architecture: Option<String>,
/// The block device mapping of the VM.
#[serde(
rename = "BlockDeviceMappings",
skip_serializing_if = "Option::is_none"
)]
pub block_device_mappings: Option<Vec<crate::models::BlockDeviceMappingCreated>>,
#[serde(rename = "BootMode", skip_serializing_if = "Option::is_none")]
pub boot_mode: Option<crate::models::BootMode>,
/// This parameter is not available. It is present in our API for the sake of historical compatibility with AWS.
#[serde(rename = "BsuOptimized", skip_serializing_if = "Option::is_none")]
pub bsu_optimized: Option<bool>,
/// The idempotency token provided when launching the VM.
#[serde(rename = "ClientToken", skip_serializing_if = "Option::is_none")]
pub client_token: Option<String>,
/// The date and time (UTC) at which the VM was created.
#[serde(rename = "CreationDate", skip_serializing_if = "Option::is_none")]
pub creation_date: Option<String>,
/// If true, you cannot delete the VM unless you change this parameter back to false.
#[serde(rename = "DeletionProtection", skip_serializing_if = "Option::is_none")]
pub deletion_protection: Option<bool>,
/// The hypervisor type of the VMs (`ovm` \\| `xen`).
#[serde(rename = "Hypervisor", skip_serializing_if = "Option::is_none")]
pub hypervisor: Option<String>,
/// The ID of the OMI used to create the VM.
#[serde(rename = "ImageId", skip_serializing_if = "Option::is_none")]
pub image_id: Option<String>,
/// (Net only) If true, the source/destination check is enabled. If false, it is disabled.
#[serde(
rename = "IsSourceDestChecked",
skip_serializing_if = "Option::is_none"
)]
pub is_source_dest_checked: Option<bool>,
/// The name of the keypair used when launching the VM.
#[serde(rename = "KeypairName", skip_serializing_if = "Option::is_none")]
pub keypair_name: Option<String>,
/// The number for the VM when launching a group of several VMs (for example, `0`, `1`, `2`, and so on).
#[serde(rename = "LaunchNumber", skip_serializing_if = "Option::is_none")]
pub launch_number: Option<i32>,
/// If true, nested virtualization is enabled. If false, it is disabled.
#[serde(
rename = "NestedVirtualization",
skip_serializing_if = "Option::is_none"
)]
pub nested_virtualization: Option<bool>,
/// The ID of the Net in which the VM is running.
#[serde(rename = "NetId", skip_serializing_if = "Option::is_none")]
pub net_id: Option<String>,
/// (Net only) The network interface cards (NICs) the VMs are attached to.
#[serde(rename = "Nics", skip_serializing_if = "Option::is_none")]
pub nics: Option<Vec<crate::models::NicLight>>,
/// Indicates the operating system (OS) of the VM.
#[serde(rename = "OsFamily", skip_serializing_if = "Option::is_none")]
pub os_family: Option<String>,
/// The performance of the VM.
#[serde(rename = "Performance", skip_serializing_if = "Option::is_none")]
pub performance: Option<String>,
#[serde(rename = "Placement", skip_serializing_if = "Option::is_none")]
pub placement: Option<Box<crate::models::Placement>>,
/// The name of the private DNS.
#[serde(rename = "PrivateDnsName", skip_serializing_if = "Option::is_none")]
pub private_dns_name: Option<String>,
/// The primary private IP of the VM.
#[serde(rename = "PrivateIp", skip_serializing_if = "Option::is_none")]
pub private_ip: Option<String>,
/// The product codes associated with the OMI used to create the VM.
#[serde(rename = "ProductCodes", skip_serializing_if = "Option::is_none")]
pub product_codes: Option<Vec<String>>,
/// The name of the public DNS.
#[serde(rename = "PublicDnsName", skip_serializing_if = "Option::is_none")]
pub public_dns_name: Option<String>,
/// The public IP of the VM.
#[serde(rename = "PublicIp", skip_serializing_if = "Option::is_none")]
pub public_ip: Option<String>,
/// The reservation ID of the VM.
#[serde(rename = "ReservationId", skip_serializing_if = "Option::is_none")]
pub reservation_id: Option<String>,
/// The name of the root device for the VM (for example, `/dev/sda1`).
#[serde(rename = "RootDeviceName", skip_serializing_if = "Option::is_none")]
pub root_device_name: Option<String>,
/// The type of root device used by the VM (always `bsu`).
#[serde(rename = "RootDeviceType", skip_serializing_if = "Option::is_none")]
pub root_device_type: Option<String>,
/// One or more security groups associated with the VM.
#[serde(rename = "SecurityGroups", skip_serializing_if = "Option::is_none")]
pub security_groups: Option<Vec<crate::models::SecurityGroupLight>>,
/// The state of the VM (`pending` \\| `running` \\| `stopping` \\| `stopped` \\| `shutting-down` \\| `terminated` \\| `quarantine`).
#[serde(rename = "State", skip_serializing_if = "Option::is_none")]
pub state: Option<String>,
/// The reason explaining the current state of the VM.
#[serde(rename = "StateReason", skip_serializing_if = "Option::is_none")]
pub state_reason: Option<String>,
/// The ID of the Subnet for the VM.
#[serde(rename = "SubnetId", skip_serializing_if = "Option::is_none")]
pub subnet_id: Option<String>,
/// One or more tags associated with the VM.
#[serde(rename = "Tags", skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<crate::models::ResourceTag>>,
/// If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM. If false, it is not.
#[serde(rename = "TpmEnabled", skip_serializing_if = "Option::is_none")]
pub tpm_enabled: Option<bool>,
/// The Base64-encoded MIME user data.
#[serde(rename = "UserData", skip_serializing_if = "Option::is_none")]
pub user_data: Option<String>,
/// The ID of the VM.
#[serde(rename = "VmId", skip_serializing_if = "Option::is_none")]
pub vm_id: Option<String>,
/// The VM behavior when you stop it. If set to `stop`, the VM stops. If set to `restart`, the VM stops then automatically restarts. If set to `terminate`, the VM stops and is deleted.
#[serde(
rename = "VmInitiatedShutdownBehavior",
skip_serializing_if = "Option::is_none"
)]
pub vm_initiated_shutdown_behavior: Option<String>,
/// The type of VM. For more information, see [VM Types](https://docs.outscale.com/en/userguide/VM-Types.html).
#[serde(rename = "VmType", skip_serializing_if = "Option::is_none")]
pub vm_type: Option<String>,
}
impl Vm {
/// Information about the VM.
pub fn new() -> Vm {
Vm {
actions_on_next_boot: None,
architecture: None,
block_device_mappings: None,
boot_mode: None,
bsu_optimized: None,
client_token: None,
creation_date: None,
deletion_protection: None,
hypervisor: None,
image_id: None,
is_source_dest_checked: None,
keypair_name: None,
launch_number: None,
nested_virtualization: None,
net_id: None,
nics: None,
os_family: None,
performance: None,
placement: None,
private_dns_name: None,
private_ip: None,
product_codes: None,
public_dns_name: None,
public_ip: None,
reservation_id: None,
root_device_name: None,
root_device_type: None,
security_groups: None,
state: None,
state_reason: None,
subnet_id: None,
tags: None,
tpm_enabled: None,
user_data: None,
vm_id: None,
vm_initiated_shutdown_behavior: None,
vm_type: None,
}
}
}