Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. UpCloud
  3. API Docs
  4. getNetworks
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

upcloud.getNetworks

Explore with Pulumi AI

UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud

Use this data source to get the available UpCloud networks.

Using getNetworks

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 getNetworks(args: GetNetworksArgs, opts?: InvokeOptions): Promise<GetNetworksResult>
function getNetworksOutput(args: GetNetworksOutputArgs, opts?: InvokeOptions): Output<GetNetworksResult>
Copy
def get_networks(filter_name: Optional[str] = None,
                 zone: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNetworksResult
def get_networks_output(filter_name: Optional[pulumi.Input[str]] = None,
                 zone: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNetworksResult]
Copy
func GetNetworks(ctx *Context, args *GetNetworksArgs, opts ...InvokeOption) (*GetNetworksResult, error)
func GetNetworksOutput(ctx *Context, args *GetNetworksOutputArgs, opts ...InvokeOption) GetNetworksResultOutput
Copy

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

public static class GetNetworks 
{
    public static Task<GetNetworksResult> InvokeAsync(GetNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworksResult> Invoke(GetNetworksInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworksResult> getNetworks(GetNetworksArgs args, InvokeOptions options)
public static Output<GetNetworksResult> getNetworks(GetNetworksArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: upcloud:index/getNetworks:getNetworks
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FilterName string
Zone string
FilterName string
Zone string
filterName String
zone String
filterName string
zone string
filterName String
zone String

getNetworks Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Networks List<UpCloud.Pulumi.UpCloud.Outputs.GetNetworksNetwork>
FilterName string
Zone string
Id string
The provider-assigned unique ID for this managed resource.
Networks []GetNetworksNetwork
FilterName string
Zone string
id String
The provider-assigned unique ID for this managed resource.
networks List<GetNetworksNetwork>
filterName String
zone String
id string
The provider-assigned unique ID for this managed resource.
networks GetNetworksNetwork[]
filterName string
zone string
id str
The provider-assigned unique ID for this managed resource.
networks Sequence[GetNetworksNetwork]
filter_name str
zone str
id String
The provider-assigned unique ID for this managed resource.
networks List<Property Map>
filterName String
zone String

Supporting Types

GetNetworksNetwork

Id This property is required. string
The UUID of the network
IpNetworks This property is required. List<UpCloud.Pulumi.UpCloud.Inputs.GetNetworksNetworkIpNetwork>
A list of IP subnets within the network
Name This property is required. string
A valid name for the network
Servers This property is required. List<UpCloud.Pulumi.UpCloud.Inputs.GetNetworksNetworkServer>
A list of attached servers
Type This property is required. string
The network type
Zone This property is required. string
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
Id This property is required. string
The UUID of the network
IpNetworks This property is required. []GetNetworksNetworkIpNetwork
A list of IP subnets within the network
Name This property is required. string
A valid name for the network
Servers This property is required. []GetNetworksNetworkServer
A list of attached servers
Type This property is required. string
The network type
Zone This property is required. string
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
id This property is required. String
The UUID of the network
ipNetworks This property is required. List<GetNetworksNetworkIpNetwork>
A list of IP subnets within the network
name This property is required. String
A valid name for the network
servers This property is required. List<GetNetworksNetworkServer>
A list of attached servers
type This property is required. String
The network type
zone This property is required. String
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
id This property is required. string
The UUID of the network
ipNetworks This property is required. GetNetworksNetworkIpNetwork[]
A list of IP subnets within the network
name This property is required. string
A valid name for the network
servers This property is required. GetNetworksNetworkServer[]
A list of attached servers
type This property is required. string
The network type
zone This property is required. string
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
id This property is required. str
The UUID of the network
ip_networks This property is required. Sequence[GetNetworksNetworkIpNetwork]
A list of IP subnets within the network
name This property is required. str
A valid name for the network
servers This property is required. Sequence[GetNetworksNetworkServer]
A list of attached servers
type This property is required. str
The network type
zone This property is required. str
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.
id This property is required. String
The UUID of the network
ipNetworks This property is required. List<Property Map>
A list of IP subnets within the network
name This property is required. String
A valid name for the network
servers This property is required. List<Property Map>
A list of attached servers
type This property is required. String
The network type
zone This property is required. String
The zone the network is in, e.g. de-fra1. You can list available zones with upctl zone list.

GetNetworksNetworkIpNetwork

Address This property is required. string
The CIDR range of the subnet
Dhcp This property is required. bool
Is DHCP enabled?
DhcpDefaultRoute This property is required. bool
Is the gateway the DHCP default route?
DhcpDns This property is required. List<string>
The DNS servers given by DHCP
DhcpRoutes This property is required. List<string>
The additional DHCP classless static routes given by DHCP
Family This property is required. string
IP address family
Gateway This property is required. string
Gateway address given by DHCP
Address This property is required. string
The CIDR range of the subnet
Dhcp This property is required. bool
Is DHCP enabled?
DhcpDefaultRoute This property is required. bool
Is the gateway the DHCP default route?
DhcpDns This property is required. []string
The DNS servers given by DHCP
DhcpRoutes This property is required. []string
The additional DHCP classless static routes given by DHCP
Family This property is required. string
IP address family
Gateway This property is required. string
Gateway address given by DHCP
address This property is required. String
The CIDR range of the subnet
dhcp This property is required. Boolean
Is DHCP enabled?
dhcpDefaultRoute This property is required. Boolean
Is the gateway the DHCP default route?
dhcpDns This property is required. List<String>
The DNS servers given by DHCP
dhcpRoutes This property is required. List<String>
The additional DHCP classless static routes given by DHCP
family This property is required. String
IP address family
gateway This property is required. String
Gateway address given by DHCP
address This property is required. string
The CIDR range of the subnet
dhcp This property is required. boolean
Is DHCP enabled?
dhcpDefaultRoute This property is required. boolean
Is the gateway the DHCP default route?
dhcpDns This property is required. string[]
The DNS servers given by DHCP
dhcpRoutes This property is required. string[]
The additional DHCP classless static routes given by DHCP
family This property is required. string
IP address family
gateway This property is required. string
Gateway address given by DHCP
address This property is required. str
The CIDR range of the subnet
dhcp This property is required. bool
Is DHCP enabled?
dhcp_default_route This property is required. bool
Is the gateway the DHCP default route?
dhcp_dns This property is required. Sequence[str]
The DNS servers given by DHCP
dhcp_routes This property is required. Sequence[str]
The additional DHCP classless static routes given by DHCP
family This property is required. str
IP address family
gateway This property is required. str
Gateway address given by DHCP
address This property is required. String
The CIDR range of the subnet
dhcp This property is required. Boolean
Is DHCP enabled?
dhcpDefaultRoute This property is required. Boolean
Is the gateway the DHCP default route?
dhcpDns This property is required. List<String>
The DNS servers given by DHCP
dhcpRoutes This property is required. List<String>
The additional DHCP classless static routes given by DHCP
family This property is required. String
IP address family
gateway This property is required. String
Gateway address given by DHCP

GetNetworksNetworkServer

Id This property is required. string
The UUID of the server
Title This property is required. string
The short description of the server
Id This property is required. string
The UUID of the server
Title This property is required. string
The short description of the server
id This property is required. String
The UUID of the server
title This property is required. String
The short description of the server
id This property is required. string
The UUID of the server
title This property is required. string
The short description of the server
id This property is required. str
The UUID of the server
title This property is required. str
The short description of the server
id This property is required. String
The UUID of the server
title This property is required. String
The short description of the server

Package Details

Repository
upcloud UpCloudLtd/pulumi-upcloud
License
Apache-2.0
Notes
This Pulumi package is based on the upcloud Terraform Provider.
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd
UpCloudLtd/pulumi-upcloud