Scaleway

v1.1.0 published on Saturday, Sep 17, 2022 by lbrlabs

getInstanceServers

Gets information about multiple instance servers.

Examples

Basic

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

// Find servers by name and zone
const myKey = pulumi.output(scaleway.getInstanceServers({
    name: "myserver",
    zone: "fr-par-2",
}));
import pulumi
import pulumi_scaleway as scaleway

my_key = scaleway.get_instance_servers(name="myserver",
    zone="fr-par-2")
using System.Collections.Generic;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    var myKey = Scaleway.GetInstanceServers.Invoke(new()
    {
        Name = "myserver",
        Zone = "fr-par-2",
    });

});
package main

import (
	"github.com/lbrlabs/pulumi-scaleway/sdk/go/scaleway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.GetInstanceServers(ctx, &GetInstanceServersArgs{
			Name: pulumi.StringRef("myserver"),
			Zone: pulumi.StringRef("fr-par-2"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.ScalewayFunctions;
import com.pulumi.scaleway.inputs.GetInstanceServersArgs;
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 myKey = ScalewayFunctions.getInstanceServers(GetInstanceServersArgs.builder()
            .name("myserver")
            .zone("fr-par-2")
            .build());

    }
}
variables:
  myKey:
    Fn::Invoke:
      Function: scaleway:getInstanceServers
      Arguments:
        name: myserver
        zone: fr-par-2

Using getInstanceServers

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 getInstanceServers(args: GetInstanceServersArgs, opts?: InvokeOptions): Promise<GetInstanceServersResult>
function getInstanceServersOutput(args: GetInstanceServersOutputArgs, opts?: InvokeOptions): Output<GetInstanceServersResult>
def get_instance_servers(name: Optional[str] = None,
                         project_id: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None,
                         zone: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetInstanceServersResult
def get_instance_servers_output(name: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[str]] = None,
                         tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         zone: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetInstanceServersResult]
func GetInstanceServers(ctx *Context, args *GetInstanceServersArgs, opts ...InvokeOption) (*GetInstanceServersResult, error)
func GetInstanceServersOutput(ctx *Context, args *GetInstanceServersOutputArgs, opts ...InvokeOption) GetInstanceServersResultOutput

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

public static class GetInstanceServers 
{
    public static Task<GetInstanceServersResult> InvokeAsync(GetInstanceServersArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceServersResult> Invoke(GetInstanceServersInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceServersResult> getInstanceServers(GetInstanceServersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: scaleway:index/getInstanceServers:getInstanceServers
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The server name used as filter. Servers with a name like it are listed.

ProjectId string

The ID of the project the server is associated with.

Tags List<string>

List of tags used as filter. Servers with these exact tags are listed.

Zone string

zone) The zone in which servers exist.

Name string

The server name used as filter. Servers with a name like it are listed.

ProjectId string

The ID of the project the server is associated with.

Tags []string

List of tags used as filter. Servers with these exact tags are listed.

Zone string

zone) The zone in which servers exist.

name String

The server name used as filter. Servers with a name like it are listed.

projectId String

The ID of the project the server is associated with.

tags List<String>

List of tags used as filter. Servers with these exact tags are listed.

zone String

zone) The zone in which servers exist.

name string

The server name used as filter. Servers with a name like it are listed.

projectId string

The ID of the project the server is associated with.

tags string[]

List of tags used as filter. Servers with these exact tags are listed.

zone string

zone) The zone in which servers exist.

name str

The server name used as filter. Servers with a name like it are listed.

project_id str

The ID of the project the server is associated with.

tags Sequence[str]

List of tags used as filter. Servers with these exact tags are listed.

zone str

zone) The zone in which servers exist.

name String

The server name used as filter. Servers with a name like it are listed.

projectId String

The ID of the project the server is associated with.

tags List<String>

List of tags used as filter. Servers with these exact tags are listed.

zone String

zone) The zone in which servers exist.

getInstanceServers Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

OrganizationId string

The organization ID the server is associated with.

ProjectId string

The ID of the project the server is associated with.

Servers List<Lbrlabs.PulumiPackage.Scaleway.Outputs.GetInstanceServersServer>

List of found servers

Zone string

The zone in which the server is.

Name string

The name of the server.

Tags List<string>

