Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. firewall
  5. firewall/shaper
  6. getTrafficshaper
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.firewall/shaper.getTrafficshaper

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Use this data source to get information on an fortios firewallshaper trafficshaper

    Using getTrafficshaper

    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 getTrafficshaper(args: GetTrafficshaperArgs, opts?: InvokeOptions): Promise<GetTrafficshaperResult>
function getTrafficshaperOutput(args: GetTrafficshaperOutputArgs, opts?: InvokeOptions): Output<GetTrafficshaperResult>
    def get_trafficshaper(name: Optional[str] = None,
                      vdomparam: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetTrafficshaperResult
def get_trafficshaper_output(name: Optional[pulumi.Input[str]] = None,
                      vdomparam: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetTrafficshaperResult]
    func LookupTrafficshaper(ctx *Context, args *LookupTrafficshaperArgs, opts ...InvokeOption) (*LookupTrafficshaperResult, error)
func LookupTrafficshaperOutput(ctx *Context, args *LookupTrafficshaperOutputArgs, opts ...InvokeOption) LookupTrafficshaperResultOutput

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

    public static class GetTrafficshaper 
{
    public static Task<GetTrafficshaperResult> InvokeAsync(GetTrafficshaperArgs args, InvokeOptions? opts = null)
    public static Output<GetTrafficshaperResult> Invoke(GetTrafficshaperInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTrafficshaperResult> getTrafficshaper(GetTrafficshaperArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: fortios:firewall/shaper/getTrafficshaper:getTrafficshaper
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Specify the name of the desired firewallshaper trafficshaper.
    Vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    Name string
    Specify the name of the desired firewallshaper trafficshaper.
    Vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    name String
    Specify the name of the desired firewallshaper trafficshaper.
    vdomparam String
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    name string
    Specify the name of the desired firewallshaper trafficshaper.
    vdomparam string
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    name str
    Specify the name of the desired firewallshaper trafficshaper.
    vdomparam str
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    name String
    Specify the name of the desired firewallshaper trafficshaper.
    vdomparam String
    Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    getTrafficshaper Result

    The following output properties are available:

    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking.
    CosMarkingMethod string
    Select VLAN CoS marking method.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method.
    ExceedBandwidth int
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId int
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth int
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumBandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    Overhead int
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    Vdomparam string
    BandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    Cos string
    VLAN CoS mark.
    CosMarking string
    Enable/disable VLAN CoS marking.
    CosMarkingMethod string
    Select VLAN CoS marking method.
    Diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    Diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    DscpMarkingMethod string
    Select DSCP marking method.
    ExceedBandwidth int
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    ExceedClassId int
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    ExceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    ExceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    GuaranteedBandwidth int
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumBandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    MaximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    Name string
    Traffic shaper name.
    Overhead int
    Per-packet size overhead used in rate computations.
    PerPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    Priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    Vdomparam string
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking.
    cosMarkingMethod String
    Select VLAN CoS marking method.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method.
    exceedBandwidth Integer
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId Integer
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Integer
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    id String
    The provider-assigned unique ID for this managed resource.
    maximumBandwidth Integer
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    overhead Integer
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    vdomparam String
    bandwidthUnit string
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    cos string
    VLAN CoS mark.
    cosMarking string
    Enable/disable VLAN CoS marking.
    cosMarkingMethod string
    Select VLAN CoS marking method.
    diffserv string
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    diffservcode string
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod string
    Select DSCP marking method.
    exceedBandwidth number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId number
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos string
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp string
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    id string
    The provider-assigned unique ID for this managed resource.
    maximumBandwidth number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos string
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp string
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name string
    Traffic shaper name.
    overhead number
    Per-packet size overhead used in rate computations.
    perPolicy string
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    priority string
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    vdomparam string
    bandwidth_unit str
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    cos str
    VLAN CoS mark.
    cos_marking str
    Enable/disable VLAN CoS marking.
    cos_marking_method str
    Select VLAN CoS marking method.
    diffserv str
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    diffservcode str
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscp_marking_method str
    Select DSCP marking method.
    exceed_bandwidth int
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceed_class_id int
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceed_cos str
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceed_dscp str
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteed_bandwidth int
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    id str
    The provider-assigned unique ID for this managed resource.
    maximum_bandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximum_cos str
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximum_dscp str
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name str
    Traffic shaper name.
    overhead int
    Per-packet size overhead used in rate computations.
    per_policy str
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    priority str
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    vdomparam str
    bandwidthUnit String
    Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    cos String
    VLAN CoS mark.
    cosMarking String
    Enable/disable VLAN CoS marking.
    cosMarkingMethod String
    Select VLAN CoS marking method.
    diffserv String
    Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
    diffservcode String
    DiffServ setting to be applied to traffic accepted by this shaper.
    dscpMarkingMethod String
    Select DSCP marking method.
    exceedBandwidth Number
    Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting.
    exceedClassId Number
    Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth].
    exceedCos String
    VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    exceedDscp String
    DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].
    guaranteedBandwidth Number
    Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting.
    id String
    The provider-assigned unique ID for this managed resource.
    maximumBandwidth Number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maximumCos String
    VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    maximumDscp String
    DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth].
    name String
    Traffic shaper name.
    overhead Number
    Per-packet size overhead used in rate computations.
    perPolicy String
    Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
    priority String
    Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
    vdomparam String

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios