Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. instance
  5. getServer
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.instance.getServer

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

Gets information about an instance server.

Using getServer

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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
Copy
def get_server(name: Optional[str] = None,
               project_id: Optional[str] = None,
               server_id: Optional[str] = None,
               zone: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               server_id: Optional[pulumi.Input[str]] = None,
               zone: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
Copy
func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput
Copy

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

public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scaleway:instance/getServer:getServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
The server name. Only one of name and server_id should be specified.
ProjectId string
The ID of the project the instance server is associated with.
ServerId string
The server id. Only one of name and server_id should be specified.
Zone string
zone) The zone in which the server exists.
Name string
The server name. Only one of name and server_id should be specified.
ProjectId string
The ID of the project the instance server is associated with.
ServerId string
The server id. Only one of name and server_id should be specified.
Zone string
zone) The zone in which the server exists.
name String
The server name. Only one of name and server_id should be specified.
projectId String
The ID of the project the instance server is associated with.
serverId String
The server id. Only one of name and server_id should be specified.
zone String
zone) The zone in which the server exists.
name string
The server name. Only one of name and server_id should be specified.
projectId string
The ID of the project the instance server is associated with.
serverId string
The server id. Only one of name and server_id should be specified.
zone string
zone) The zone in which the server exists.
name str
The server name. Only one of name and server_id should be specified.
project_id str
The ID of the project the instance server is associated with.
server_id str
The server id. Only one of name and server_id should be specified.
zone str
zone) The zone in which the server exists.
name String
The server name. Only one of name and server_id should be specified.
projectId String
The ID of the project the instance server is associated with.
serverId String
The server id. Only one of name and server_id should be specified.
zone String
zone) The zone in which the server exists.

getServer Result

The following output properties are available:

AdditionalVolumeIds List<string>
The additional volumes attached to the server.
BootType string
BootscriptId string
CloudInit string
The cloud init script associated with this server.
EnableDynamicIp bool
True if dynamic IP in enable on the server.
EnableIpv6 bool
Determines if IPv6 is enabled for the server.
Id string
The provider-assigned unique ID for this managed resource.
Image string
The UUID and the label of the base image used by the server.
IpId string
IpIds List<string>
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 )
OrganizationId string
The ID of the organization the server is associated with.
PlacementGroupId string
The placement group the server is attached to.
PlacementGroupPolicyRespected bool
True when the placement group policy is respected.
PrivateIp string
The Scaleway internal IP address of the server.
PrivateNetworks List<Pulumiverse.Scaleway.Instance.Outputs.GetServerPrivateNetwork>
PublicIp string
The public IP address of the server.
PublicIps List<Pulumiverse.Scaleway.Instance.Outputs.GetServerPublicIp>
The list of public IPs of the server
ReplaceOnTypeChange bool
RootVolumes List<Pulumiverse.Scaleway.Instance.Outputs.GetServerRootVolume>
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>
The tags associated with the server.
Type string
The commercial type of the server. You find all the available types on the pricing page.
UserData Dictionary<string, string>
The user data associated with the server.
Name string
ProjectId string
ServerId string
Zone string
AdditionalVolumeIds []string
The additional volumes attached to the server.
BootType string
BootscriptId string
CloudInit string
The cloud init script associated with this server.
EnableDynamicIp bool
True if dynamic IP in enable on the server.
EnableIpv6 bool
Determines if IPv6 is enabled for the server.
Id string
The provider-assigned unique ID for this managed resource.
Image string
The UUID and the label of the base image used by the server.
IpId string
IpIds []string
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 )
OrganizationId string
The ID of the organization the server is associated with.
PlacementGroupId string
The placement group the server is attached to.
PlacementGroupPolicyRespected bool
True when the placement group policy is respected.
PrivateIp string
The Scaleway internal IP address of the server.
PrivateNetworks []GetServerPrivateNetwork
PublicIp string
The public IP address of the server.
PublicIps []GetServerPublicIp
The list of public IPs of the server
ReplaceOnTypeChange bool
RootVolumes []GetServerRootVolume
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
The tags associated with the server.
Type string
The commercial type of the server. You find all the available types on the pricing page.
UserData map[string]string
The user data associated with the server.
Name string
ProjectId string
ServerId string
Zone string
additionalVolumeIds List<String>
The additional volumes attached to the server.
bootType String
bootscriptId String
cloudInit String
The cloud init script associated with this server.
enableDynamicIp Boolean
True if dynamic IP in enable on the server.
enableIpv6 Boolean
Determines if IPv6 is enabled for the server.
id String
The provider-assigned unique ID for this managed resource.
image String
The UUID and the label of the base image used by the server.
ipId String
ipIds List<String>
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 )
organizationId String
The ID of the organization the server is associated with.
placementGroupId String
The placement group the server is attached to.
placementGroupPolicyRespected Boolean
True when the placement group policy is respected.
privateIp String
The Scaleway internal IP address of the server.
privateNetworks List<GetServerPrivateNetwork>
publicIp String
The public IP address of the server.
publicIps List<GetServerPublicIp>
The list of public IPs of the server
replaceOnTypeChange Boolean
rootVolumes List<GetServerRootVolume>
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>
The tags associated with the server.
type String
The commercial type of the server. You find all the available types on the pricing page.
userData Map<String,String>
The user data associated with the server.
name String
projectId String
serverId String
zone String
additionalVolumeIds string[]
The additional volumes attached to the server.
bootType string
bootscriptId string
cloudInit string
The cloud init script associated with this server.
enableDynamicIp boolean
True if dynamic IP in enable on the server.
enableIpv6 boolean
Determines if IPv6 is enabled for the server.
id string
The provider-assigned unique ID for this managed resource.
image string
The UUID and the label of the base image used by the server.
ipId string
ipIds string[]
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 )
organizationId string
The ID of the organization the server is associated with.
placementGroupId string
The placement group the server is attached to.
placementGroupPolicyRespected boolean
True when the placement group policy is respected.
privateIp string
The Scaleway internal IP address of the server.
privateNetworks GetServerPrivateNetwork[]
publicIp string
The public IP address of the server.
publicIps GetServerPublicIp[]
The list of public IPs of the server
replaceOnTypeChange boolean
rootVolumes GetServerRootVolume[]
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[]
The tags associated with the server.
type string
The commercial type of the server. You find all the available types on the pricing page.
userData {[key: string]: string}
The user data associated with the server.
name string
projectId string
serverId string
zone string
additional_volume_ids Sequence[str]
The additional volumes attached to the server.
boot_type str
bootscript_id str
cloud_init str
The cloud init script associated with this server.
enable_dynamic_ip bool
True if dynamic IP in enable on the server.
enable_ipv6 bool
Determines if IPv6 is enabled for the server.
id str
The provider-assigned unique ID for this managed resource.
image str
The UUID and the label of the base image used by the server.
ip_id str
ip_ids Sequence[str]
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 )
organization_id str
The ID of the organization the server is associated with.
placement_group_id str
The placement group the server is attached to.
placement_group_policy_respected bool
True when the placement group policy is respected.
private_ip str
The Scaleway internal IP address of the server.
private_networks Sequence[GetServerPrivateNetwork]
public_ip str
The public IP address of the server.
public_ips Sequence[GetServerPublicIp]
The list of public IPs of the server
replace_on_type_change bool
root_volumes Sequence[GetServerRootVolume]
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]
The tags associated with the server.
type str
The commercial type of the server. You find all the available types on the pricing page.
user_data Mapping[str, str]
The user data associated with the server.
name str
project_id str
server_id str
zone str
additionalVolumeIds List<String>
The additional volumes attached to the server.
bootType String
bootscriptId String
cloudInit String
The cloud init script associated with this server.
enableDynamicIp Boolean
True if dynamic IP in enable on the server.
enableIpv6 Boolean
Determines if IPv6 is enabled for the server.
id String
The provider-assigned unique ID for this managed resource.
image String
The UUID and the label of the base image used by the server.
ipId String
ipIds List<String>
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 )
organizationId String
The ID of the organization the server is associated with.
placementGroupId String
The placement group the server is attached to.
placementGroupPolicyRespected Boolean
True when the placement group policy is respected.
privateIp String
The Scaleway internal IP address of the server.
privateNetworks List<Property Map>
publicIp String
The public IP address of the server.
publicIps List<Property Map>
The list of public IPs of the server
replaceOnTypeChange Boolean
rootVolumes List<Property Map>
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>
The tags associated with the server.
type String
The commercial type of the server. You find all the available types on the pricing page.
userData Map<String>
The user data associated with the server.
name String
projectId String
serverId String
zone String

Supporting Types

GetServerPrivateNetwork

