1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Virtualwirepair
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.Virtualwirepair

Explore with Pulumi AI

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

    Configure virtual wire pairs.

    Create Virtualwirepair Resource

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

    Constructor syntax

    new Virtualwirepair(name: string, args: VirtualwirepairArgs, opts?: CustomResourceOptions);
    @overload
    def Virtualwirepair(resource_name: str,
                        args: VirtualwirepairArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def Virtualwirepair(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        members: Optional[Sequence[VirtualwirepairMemberArgs]] = None,
                        dynamic_sort_subtable: Optional[str] = None,
                        get_all_tables: Optional[str] = None,
                        name: Optional[str] = None,
                        vdomparam: Optional[str] = None,
                        vlan_filter: Optional[str] = None,
                        wildcard_vlan: Optional[str] = None)
    func NewVirtualwirepair(ctx *Context, name string, args VirtualwirepairArgs, opts ...ResourceOption) (*Virtualwirepair, error)
    public Virtualwirepair(string name, VirtualwirepairArgs args, CustomResourceOptions? opts = null)
    public Virtualwirepair(String name, VirtualwirepairArgs args)
    public Virtualwirepair(String name, VirtualwirepairArgs args, CustomResourceOptions options)
    
    type: fortios:system:Virtualwirepair
    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 VirtualwirepairArgs
    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 VirtualwirepairArgs
    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 VirtualwirepairArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualwirepairArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualwirepairArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualwirepairResource = new Fortios.System.Virtualwirepair("virtualwirepairResource", new()
    {
        Members = new[]
        {
            new Fortios.System.Inputs.VirtualwirepairMemberArgs
            {
                InterfaceName = "string",
            },
        },
        DynamicSortSubtable = "string",
        GetAllTables = "string",
        Name = "string",
        Vdomparam = "string",
        VlanFilter = "string",
        WildcardVlan = "string",
    });
    
    example, err := system.NewVirtualwirepair(ctx, "virtualwirepairResource", &system.VirtualwirepairArgs{
    	Members: system.VirtualwirepairMemberArray{
    		&system.VirtualwirepairMemberArgs{
    			InterfaceName: pulumi.String("string"),
    		},
    	},
    	DynamicSortSubtable: pulumi.String("string"),
    	GetAllTables:        pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Vdomparam:           pulumi.String("string"),
    	VlanFilter:          pulumi.String("string"),
    	WildcardVlan:        pulumi.String("string"),
    })
    
    var virtualwirepairResource = new Virtualwirepair("virtualwirepairResource", VirtualwirepairArgs.builder()
        .members(VirtualwirepairMemberArgs.builder()
            .interfaceName("string")
            .build())
        .dynamicSortSubtable("string")
        .getAllTables("string")
        .name("string")
        .vdomparam("string")
        .vlanFilter("string")
        .wildcardVlan("string")
        .build());
    
    virtualwirepair_resource = fortios.system.Virtualwirepair("virtualwirepairResource",
        members=[{
            "interface_name": "string",
        }],
        dynamic_sort_subtable="string",
        get_all_tables="string",
        name="string",
        vdomparam="string",
        vlan_filter="string",
        wildcard_vlan="string")
    
    const virtualwirepairResource = new fortios.system.Virtualwirepair("virtualwirepairResource", {
        members: [{
            interfaceName: "string",
        }],
        dynamicSortSubtable: "string",
        getAllTables: "string",
        name: "string",
        vdomparam: "string",
        vlanFilter: "string",
        wildcardVlan: "string",
    });
    
    type: fortios:system:Virtualwirepair
    properties:
        dynamicSortSubtable: string
        getAllTables: string
        members:
            - interfaceName: string
        name: string
        vdomparam: string
        vlanFilter: string
        wildcardVlan: string
    

    Virtualwirepair 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 Virtualwirepair resource accepts the following input properties:

    Members List<Pulumiverse.Fortios.System.Inputs.VirtualwirepairMember>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    Name string
    Virtual-wire-pair name. Must be a unique interface 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.
    VlanFilter string
    Set VLAN filters.
    WildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    Members []VirtualwirepairMemberArgs
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    Name string
    Virtual-wire-pair name. Must be a unique interface 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.
    VlanFilter string
    Set VLAN filters.
    WildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    members List<VirtualwirepairMember>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    name String
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter String
    Set VLAN filters.
    wildcardVlan String
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    members VirtualwirepairMember[]
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    name string
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter string
    Set VLAN filters.
    wildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    members Sequence[VirtualwirepairMemberArgs]
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    name str
    Virtual-wire-pair name. Must be a unique interface 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.
    vlan_filter str
    Set VLAN filters.
    wildcard_vlan str
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    members List<Property Map>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    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.
    name String
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter String
    Set VLAN filters.
    wildcardVlan String
    Enable/disable wildcard VLAN. Valid values: enable, disable.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Virtualwirepair 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 Virtualwirepair Resource

    Get an existing Virtualwirepair 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?: VirtualwirepairState, opts?: CustomResourceOptions): Virtualwirepair
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dynamic_sort_subtable: Optional[str] = None,
            get_all_tables: Optional[str] = None,
            members: Optional[Sequence[VirtualwirepairMemberArgs]] = None,
            name: Optional[str] = None,
            vdomparam: Optional[str] = None,
            vlan_filter: Optional[str] = None,
            wildcard_vlan: Optional[str] = None) -> Virtualwirepair
    func GetVirtualwirepair(ctx *Context, name string, id IDInput, state *VirtualwirepairState, opts ...ResourceOption) (*Virtualwirepair, error)
    public static Virtualwirepair Get(string name, Input<string> id, VirtualwirepairState? state, CustomResourceOptions? opts = null)
    public static Virtualwirepair get(String name, Output<String> id, VirtualwirepairState 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.
    Members List<Pulumiverse.Fortios.System.Inputs.VirtualwirepairMember>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    Name string
    Virtual-wire-pair name. Must be a unique interface 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.
    VlanFilter string
    Set VLAN filters.
    WildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    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.
    Members []VirtualwirepairMemberArgs
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    Name string
    Virtual-wire-pair name. Must be a unique interface 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.
    VlanFilter string
    Set VLAN filters.
    WildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    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.
    members List<VirtualwirepairMember>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    name String
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter String
    Set VLAN filters.
    wildcardVlan String
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    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.
    members VirtualwirepairMember[]
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    name string
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter string
    Set VLAN filters.
    wildcardVlan string
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    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.
    members Sequence[VirtualwirepairMemberArgs]
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    name str
    Virtual-wire-pair name. Must be a unique interface 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.
    vlan_filter str
    Set VLAN filters.
    wildcard_vlan str
    Enable/disable wildcard VLAN. Valid values: enable, disable.
    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.
    members List<Property Map>
    Interfaces belong to the virtual-wire-pair. The structure of member block is documented below.
    name String
    Virtual-wire-pair name. Must be a unique interface 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.
    vlanFilter String
    Set VLAN filters.
    wildcardVlan String
    Enable/disable wildcard VLAN. Valid values: enable, disable.

    Supporting Types

    VirtualwirepairMember, VirtualwirepairMemberArgs

    InterfaceName string
    Interface name.
    InterfaceName string
    Interface name.
    interfaceName String
    Interface name.
    interfaceName string
    Interface name.
    interface_name str
    Interface name.
    interfaceName String
    Interface name.

    Import

    System VirtualWirePair can be imported using any of these accepted formats:

    $ pulumi import fortios:system/virtualwirepair:Virtualwirepair labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:system/virtualwirepair:Virtualwirepair 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