Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getWirelessSsidsTrafficShapingRules
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.getWirelessSsidsTrafficShapingRules

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

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

const example = meraki.networks.getWirelessSsidsTrafficShapingRules({
    networkId: "string",
    number: "string",
});
export const merakiNetworksWirelessSsidsTrafficShapingRulesExample = example.then(example => example.item);

    import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_wireless_ssids_traffic_shaping_rules(network_id="string",
    number="string")
pulumi.export("merakiNetworksWirelessSsidsTrafficShapingRulesExample", example.item)

    package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.LookupWirelessSsidsTrafficShapingRules(ctx, &networks.LookupWirelessSsidsTrafficShapingRulesArgs{
			NetworkId: "string",
			Number:    "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksWirelessSsidsTrafficShapingRulesExample", example.Item)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetWirelessSsidsTrafficShapingRules.Invoke(new()
    {
        NetworkId = "string",
        Number = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksWirelessSsidsTrafficShapingRulesExample"] = example.Apply(getWirelessSsidsTrafficShapingRulesResult => getWirelessSsidsTrafficShapingRulesResult.Item),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetWirelessSsidsTrafficShapingRulesArgs;
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 = NetworksFunctions.getWirelessSsidsTrafficShapingRules(GetWirelessSsidsTrafficShapingRulesArgs.builder()
            .networkId("string")
            .number("string")
            .build());

        ctx.export("merakiNetworksWirelessSsidsTrafficShapingRulesExample", example.applyValue(getWirelessSsidsTrafficShapingRulesResult -> getWirelessSsidsTrafficShapingRulesResult.item()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:networks:getWirelessSsidsTrafficShapingRules
      Arguments:
        networkId: string
        number: string
outputs:
  merakiNetworksWirelessSsidsTrafficShapingRulesExample: ${example.item}

    Using getWirelessSsidsTrafficShapingRules

    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 getWirelessSsidsTrafficShapingRules(args: GetWirelessSsidsTrafficShapingRulesArgs, opts?: InvokeOptions): Promise<GetWirelessSsidsTrafficShapingRulesResult>
function getWirelessSsidsTrafficShapingRulesOutput(args: GetWirelessSsidsTrafficShapingRulesOutputArgs, opts?: InvokeOptions): Output<GetWirelessSsidsTrafficShapingRulesResult>
    def get_wireless_ssids_traffic_shaping_rules(network_id: Optional[str] = None,
                                             number: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetWirelessSsidsTrafficShapingRulesResult
def get_wireless_ssids_traffic_shaping_rules_output(network_id: Optional[pulumi.Input[str]] = None,
                                             number: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetWirelessSsidsTrafficShapingRulesResult]
    func LookupWirelessSsidsTrafficShapingRules(ctx *Context, args *LookupWirelessSsidsTrafficShapingRulesArgs, opts ...InvokeOption) (*LookupWirelessSsidsTrafficShapingRulesResult, error)
func LookupWirelessSsidsTrafficShapingRulesOutput(ctx *Context, args *LookupWirelessSsidsTrafficShapingRulesOutputArgs, opts ...InvokeOption) LookupWirelessSsidsTrafficShapingRulesResultOutput

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

    public static class GetWirelessSsidsTrafficShapingRules 
{
    public static Task<GetWirelessSsidsTrafficShapingRulesResult> InvokeAsync(GetWirelessSsidsTrafficShapingRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetWirelessSsidsTrafficShapingRulesResult> Invoke(GetWirelessSsidsTrafficShapingRulesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWirelessSsidsTrafficShapingRulesResult> getWirelessSsidsTrafficShapingRules(GetWirelessSsidsTrafficShapingRulesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:networks/getWirelessSsidsTrafficShapingRules:getWirelessSsidsTrafficShapingRules
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.
    networkId string
    networkId path parameter. Network ID
    number string
    number path parameter.
    network_id str
    networkId path parameter. Network ID
    number str
    number path parameter.
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.

    getWirelessSsidsTrafficShapingRules Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessSsidsTrafficShapingRulesItem
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Item GetWirelessSsidsTrafficShapingRulesItem
    NetworkId string
    networkId path parameter. Network ID
    Number string
    number path parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsTrafficShapingRulesItem
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsTrafficShapingRulesItem
    networkId string
    networkId path parameter. Network ID
    number string
    number path parameter.
    id str
    The provider-assigned unique ID for this managed resource.
    item GetWirelessSsidsTrafficShapingRulesItem
    network_id str
    networkId path parameter. Network ID
    number str
    number path parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    item Property Map
    networkId String
    networkId path parameter. Network ID
    number String
    number path parameter.

    Supporting Types

    GetWirelessSsidsTrafficShapingRulesItem

    DefaultRulesEnabled bool
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    Rules List<GetWirelessSsidsTrafficShapingRulesItemRule>
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    TrafficShapingEnabled bool
    Whether traffic shaping rules are applied to clients on your SSID.
    DefaultRulesEnabled bool
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    Rules []GetWirelessSsidsTrafficShapingRulesItemRule
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    TrafficShapingEnabled bool
    Whether traffic shaping rules are applied to clients on your SSID.
    defaultRulesEnabled Boolean
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    rules List<GetWirelessSsidsTrafficShapingRulesItemRule>
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    trafficShapingEnabled Boolean
    Whether traffic shaping rules are applied to clients on your SSID.
    defaultRulesEnabled boolean
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    rules GetWirelessSsidsTrafficShapingRulesItemRule[]
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    trafficShapingEnabled boolean
    Whether traffic shaping rules are applied to clients on your SSID.
    default_rules_enabled bool
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    rules Sequence[GetWirelessSsidsTrafficShapingRulesItemRule]
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    traffic_shaping_enabled bool
    Whether traffic shaping rules are applied to clients on your SSID.
    defaultRulesEnabled Boolean
    Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
    rules List<Property Map>
    An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
    trafficShapingEnabled Boolean
    Whether traffic shaping rules are applied to clients on your SSID.

    GetWirelessSsidsTrafficShapingRulesItemRule

    Definitions List<GetWirelessSsidsTrafficShapingRulesItemRuleDefinition>
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    DscpTagValue int
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    PcpTagValue int
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    PerClientBandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits
    An object describing the bandwidth settings for your rule.
    Definitions []GetWirelessSsidsTrafficShapingRulesItemRuleDefinition
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    DscpTagValue int
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    PcpTagValue int
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    PerClientBandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits
    An object describing the bandwidth settings for your rule.
    definitions List<GetWirelessSsidsTrafficShapingRulesItemRuleDefinition>
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    dscpTagValue Integer
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    pcpTagValue Integer
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    perClientBandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits
    An object describing the bandwidth settings for your rule.
    definitions GetWirelessSsidsTrafficShapingRulesItemRuleDefinition[]
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    dscpTagValue number
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    pcpTagValue number
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    perClientBandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits
    An object describing the bandwidth settings for your rule.
    definitions Sequence[GetWirelessSsidsTrafficShapingRulesItemRuleDefinition]
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    dscp_tag_value int
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    pcp_tag_value int
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    per_client_bandwidth_limits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits
    An object describing the bandwidth settings for your rule.
    definitions List<Property Map>
    A list of objects describing the definitions of your traffic shaping rule. At least one definition is required.
    dscpTagValue Number
    The DSCP tag applied by your rule. null means 'Do not change DSCP tag'. For a list of possible tag values, use the trafficShaping/dscpTaggingOptions endpoint.
    pcpTagValue Number
    The PCP tag applied by your rule. Can be 0 (lowest priority) through 7 (highest priority). null means 'Do not set PCP tag'.
    perClientBandwidthLimits Property Map
    An object describing the bandwidth settings for your rule.

    GetWirelessSsidsTrafficShapingRulesItemRuleDefinition

    Type string
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    Value string
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).
    Type string
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    Value string
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).
    type String
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    value String
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).
    type string
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    value string
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).
    type str
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    value str
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).
    type String
    The type of definition. Can be one of 'application', 'applicationCategory', 'host', 'port', 'ipRange' or 'localNet'.
    value String
    If "type" is 'host', 'port', 'ipRange' or 'localNet', then "value" must be a string, matching either a hostname (e.g. "somesite.com"), a port (e.g. 8080), or an IP range ("192.1.0.0", "192.1.0.0/16", or "10.1.0.0/16:80"). 'localNet' also supports CIDR notation, excluding custom ports. If "type" is 'application' or 'applicationCategory', then "value" must be an object with the structure { "id": "meraki:layer7/..." }, where "id" is the application category or application ID (for a list of IDs for your network, use the trafficShaping/applicationCategories endpoint).

    GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimits

    BandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    Settings string
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.
    BandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    Settings string
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.
    bandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    settings String
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.
    bandwidthLimits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    settings string
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.
    bandwidth_limits GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    settings str
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.
    bandwidthLimits Property Map
    The bandwidth limits object, specifying the upload ('limitUp') and download ('limitDown') speed in Kbps. These are only enforced if 'settings' is set to 'custom'.
    settings String
    How bandwidth limits are applied by your rule. Can be one of 'network default', 'ignore' or 'custom'.

    GetWirelessSsidsTrafficShapingRulesItemRulePerClientBandwidthLimitsBandwidthLimits

    LimitDown int
    The maximum download limit (integer, in Kbps).
    LimitUp int
    The maximum upload limit (integer, in Kbps).
    LimitDown int
    The maximum download limit (integer, in Kbps).
    LimitUp int
    The maximum upload limit (integer, in Kbps).
    limitDown Integer
    The maximum download limit (integer, in Kbps).
    limitUp Integer
    The maximum upload limit (integer, in Kbps).
    limitDown number
    The maximum download limit (integer, in Kbps).
    limitUp number
    The maximum upload limit (integer, in Kbps).
    limit_down int
    The maximum download limit (integer, in Kbps).
    limit_up int
    The maximum upload limit (integer, in Kbps).
    limitDown Number
    The maximum download limit (integer, in Kbps).
    limitUp Number
    The maximum upload limit (integer, in Kbps).

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki