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

fortios.router.Multicastflow

Explore with Pulumi AI

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

    Configure multicast-flow.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.router.Multicastflow("trname", {flows: [{
    groupAddr: "224.252.0.0",
    sourceAddr: "224.112.0.0",
}]});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.router.Multicastflow("trname", flows=[fortios.router.MulticastflowFlowArgs(
    group_addr="224.252.0.0",
    source_addr="224.112.0.0",
)])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/router"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := router.NewMulticastflow(ctx, "trname", &router.MulticastflowArgs{
			Flows: router.MulticastflowFlowArray{
				&router.MulticastflowFlowArgs{
					GroupAddr:  pulumi.String("224.252.0.0"),
					SourceAddr: pulumi.String("224.112.0.0"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.Router.Multicastflow("trname", new()
    {
        Flows = new[]
        {
            new Fortios.Router.Inputs.MulticastflowFlowArgs
            {
                GroupAddr = "224.252.0.0",
                SourceAddr = "224.112.0.0",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.router.Multicastflow;
import com.pulumi.fortios.router.MulticastflowArgs;
import com.pulumi.fortios.router.inputs.MulticastflowFlowArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Multicastflow("trname", MulticastflowArgs.builder()
            .flows(MulticastflowFlowArgs.builder()
                .groupAddr("224.252.0.0")
                .sourceAddr("224.112.0.0")
                .build())
            .build());

    }
}

    resources:
  trname:
    type: fortios:router:Multicastflow
    properties:
      flows:
        - groupAddr: 224.252.0.0
          sourceAddr: 224.112.0.0

    Create Multicastflow Resource

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

    Constructor syntax

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

@overload
def Multicastflow(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  comments: Optional[str] = None,
                  dynamic_sort_subtable: Optional[str] = None,
                  flows: Optional[Sequence[MulticastflowFlowArgs]] = None,
                  get_all_tables: Optional[str] = None,
                  name: Optional[str] = None,
                  vdomparam: Optional[str] = None)
    func NewMulticastflow(ctx *Context, name string, args *MulticastflowArgs, opts ...ResourceOption) (*Multicastflow, error)
    public Multicastflow(string name, MulticastflowArgs? args = null, CustomResourceOptions? opts = null)
    public Multicastflow(String name, MulticastflowArgs args)
public Multicastflow(String name, MulticastflowArgs args, CustomResourceOptions options)

    type: fortios:router:Multicastflow
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 MulticastflowArgs
    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 MulticastflowArgs
    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 MulticastflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MulticastflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MulticastflowArgs
    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 multicastflowResource = new Fortios.Router.Multicastflow("multicastflowResource", new()
{
    Comments = "string",
    DynamicSortSubtable = "string",
    Flows = new[]
    {
        new Fortios.Router.Inputs.MulticastflowFlowArgs
        {
            GroupAddr = "string",
            Id = 0,
            SourceAddr = "string",
        },
    },
    GetAllTables = "string",
    Name = "string",
    Vdomparam = "string",
});

    example, err := router.NewMulticastflow(ctx, "multicastflowResource", &router.MulticastflowArgs{
	Comments:            pulumi.String("string"),
	DynamicSortSubtable: pulumi.String("string"),
	Flows: router.MulticastflowFlowArray{
		&router.MulticastflowFlowArgs{
			GroupAddr:  pulumi.String("string"),
			Id:         pulumi.Int(0),
			SourceAddr: pulumi.String("string"),
		},
	},
	GetAllTables: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Vdomparam:    pulumi.String("string"),
})

    var multicastflowResource = new Multicastflow("multicastflowResource", MulticastflowArgs.builder()
    .comments("string")
    .dynamicSortSubtable("string")
    .flows(MulticastflowFlowArgs.builder()
        .groupAddr("string")
        .id(0)
        .sourceAddr("string")
        .build())
    .getAllTables("string")
    .name("string")
    .vdomparam("string")
    .build());

    multicastflow_resource = fortios.router.Multicastflow("multicastflowResource",
    comments="string",
    dynamic_sort_subtable="string",
    flows=[{
        "group_addr": "string",
        "id": 0,
        "source_addr": "string",
    }],
    get_all_tables="string",
    name="string",
    vdomparam="string")

    const multicastflowResource = new fortios.router.Multicastflow("multicastflowResource", {
    comments: "string",
    dynamicSortSubtable: "string",
    flows: [{
        groupAddr: "string",
        id: 0,
        sourceAddr: "string",
    }],
    getAllTables: "string",
    name: "string",
    vdomparam: "string",
});

    type: fortios:router:Multicastflow
properties:
    comments: string
    dynamicSortSubtable: string
    flows:
        - groupAddr: string
          id: 0
          sourceAddr: string
    getAllTables: string
    name: string
    vdomparam: string

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

    Comments string
    Comment.
    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 ].
    Flows List<Pulumiverse.Fortios.Router.Inputs.MulticastflowFlow>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    Comments string
    Comment.
    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 ].
    Flows []MulticastflowFlowArgs
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments String
    Comment.
    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 ].
    flows List<MulticastflowFlow>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments string
    Comment.
    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 ].
    flows MulticastflowFlow[]
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments str
    Comment.
    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 ].
    flows Sequence[MulticastflowFlowArgs]
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments String
    Comment.
    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 ].
    flows List<Property Map>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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 Multicastflow 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 Multicastflow Resource

    Get an existing Multicastflow 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?: MulticastflowState, opts?: CustomResourceOptions): Multicastflow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comments: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        flows: Optional[Sequence[MulticastflowFlowArgs]] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Multicastflow
    func GetMulticastflow(ctx *Context, name string, id IDInput, state *MulticastflowState, opts ...ResourceOption) (*Multicastflow, error)
    public static Multicastflow Get(string name, Input<string> id, MulticastflowState? state, CustomResourceOptions? opts = null)
    public static Multicastflow get(String name, Output<String> id, MulticastflowState 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:
    Comments string
    Comment.
    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 ].
    Flows List<Pulumiverse.Fortios.Router.Inputs.MulticastflowFlow>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    Comments string
    Comment.
    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 ].
    Flows []MulticastflowFlowArgs
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments String
    Comment.
    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 ].
    flows List<MulticastflowFlow>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments string
    Comment.
    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 ].
    flows MulticastflowFlow[]
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments str
    Comment.
    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 ].
    flows Sequence[MulticastflowFlowArgs]
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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.
    comments String
    Comment.
    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 ].
    flows List<Property Map>
    Multicast-flow entries. The structure of flows block is documented below.
    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
    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

    MulticastflowFlow, MulticastflowFlowArgs

    GroupAddr string
    Multicast group IP address.
    Id int
    Flow ID.
    SourceAddr string
    Multicast source IP address.
    GroupAddr string
    Multicast group IP address.
    Id int
    Flow ID.
    SourceAddr string
    Multicast source IP address.
    groupAddr String
    Multicast group IP address.
    id Integer
    Flow ID.
    sourceAddr String
    Multicast source IP address.
    groupAddr string
    Multicast group IP address.
    id number
    Flow ID.
    sourceAddr string
    Multicast source IP address.
    group_addr str
    Multicast group IP address.
    id int
    Flow ID.
    source_addr str
    Multicast source IP address.
    groupAddr String
    Multicast group IP address.
    id Number
    Flow ID.
    sourceAddr String
    Multicast source IP address.

    Import

    Router MulticastFlow can be imported using any of these accepted formats:

    $ pulumi import fortios:router/multicastflow:Multicastflow labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:router/multicastflow:Multicastflow 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