1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getVpcIpAddressAllocation
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

nsxt.getVpcIpAddressAllocation

Explore with Pulumi AI

nsxt logo
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

    This data source provides information about IP address allocation under VPC on NSX.

    This data source is applicable to NSX Policy Manager.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const demoproj = nsxt.getPolicyProject({
        displayName: "demoproj",
    });
    const demovpc = demoproj.then(demoproj => nsxt.getVpc({
        context: {
            projectId: demoproj.id,
        },
        displayName: "vpc1",
    }));
    const test = Promise.all([demoproj, demovpc]).then(([demoproj, demovpc]) => nsxt.getVpcIpAddressAllocation({
        context: {
            projectId: demoproj.id,
            vpcId: demovpc.id,
        },
        allocationIps: "10.203.5.19",
    }));
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    demoproj = nsxt.get_policy_project(display_name="demoproj")
    demovpc = nsxt.get_vpc(context={
            "project_id": demoproj.id,
        },
        display_name="vpc1")
    test = nsxt.get_vpc_ip_address_allocation(context={
            "project_id": demoproj.id,
            "vpc_id": demovpc.id,
        },
        allocation_ips="10.203.5.19")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		demoproj, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{
    			DisplayName: pulumi.StringRef("demoproj"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		demovpc, err := nsxt.LookupVpc(ctx, &nsxt.LookupVpcArgs{
    			Context: nsxt.GetVpcContext{
    				ProjectId: demoproj.Id,
    			},
    			DisplayName: pulumi.StringRef("vpc1"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nsxt.LookupVpcIpAddressAllocation(ctx, &nsxt.LookupVpcIpAddressAllocationArgs{
    			Context: nsxt.GetVpcIpAddressAllocationContext{
    				ProjectId: demoproj.Id,
    				VpcId:     demovpc.Id,
    			},
    			AllocationIps: "10.203.5.19",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nsxt = Pulumi.Nsxt;
    
    return await Deployment.RunAsync(() => 
    {
        var demoproj = Nsxt.GetPolicyProject.Invoke(new()
        {
            DisplayName = "demoproj",
        });
    
        var demovpc = Nsxt.GetVpc.Invoke(new()
        {
            Context = new Nsxt.Inputs.GetVpcContextInputArgs
            {
                ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
            },
            DisplayName = "vpc1",
        });
    
        var test = Nsxt.GetVpcIpAddressAllocation.Invoke(new()
        {
            Context = new Nsxt.Inputs.GetVpcIpAddressAllocationContextInputArgs
            {
                ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
                VpcId = demovpc.Apply(getVpcResult => getVpcResult.Id),
            },
            AllocationIps = "10.203.5.19",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nsxt.NsxtFunctions;
    import com.pulumi.nsxt.inputs.GetPolicyProjectArgs;
    import com.pulumi.nsxt.inputs.GetVpcArgs;
    import com.pulumi.nsxt.inputs.GetVpcContextArgs;
    import com.pulumi.nsxt.inputs.GetVpcIpAddressAllocationArgs;
    import com.pulumi.nsxt.inputs.GetVpcIpAddressAllocationContextArgs;
    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 demoproj = NsxtFunctions.getPolicyProject(GetPolicyProjectArgs.builder()
                .displayName("demoproj")
                .build());
    
            final var demovpc = NsxtFunctions.getVpc(GetVpcArgs.builder()
                .context(GetVpcContextArgs.builder()
                    .projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
                    .build())
                .displayName("vpc1")
                .build());
    
            final var test = NsxtFunctions.getVpcIpAddressAllocation(GetVpcIpAddressAllocationArgs.builder()
                .context(GetVpcIpAddressAllocationContextArgs.builder()
                    .projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
                    .vpcId(demovpc.applyValue(getVpcResult -> getVpcResult.id()))
                    .build())
                .allocationIps("10.203.5.19")
                .build());
    
        }
    }
    
    variables:
      demoproj:
        fn::invoke:
          function: nsxt:getPolicyProject
          arguments:
            displayName: demoproj
      demovpc:
        fn::invoke:
          function: nsxt:getVpc
          arguments:
            context:
              projectId: ${demoproj.id}
            displayName: vpc1
      test:
        fn::invoke:
          function: nsxt:getVpcIpAddressAllocation
          arguments:
            context:
              projectId: ${demoproj.id}
              vpcId: ${demovpc.id}
            allocationIps: 10.203.5.19
    

    Using getVpcIpAddressAllocation

    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 getVpcIpAddressAllocation(args: GetVpcIpAddressAllocationArgs, opts?: InvokeOptions): Promise<GetVpcIpAddressAllocationResult>
    function getVpcIpAddressAllocationOutput(args: GetVpcIpAddressAllocationOutputArgs, opts?: InvokeOptions): Output<GetVpcIpAddressAllocationResult>
    def get_vpc_ip_address_allocation(allocation_ips: Optional[str] = None,
                                      context: Optional[GetVpcIpAddressAllocationContext] = None,
                                      description: Optional[str] = None,
                                      display_name: Optional[str] = None,
                                      id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetVpcIpAddressAllocationResult
    def get_vpc_ip_address_allocation_output(allocation_ips: Optional[pulumi.Input[str]] = None,
                                      context: Optional[pulumi.Input[GetVpcIpAddressAllocationContextArgs]] = None,
                                      description: Optional[pulumi.Input[str]] = None,
                                      display_name: Optional[pulumi.Input[str]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetVpcIpAddressAllocationResult]
    func LookupVpcIpAddressAllocation(ctx *Context, args *LookupVpcIpAddressAllocationArgs, opts ...InvokeOption) (*LookupVpcIpAddressAllocationResult, error)
    func LookupVpcIpAddressAllocationOutput(ctx *Context, args *LookupVpcIpAddressAllocationOutputArgs, opts ...InvokeOption) LookupVpcIpAddressAllocationResultOutput

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

    public static class GetVpcIpAddressAllocation 
    {
        public static Task<GetVpcIpAddressAllocationResult> InvokeAsync(GetVpcIpAddressAllocationArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcIpAddressAllocationResult> Invoke(GetVpcIpAddressAllocationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcIpAddressAllocationResult> getVpcIpAddressAllocation(GetVpcIpAddressAllocationArgs args, InvokeOptions options)
    public static Output<GetVpcIpAddressAllocationResult> getVpcIpAddressAllocation(GetVpcIpAddressAllocationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getVpcIpAddressAllocation:getVpcIpAddressAllocation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AllocationIps string
    IP or CIDR that was allocated
    Context GetVpcIpAddressAllocationContext
    The context which the object belongs to
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Subnet to retrieve.
    Id string
    The ID of Subnet to retrieve.
    AllocationIps string
    IP or CIDR that was allocated
    Context GetVpcIpAddressAllocationContext
    The context which the object belongs to
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Subnet to retrieve.
    Id string
    The ID of Subnet to retrieve.
    allocationIps String
    IP or CIDR that was allocated
    context GetVpcIpAddressAllocationContext
    The context which the object belongs to
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Subnet to retrieve.
    id String
    The ID of Subnet to retrieve.
    allocationIps string
    IP or CIDR that was allocated
    context GetVpcIpAddressAllocationContext
    The context which the object belongs to
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the Subnet to retrieve.
    id string
    The ID of Subnet to retrieve.
    allocation_ips str
    IP or CIDR that was allocated
    context GetVpcIpAddressAllocationContext
    The context which the object belongs to
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the Subnet to retrieve.
    id str
    The ID of Subnet to retrieve.
    allocationIps String
    IP or CIDR that was allocated
    context Property Map
    The context which the object belongs to
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Subnet to retrieve.
    id String
    The ID of Subnet to retrieve.

    getVpcIpAddressAllocation Result

    The following output properties are available:

    AllocationIps string
    Context GetVpcIpAddressAllocationContext
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    AllocationIps string
    Context GetVpcIpAddressAllocationContext
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    allocationIps String
    context GetVpcIpAddressAllocationContext
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    allocationIps string
    context GetVpcIpAddressAllocationContext
    description string
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    allocation_ips str
    context GetVpcIpAddressAllocationContext
    description str
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    allocationIps String
    context Property Map
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.

    Supporting Types

    GetVpcIpAddressAllocationContext

    ProjectId string
    The ID of the project which the object belongs to
    VpcId string
    The ID of the VPC which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    VpcId string
    The ID of the VPC which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    vpcId String
    The ID of the VPC which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    vpcId string
    The ID of the VPC which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    vpc_id str
    The ID of the VPC which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    vpcId String
    The ID of the VPC which the object belongs to

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware