Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. vpn
  5. vpn/ipsec
  6. Fec
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.vpn/ipsec.Fec

Explore with Pulumi AI

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

    Configure Forward Error Correction (FEC) mapping profiles. Applies to FortiOS Version >= 7.0.2.

    Create Fec Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Fec(name: string, args?: FecArgs, opts?: CustomResourceOptions);
    @overload
def Fec(resource_name: str,
        args: Optional[FecArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Fec(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        mappings: Optional[Sequence[FecMappingArgs]] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None)
    func NewFec(ctx *Context, name string, args *FecArgs, opts ...ResourceOption) (*Fec, error)
    public Fec(string name, FecArgs? args = null, CustomResourceOptions? opts = null)
    public Fec(String name, FecArgs args)
public Fec(String name, FecArgs args, CustomResourceOptions options)

    type: fortios:vpn/ipsec/fec:Fec
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args FecArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FecArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FecArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FecArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FecArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Fec Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Fec resource accepts the following input properties:

    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mappings List<Pulumiverse.Fortios.Vpn.Ipsec.Inputs.FecMapping>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    Name string
    Profile name.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mappings []FecMappingArgs
    FEC redundancy mapping table. The structure of mappings block is documented below.
    Name string
    Profile name.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings List<FecMapping>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name String
    Profile name.
    vdomparam String
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings FecMapping[]
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name string
    Profile name.
    vdomparam string
    Specifies the vdom to which the resource 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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings Sequence[FecMappingArgs]
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name str
    Profile name.
    vdomparam str
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings List<Property Map>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name String
    Profile name.
    vdomparam String
    Specifies the vdom to which the resource 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Fec resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Fec Resource

    Get an existing Fec resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FecState, opts?: CustomResourceOptions): Fec
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dynamic_sort_subtable: Optional[str] = None,
        get_all_tables: Optional[str] = None,
        mappings: Optional[Sequence[FecMappingArgs]] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Fec
    func GetFec(ctx *Context, name string, id IDInput, state *FecState, opts ...ResourceOption) (*Fec, error)
    public static Fec Get(string name, Input<string> id, FecState? state, CustomResourceOptions? opts = null)
    public static Fec get(String name, Output<String> id, FecState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mappings List<Pulumiverse.Fortios.Vpn.Ipsec.Inputs.FecMapping>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    Name string
    Profile name.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Mappings []FecMappingArgs
    FEC redundancy mapping table. The structure of mappings block is documented below.
    Name string
    Profile name.
    Vdomparam string
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings List<FecMapping>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name String
    Profile name.
    vdomparam String
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings FecMapping[]
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name string
    Profile name.
    vdomparam string
    Specifies the vdom to which the resource 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.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings Sequence[FecMappingArgs]
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name str
    Profile name.
    vdomparam str
    Specifies the vdom to which the resource 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.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    mappings List<Property Map>
    FEC redundancy mapping table. The structure of mappings block is documented below.
    name String
    Profile name.
    vdomparam String
    Specifies the vdom to which the resource 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.

    Supporting Types

    FecMapping, FecMappingArgs

    BandwidthBiThreshold int
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    BandwidthDownThreshold int
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    BandwidthUpThreshold int
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    Base int
    Number of base FEC packets (1 - 20).
    LatencyThreshold int
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    PacketLossThreshold int
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    Redundant int
    Number of redundant FEC packets (1 - 5).
    Seqno int
    Sequence number (1 - 64).
    BandwidthBiThreshold int
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    BandwidthDownThreshold int
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    BandwidthUpThreshold int
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    Base int
    Number of base FEC packets (1 - 20).
    LatencyThreshold int
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    PacketLossThreshold int
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    Redundant int
    Number of redundant FEC packets (1 - 5).
    Seqno int
    Sequence number (1 - 64).
    bandwidthBiThreshold Integer
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthDownThreshold Integer
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthUpThreshold Integer
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    base Integer
    Number of base FEC packets (1 - 20).
    latencyThreshold Integer
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    packetLossThreshold Integer
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    redundant Integer
    Number of redundant FEC packets (1 - 5).
    seqno Integer
    Sequence number (1 - 64).
    bandwidthBiThreshold number
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthDownThreshold number
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthUpThreshold number
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    base number
    Number of base FEC packets (1 - 20).
    latencyThreshold number
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    packetLossThreshold number
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    redundant number
    Number of redundant FEC packets (1 - 5).
    seqno number
    Sequence number (1 - 64).
    bandwidth_bi_threshold int
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidth_down_threshold int
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidth_up_threshold int
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    base int
    Number of base FEC packets (1 - 20).
    latency_threshold int
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    packet_loss_threshold int
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    redundant int
    Number of redundant FEC packets (1 - 5).
    seqno int
    Sequence number (1 - 64).
    bandwidthBiThreshold Number
    Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthDownThreshold Number
    Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold).
    bandwidthUpThreshold Number
    Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold).
    base Number
    Number of base FEC packets (1 - 20).
    latencyThreshold Number
    Apply FEC parameters when latency is <= threshold (0 means no threshold).
    packetLossThreshold Number
    Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold).
    redundant Number
    Number of redundant FEC packets (1 - 5).
    seqno Number
    Sequence number (1 - 64).

    Import

    VpnIpsec Fec can be imported using any of these accepted formats:

    $ pulumi import fortios:vpn/ipsec/fec:Fec labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:vpn/ipsec/fec:Fec labelname {{name}}

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    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