@pulumiverse/fortios/system/switchinterface.d.ts

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Configure software switch interfaces by grouping physical and WiFi interfaces.
 *
 * ## Import
 *
 * System SwitchInterface can be imported using any of these accepted formats:
 *
 * ```sh
 * $ pulumi import fortios:system/switchinterface:Switchinterface labelname {{name}}
 * ```
 *
 * If you do not want to import arguments of block:
 *
 * $ export "FORTIOS_IMPORT_TABLE"="false"
 *
 * ```sh
 * $ pulumi import fortios:system/switchinterface:Switchinterface labelname {{name}}
 * ```
 *
 * $ unset "FORTIOS_IMPORT_TABLE"
 */
export declare class Switchinterface extends pulumi.CustomResource {
    /**
     * Get an existing Switchinterface resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SwitchinterfaceState, opts?: pulumi.CustomResourceOptions): Switchinterface;
    /**
     * Returns true if the given object is an instance of Switchinterface.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Switchinterface;
    /**
     * 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 ].
     */
    readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
    /**
     * 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.
     */
    readonly getAllTables: pulumi.Output<string | undefined>;
    /**
     * Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: `implicit`, `explicit`.
     */
    readonly intraSwitchPolicy: pulumi.Output<string>;
    /**
     * Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
     */
    readonly macTtl: pulumi.Output<number>;
    /**
     * Names of the interfaces that belong to the virtual switch. The structure of `member` block is documented below.
     */
    readonly members: pulumi.Output<outputs.system.SwitchinterfaceMember[] | undefined>;
    /**
     * Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
     */
    readonly name: pulumi.Output<string>;
    /**
     * Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: `disable`, `enable`.
     */
    readonly span: pulumi.Output<string>;
    /**
     * SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
     */
    readonly spanDestPort: pulumi.Output<string>;
    /**
     * The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: `rx`, `tx`, `both`.
     */
    readonly spanDirection: pulumi.Output<string>;
    /**
     * Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of `spanSourcePort` block is documented below.
     */
    readonly spanSourcePorts: pulumi.Output<outputs.system.SwitchinterfaceSpanSourcePort[] | undefined>;
    /**
     * Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: `switch`, `hub`.
     */
    readonly type: pulumi.Output<string>;
    /**
     * VDOM that the software switch belongs to.
     */
    readonly vdom: pulumi.Output<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.
     */
    readonly vdomparam: pulumi.Output<string>;
    /**
     * Create a Switchinterface resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: SwitchinterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Switchinterface resources.
 */
export interface SwitchinterfaceState {
    /**
     * 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 ].
     */
    dynamicSortSubtable?: pulumi.Input<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.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: `implicit`, `explicit`.
     */
    intraSwitchPolicy?: pulumi.Input<string>;
    /**
     * Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
     */
    macTtl?: pulumi.Input<number>;
    /**
     * Names of the interfaces that belong to the virtual switch. The structure of `member` block is documented below.
     */
    members?: pulumi.Input<pulumi.Input<inputs.system.SwitchinterfaceMember>[]>;
    /**
     * Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
     */
    name?: pulumi.Input<string>;
    /**
     * Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: `disable`, `enable`.
     */
    span?: pulumi.Input<string>;
    /**
     * SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
     */
    spanDestPort?: pulumi.Input<string>;
    /**
     * The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: `rx`, `tx`, `both`.
     */
    spanDirection?: pulumi.Input<string>;
    /**
     * Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of `spanSourcePort` block is documented below.
     */
    spanSourcePorts?: pulumi.Input<pulumi.Input<inputs.system.SwitchinterfaceSpanSourcePort>[]>;
    /**
     * Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: `switch`, `hub`.
     */
    type?: pulumi.Input<string>;
    /**
     * VDOM that the software switch belongs to.
     */
    vdom?: pulumi.Input<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.
     */
    vdomparam?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Switchinterface resource.
 */
export interface SwitchinterfaceArgs {
    /**
     * 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 ].
     */
    dynamicSortSubtable?: pulumi.Input<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.
     */
    getAllTables?: pulumi.Input<string>;
    /**
     * Allow any traffic between switch interfaces or require firewall policies to allow traffic between switch interfaces. Valid values: `implicit`, `explicit`.
     */
    intraSwitchPolicy?: pulumi.Input<string>;
    /**
     * Duration for which MAC addresses are held in the ARP table (300 - 8640000 sec, default = 300).
     */
    macTtl?: pulumi.Input<number>;
    /**
     * Names of the interfaces that belong to the virtual switch. The structure of `member` block is documented below.
     */
    members?: pulumi.Input<pulumi.Input<inputs.system.SwitchinterfaceMember>[]>;
    /**
     * Interface name (name cannot be in use by any other interfaces, VLANs, or inter-VDOM links).
     */
    name?: pulumi.Input<string>;
    /**
     * Enable/disable port spanning. Port spanning echoes traffic received by the software switch to the span destination port. Valid values: `disable`, `enable`.
     */
    span?: pulumi.Input<string>;
    /**
     * SPAN destination port name. All traffic on the SPAN source ports is echoed to the SPAN destination port.
     */
    spanDestPort?: pulumi.Input<string>;
    /**
     * The direction in which the SPAN port operates, either: rx, tx, or both. Valid values: `rx`, `tx`, `both`.
     */
    spanDirection?: pulumi.Input<string>;
    /**
     * Physical interface name. Port spanning echoes all traffic on the SPAN source ports to the SPAN destination port. The structure of `spanSourcePort` block is documented below.
     */
    spanSourcePorts?: pulumi.Input<pulumi.Input<inputs.system.SwitchinterfaceSpanSourcePort>[]>;
    /**
     * Type of switch based on functionality: switch for normal functionality, or hub to duplicate packets to all port members. Valid values: `switch`, `hub`.
     */
    type?: pulumi.Input<string>;
    /**
     * VDOM that the software switch belongs to.
     */
    vdom?: pulumi.Input<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.
     */
    vdomparam?: pulumi.Input<string>;
}