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

fortios.switchcontroller.Igmpsnooping

Explore with Pulumi AI

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

    Configure FortiSwitch IGMP snooping global settings.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname = new fortios.switchcontroller.Igmpsnooping("trname", {
        agingTime: 300,
        floodUnknownMulticast: "disable",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname = fortios.switchcontroller.Igmpsnooping("trname",
        aging_time=300,
        flood_unknown_multicast="disable")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/switchcontroller"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := switchcontroller.NewIgmpsnooping(ctx, "trname", &switchcontroller.IgmpsnoopingArgs{
    			AgingTime:             pulumi.Int(300),
    			FloodUnknownMulticast: pulumi.String("disable"),
    		})
    		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.Switchcontroller.Igmpsnooping("trname", new()
        {
            AgingTime = 300,
            FloodUnknownMulticast = "disable",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.switchcontroller.Igmpsnooping;
    import com.pulumi.fortios.switchcontroller.IgmpsnoopingArgs;
    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 Igmpsnooping("trname", IgmpsnoopingArgs.builder()
                .agingTime(300)
                .floodUnknownMulticast("disable")
                .build());
    
        }
    }
    
    resources:
      trname:
        type: fortios:switchcontroller:Igmpsnooping
        properties:
          agingTime: 300
          floodUnknownMulticast: disable
    

    Create Igmpsnooping Resource

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

    Constructor syntax

    new Igmpsnooping(name: string, args?: IgmpsnoopingArgs, opts?: CustomResourceOptions);
    @overload
    def Igmpsnooping(resource_name: str,
                     args: Optional[IgmpsnoopingArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Igmpsnooping(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     aging_time: Optional[int] = None,
                     flood_unknown_multicast: Optional[str] = None,
                     query_interval: Optional[int] = None,
                     vdomparam: Optional[str] = None)
    func NewIgmpsnooping(ctx *Context, name string, args *IgmpsnoopingArgs, opts ...ResourceOption) (*Igmpsnooping, error)
    public Igmpsnooping(string name, IgmpsnoopingArgs? args = null, CustomResourceOptions? opts = null)
    public Igmpsnooping(String name, IgmpsnoopingArgs args)
    public Igmpsnooping(String name, IgmpsnoopingArgs args, CustomResourceOptions options)
    
    type: fortios:switchcontroller:Igmpsnooping
    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 IgmpsnoopingArgs
    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 IgmpsnoopingArgs
    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 IgmpsnoopingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IgmpsnoopingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IgmpsnoopingArgs
    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 igmpsnoopingResource = new Fortios.Switchcontroller.Igmpsnooping("igmpsnoopingResource", new()
    {
        AgingTime = 0,
        FloodUnknownMulticast = "string",
        QueryInterval = 0,
        Vdomparam = "string",
    });
    
    example, err := switchcontroller.NewIgmpsnooping(ctx, "igmpsnoopingResource", &switchcontroller.IgmpsnoopingArgs{
    	AgingTime:             pulumi.Int(0),
    	FloodUnknownMulticast: pulumi.String("string"),
    	QueryInterval:         pulumi.Int(0),
    	Vdomparam:             pulumi.String("string"),
    })
    
    var igmpsnoopingResource = new Igmpsnooping("igmpsnoopingResource", IgmpsnoopingArgs.builder()
        .agingTime(0)
        .floodUnknownMulticast("string")
        .queryInterval(0)
        .vdomparam("string")
        .build());
    
    igmpsnooping_resource = fortios.switchcontroller.Igmpsnooping("igmpsnoopingResource",
        aging_time=0,
        flood_unknown_multicast="string",
        query_interval=0,
        vdomparam="string")
    
    const igmpsnoopingResource = new fortios.switchcontroller.Igmpsnooping("igmpsnoopingResource", {
        agingTime: 0,
        floodUnknownMulticast: "string",
        queryInterval: 0,
        vdomparam: "string",
    });
    
    type: fortios:switchcontroller:Igmpsnooping
    properties:
        agingTime: 0
        floodUnknownMulticast: string
        queryInterval: 0
        vdomparam: string
    

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

    AgingTime int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    FloodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    QueryInterval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    AgingTime int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    FloodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    QueryInterval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime Integer
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast String
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval Integer
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime number
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval number
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    aging_time int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    flood_unknown_multicast str
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    query_interval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime Number
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast String
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval Number
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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 Igmpsnooping 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 Igmpsnooping Resource

    Get an existing Igmpsnooping 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?: IgmpsnoopingState, opts?: CustomResourceOptions): Igmpsnooping
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aging_time: Optional[int] = None,
            flood_unknown_multicast: Optional[str] = None,
            query_interval: Optional[int] = None,
            vdomparam: Optional[str] = None) -> Igmpsnooping
    func GetIgmpsnooping(ctx *Context, name string, id IDInput, state *IgmpsnoopingState, opts ...ResourceOption) (*Igmpsnooping, error)
    public static Igmpsnooping Get(string name, Input<string> id, IgmpsnoopingState? state, CustomResourceOptions? opts = null)
    public static Igmpsnooping get(String name, Output<String> id, IgmpsnoopingState 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:
    AgingTime int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    FloodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    QueryInterval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    AgingTime int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    FloodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    QueryInterval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime Integer
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast String
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval Integer
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime number
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast string
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval number
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    aging_time int
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    flood_unknown_multicast str
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    query_interval int
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.
    agingTime Number
    Maximum number of seconds to retain a multicast snooping entry for which no packets have been seen (15 - 3600 sec, default = 300).
    floodUnknownMulticast String
    Enable/disable unknown multicast flooding. Valid values: enable, disable.
    queryInterval Number
    Maximum time after which IGMP query will be sent (10 - 1200 sec, default = 125).
    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.

    Import

    SwitchController IgmpSnooping can be imported using any of these accepted formats:

    $ pulumi import fortios:switchcontroller/igmpsnooping:Igmpsnooping labelname SwitchControllerIgmpSnooping
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:switchcontroller/igmpsnooping:Igmpsnooping labelname SwitchControllerIgmpSnooping
    

    $ 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