1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyVniPool
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.getPolicyVniPool

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    This data source provides information about policy VNI Pools configured in NSX.

    This data source is applicable to NSX Policy Manager.

    This data source is supported with NSX 3.0.0 onwards.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nsxt from "@pulumi/nsxt";
    
    const test = nsxt.getPolicyVniPool({
        displayName: "vnipool1",
    });
    
    import pulumi
    import pulumi_nsxt as nsxt
    
    test = nsxt.get_policy_vni_pool(display_name="vnipool1")
    
    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 {
    		_, err := nsxt.LookupPolicyVniPool(ctx, &nsxt.LookupPolicyVniPoolArgs{
    			DisplayName: pulumi.StringRef("vnipool1"),
    		}, 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 test = Nsxt.GetPolicyVniPool.Invoke(new()
        {
            DisplayName = "vnipool1",
        });
    
    });
    
    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.GetPolicyVniPoolArgs;
    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 = NsxtFunctions.getPolicyVniPool(GetPolicyVniPoolArgs.builder()
                .displayName("vnipool1")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: nsxt:getPolicyVniPool
          arguments:
            displayName: vnipool1
    

    Using getPolicyVniPool

    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 getPolicyVniPool(args: GetPolicyVniPoolArgs, opts?: InvokeOptions): Promise<GetPolicyVniPoolResult>
    function getPolicyVniPoolOutput(args: GetPolicyVniPoolOutputArgs, opts?: InvokeOptions): Output<GetPolicyVniPoolResult>
    def get_policy_vni_pool(description: Optional[str] = None,
                            display_name: Optional[str] = None,
                            id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPolicyVniPoolResult
    def get_policy_vni_pool_output(description: Optional[pulumi.Input[str]] = None,
                            display_name: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPolicyVniPoolResult]
    func LookupPolicyVniPool(ctx *Context, args *LookupPolicyVniPoolArgs, opts ...InvokeOption) (*LookupPolicyVniPoolResult, error)
    func LookupPolicyVniPoolOutput(ctx *Context, args *LookupPolicyVniPoolOutputArgs, opts ...InvokeOption) LookupPolicyVniPoolResultOutput

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

    public static class GetPolicyVniPool 
    {
        public static Task<GetPolicyVniPoolResult> InvokeAsync(GetPolicyVniPoolArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyVniPoolResult> Invoke(GetPolicyVniPoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyVniPoolResult> getPolicyVniPool(GetPolicyVniPoolArgs args, InvokeOptions options)
    public static Output<GetPolicyVniPoolResult> getPolicyVniPool(GetPolicyVniPoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: nsxt:index/getPolicyVniPool:getPolicyVniPool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the VNI Pool Config to retrieve.
    Id string
    The ID of VNI Pool Config to retrieve.
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the VNI Pool Config to retrieve.
    Id string
    The ID of VNI Pool Config to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the VNI Pool Config to retrieve.
    id String
    The ID of VNI Pool Config to retrieve.
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the VNI Pool Config to retrieve.
    id string
    The ID of VNI Pool Config to retrieve.
    description str
    The description of the resource.
    display_name str
    The Display Name prefix of the VNI Pool Config to retrieve.
    id str
    The ID of VNI Pool Config to retrieve.
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the VNI Pool Config to retrieve.
    id String
    The ID of VNI Pool Config to retrieve.

    getPolicyVniPool Result

    The following output properties are available:

    Description string
    The description of the resource.
    DisplayName string
    End double
    The end range of VNI Pool.
    Id string
    Path string
    The NSX path of the policy resource.
    Start double
    The start range of VNI Pool.
    Description string
    The description of the resource.
    DisplayName string
    End float64
    The end range of VNI Pool.
    Id string
    Path string
    The NSX path of the policy resource.
    Start float64
    The start range of VNI Pool.
    description String
    The description of the resource.
    displayName String
    end Double
    The end range of VNI Pool.
    id String
    path String
    The NSX path of the policy resource.
    start Double
    The start range of VNI Pool.
    description string
    The description of the resource.
    displayName string
    end number
    The end range of VNI Pool.
    id string
    path string
    The NSX path of the policy resource.
    start number
    The start range of VNI Pool.
    description str
    The description of the resource.
    display_name str
    end float
    The end range of VNI Pool.
    id str
    path str
    The NSX path of the policy resource.
    start float
    The start range of VNI Pool.
    description String
    The description of the resource.
    displayName String
    end Number
    The end range of VNI Pool.
    id String
    path String
    The NSX path of the policy resource.
    start Number
    The start range of VNI Pool.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware