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

vcd.getNsxtEdgegatewayQosProfile

Explore with Pulumi AI

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

    Supported in provider v3.9+ and VCD 10.3.2+ with NSX-T.

    Provides a data source to read NSX-T Edge Gateway QoS profiles, which can be used to modify NSX-T Edge Gateway Rate Limiting (QoS) configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const first = vcd.getNsxtManager({
        name: "nsxt-manager-name",
    });
    const qos_1 = vcd.getNsxtEdgegatewayQosProfile({
        nsxtManagerId: data.nsxt_manager_id.first.id,
        name: "qos-profile-1",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    first = vcd.get_nsxt_manager(name="nsxt-manager-name")
    qos_1 = vcd.get_nsxt_edgegateway_qos_profile(nsxt_manager_id=data["nsxt_manager_id"]["first"]["id"],
        name="qos-profile-1")
    
    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.GetNsxtManager(ctx, &vcd.GetNsxtManagerArgs{
    			Name: "nsxt-manager-name",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = vcd.GetNsxtEdgegatewayQosProfile(ctx, &vcd.GetNsxtEdgegatewayQosProfileArgs{
    			NsxtManagerId: data.Nsxt_manager_id.First.Id,
    			Name:          "qos-profile-1",
    		}, 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 = Vcd.GetNsxtManager.Invoke(new()
        {
            Name = "nsxt-manager-name",
        });
    
        var qos_1 = Vcd.GetNsxtEdgegatewayQosProfile.Invoke(new()
        {
            NsxtManagerId = data.Nsxt_manager_id.First.Id,
            Name = "qos-profile-1",
        });
    
    });
    
    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.GetNsxtManagerArgs;
    import com.pulumi.vcd.inputs.GetNsxtEdgegatewayQosProfileArgs;
    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 = VcdFunctions.getNsxtManager(GetNsxtManagerArgs.builder()
                .name("nsxt-manager-name")
                .build());
    
            final var qos-1 = VcdFunctions.getNsxtEdgegatewayQosProfile(GetNsxtEdgegatewayQosProfileArgs.builder()
                .nsxtManagerId(data.nsxt_manager_id().first().id())
                .name("qos-profile-1")
                .build());
    
        }
    }
    
    variables:
      first:
        fn::invoke:
          function: vcd:getNsxtManager
          arguments:
            name: nsxt-manager-name
      qos-1:
        fn::invoke:
          function: vcd:getNsxtEdgegatewayQosProfile
          arguments:
            nsxtManagerId: ${data.nsxt_manager_id.first.id}
            name: qos-profile-1
    

    Using getNsxtEdgegatewayQosProfile

    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 getNsxtEdgegatewayQosProfile(args: GetNsxtEdgegatewayQosProfileArgs, opts?: InvokeOptions): Promise<GetNsxtEdgegatewayQosProfileResult>
    function getNsxtEdgegatewayQosProfileOutput(args: GetNsxtEdgegatewayQosProfileOutputArgs, opts?: InvokeOptions): Output<GetNsxtEdgegatewayQosProfileResult>
    def get_nsxt_edgegateway_qos_profile(id: Optional[str] = None,
                                         name: Optional[str] = None,
                                         nsxt_manager_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetNsxtEdgegatewayQosProfileResult
    def get_nsxt_edgegateway_qos_profile_output(id: Optional[pulumi.Input[str]] = None,
                                         name: Optional[pulumi.Input[str]] = None,
                                         nsxt_manager_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetNsxtEdgegatewayQosProfileResult]
    func GetNsxtEdgegatewayQosProfile(ctx *Context, args *GetNsxtEdgegatewayQosProfileArgs, opts ...InvokeOption) (*GetNsxtEdgegatewayQosProfileResult, error)
    func GetNsxtEdgegatewayQosProfileOutput(ctx *Context, args *GetNsxtEdgegatewayQosProfileOutputArgs, opts ...InvokeOption) GetNsxtEdgegatewayQosProfileResultOutput

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

    public static class GetNsxtEdgegatewayQosProfile 
    {
        public static Task<GetNsxtEdgegatewayQosProfileResult> InvokeAsync(GetNsxtEdgegatewayQosProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetNsxtEdgegatewayQosProfileResult> Invoke(GetNsxtEdgegatewayQosProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNsxtEdgegatewayQosProfileResult> getNsxtEdgegatewayQosProfile(GetNsxtEdgegatewayQosProfileArgs args, InvokeOptions options)
    public static Output<GetNsxtEdgegatewayQosProfileResult> getNsxtEdgegatewayQosProfile(GetNsxtEdgegatewayQosProfileArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNsxtEdgegatewayQosProfile:getNsxtEdgegatewayQosProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    QoS Profile Name
    NsxtManagerId string
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    Id string
    Name string
    QoS Profile Name
    NsxtManagerId string
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    Id string
    name String
    QoS Profile Name
    nsxtManagerId String
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    id String
    name string
    QoS Profile Name
    nsxtManagerId string
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    id string
    name str
    QoS Profile Name
    nsxt_manager_id str
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    id str
    name String
    QoS Profile Name
    nsxtManagerId String
    NSX-T Manager where the QoS profile is defined in (can be looked up using vcd.getNsxtManager data source)
    id String

    getNsxtEdgegatewayQosProfile Result

    The following output properties are available:

    BurstSize double
    Burst size defined in bytes
    CommittedBandwidth double
    Committed bandwith specificd in Mb/s
    Description string
    Description of QoS Profile
    ExcessAction string
    Excess action defines action on traffic exceeding bandwidth
    Id string
    Name string
    NsxtManagerId string
    BurstSize float64
    Burst size defined in bytes
    CommittedBandwidth float64
    Committed bandwith specificd in Mb/s
    Description string
    Description of QoS Profile
    ExcessAction string
    Excess action defines action on traffic exceeding bandwidth
    Id string
    Name string
    NsxtManagerId string
    burstSize Double
    Burst size defined in bytes
    committedBandwidth Double
    Committed bandwith specificd in Mb/s
    description String
    Description of QoS Profile
    excessAction String
    Excess action defines action on traffic exceeding bandwidth
    id String
    name String
    nsxtManagerId String
    burstSize number
    Burst size defined in bytes
    committedBandwidth number
    Committed bandwith specificd in Mb/s
    description string
    Description of QoS Profile
    excessAction string
    Excess action defines action on traffic exceeding bandwidth
    id string
    name string
    nsxtManagerId string
    burst_size float
    Burst size defined in bytes
    committed_bandwidth float
    Committed bandwith specificd in Mb/s
    description str
    Description of QoS Profile
    excess_action str
    Excess action defines action on traffic exceeding bandwidth
    id str
    name str
    nsxt_manager_id str
    burstSize Number
    Burst size defined in bytes
    committedBandwidth Number
    Committed bandwith specificd in Mb/s
    description String
    Description of QoS Profile
    excessAction String
    Excess action defines action on traffic exceeding bandwidth
    id String
    name String
    nsxtManagerId 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