Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/octl_iaas.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ OUTSCALE IaaS management
* [octl iaas virtualgateway](octl_iaas_virtualgateway.md) - virtualgateway commands
* [octl iaas vm](octl_iaas_vm.md) - vm commands
* [octl iaas vmgroup](octl_iaas_vmgroup.md) - vmgroup commands
* [octl iaas vmsstophistory](octl_iaas_vmsstophistory.md) - vmsstophistory commands
* [octl iaas vmtemplate](octl_iaas_vmtemplate.md) - vmtemplate commands
* [octl iaas vmtype](octl_iaas_vmtype.md) - vmtype commands
* [octl iaas volume](octl_iaas_volume.md) - volume commands
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/octl_iaas_account_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Creates an OUTSCALE account.

* You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.

* If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`).

For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-OUTSCALE-Account.html).

```
Expand Down
1 change: 1 addition & 0 deletions docs/reference/octl_iaas_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ iaas api calls
* [octl iaas api ReadVms](octl_iaas_api_ReadVms.md) - Lists one or more of your virtual machines (VMs).
* [octl iaas api ReadVmsHealth](octl_iaas_api_ReadVmsHealth.md) - Lists the state of one or more backend virtual machines (VMs) registered with a specified load balancer.
* [octl iaas api ReadVmsState](octl_iaas_api_ReadVmsState.md) - Lists the status of one or more virtual machines (VMs).
* [octl iaas api ReadVmsStopHistory](octl_iaas_api_ReadVmsStopHistory.md) - Lists the stop history of one or more VMs.
* [octl iaas api ReadVolumeUpdateTasks](octl_iaas_api_ReadVolumeUpdateTasks.md) - Lists one or more specified tasks of volume update.
* [octl iaas api ReadVolumes](octl_iaas_api_ReadVolumes.md) - Lists one or more specified Block Storage Unit (BSU) volumes.
* [octl iaas api ReadVpnConnections](octl_iaas_api_ReadVpnConnections.md) - Lists one or more VPN connections.
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/octl_iaas_api_CreateAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Creates an OUTSCALE account.

* You need OUTSCALE credentials and the appropriate quotas to create an account via API. To get quotas, you can send an email to sales@outscale.com.

* If you want to pass a numeral value as a string instead of an integer, you must wrap your string in additional quotes (for example, `'"92000"'`).