The tags associated with the server.

Id string

The provider-assigned unique ID for this managed resource.

OrganizationId string

The organization ID the server is associated with.

ProjectId string

The ID of the project the server is associated with.

Servers []GetInstanceServersServer

List of found servers

Zone string

The zone in which the server is.

Name string

The name of the server.

Tags []string

The tags associated with the server.

id String

The provider-assigned unique ID for this managed resource.

organizationId String

The organization ID the server is associated with.

projectId String

The ID of the project the server is associated with.

servers List<GetInstanceServersServer>

List of found servers

zone String

The zone in which the server is.

name String

The name of the server.

tags List<String>

The tags associated with the server.

id string

The provider-assigned unique ID for this managed resource.

organizationId string

The organization ID the server is associated with.

projectId string

The ID of the project the server is associated with.

servers GetInstanceServersServer[]

List of found servers

zone string

The zone in which the server is.

name string

The name of the server.

tags string[]

The tags associated with the server.

id str

The provider-assigned unique ID for this managed resource.

organization_id str

The organization ID the server is associated with.

project_id str

The ID of the project the server is associated with.

servers Sequence[GetInstanceServersServer]

List of found servers

zone str

The zone in which the server is.

name str

The name of the server.

tags Sequence[str]

The tags associated with the server.

id String

The provider-assigned unique ID for this managed resource.

organizationId String

The organization ID the server is associated with.

projectId String

The ID of the project the server is associated with.

servers List<Property Map>

List of found servers

zone String

The zone in which the server is.

name String

The name of the server.

tags List<String>

The tags associated with the server.

Supporting Types

GetInstanceServersServer

BootType string

The boot Type of the server. Possible values are: local, bootscript or rescue.

BootscriptId string

The ID of the bootscript.

EnableDynamicIp bool

If true a dynamic IP will be attached to the server.

EnableIpv6 bool

Determines if IPv6 is enabled for the server.

Id string

The ID of the server.

Image string

The UUID or the label of the base image used by the server.

Ipv6Address string

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

Ipv6Gateway string

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

Ipv6PrefixLength int

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

Name string

The server name used as filter. Servers with a name like it are listed.

OrganizationId string

The organization ID the server is associated with.

PlacementGroupId string

The placement group the server is attached to.

PlacementGroupPolicyRespected bool
PrivateIp string

The Scaleway internal IP address of the server.

ProjectId string

The ID of the project the server is associated with.

PublicIp string

The public IPv4 address of the server.

SecurityGroupId string

The security group the server is attached to.

State string

The state of the server. Possible values are: started, stopped or standby.

Tags List<string>

List of tags used as filter. Servers with these exact tags are listed.

Type string

The commercial type of the server.

Zone string

zone) The zone in which servers exist.

BootType string

The boot Type of the server. Possible values are: local, bootscript or rescue.

BootscriptId string

The ID of the bootscript.

EnableDynamicIp bool

If true a dynamic IP will be attached to the server.

EnableIpv6 bool

Determines if IPv6 is enabled for the server.

Id string

The ID of the server.

Image string

The UUID or the label of the base image used by the server.

Ipv6Address string

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

Ipv6Gateway string

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

Ipv6PrefixLength int

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

Name string

The server name used as filter. Servers with a name like it are listed.

OrganizationId string

The organization ID the server is associated with.

PlacementGroupId string

The placement group the server is attached to.

PlacementGroupPolicyRespected bool
PrivateIp string

The Scaleway internal IP address of the server.

ProjectId string

The ID of the project the server is associated with.

PublicIp string

The public IPv4 address of the server.

SecurityGroupId string

The security group the server is attached to.

State string

The state of the server. Possible values are: started, stopped or standby.

Tags []string

List of tags used as filter. Servers with these exact tags are listed.

Type string

The commercial type of the server.

Zone string

zone) The zone in which servers exist.

bootType String

The boot Type of the server. Possible values are: local, bootscript or rescue.

bootscriptId String

The ID of the bootscript.

enableDynamicIp Boolean

If true a dynamic IP will be attached to the server.

enableIpv6 Boolean

Determines if IPv6 is enabled for the server.

id String

The ID of the server.

image String

The UUID or the label of the base image used by the server.

ipv6Address String

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

ipv6Gateway String

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

ipv6PrefixLength Integer

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

name String

The server name used as filter. Servers with a name like it are listed.

organizationId String

The organization ID the server is associated with.

placementGroupId String

The placement group the server is attached to.

placementGroupPolicyRespected Boolean
privateIp String

The Scaleway internal IP address of the server.

projectId String

The ID of the project the server is associated with.

publicIp String

The public IPv4 address of the server.

securityGroupId String

The security group the server is attached to.

state String

The state of the server. Possible values are: started, stopped or standby.

tags List<String>

List of tags used as filter. Servers with these exact tags are listed.

type String

The commercial type of the server.

zone String

zone) The zone in which servers exist.

bootType string

The boot Type of the server. Possible values are: local, bootscript or rescue.

bootscriptId string

The ID of the bootscript.

enableDynamicIp boolean

If true a dynamic IP will be attached to the server.

enableIpv6 boolean

Determines if IPv6 is enabled for the server.

id string

The ID of the server.

image string

The UUID or the label of the base image used by the server.

ipv6Address string

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

ipv6Gateway string

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

ipv6PrefixLength number

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

name string

The server name used as filter. Servers with a name like it are listed.

organizationId string

The organization ID the server is associated with.

placementGroupId string

The placement group the server is attached to.

placementGroupPolicyRespected boolean
privateIp string

The Scaleway internal IP address of the server.

projectId string

The ID of the project the server is associated with.

publicIp string

The public IPv4 address of the server.

securityGroupId string

The security group the server is attached to.

state string

The state of the server. Possible values are: started, stopped or standby.

tags string[]

List of tags used as filter. Servers with these exact tags are listed.

type string

The commercial type of the server.

zone string

zone) The zone in which servers exist.

boot_type str

The boot Type of the server. Possible values are: local, bootscript or rescue.

bootscript_id str

The ID of the bootscript.

enable_dynamic_ip bool

If true a dynamic IP will be attached to the server.

enable_ipv6 bool

Determines if IPv6 is enabled for the server.

id str

The ID of the server.

image str

The UUID or the label of the base image used by the server.

ipv6_address str

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

ipv6_gateway str

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

ipv6_prefix_length int

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

name str

The server name used as filter. Servers with a name like it are listed.

organization_id str

The organization ID the server is associated with.

placement_group_id str

The placement group the server is attached to.

placement_group_policy_respected bool
private_ip str

The Scaleway internal IP address of the server.

project_id str

The ID of the project the server is associated with.

public_ip str

The public IPv4 address of the server.

security_group_id str

The security group the server is attached to.

state str

The state of the server. Possible values are: started, stopped or standby.

tags Sequence[str]

List of tags used as filter. Servers with these exact tags are listed.

type str

The commercial type of the server.

zone str

zone) The zone in which servers exist.

bootType String

The boot Type of the server. Possible values are: local, bootscript or rescue.

bootscriptId String

The ID of the bootscript.

enableDynamicIp Boolean

If true a dynamic IP will be attached to the server.

enableIpv6 Boolean

Determines if IPv6 is enabled for the server.

id String

The ID of the server.

image String

The UUID or the label of the base image used by the server.

ipv6Address String

The default ipv6 address routed to the server. ( Only set when enable_ipv6 is set to true )

ipv6Gateway String

The ipv6 gateway address. ( Only set when enable_ipv6 is set to true )

ipv6PrefixLength Number

The prefix length of the ipv6 subnet routed to the server. ( Only set when enable_ipv6 is set to true )

name String

The server name used as filter. Servers with a name like it are listed.

organizationId String

The organization ID the server is associated with.

placementGroupId String

The placement group the server is attached to.

placementGroupPolicyRespected Boolean
privateIp String

The Scaleway internal IP address of the server.

projectId String

The ID of the project the server is associated with.

publicIp String

The public IPv4 address of the server.

securityGroupId String

The security group the server is attached to.

state String

The state of the server. Possible values are: started, stopped or standby.

tags List<String>

List of tags used as filter. Servers with these exact tags are listed.

type String

The commercial type of the server.

zone String

zone) The zone in which servers exist.

Package Details

Repository
https://github.com/lbrlabs/pulumi-scaleway
License
Apache-2.0
Notes

This Pulumi package is based on the scaleway Terraform Provider.