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

scm.getQosProfileList

Explore with Pulumi AI

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

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getQosProfileList({
        folder: "Shared",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_qos_profile_list(folder="Shared")
    
    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.GetQosProfileList(ctx, &scm.GetQosProfileListArgs{
    			Folder: pulumi.StringRef("Shared"),
    		}, 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.GetQosProfileList.Invoke(new()
        {
            Folder = "Shared",
        });
    
    });
    
    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.GetQosProfileListArgs;
    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.getQosProfileList(GetQosProfileListArgs.builder()
                .folder("Shared")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getQosProfileList
          Arguments:
            folder: Shared
    

    Using getQosProfileList

    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 getQosProfileList(args: GetQosProfileListArgs, opts?: InvokeOptions): Promise<GetQosProfileListResult>
    function getQosProfileListOutput(args: GetQosProfileListOutputArgs, opts?: InvokeOptions): Output<GetQosProfileListResult>
    def get_qos_profile_list(device: Optional[str] = None,
                             folder: Optional[str] = None,
                             limit: Optional[int] = None,
                             name: Optional[str] = None,
                             offset: Optional[int] = None,
                             snippet: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetQosProfileListResult
    def get_qos_profile_list_output(device: Optional[pulumi.Input[str]] = None,
                             folder: Optional[pulumi.Input[str]] = None,
                             limit: Optional[pulumi.Input[int]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             offset: Optional[pulumi.Input[int]] = None,
                             snippet: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetQosProfileListResult]
    func GetQosProfileList(ctx *Context, args *GetQosProfileListArgs, opts ...InvokeOption) (*GetQosProfileListResult, error)
    func GetQosProfileListOutput(ctx *Context, args *GetQosProfileListOutputArgs, opts ...InvokeOption) GetQosProfileListResultOutput

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

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

    The following arguments are supported:

    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Integer
    The Offset param. Default: 0.
    snippet String
    The Snippet param.
    device string
    The Device param.
    folder string
    The Folder param.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name string
    The Name param.
    offset number
    The Offset param. Default: 0.
    snippet string
    The Snippet param.
    device str
    The Device param.
    folder str
    The Folder param.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name str
    The Name param.
    offset int
    The Offset param. Default: 0.
    snippet str
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Number
    The Offset param. Default: 0.
    snippet String
    The Snippet param.

    getQosProfileList Result

    The following output properties are available:

    Datas List<GetQosProfileListData>
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Datas []GetQosProfileListData
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    datas List<GetQosProfileListData>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Integer
    The Offset param. Default: 0.
    tfid String
    total Integer
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    datas GetQosProfileListData[]
    The Data param.
    id string
    The provider-assigned unique ID for this managed resource.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset number
    The Offset param. Default: 0.
    tfid string
    total number
    The Total param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    datas Sequence[GetQosProfileListData]
    The Data param.
    id str
    The provider-assigned unique ID for this managed resource.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset int
    The Offset param. Default: 0.
    tfid str
    total int
    The Total param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    datas List<Property Map>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Number
    The Offset param. Default: 0.
    tfid String
    total Number
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.

    Supporting Types

    GetQosProfileListData

    AggregateBandwidth GetQosProfileListDataAggregateBandwidth
    The AggregateBandwidth param.
    ClassBandwidthType GetQosProfileListDataClassBandwidthType
    The ClassBandwidthType param.
    Id string
    UUID of the resource.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    AggregateBandwidth GetQosProfileListDataAggregateBandwidth
    The AggregateBandwidth param.
    ClassBandwidthType GetQosProfileListDataClassBandwidthType
    The ClassBandwidthType param.
    Id string
    UUID of the resource.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    aggregateBandwidth GetQosProfileListDataAggregateBandwidth
    The AggregateBandwidth param.
    classBandwidthType GetQosProfileListDataClassBandwidthType
    The ClassBandwidthType param.
    id String
    UUID of the resource.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    aggregateBandwidth GetQosProfileListDataAggregateBandwidth
    The AggregateBandwidth param.
    classBandwidthType GetQosProfileListDataClassBandwidthType
    The ClassBandwidthType param.
    id string
    UUID of the resource.
    name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    aggregate_bandwidth GetQosProfileListDataAggregateBandwidth
    The AggregateBandwidth param.
    class_bandwidth_type GetQosProfileListDataClassBandwidthType
    The ClassBandwidthType param.
    id str
    UUID of the resource.
    name str
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.
    aggregateBandwidth Property Map
    The AggregateBandwidth param.
    classBandwidthType Property Map
    The ClassBandwidthType param.
    id String
    UUID of the resource.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 31 characters.

    GetQosProfileListDataAggregateBandwidth

    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.

    GetQosProfileListDataClassBandwidthType

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

    GetQosProfileListDataClassBandwidthTypeMbps

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

    GetQosProfileListDataClassBandwidthTypeMbpsClass

    ClassBandwidth GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
    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".

    GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth

    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.

    GetQosProfileListDataClassBandwidthTypePercentage

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

    GetQosProfileListDataClassBandwidthTypePercentageClass

    ClassBandwidth GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
    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 GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
    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".

    GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth

    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