Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. getVmStates
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.getVmStates

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Provides information about VM states.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";

const vmStates01 = outscale.getVmStates({
    filters: [
        {
            name: "vm_ids",
            values: [
                "i-12345678",
                "i-87654321",
            ],
        },
        {
            name: "vm_states",
            values: ["running"],
        },
    ],
});

    import pulumi
import pulumi_outscale as outscale

vm_states01 = outscale.get_vm_states(filters=[
    {
        "name": "vm_ids",
        "values": [
            "i-12345678",
            "i-87654321",
        ],
    },
    {
        "name": "vm_states",
        "values": ["running"],
    },
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.GetVmStates(ctx, &outscale.GetVmStatesArgs{
			Filters: []outscale.GetVmStatesFilter{
				{
					Name: "vm_ids",
					Values: []string{
						"i-12345678",
						"i-87654321",
					},
				},
				{
					Name: "vm_states",
					Values: []string{
						"running",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var vmStates01 = Outscale.GetVmStates.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVmStatesFilterInputArgs
            {
                Name = "vm_ids",
                Values = new[]
                {
                    "i-12345678",
                    "i-87654321",
                },
            },
            new Outscale.Inputs.GetVmStatesFilterInputArgs
            {
                Name = "vm_states",
                Values = new[]
                {
                    "running",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetVmStatesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var vmStates01 = OutscaleFunctions.getVmStates(GetVmStatesArgs.builder()
            .filters(            
                GetVmStatesFilterArgs.builder()
                    .name("vm_ids")
                    .values(                    
                        "i-12345678",
                        "i-87654321")
                    .build(),
                GetVmStatesFilterArgs.builder()
                    .name("vm_states")
                    .values("running")
                    .build())
            .build());

    }
}

    variables:
  vmStates01:
    fn::invoke:
      function: outscale:getVmStates
      arguments:
        filters:
          - name: vm_ids
            values:
              - i-12345678
              - i-87654321
          - name: vm_states
            values:
              - running

    Using getVmStates

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVmStates(args: GetVmStatesArgs, opts?: InvokeOptions): Promise<GetVmStatesResult>
function getVmStatesOutput(args: GetVmStatesOutputArgs, opts?: InvokeOptions): Output<GetVmStatesResult>
    def get_vm_states(all_vms: Optional[bool] = None,
                  filters: Optional[Sequence[GetVmStatesFilter]] = None,
                  id: Optional[str] = None,
                  vm_ids: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVmStatesResult
def get_vm_states_output(all_vms: Optional[pulumi.Input[bool]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVmStatesFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  vm_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetVmStatesResult]
    func GetVmStates(ctx *Context, args *GetVmStatesArgs, opts ...InvokeOption) (*GetVmStatesResult, error)
func GetVmStatesOutput(ctx *Context, args *GetVmStatesOutputArgs, opts ...InvokeOption) GetVmStatesResultOutput

    > Note: This function is named GetVmStates in the Go SDK.

    public static class GetVmStates 
{
    public static Task<GetVmStatesResult> InvokeAsync(GetVmStatesArgs args, InvokeOptions? opts = null)
    public static Output<GetVmStatesResult> Invoke(GetVmStatesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVmStatesResult> getVmStates(GetVmStatesArgs args, InvokeOptions options)
public static Output<GetVmStatesResult> getVmStates(GetVmStatesArgs args, InvokeOptions options)

    fn::invoke:
  function: outscale:index/getVmStates:getVmStates
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AllVms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    Filters List<GetVmStatesFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    VmIds List<string>
    AllVms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    Filters []GetVmStatesFilter
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    Id string
    VmIds []string
    allVms Boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    filters List<GetVmStatesFilter>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    vmIds List<String>
    allVms boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    filters GetVmStatesFilter[]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id string
    vmIds string[]
    all_vms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    filters Sequence[GetVmStatesFilter]
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id str
    vm_ids Sequence[str]
    allVms Boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    filters List<Property Map>
    A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
    id String
    vmIds List<String>

    getVmStates Result

    The following output properties are available:

    Id string
    RequestId string
    VmStates List<GetVmStatesVmState>
    Information about one or more VM states.
    AllVms bool
    Filters List<GetVmStatesFilter>
    VmIds List<string>
    Id string
    RequestId string
    VmStates []GetVmStatesVmState
    Information about one or more VM states.
    AllVms bool
    Filters []GetVmStatesFilter
    VmIds []string
    id String
    requestId String
    vmStates List<GetVmStatesVmState>
    Information about one or more VM states.
    allVms Boolean
    filters List<GetVmStatesFilter>
    vmIds List<String>
    id string
    requestId string
    vmStates GetVmStatesVmState[]
    Information about one or more VM states.
    allVms boolean
    filters GetVmStatesFilter[]
    vmIds string[]
    id str
    request_id str
    vm_states Sequence[GetVmStatesVmState]
    Information about one or more VM states.
    all_vms bool
    filters Sequence[GetVmStatesFilter]
    vm_ids Sequence[str]
    id String
    requestId String
    vmStates List<Property Map>
    Information about one or more VM states.
    allVms Boolean
    filters List<Property Map>
    vmIds List<String>

    Supporting Types

    GetVmStatesFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    GetVmStatesVmState

    AllVms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    MaintenanceEvents List<GetVmStatesVmStateMaintenanceEvent>
    One or more scheduled events associated with the VM.
    SubregionName string
    The name of the Subregion of the VM.
    VmId string
    The ID of the VM.
    VmState string
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
    AllVms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    MaintenanceEvents []GetVmStatesVmStateMaintenanceEvent
    One or more scheduled events associated with the VM.
    SubregionName string
    The name of the Subregion of the VM.
    VmId string
    The ID of the VM.
    VmState string
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
    allVms Boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    maintenanceEvents List<GetVmStatesVmStateMaintenanceEvent>
    One or more scheduled events associated with the VM.
    subregionName String
    The name of the Subregion of the VM.
    vmId String
    The ID of the VM.
    vmState String
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
    allVms boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    maintenanceEvents GetVmStatesVmStateMaintenanceEvent[]
    One or more scheduled events associated with the VM.
    subregionName string
    The name of the Subregion of the VM.
    vmId string
    The ID of the VM.
    vmState string
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
    all_vms bool
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    maintenance_events Sequence[GetVmStatesVmStateMaintenanceEvent]
    One or more scheduled events associated with the VM.
    subregion_name str
    The name of the Subregion of the VM.
    vm_id str
    The ID of the VM.
    vm_state str
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).
    allVms Boolean
    If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
    maintenanceEvents List<Property Map>
    One or more scheduled events associated with the VM.
    subregionName String
    The name of the Subregion of the VM.
    vmId String
    The ID of the VM.
    vmState String
    The state of the VM (pending | running | stopping | stopped | shutting-down | terminated | quarantine).

    GetVmStatesVmStateMaintenanceEvent

    Code string
    The code of the event (system-reboot | system-maintenance).
    Description string
    The description of the event.
    NotAfter string
    The latest scheduled end date and time (UTC) for the event.
    NotBefore string
    The earliest scheduled start date and time (UTC) for the event.
    Code string
    The code of the event (system-reboot | system-maintenance).
    Description string
    The description of the event.
    NotAfter string
    The latest scheduled end date and time (UTC) for the event.
    NotBefore string
    The earliest scheduled start date and time (UTC) for the event.
    code String
    The code of the event (system-reboot | system-maintenance).
    description String
    The description of the event.
    notAfter String
    The latest scheduled end date and time (UTC) for the event.
    notBefore String
    The earliest scheduled start date and time (UTC) for the event.
    code string
    The code of the event (system-reboot | system-maintenance).
    description string
    The description of the event.
    notAfter string
    The latest scheduled end date and time (UTC) for the event.
    notBefore string
    The earliest scheduled start date and time (UTC) for the event.
    code str
    The code of the event (system-reboot | system-maintenance).
    description str
    The description of the event.
    not_after str
    The latest scheduled end date and time (UTC) for the event.
    not_before str
    The earliest scheduled start date and time (UTC) for the event.
    code String
    The code of the event (system-reboot | system-maintenance).
    description String
    The description of the event.
    notAfter String
    The latest scheduled end date and time (UTC) for the event.
    notBefore String
    The earliest scheduled start date and time (UTC) for the event.

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale