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

vcd.getPortgroup

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Provides a data source for available vCenter Port Groups.

    Supported in provider v3.0+

    Example Usage

    VSwitch Port Group

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const first_pg_vswitch = vcd.getPortgroup({
        name: "pg-name",
        type: "NETWORK",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    first_pg_vswitch = vcd.get_portgroup(name="pg-name",
        type="NETWORK")
    
    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.GetPortgroup(ctx, &vcd.GetPortgroupArgs{
    			Name: "pg-name",
    			Type: "NETWORK",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var first_pg_vswitch = Vcd.GetPortgroup.Invoke(new()
        {
            Name = "pg-name",
            Type = "NETWORK",
        });
    
    });
    
    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.GetPortgroupArgs;
    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 first-pg-vswitch = VcdFunctions.getPortgroup(GetPortgroupArgs.builder()
                .name("pg-name")
                .type("NETWORK")
                .build());
    
        }
    }
    
    variables:
      first-pg-vswitch:
        fn::invoke:
          function: vcd:getPortgroup
          arguments:
            name: pg-name
            type: NETWORK
    

    Distributed Port Group

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const first_pg_dvswitch = vcd.getPortgroup({
        name: "pg-name",
        type: "DV_PORTGROUP",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    first_pg_dvswitch = vcd.get_portgroup(name="pg-name",
        type="DV_PORTGROUP")
    
    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.GetPortgroup(ctx, &vcd.GetPortgroupArgs{
    			Name: "pg-name",
    			Type: "DV_PORTGROUP",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var first_pg_dvswitch = Vcd.GetPortgroup.Invoke(new()
        {
            Name = "pg-name",
            Type = "DV_PORTGROUP",
        });
    
    });
    
    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.GetPortgroupArgs;
    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 first-pg-dvswitch = VcdFunctions.getPortgroup(GetPortgroupArgs.builder()
                .name("pg-name")
                .type("DV_PORTGROUP")
                .build());
    
        }
    }
    
    variables:
      first-pg-dvswitch:
        fn::invoke:
          function: vcd:getPortgroup
          arguments:
            name: pg-name
            type: DV_PORTGROUP
    

    Using getPortgroup

    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 getPortgroup(args: GetPortgroupArgs, opts?: InvokeOptions): Promise<GetPortgroupResult>
    function getPortgroupOutput(args: GetPortgroupOutputArgs, opts?: InvokeOptions): Output<GetPortgroupResult>
    def get_portgroup(id: Optional[str] = None,
                      name: Optional[str] = None,
                      type: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPortgroupResult
    def get_portgroup_output(id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      type: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPortgroupResult]
    func GetPortgroup(ctx *Context, args *GetPortgroupArgs, opts ...InvokeOption) (*GetPortgroupResult, error)
    func GetPortgroupOutput(ctx *Context, args *GetPortgroupOutputArgs, opts ...InvokeOption) GetPortgroupResultOutput

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

    public static class GetPortgroup 
    {
        public static Task<GetPortgroupResult> InvokeAsync(GetPortgroupArgs args, InvokeOptions? opts = null)
        public static Output<GetPortgroupResult> Invoke(GetPortgroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPortgroupResult> getPortgroup(GetPortgroupArgs args, InvokeOptions options)
    public static Output<GetPortgroupResult> getPortgroup(GetPortgroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getPortgroup:getPortgroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Organization VDC name
    Type string
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    Id string
    Name string
    Organization VDC name
    Type string
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    Id string
    name String
    Organization VDC name
    type String
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    id String
    name string
    Organization VDC name
    type string
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    id string
    name str
    Organization VDC name
    type str
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    id str
    name String
    Organization VDC name
    type String
    NETWORK for vSwitch port group or DV_PORTGROUP for distributed port group.
    id String

    getPortgroup Result

    The following output properties are available:

    Id string
    Name string
    Type string
    Id string
    Name string
    Type string
    id String
    name String
    type String
    id string
    name string
    type string
    id str
    name str
    type str
    id String
    name String
    type String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware