Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. instance
  5. getServers
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.instance.getServers

Explore with Pulumi AI

scaleway logo
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    Gets information about multiple instance servers.

    Examples

    Using getServers

    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 getServers(args: GetServersArgs, opts?: InvokeOptions): Promise<GetServersResult>
function getServersOutput(args: GetServersOutputArgs, opts?: InvokeOptions): Output<GetServersResult>
    def get_servers(name: Optional[str] = None,
                project_id: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                zone: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServersResult
def get_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[GetServersResult]
    func GetServers(ctx *Context, args *GetServersArgs, opts ...InvokeOption) (*GetServersResult, error)
func GetServersOutput(ctx *Context, args *GetServersOutputArgs, opts ...InvokeOption) GetServersResultOutput

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

    public static class GetServers 
{
    public static Task<GetServersResult> InvokeAsync(GetServersArgs args, InvokeOptions? opts = null)
    public static Output<GetServersResult> Invoke(GetServersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServersResult> getServers(GetServersArgs args, InvokeOptions options)
public static Output<GetServersResult> getServers(GetServersArgs args, InvokeOptions options)

    fn::invoke:
  function: scaleway:instance/getServers:getServers
  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.

    getServers 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<Pulumiverse.Scaleway.Instance.Outputs.GetServersServer>
    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 []GetServersServer
    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<GetServersServer>
    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 GetServersServer[]
    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[GetServersServer]
    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

    GetServersServer

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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    PublicIps List<Pulumiverse.Scaleway.Instance.Inputs.GetServersServerPublicIp>
    The list of public IPs of the server
    RoutedIpEnabled bool
    True if the server support routed ip only.
    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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    PublicIps []GetServersServerPublicIp
    The list of public IPs of the server
    RoutedIpEnabled bool
    True if the server support routed ip only.
    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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    publicIps List<GetServersServerPublicIp>
    The list of public IPs of the server
    routedIpEnabled Boolean
    True if the server support routed ip only.
    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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    publicIps GetServersServerPublicIp[]
    The list of public IPs of the server
    routedIpEnabled boolean
    True if the server support routed ip only.
    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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    public_ips Sequence[GetServersServerPublicIp]
    The list of public IPs of the server
    routed_ip_enabled bool
    True if the server support routed ip only.
    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

    Deprecated: bootscript are not supported

    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 IP
    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 IP address of the server.

    Deprecated: Use public_ips instead

    publicIps List<Property Map>
    The list of public IPs of the server
    routedIpEnabled Boolean
    True if the server support routed ip only.
    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.

    GetServersServerPublicIp

    Address string
    The address of the IP
    Id string
    The ID of the IP
    Address string
    The address of the IP
    Id string
    The ID of the IP
    address String
    The address of the IP
    id String
    The ID of the IP
    address string
    The address of the IP
    id string
    The ID of the IP
    address str
    The address of the IP
    id str
    The ID of the IP
    address String
    The address of the IP
    id String
    The ID of the IP

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway