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

fortios.firewall/shaper.getPeripshaper

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 peripshaper

    Using getPeripshaper

    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 getPeripshaper(args: GetPeripshaperArgs, opts?: InvokeOptions): Promise<GetPeripshaperResult>
function getPeripshaperOutput(args: GetPeripshaperOutputArgs, opts?: InvokeOptions): Output<GetPeripshaperResult>
    def get_peripshaper(name: Optional[str] = None,
                    vdomparam: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPeripshaperResult
def get_peripshaper_output(name: Optional[pulumi.Input[str]] = None,
                    vdomparam: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPeripshaperResult]
    func LookupPeripshaper(ctx *Context, args *LookupPeripshaperArgs, opts ...InvokeOption) (*LookupPeripshaperResult, error)
func LookupPeripshaperOutput(ctx *Context, args *LookupPeripshaperOutputArgs, opts ...InvokeOption) LookupPeripshaperResultOutput

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

    public static class GetPeripshaper 
{
    public static Task<GetPeripshaperResult> InvokeAsync(GetPeripshaperArgs args, InvokeOptions? opts = null)
    public static Output<GetPeripshaperResult> Invoke(GetPeripshaperInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPeripshaperResult> getPeripshaper(GetPeripshaperArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Name string
    Specify the name of the desired firewallshaper peripshaper.
    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 peripshaper.
    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 peripshaper.
    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 peripshaper.
    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 peripshaper.
    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 peripshaper.
    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.

    getPeripshaper Result

    The following output properties are available:

    BandwidthUnit string
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    DiffservForward string
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    DiffservReverse string
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    DiffservcodeForward string
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    DiffservcodeRev string
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxBandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaxConcurrentSession int
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    MaxConcurrentTcpSession int
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    MaxConcurrentUdpSession int
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    Name string
    Traffic shaper name.
    Vdomparam string
    BandwidthUnit string
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    DiffservForward string
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    DiffservReverse string
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    DiffservcodeForward string
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    DiffservcodeRev string
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxBandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    MaxConcurrentSession int
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    MaxConcurrentTcpSession int
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    MaxConcurrentUdpSession int
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    Name string
    Traffic shaper name.
    Vdomparam string
    bandwidthUnit String
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    diffservForward String
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    diffservReverse String
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    diffservcodeForward String
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    diffservcodeRev String
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    id String
    The provider-assigned unique ID for this managed resource.
    maxBandwidth Integer
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maxConcurrentSession Integer
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentTcpSession Integer
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentUdpSession Integer
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    name String
    Traffic shaper name.
    vdomparam String
    bandwidthUnit string
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    diffservForward string
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    diffservReverse string
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    diffservcodeForward string
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    diffservcodeRev string
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    id string
    The provider-assigned unique ID for this managed resource.
    maxBandwidth number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maxConcurrentSession number
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentTcpSession number
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentUdpSession number
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    name string
    Traffic shaper name.
    vdomparam string
    bandwidth_unit str
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    diffserv_forward str
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    diffserv_reverse str
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    diffservcode_forward str
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    diffservcode_rev str
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    id str
    The provider-assigned unique ID for this managed resource.
    max_bandwidth int
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    max_concurrent_session int
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    max_concurrent_tcp_session int
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    max_concurrent_udp_session int
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    name str
    Traffic shaper name.
    vdomparam str
    bandwidthUnit String
    Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
    diffservForward String
    Enable/disable changing the Forward (original) DiffServ setting applied to traffic accepted by this shaper.
    diffservReverse String
    Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic accepted by this shaper.
    diffservcodeForward String
    Forward (original) DiffServ setting to be applied to traffic accepted by this shaper.
    diffservcodeRev String
    Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
    id String
    The provider-assigned unique ID for this managed resource.
    maxBandwidth Number
    Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting.
    maxConcurrentSession Number
    Maximum number of concurrent sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentTcpSession Number
    Maximum number of concurrent TCP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    maxConcurrentUdpSession Number
    Maximum number of concurrent UDP sessions allowed by this shaper (0 - 2097000). 0 means no limit.
    name String
    Traffic shaper name.
    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