For more information, see [About Your Account](https://docs.outscale.com/en/userguide/About-Your-OUTSCALE-Account.html).

```
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/octl_iaas_api_CreateNetPeering.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ octl iaas api CreateNetPeering [flags]
### Options

```
--AccepterNetId string The ID of the Net you want to connect with.
--AccepterNetId string The ID of the Net you want to connect with.<br/ > If the Net does not belong to you, you must also specify the AccepterOwnerId parameter with the OUTSCALE account ID owning the Net you want to connect with.
--AccepterOwnerId string The OUTSCALE account ID of the owner of the Net you want to connect with.
--DryRun If true, checks whether you have the required permissions to perform the action.
--SourceNetId string The ID of the Net you send the peering request from.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/octl_iaas_api_CreatePublicIp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Acquires a public IP for your account.

Acquires a public IP for your account.

A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud or in a Net, a network interface card (NIC), a NAT service.
A public IP is a static IP designed for dynamic Cloud computing. It can be associated with a virtual machine (VM) in the public Cloud, a VM in a Net, a network interface card (NIC), or a NAT service.

For more information, see [About Public IPs](https://docs.outscale.com/en/userguide/About-Public-IPs.html).

Expand Down
84 changes: 43 additions & 41 deletions docs/reference/octl_iaas_api_CreateVms.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,47 +29,49 @@ octl iaas api CreateVms [flags]
### Options

```
--ActionsOnNextBoot.SecureBoot string One action to perform on the next boot of the VM (enable | disable | setup-mode | none).
--BlockDeviceMappings.0.Bsu.DeleteOnVmDeletion If set to true, the volume is deleted when terminating the VM.
--BlockDeviceMappings.0.Bsu.Iops int The number of I/O operations per second (IOPS).
--BlockDeviceMappings.0.Bsu.SnapshotId string The ID of the snapshot used to create the volume.
--BlockDeviceMappings.0.Bsu.VolumeSize int The size of the volume, in gibibytes (GiB).
--BlockDeviceMappings.0.Bsu.VolumeType string The type of the volume (standard | io1 | gp2).
--BlockDeviceMappings.0.DeviceName string The device name for the volume.
--BlockDeviceMappings.0.NoDevice string Removes the device which is included in the block device mapping of the OMI.
--BlockDeviceMappings.0.VirtualDeviceName string The name of the virtual device (ephemeralN).
--BootMode string Information about the boot mode of the VM.
--BootOnCreation If true, the VM is started on creation.
--BsuOptimized This parameter is not available.
--ClientToken string A unique identifier which enables you to manage the idempotency.
--DeletionProtection If true, you cannot delete the VM unless you change this parameter back to false.
--DryRun If true, checks whether you have the required permissions to perform the action.
--ImageId string The ID of the OMI used to create the VM.
--KeypairName string The name of the keypair.
--MaxVmsCount int The maximum number of VMs you want to create.
--MinVmsCount int The minimum number of VMs you want to create.
--NestedVirtualization (dedicated tenancy only) If true, nested virtualization is enabled.
--Nics.0.DeleteOnVmDeletion If true, the NIC is deleted when the VM is terminated.
--Nics.0.Description string The description of the NIC, if you are creating a NIC when creating the VM.
--Nics.0.DeviceNumber int The index of the VM device for the NIC attachment (between 0 and 7, both included).
--Nics.0.NicId string The ID of the NIC, if you are attaching an existing NIC when creating a VM.
--Nics.0.PrivateIps.0.IsPrimary If true, the IP is the primary private IP of the NIC.
--Nics.0.PrivateIps.0.PrivateIp string A private IP for the NIC.
--Nics.0.SecondaryPrivateIpCount int The number of secondary private IPs, if you create a NIC when creating a VM.
--Nics.0.SecurityGroupIds strings One or more IDs of security groups for the NIC, if you create a NIC when creating a VM.
--Nics.0.SubnetId string The ID of the Subnet for the NIC, if you create a NIC when creating a VM.
--Performance string The performance of the VM.
--Placement.SubregionName string The name of the Subregion.
--Placement.Tenancy string The tenancy of the VM (default, dedicated, or a dedicated group ID).
--PrivateIps strings One or more private IPs of the VM.
--SecurityGroupIds strings One or more IDs of security group for the VMs.
--SecurityGroups strings One or more names of security groups for the VMs.
--SubnetId string The ID of the Subnet in which you want to create the VM.
--TpmEnabled If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM.
--UserData string Data or script used to add a specific configuration to the VM.
--VmInitiatedShutdownBehavior string The VM behavior when you stop it.
--VmType string The type of VM.
-h, --help help for CreateVms
--ActionsOnNextBoot.SecureBoot string One action to perform on the next boot of the VM (enable | disable | setup-mode | none).
--BlockDeviceMappings.0.Bsu.DeleteOnVmDeletion If set to true, the volume is deleted when terminating the VM.
--BlockDeviceMappings.0.Bsu.Iops int The number of I/O operations per second (IOPS).
--BlockDeviceMappings.0.Bsu.SnapshotId string The ID of the snapshot used to create the volume.
--BlockDeviceMappings.0.Bsu.VolumeSize int The size of the volume, in gibibytes (GiB).
--BlockDeviceMappings.0.Bsu.VolumeType string The type of the volume (standard | io1 | gp2).
--BlockDeviceMappings.0.DeviceName string The device name for the volume.
--BlockDeviceMappings.0.NoDevice string Removes the device which is included in the block device mapping of the OMI.
--BlockDeviceMappings.0.VirtualDeviceName string The name of the virtual device (ephemeralN).
--BootMode string Information about the boot mode of the VM.
--BootOnCreation If true, the VM is started on creation.
--BsuOptimized This parameter is not available.
--ClientToken string A unique identifier which enables you to manage the idempotency.
--DeletionProtection If true, you cannot delete the VM unless you change this parameter back to false.
--DryRun If true, checks whether you have the required permissions to perform the action.
--ImageId string The ID of the OMI used to create the VM.
--KeypairName string The name of the keypair.
--MaxVmsCount int The maximum number of VMs you want to create.
--MinVmsCount int The minimum number of VMs you want to create.
--NestedVirtualization (dedicated tenancy only) If true, nested virtualization is enabled.
--Nics.0.DeleteOnVmDeletion If true, the NIC is deleted when the VM is terminated.
--Nics.0.Description string The description of the NIC, if you are creating a NIC when creating the VM.
--Nics.0.DeviceNumber int The index of the VM device for the NIC attachment (between 0 and 7, both included).
--Nics.0.NicId string The ID of the NIC, if you are attaching an existing NIC when creating a VM.
--Nics.0.PrivateIps.0.IsPrimary If true, the IP is the primary private IP of the NIC.
--Nics.0.PrivateIps.0.PrivateIp string A private IP for the NIC.
--Nics.0.SecondaryPrivateIpCount int The number of secondary private IPs, if you create a NIC when creating a VM.
--Nics.0.SecurityGroupIds strings One or more IDs of security groups for the NIC, if you create a NIC when creating a VM.
--Nics.0.SubnetId string The ID of the Subnet for the NIC, if you create a NIC when creating a VM.
--Performance string The performance of the VM.
--Placement.SubregionName string The name of the Subregion.
--Placement.Tenancy string The tenancy of the VM (default, dedicated, or a dedicated group ID).
--PrivateIps strings One or more private IPs of the VM.
--SecurityGroupIds strings One or more IDs of security group for the VMs.
--SecurityGroups strings One or more names of security groups for the VMs.
--ShutdownBehaviorConfiguration.GuestAction string The action performed by the orchestrator when the VM is shut down from the guest operating system.
--ShutdownBehaviorConfiguration.HostAction string The action performed by the orchestrator when the VM is shut down due to a host infrastructure failure.
--SubnetId string The ID of the Subnet in which you want to create the VM.
--TpmEnabled If true, a virtual Trusted Platform Module (vTPM) is enabled on the VM.
--UserData string Data or script used to add a specific configuration to the VM.
--VmInitiatedShutdownBehavior string The VM behavior when you stop it.
--VmType string The type of VM.
-h, --help help for CreateVms
```

### Options inherited from parent commands
Expand Down
53 changes: 53 additions & 0 deletions docs/reference/octl_iaas_api_ReadVmsStopHistory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## octl iaas api ReadVmsStopHistory

Lists the stop history of one or more VMs.

### Synopsis

Lists the stop history of one or more VMs.

```
octl iaas api ReadVmsStopHistory [flags]
```

### Options

```
--Filters.StateReasons strings The reason explaining why the VM stopped.
--Filters.StopDateAfter osctime The date and time (UTC), or the date, after which you want to retrieve VM stops, in ISO 8601 format (for example, 2026-06-14T00:00:00.000Z or 2026-06-14).
--Filters.StopDateBefore osctime The date and time (UTC), or the date, before which you want to retrieve VM stops, in ISO 8601 format (for example, 2026-06-14T00:00:00.000Z or 2026-06-14).
--Filters.VmIds strings The IDs of the stopped VM(s).
--NextPageToken string The token to request the next page of results.
--ResultsPerPage int The maximum number of logs returned in a single response (between 1 and 1000, both included).
-h, --help help for ReadVmsStopHistory
```

### Options inherited from parent commands

```
-c, --columns string columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content>
--config string Path of profile file (by default, ~/.osc/config.json)
--dry-run Display the request payload that would be sent to the API without sending it
--elapsed add elapsed time column when using --watch (default true)
--filter strings comma separated list of filters for results - name:value,name:value, alias for jq filter 'select(.name | tostring | test("value"))'
--interval duration interval between two watch/waitfor iterations (default 5s)
--jq string jq filter
--max-pages int maximum number of pages a command can fetch (default 20)
--no-upgrade do not check for new versions
-O, --out-file string redirect output to file
-o, --output string output format (raw, json, yaml, table, csv, none, base64, text)
--payload string JSON content for query body
--profile string Profile to use in profile file (by default, "default")
--single convert single entry lists to a single object
--template string JSON template file for query body
-v, --verbose Verbose output
--waitfor string repeatedly call the API until the specified jq expression returns 1/true or a non empty result
--waitfor-timeout duration maximum duration of a wait (default 10m0s)
--watch repeatedly call the API and display changes
-y, --yes answer yes to all prompts
```

### SEE ALSO

* [octl iaas api](octl_iaas_api.md) - iaas api calls

Loading
Loading