1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNetworkPool
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNetworkPool

Explore with Pulumi AI

Provides a data source for a network pool attached to a VCD.

Supported in provider v3.10+

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const np1 = vcd.getNetworkPool({
    name: "NSX-T Overlay 1",
});
Copy
import pulumi
import pulumi_vcd as vcd

np1 = vcd.get_network_pool(name="NSX-T Overlay 1")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vcd.LookupNetworkPool(ctx, &vcd.LookupNetworkPoolArgs{
			Name: "NSX-T Overlay 1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var np1 = Vcd.GetNetworkPool.Invoke(new()
    {
        Name = "NSX-T Overlay 1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetNetworkPoolArgs;
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 np1 = VcdFunctions.getNetworkPool(GetNetworkPoolArgs.builder()
            .name("NSX-T Overlay 1")
            .build());

    }
}
Copy
variables:
  np1:
    fn::invoke:
      function: vcd:getNetworkPool
      arguments:
        name: NSX-T Overlay 1
Copy

Using getNetworkPool

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 getNetworkPool(args: GetNetworkPoolArgs, opts?: InvokeOptions): Promise<GetNetworkPoolResult>
function getNetworkPoolOutput(args: GetNetworkPoolOutputArgs, opts?: InvokeOptions): Output<GetNetworkPoolResult>
Copy
def get_network_pool(id: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNetworkPoolResult
def get_network_pool_output(id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNetworkPoolResult]
Copy
func LookupNetworkPool(ctx *Context, args *LookupNetworkPoolArgs, opts ...InvokeOption) (*LookupNetworkPoolResult, error)
func LookupNetworkPoolOutput(ctx *Context, args *LookupNetworkPoolOutputArgs, opts ...InvokeOption) LookupNetworkPoolResultOutput
Copy

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

public static class GetNetworkPool 
{
    public static Task<GetNetworkPoolResult> InvokeAsync(GetNetworkPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkPoolResult> Invoke(GetNetworkPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNetworkPoolResult> getNetworkPool(GetNetworkPoolArgs args, InvokeOptions options)
public static Output<GetNetworkPoolResult> getNetworkPool(GetNetworkPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getNetworkPool:getNetworkPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
network pool name.
Id string
Name This property is required. string
network pool name.
Id string
name This property is required. String
network pool name.
id String
name This property is required. string
network pool name.
id string
name This property is required. str
network pool name.
id str
name This property is required. String
network pool name.
id String

getNetworkPool Result

The following output properties are available:

Supporting Types

GetNetworkPoolBacking

distributedSwitches This property is required. List<Property Map>
portGroups This property is required. List<Property Map>
rangeIds This property is required. List<Property Map>
transportZones This property is required. List<Property Map>

GetNetworkPoolBackingDistributedSwitch

Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String
id This property is required. string
name This property is required. string
network pool name.
type This property is required. string
id This property is required. str
name This property is required. str
network pool name.
type This property is required. str
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String

GetNetworkPoolBackingPortGroup

Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String
id This property is required. string
name This property is required. string
network pool name.
type This property is required. string
id This property is required. str
name This property is required. str
network pool name.
type This property is required. str
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String

GetNetworkPoolBackingRangeId

EndId This property is required. double
StartId This property is required. double
EndId This property is required. float64
StartId This property is required. float64
endId This property is required. Double
startId This property is required. Double
endId This property is required. number
startId This property is required. number
end_id This property is required. float
start_id This property is required. float
endId This property is required. Number
startId This property is required. Number

GetNetworkPoolBackingTransportZone

Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
Id This property is required. string
Name This property is required. string
network pool name.
Type This property is required. string
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String
id This property is required. string
name This property is required. string
network pool name.
type This property is required. string
id This property is required. str
name This property is required. str
network pool name.
type This property is required. str
id This property is required. String
name This property is required. String
network pool name.
type This property is required. String

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.