1. Packages
  2. UpCloud
  3. API Docs
  4. getIpAddresses
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd

upcloud.getIpAddresses

Explore with Pulumi AI

upcloud logo
UpCloud v0.1.0 published on Friday, Mar 14, 2025 by UpCloudLtd

    Returns a set of IP Addresses that are associated with the UpCloud account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as upcloud from "@pulumi/upcloud";
    
    const allIpAddresses = upcloud.getIpAddresses({});
    
    import pulumi
    import pulumi_upcloud as upcloud
    
    all_ip_addresses = upcloud.get_ip_addresses()
    
    package main
    
    import (
    	"github.com/UpCloudLtd/pulumi-upcloud/sdk/go/upcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := upcloud.GetIpAddresses(ctx, &upcloud.GetIpAddressesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using UpCloud = Pulumi.UpCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var allIpAddresses = UpCloud.GetIpAddresses.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.upcloud.UpcloudFunctions;
    import com.pulumi.upcloud.inputs.GetIpAddressesArgs;
    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 allIpAddresses = UpcloudFunctions.getIpAddresses();
    
        }
    }
    
    variables:
      allIpAddresses:
        fn::invoke:
          function: upcloud:getIpAddresses
          arguments: {}
    

    Using getIpAddresses

    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 getIpAddresses(args: GetIpAddressesArgs, opts?: InvokeOptions): Promise<GetIpAddressesResult>
    function getIpAddressesOutput(args: GetIpAddressesOutputArgs, opts?: InvokeOptions): Output<GetIpAddressesResult>
    def get_ip_addresses(addresses: Optional[Sequence[GetIpAddressesAddress]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIpAddressesResult
    def get_ip_addresses_output(addresses: Optional[pulumi.Input[Sequence[pulumi.Input[GetIpAddressesAddressArgs]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIpAddressesResult]
    func GetIpAddresses(ctx *Context, args *GetIpAddressesArgs, opts ...InvokeOption) (*GetIpAddressesResult, error)
    func GetIpAddressesOutput(ctx *Context, args *GetIpAddressesOutputArgs, opts ...InvokeOption) GetIpAddressesResultOutput

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

    public static class GetIpAddresses 
    {
        public static Task<GetIpAddressesResult> InvokeAsync(GetIpAddressesArgs args, InvokeOptions? opts = null)
        public static Output<GetIpAddressesResult> Invoke(GetIpAddressesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpAddressesResult> getIpAddresses(GetIpAddressesArgs args, InvokeOptions options)
    public static Output<GetIpAddressesResult> getIpAddresses(GetIpAddressesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: upcloud:index/getIpAddresses:getIpAddresses
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getIpAddresses Result

    The following output properties are available:

    Id string
    ID of the resource.
    Addresses []GetIpAddressesAddress
    id String
    ID of the resource.
    addresses List<GetIpAddressesAddress>
    id string
    ID of the resource.
    addresses GetIpAddressesAddress[]
    id String
    ID of the resource.
    addresses List<Property Map>

    Supporting Types

    GetIpAddressesAddress

    Access string
    Is address for utility or public network
    Address string
    An UpCloud assigned IP Address
    Family string
    IP address family
    Floating bool
    Does the IP Address represents a floating IP Address
    Mac string
    MAC address of server interface to assign address to
    PartOfPlan bool
    Is the address a part of a plan
    PtrRecord string
    A reverse DNS record entry
    Server string
    The unique identifier for a server
    Zone string
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.
    Access string
    Is address for utility or public network
    Address string
    An UpCloud assigned IP Address
    Family string
    IP address family
    Floating bool
    Does the IP Address represents a floating IP Address
    Mac string
    MAC address of server interface to assign address to
    PartOfPlan bool
    Is the address a part of a plan
    PtrRecord string
    A reverse DNS record entry
    Server string
    The unique identifier for a server
    Zone string
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.
    access String
    Is address for utility or public network
    address String
    An UpCloud assigned IP Address
    family String
    IP address family
    floating Boolean
    Does the IP Address represents a floating IP Address
    mac String
    MAC address of server interface to assign address to
    partOfPlan Boolean
    Is the address a part of a plan
    ptrRecord String
    A reverse DNS record entry
    server String
    The unique identifier for a server
    zone String
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.
    access string
    Is address for utility or public network
    address string
    An UpCloud assigned IP Address
    family string
    IP address family
    floating boolean
    Does the IP Address represents a floating IP Address
    mac string
    MAC address of server interface to assign address to
    partOfPlan boolean
    Is the address a part of a plan
    ptrRecord string
    A reverse DNS record entry
    server string
    The unique identifier for a server
    zone string
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.
    access str
    Is address for utility or public network
    address str
    An UpCloud assigned IP Address
    family str
    IP address family
    floating bool
    Does the IP Address represents a floating IP Address
    mac str
    MAC address of server interface to assign address to
    part_of_plan bool
    Is the address a part of a plan
    ptr_record str
    A reverse DNS record entry
    server str
    The unique identifier for a server
    zone str
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.
    access String
    Is address for utility or public network
    address String
    An UpCloud assigned IP Address
    family String
    IP address family
    floating Boolean
    Does the IP Address represents a floating IP Address
    mac String
    MAC address of server interface to assign address to
    partOfPlan Boolean
    Is the address a part of a plan
    ptrRecord String
    A reverse DNS record entry
    server String
    The unique identifier for a server
    zone String
    Zone of address, required when assigning a detached floating IP address, e.g. de-fra1. You can list available zones with upctl zone list.

    Package Details

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