MacAddress This property is required. string
MAC address of the NIC
PnId This property is required. string
The Private Network ID
PnicId This property is required. string
The ID of the NIC
Status This property is required. string
The private NIC state
Zone This property is required. string
zone) The zone in which the server exists.
MacAddress This property is required. string
MAC address of the NIC
PnId This property is required. string
The Private Network ID
PnicId This property is required. string
The ID of the NIC
Status This property is required. string
The private NIC state
Zone This property is required. string
zone) The zone in which the server exists.
macAddress This property is required. String
MAC address of the NIC
pnId This property is required. String
The Private Network ID
pnicId This property is required. String
The ID of the NIC
status This property is required. String
The private NIC state
zone This property is required. String
zone) The zone in which the server exists.
macAddress This property is required. string
MAC address of the NIC
pnId This property is required. string
The Private Network ID
pnicId This property is required. string
The ID of the NIC
status This property is required. string
The private NIC state
zone This property is required. string
zone) The zone in which the server exists.
mac_address This property is required. str
MAC address of the NIC
pn_id This property is required. str
The Private Network ID
pnic_id This property is required. str
The ID of the NIC
status This property is required. str
The private NIC state
zone This property is required. str
zone) The zone in which the server exists.
macAddress This property is required. String
MAC address of the NIC
pnId This property is required. String
The Private Network ID
pnicId This property is required. String
The ID of the NIC
status This property is required. String
The private NIC state
zone This property is required. String
zone) The zone in which the server exists.

GetServerPublicIp

Address This property is required. string
The address of the IP
Id This property is required. string
The ID of the IP
Address This property is required. string
The address of the IP
Id This property is required. string
The ID of the IP
address This property is required. String
The address of the IP
id This property is required. String
The ID of the IP
address This property is required. string
The address of the IP
id This property is required. string
The ID of the IP
address This property is required. str
The address of the IP
id This property is required. str
The ID of the IP
address This property is required. String
The address of the IP
id This property is required. String
The ID of the IP

GetServerRootVolume

Boot This property is required. bool
Set the volume where the boot the server
DeleteOnTermination This property is required. bool
Forces deletion of the root volume on instance termination.
Name This property is required. string
The server name. Only one of name and server_id should be specified.
SbsIops This property is required. int
SBS Volume IOPS, only with volume_type as sbs_volume
SizeInGb This property is required. int
Size of the root volume in gigabytes.
VolumeId This property is required. string
The volume ID of the root volume of the server.
VolumeType This property is required. string
Volume type of the root volume
Boot This property is required. bool
Set the volume where the boot the server
DeleteOnTermination This property is required. bool
Forces deletion of the root volume on instance termination.
Name This property is required. string
The server name. Only one of name and server_id should be specified.
SbsIops This property is required. int
SBS Volume IOPS, only with volume_type as sbs_volume
SizeInGb This property is required. int
Size of the root volume in gigabytes.
VolumeId This property is required. string
The volume ID of the root volume of the server.
VolumeType This property is required. string
Volume type of the root volume
boot This property is required. Boolean
Set the volume where the boot the server
deleteOnTermination This property is required. Boolean
Forces deletion of the root volume on instance termination.
name This property is required. String
The server name. Only one of name and server_id should be specified.
sbsIops This property is required. Integer
SBS Volume IOPS, only with volume_type as sbs_volume
sizeInGb This property is required. Integer
Size of the root volume in gigabytes.
volumeId This property is required. String
The volume ID of the root volume of the server.
volumeType This property is required. String
Volume type of the root volume
boot This property is required. boolean
Set the volume where the boot the server
deleteOnTermination This property is required. boolean
Forces deletion of the root volume on instance termination.
name This property is required. string
The server name. Only one of name and server_id should be specified.
sbsIops This property is required. number
SBS Volume IOPS, only with volume_type as sbs_volume
sizeInGb This property is required. number
Size of the root volume in gigabytes.
volumeId This property is required. string
The volume ID of the root volume of the server.
volumeType This property is required. string
Volume type of the root volume
boot This property is required. bool
Set the volume where the boot the server
delete_on_termination This property is required. bool
Forces deletion of the root volume on instance termination.
name This property is required. str
The server name. Only one of name and server_id should be specified.
sbs_iops This property is required. int
SBS Volume IOPS, only with volume_type as sbs_volume
size_in_gb This property is required. int
Size of the root volume in gigabytes.
volume_id This property is required. str
The volume ID of the root volume of the server.
volume_type This property is required. str
Volume type of the root volume
boot This property is required. Boolean
Set the volume where the boot the server
deleteOnTermination This property is required. Boolean
Forces deletion of the root volume on instance termination.
name This property is required. String
The server name. Only one of name and server_id should be specified.
sbsIops This property is required. Number
SBS Volume IOPS, only with volume_type as sbs_volume
sizeInGb This property is required. Number
Size of the root volume in gigabytes.
volumeId This property is required. String
The volume ID of the root volume of the server.
volumeType This property is required. String
Volume type of the root volume

Package Details

Repository
scaleway pulumiverse/pulumi-scaleway
License
Apache-2.0
Notes
This Pulumi package is based on the scaleway Terraform Provider.
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway