1. Packages
  2. Strata Cloud Manager (Palo Alto SCM)
  3. API Docs
  4. getQosProfile
Strata Cloud Manager v0.1.4 published on Tuesday, Sep 24, 2024 by Pulumi

scm.getQosProfile

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.4 published on Tuesday, Sep 24, 2024 by Pulumi

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getQosProfile({
        id: "1234-56-789",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_qos_profile(id="1234-56-789")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scm.LookupQosProfile(ctx, &scm.LookupQosProfileArgs{
    			Id: "1234-56-789",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetQosProfile.Invoke(new()
        {
            Id = "1234-56-789",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetQosProfileArgs;
    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 example = ScmFunctions.getQosProfile(GetQosProfileArgs.builder()
                .id("1234-56-789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getQosProfile
          Arguments:
            id: 1234-56-789
    

    Using getQosProfile

    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 getQosProfile(args: GetQosProfileArgs, opts?: InvokeOptions): Promise<GetQosProfileResult>
    function getQosProfileOutput(args: GetQosProfileOutputArgs, opts?: InvokeOptions): Output<GetQosProfileResult>
    def get_qos_profile(folder: Optional[str] = None,
                        id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetQosProfileResult
    def get_qos_profile_output(folder: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetQosProfileResult]
    func LookupQosProfile(ctx *Context, args *LookupQosProfileArgs, opts ...InvokeOption) (*LookupQosProfileResult, error)
    func LookupQosProfileOutput(ctx *Context, args *LookupQosProfileOutputArgs, opts ...InvokeOption) LookupQosProfileResultOutput

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

    public static class GetQosProfile 
    {
        public static Task<GetQosProfileResult> InvokeAsync(GetQosProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetQosProfileResult> Invoke(GetQosProfileInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQosProfileResult> getQosProfile(GetQosProfileArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getQosProfile:getQosProfile
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The Id param.
    Folder string
    The Folder param.
    Id string
    The Id param.
    Folder string
    The Folder param.
    id String
    The Id param.
    folder String
    The Folder param.
    id string
    The Id param.
    folder string
    The Folder param.
    id str
    The Id param.
    folder str
    The Folder param.
    id String
    The Id param.
    folder String
    The Folder param.

    getQosProfile Result

    The following output properties are available:

    AggregateBandwidth GetQosProfileAggregateBandwidth
    The AggregateBandwidth param.
    ClassBandwidthType GetQosProfileClassBandwidthType
    The ClassBandwidthType param.
    Id string
    The Id param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Tfid string
    Folder string
    The Folder param.
    AggregateBandwidth GetQosProfileAggregateBandwidth
    The AggregateBandwidth param.
    ClassBandwidthType GetQosProfileClassBandwidthType
    The ClassBandwidthType param.
    Id string
    The Id param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    Tfid string
    Folder string
    The Folder param.
    aggregateBandwidth GetQosProfileAggregateBandwidth
    The AggregateBandwidth param.
    classBandwidthType GetQosProfileClassBandwidthType
    The ClassBandwidthType param.
    id String
    The Id param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    tfid String
    folder String
    The Folder param.
    aggregateBandwidth GetQosProfileAggregateBandwidth
    The AggregateBandwidth param.
    classBandwidthType GetQosProfileClassBandwidthType
    The ClassBandwidthType param.
    id string
    The Id param.
    name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    tfid string
    folder string
    The Folder param.
    aggregate_bandwidth GetQosProfileAggregateBandwidth
    The AggregateBandwidth param.
    class_bandwidth_type GetQosProfileClassBandwidthType
    The ClassBandwidthType param.
    id str
    The Id param.
    name str
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    tfid str
    folder str
    The Folder param.
    aggregateBandwidth Property Map
    The AggregateBandwidth param.
    classBandwidthType Property Map
    The ClassBandwidthType param.
    id String
    The Id param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    tfid String
    folder String
    The Folder param.

    Supporting Types

    GetQosProfileAggregateBandwidth

    EgressGuaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    EgressMax int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    EgressGuaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    EgressMax int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed Integer
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    egressMax Integer
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed number
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    egressMax number
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egress_guaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    egress_max int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed Number
    guaranteed sending bandwidth in mbps. Value must be between 0 and 16000.
    egressMax Number
    max sending bandwidth in mbps. Value must be between 0 and 60000.

    GetQosProfileClassBandwidthType

    mbps Property Map
    The Mbps param.
    percentage Property Map
    The Percentage param.

    GetQosProfileClassBandwidthTypeMbps

    Classes []GetQosProfileClassBandwidthTypeMbpsClass
    QoS setting for traffic classes.
    classes GetQosProfileClassBandwidthTypeMbpsClass[]
    QoS setting for traffic classes.
    classes List<Property Map>
    QoS setting for traffic classes.

    GetQosProfileClassBandwidthTypeMbpsClass

    ClassBandwidth GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
    The ClassBandwidth param.
    Name string
    Traffic class. String length must not exceed 31 characters.
    Priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    ClassBandwidth GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
    The ClassBandwidth param.
    Name string
    Traffic class. String length must not exceed 31 characters.
    Priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
    The ClassBandwidth param.
    name String
    Traffic class. String length must not exceed 31 characters.
    priority String
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
    The ClassBandwidth param.
    name string
    Traffic class. String length must not exceed 31 characters.
    priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    class_bandwidth GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
    The ClassBandwidth param.
    name str
    Traffic class. String length must not exceed 31 characters.
    priority str
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth Property Map
    The ClassBandwidth param.
    name String
    Traffic class. String length must not exceed 31 characters.
    priority String
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".

    GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth

    EgressGuaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    EgressMax int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    EgressGuaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    EgressMax int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed Integer
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    egressMax Integer
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed number
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    egressMax number
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egress_guaranteed int
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    egress_max int
    max sending bandwidth in mbps. Value must be between 0 and 60000.
    egressGuaranteed Number
    guaranteed sending bandwidth in mbps. Value must be between 0 and 60000.
    egressMax Number
    max sending bandwidth in mbps. Value must be between 0 and 60000.

    GetQosProfileClassBandwidthTypePercentage

    classes List<Property Map>
    QoS setting for traffic classes.

    GetQosProfileClassBandwidthTypePercentageClass

    ClassBandwidth GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
    The ClassBandwidth param.
    Name string
    Traffic class. String length must not exceed 31 characters.
    Priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    ClassBandwidth GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
    The ClassBandwidth param.
    Name string
    Traffic class. String length must not exceed 31 characters.
    Priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
    The ClassBandwidth param.
    name String
    Traffic class. String length must not exceed 31 characters.
    priority String
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
    The ClassBandwidth param.
    name string
    Traffic class. String length must not exceed 31 characters.
    priority string
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    class_bandwidth GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
    The ClassBandwidth param.
    name str
    Traffic class. String length must not exceed 31 characters.
    priority str
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".
    classBandwidth Property Map
    The ClassBandwidth param.
    name String
    Traffic class. String length must not exceed 31 characters.
    priority String
    traffic class priority. String must be one of these: "real-time", "high", "medium", "low". Default: "medium".

    GetQosProfileClassBandwidthTypePercentageClassClassBandwidth

    EgressGuaranteed int
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    EgressMax int
    max sending bandwidth in percentage. Value must be between 0 and 100.
    EgressGuaranteed int
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    EgressMax int
    max sending bandwidth in percentage. Value must be between 0 and 100.
    egressGuaranteed Integer
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    egressMax Integer
    max sending bandwidth in percentage. Value must be between 0 and 100.
    egressGuaranteed number
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    egressMax number
    max sending bandwidth in percentage. Value must be between 0 and 100.
    egress_guaranteed int
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    egress_max int
    max sending bandwidth in percentage. Value must be between 0 and 100.
    egressGuaranteed Number
    guaranteed sending bandwidth in percentage. Value must be between 0 and 100.
    egressMax Number
    max sending bandwidth in percentage. Value must be between 0 and 100.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.4 published on Tuesday, Sep 24, 2024 by Pulumi