1. Packages
  2. Netaddr Provider
  3. API Docs
  4. getRangeIpv4
netaddr 0.5.1 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

netaddr.getRangeIpv4

Explore with Pulumi AI

netaddr logo
netaddr 0.5.1 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine

    Retrieves data on an existing ipv4 address range.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as netaddr from "@pulumi/netaddr";
    
    const test = netaddr.getRangeIpv4({
        keyPrefix: "/test/ipv4/",
    });
    export const dataRangeIpv4Test = Promise.all([test, test]).then(([test, test1]) => `first_address: ${test.firstAddress}, last_address: ${test1.lastAddress}`);
    
    import pulumi
    import pulumi_netaddr as netaddr
    
    test = netaddr.get_range_ipv4(key_prefix="/test/ipv4/")
    pulumi.export("dataRangeIpv4Test", f"first_address: {test.first_address}, last_address: {test.last_address}")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netaddr/netaddr"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := netaddr.LookupRangeIpv4(ctx, &netaddr.LookupRangeIpv4Args{
    			KeyPrefix: "/test/ipv4/",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dataRangeIpv4Test", pulumi.Sprintf("first_address: %v, last_address: %v", test.FirstAddress, test.LastAddress))
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Netaddr = Pulumi.Netaddr;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Netaddr.GetRangeIpv4.Invoke(new()
        {
            KeyPrefix = "/test/ipv4/",
        });
    
        return new Dictionary<string, object?>
        {
            ["dataRangeIpv4Test"] = Output.Tuple(test, test).Apply(values =>
            {
                var test = values.Item1;
                var test1 = values.Item2;
                return $"first_address: {test.Apply(getRangeIpv4Result => getRangeIpv4Result.FirstAddress)}, last_address: {test1.LastAddress}";
            }),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.netaddr.NetaddrFunctions;
    import com.pulumi.netaddr.inputs.GetRangeIpv4Args;
    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 test = NetaddrFunctions.getRangeIpv4(GetRangeIpv4Args.builder()
                .keyPrefix("/test/ipv4/")
                .build());
    
            ctx.export("dataRangeIpv4Test", String.format("first_address: %s, last_address: %s", test.applyValue(getRangeIpv4Result -> getRangeIpv4Result.firstAddress()),test.applyValue(getRangeIpv4Result -> getRangeIpv4Result.lastAddress())));
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: netaddr:getRangeIpv4
          arguments:
            keyPrefix: /test/ipv4/
    outputs:
      dataRangeIpv4Test: 'first_address: ${test.firstAddress}, last_address: ${test.lastAddress}'
    

    Using getRangeIpv4

    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 getRangeIpv4(args: GetRangeIpv4Args, opts?: InvokeOptions): Promise<GetRangeIpv4Result>
    function getRangeIpv4Output(args: GetRangeIpv4OutputArgs, opts?: InvokeOptions): Output<GetRangeIpv4Result>
    def get_range_ipv4(id: Optional[str] = None,
                       key_prefix: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRangeIpv4Result
    def get_range_ipv4_output(id: Optional[pulumi.Input[str]] = None,
                       key_prefix: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRangeIpv4Result]
    func LookupRangeIpv4(ctx *Context, args *LookupRangeIpv4Args, opts ...InvokeOption) (*LookupRangeIpv4Result, error)
    func LookupRangeIpv4Output(ctx *Context, args *LookupRangeIpv4OutputArgs, opts ...InvokeOption) LookupRangeIpv4ResultOutput

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

    public static class GetRangeIpv4 
    {
        public static Task<GetRangeIpv4Result> InvokeAsync(GetRangeIpv4Args args, InvokeOptions? opts = null)
        public static Output<GetRangeIpv4Result> Invoke(GetRangeIpv4InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRangeIpv4Result> getRangeIpv4(GetRangeIpv4Args args, InvokeOptions options)
    public static Output<GetRangeIpv4Result> getRangeIpv4(GetRangeIpv4Args args, InvokeOptions options)
    
    fn::invoke:
      function: netaddr:index/getRangeIpv4:getRangeIpv4
      arguments:
        # arguments dictionary

    The following arguments are supported:

    KeyPrefix string
    Etcd key prefix for address range.
    Id string
    The ID of this resource.
    KeyPrefix string
    Etcd key prefix for address range.
    Id string
    The ID of this resource.
    keyPrefix String
    Etcd key prefix for address range.
    id String
    The ID of this resource.
    keyPrefix string
    Etcd key prefix for address range.
    id string
    The ID of this resource.
    key_prefix str
    Etcd key prefix for address range.
    id str
    The ID of this resource.
    keyPrefix String
    Etcd key prefix for address range.
    id String
    The ID of this resource.

    getRangeIpv4 Result

    The following output properties are available:

    FirstAddress string
    First assignable address in the range.
    Id string
    The ID of this resource.
    KeyPrefix string
    Etcd key prefix for address range.
    LastAddress string
    Last assignable address in the range.
    FirstAddress string
    First assignable address in the range.
    Id string
    The ID of this resource.
    KeyPrefix string
    Etcd key prefix for address range.
    LastAddress string
    Last assignable address in the range.
    firstAddress String
    First assignable address in the range.
    id String
    The ID of this resource.
    keyPrefix String
    Etcd key prefix for address range.
    lastAddress String
    Last assignable address in the range.
    firstAddress string
    First assignable address in the range.
    id string
    The ID of this resource.
    keyPrefix string
    Etcd key prefix for address range.
    lastAddress string
    Last assignable address in the range.
    first_address str
    First assignable address in the range.
    id str
    The ID of this resource.
    key_prefix str
    Etcd key prefix for address range.
    last_address str
    Last assignable address in the range.
    firstAddress String
    First assignable address in the range.
    id String
    The ID of this resource.
    keyPrefix String
    Etcd key prefix for address range.
    lastAddress String
    Last assignable address in the range.

    Package Details

    Repository
    netaddr ferlab-ste-justine/terraform-provider-netaddr
    License
    Notes
    This Pulumi package is based on the netaddr Terraform Provider.
    netaddr logo
    netaddr 0.5.1 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine