Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. firewall
  5. Multicastpolicy
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.firewall.Multicastpolicy

Explore with Pulumi AI

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

    Configure multicast NAT policies.

    Example Usage

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

const trname = new fortios.firewall.Multicastpolicy("trname", {
    action: "accept",
    dnat: "0.0.0.0",
    dstaddrs: [{
        name: "all",
    }],
    dstintf: "port4",
    endPort: 65535,
    fosid: 1,
    logtraffic: "enable",
    protocol: 0,
    snat: "disable",
    snatIp: "0.0.0.0",
    srcaddrs: [{
        name: "all",
    }],
    srcintf: "port3",
    startPort: 1,
    status: "enable",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.firewall.Multicastpolicy("trname",
    action="accept",
    dnat="0.0.0.0",
    dstaddrs=[fortios.firewall.MulticastpolicyDstaddrArgs(
        name="all",
    )],
    dstintf="port4",
    end_port=65535,
    fosid=1,
    logtraffic="enable",
    protocol=0,
    snat="disable",
    snat_ip="0.0.0.0",
    srcaddrs=[fortios.firewall.MulticastpolicySrcaddrArgs(
        name="all",
    )],
    srcintf="port3",
    start_port=1,
    status="enable")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firewall.NewMulticastpolicy(ctx, "trname", &firewall.MulticastpolicyArgs{
			Action: pulumi.String("accept"),
			Dnat:   pulumi.String("0.0.0.0"),
			Dstaddrs: firewall.MulticastpolicyDstaddrArray{
				&firewall.MulticastpolicyDstaddrArgs{
					Name: pulumi.String("all"),
				},
			},
			Dstintf:    pulumi.String("port4"),
			EndPort:    pulumi.Int(65535),
			Fosid:      pulumi.Int(1),
			Logtraffic: pulumi.String("enable"),
			Protocol:   pulumi.Int(0),
			Snat:       pulumi.String("disable"),
			SnatIp:     pulumi.String("0.0.0.0"),
			Srcaddrs: firewall.MulticastpolicySrcaddrArray{
				&firewall.MulticastpolicySrcaddrArgs{
					Name: pulumi.String("all"),
				},
			},
			Srcintf:   pulumi.String("port3"),
			StartPort: pulumi.Int(1),
			Status:    pulumi.String("enable"),
		})
		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.Firewall.Multicastpolicy("trname", new()
    {
        Action = "accept",
        Dnat = "0.0.0.0",
        Dstaddrs = new[]
        {
            new Fortios.Firewall.Inputs.MulticastpolicyDstaddrArgs
            {
                Name = "all",
            },
        },
        Dstintf = "port4",
        EndPort = 65535,
        Fosid = 1,
        Logtraffic = "enable",
        Protocol = 0,
        Snat = "disable",
        SnatIp = "0.0.0.0",
        Srcaddrs = new[]
        {
            new Fortios.Firewall.Inputs.MulticastpolicySrcaddrArgs
            {
                Name = "all",
            },
        },
        Srcintf = "port3",
        StartPort = 1,
        Status = "enable",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.firewall.Multicastpolicy;
import com.pulumi.fortios.firewall.MulticastpolicyArgs;
import com.pulumi.fortios.firewall.inputs.MulticastpolicyDstaddrArgs;
import com.pulumi.fortios.firewall.inputs.MulticastpolicySrcaddrArgs;
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 Multicastpolicy("trname", MulticastpolicyArgs.builder()
            .action("accept")
            .dnat("0.0.0.0")
            .dstaddrs(MulticastpolicyDstaddrArgs.builder()
                .name("all")
                .build())
            .dstintf("port4")
            .endPort(65535)
            .fosid(1)
            .logtraffic("enable")
            .protocol(0)
            .snat("disable")
            .snatIp("0.0.0.0")
            .srcaddrs(MulticastpolicySrcaddrArgs.builder()
                .name("all")
                .build())
            .srcintf("port3")
            .startPort(1)
            .status("enable")
            .build());

    }
}

    resources:
  trname:
    type: fortios:firewall:Multicastpolicy
    properties:
      action: accept
      dnat: 0.0.0.0
      dstaddrs:
        - name: all
      dstintf: port4
      endPort: 65535
      fosid: 1
      logtraffic: enable
      protocol: 0
      snat: disable
      snatIp: 0.0.0.0
      srcaddrs:
        - name: all
      srcintf: port3
      startPort: 1
      status: enable

    Create Multicastpolicy Resource

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

    Constructor syntax

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

@overload
def Multicastpolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dstaddrs: Optional[Sequence[MulticastpolicyDstaddrArgs]] = None,
                    srcintf: Optional[str] = None,
                    srcaddrs: Optional[Sequence[MulticastpolicySrcaddrArgs]] = None,
                    dstintf: Optional[str] = None,
                    name: Optional[str] = None,
                    protocol: Optional[int] = None,
                    dynamic_sort_subtable: Optional[str] = None,
                    end_port: Optional[int] = None,
                    fosid: Optional[int] = None,
                    get_all_tables: Optional[str] = None,
                    ips_sensor: Optional[str] = None,
                    logtraffic: Optional[str] = None,
                    action: Optional[str] = None,
                    dnat: Optional[str] = None,
                    snat: Optional[str] = None,
                    snat_ip: Optional[str] = None,
                    comments: Optional[str] = None,
                    auto_asic_offload: Optional[str] = None,
                    start_port: Optional[int] = None,
                    status: Optional[str] = None,
                    traffic_shaper: Optional[str] = None,
                    utm_status: Optional[str] = None,
                    uuid: Optional[str] = None,
                    vdomparam: Optional[str] = None)
    func NewMulticastpolicy(ctx *Context, name string, args MulticastpolicyArgs, opts ...ResourceOption) (*Multicastpolicy, error)
    public Multicastpolicy(string name, MulticastpolicyArgs args, CustomResourceOptions? opts = null)
    public Multicastpolicy(String name, MulticastpolicyArgs args)
public Multicastpolicy(String name, MulticastpolicyArgs args, CustomResourceOptions options)

    type: fortios:firewall:Multicastpolicy
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 MulticastpolicyArgs
    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 MulticastpolicyArgs
    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 MulticastpolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MulticastpolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MulticastpolicyArgs
    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 multicastpolicyResource = new Fortios.Firewall.Multicastpolicy("multicastpolicyResource", new()
{
    Dstaddrs = new[]
    {
        new Fortios.Firewall.Inputs.MulticastpolicyDstaddrArgs
        {
            Name = "string",
        },
    },
    Srcintf = "string",
    Srcaddrs = new[]
    {
        new Fortios.Firewall.Inputs.MulticastpolicySrcaddrArgs
        {
            Name = "string",
        },
    },
    Dstintf = "string",
    Name = "string",
    Protocol = 0,
    DynamicSortSubtable = "string",
    EndPort = 0,
    Fosid = 0,
    GetAllTables = "string",
    IpsSensor = "string",
    Logtraffic = "string",
    Action = "string",
    Dnat = "string",
    Snat = "string",
    SnatIp = "string",
    Comments = "string",
    AutoAsicOffload = "string",
    StartPort = 0,
    Status = "string",
    TrafficShaper = "string",
    UtmStatus = "string",
    Uuid = "string",
    Vdomparam = "string",
});

    example, err := firewall.NewMulticastpolicy(ctx, "multicastpolicyResource", &firewall.MulticastpolicyArgs{
	Dstaddrs: firewall.MulticastpolicyDstaddrArray{
		&firewall.MulticastpolicyDstaddrArgs{
			Name: pulumi.String("string"),
		},
	},
	Srcintf: pulumi.String("string"),
	Srcaddrs: firewall.MulticastpolicySrcaddrArray{
		&firewall.MulticastpolicySrcaddrArgs{
			Name: pulumi.String("string"),
		},
	},
	Dstintf:             pulumi.String("string"),
	Name:                pulumi.String("string"),
	Protocol:            pulumi.Int(0),
	DynamicSortSubtable: pulumi.String("string"),
	EndPort:             pulumi.Int(0),
	Fosid:               pulumi.Int(0),
	GetAllTables:        pulumi.String("string"),
	IpsSensor:           pulumi.String("string"),
	Logtraffic:          pulumi.String("string"),
	Action:              pulumi.String("string"),
	Dnat:                pulumi.String("string"),
	Snat:                pulumi.String("string"),
	SnatIp:              pulumi.String("string"),
	Comments:            pulumi.String("string"),
	AutoAsicOffload:     pulumi.String("string"),
	StartPort:           pulumi.Int(0),
	Status:              pulumi.String("string"),
	TrafficShaper:       pulumi.String("string"),
	UtmStatus:           pulumi.String("string"),
	Uuid:                pulumi.String("string"),
	Vdomparam:           pulumi.String("string"),
})

    var multicastpolicyResource = new Multicastpolicy("multicastpolicyResource", MulticastpolicyArgs.builder()
    .dstaddrs(MulticastpolicyDstaddrArgs.builder()
        .name("string")
        .build())
    .srcintf("string")
    .srcaddrs(MulticastpolicySrcaddrArgs.builder()
        .name("string")
        .build())
    .dstintf("string")
    .name("string")
    .protocol(0)
    .dynamicSortSubtable("string")
    .endPort(0)
    .fosid(0)
    .getAllTables("string")
    .ipsSensor("string")
    .logtraffic("string")
    .action("string")
    .dnat("string")
    .snat("string")
    .snatIp("string")
    .comments("string")
    .autoAsicOffload("string")
    .startPort(0)
    .status("string")
    .trafficShaper("string")
    .utmStatus("string")
    .uuid("string")
    .vdomparam("string")
    .build());

    multicastpolicy_resource = fortios.firewall.Multicastpolicy("multicastpolicyResource",
    dstaddrs=[fortios.firewall.MulticastpolicyDstaddrArgs(
        name="string",
    )],
    srcintf="string",
    srcaddrs=[fortios.firewall.MulticastpolicySrcaddrArgs(
        name="string",
    )],
    dstintf="string",
    name="string",
    protocol=0,
    dynamic_sort_subtable="string",
    end_port=0,
    fosid=0,
    get_all_tables="string",
    ips_sensor="string",
    logtraffic="string",
    action="string",
    dnat="string",
    snat="string",
    snat_ip="string",
    comments="string",
    auto_asic_offload="string",
    start_port=0,
    status="string",
    traffic_shaper="string",
    utm_status="string",
    uuid="string",
    vdomparam="string")

    const multicastpolicyResource = new fortios.firewall.Multicastpolicy("multicastpolicyResource", {
    dstaddrs: [{
        name: "string",
    }],
    srcintf: "string",
    srcaddrs: [{
        name: "string",
    }],
    dstintf: "string",
    name: "string",
    protocol: 0,
    dynamicSortSubtable: "string",
    endPort: 0,
    fosid: 0,
    getAllTables: "string",
    ipsSensor: "string",
    logtraffic: "string",
    action: "string",
    dnat: "string",
    snat: "string",
    snatIp: "string",
    comments: "string",
    autoAsicOffload: "string",
    startPort: 0,
    status: "string",
    trafficShaper: "string",
    utmStatus: "string",
    uuid: "string",
    vdomparam: "string",
});

    type: fortios:firewall:Multicastpolicy
properties:
    action: string
    autoAsicOffload: string
    comments: string
    dnat: string
    dstaddrs:
        - name: string
    dstintf: string
    dynamicSortSubtable: string
    endPort: 0
    fosid: 0
    getAllTables: string
    ipsSensor: string
    logtraffic: string
    name: string
    protocol: 0
    snat: string
    snatIp: string
    srcaddrs:
        - name: string
    srcintf: string
    startPort: 0
    status: string
    trafficShaper: string
    utmStatus: string
    uuid: string
    vdomparam: string

    Multicastpolicy Resource Properties

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

    Inputs

    The Multicastpolicy resource accepts the following input properties:

    Dstaddrs List<Pulumiverse.Fortios.Firewall.Inputs.MulticastpolicyDstaddr>
    Destination address objects. The structure of dstaddr block is documented below.
    Dstintf string
    Destination interface name.
    Srcaddrs List<Pulumiverse.Fortios.Firewall.Inputs.MulticastpolicySrcaddr>
    Source address objects. The structure of srcaddr block is documented below.
    Srcintf string
    Source interface name.
    Action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    AutoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    Comments string
    Comment.
    Dnat string
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    EndPort int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Fosid int
    Policy ID.
    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.
    IpsSensor string
    Name of an existing IPS sensor.
    Logtraffic string
    Enable/disable logging traffic accepted by this policy.
    Name string
    Policy name.
    Protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    Snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    SnatIp string
    IPv4 address to be used as the source address for NATed traffic.
    StartPort int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Status string
    Enable/disable this policy. Valid values: enable, disable.
    TrafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    UtmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    Dstaddrs []MulticastpolicyDstaddrArgs
    Destination address objects. The structure of dstaddr block is documented below.
    Dstintf string
    Destination interface name.
    Srcaddrs []MulticastpolicySrcaddrArgs
    Source address objects. The structure of srcaddr block is documented below.
    Srcintf string
    Source interface name.
    Action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    AutoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    Comments string
    Comment.
    Dnat string
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    EndPort int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Fosid int
    Policy ID.
    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.
    IpsSensor string
    Name of an existing IPS sensor.
    Logtraffic string
    Enable/disable logging traffic accepted by this policy.
    Name string
    Policy name.
    Protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    Snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    SnatIp string
    IPv4 address to be used as the source address for NATed traffic.
    StartPort int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Status string
    Enable/disable this policy. Valid values: enable, disable.
    TrafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    UtmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    dstaddrs List<MulticastpolicyDstaddr>
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf String
    Destination interface name.
    srcaddrs List<MulticastpolicySrcaddr>
    Source address objects. The structure of srcaddr block is documented below.
    srcintf String
    Source interface name.
    action String
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload String
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments String
    Comment.
    dnat String
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    endPort Integer
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid Integer
    Policy ID.
    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.
    ipsSensor String
    Name of an existing IPS sensor.
    logtraffic String
    Enable/disable logging traffic accepted by this policy.
    name String
    Policy name.
    protocol Integer
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat String
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp String
    IPv4 address to be used as the source address for NATed traffic.
    startPort Integer
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status String
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper String
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus String
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    dstaddrs MulticastpolicyDstaddr[]
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf string
    Destination interface name.
    srcaddrs MulticastpolicySrcaddr[]
    Source address objects. The structure of srcaddr block is documented below.
    srcintf string
    Source interface name.
    action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments string
    Comment.
    dnat string
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    endPort number
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid number
    Policy ID.
    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.
    ipsSensor string
    Name of an existing IPS sensor.
    logtraffic string
    Enable/disable logging traffic accepted by this policy.
    name string
    Policy name.
    protocol number
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp string
    IPv4 address to be used as the source address for NATed traffic.
    startPort number
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status string
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    dstaddrs Sequence[MulticastpolicyDstaddrArgs]
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf str
    Destination interface name.
    srcaddrs Sequence[MulticastpolicySrcaddrArgs]
    Source address objects. The structure of srcaddr block is documented below.
    srcintf str
    Source interface name.
    action str
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    auto_asic_offload str
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments str
    Comment.
    dnat str
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    end_port int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid int
    Policy ID.
    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.
    ips_sensor str
    Name of an existing IPS sensor.
    logtraffic str
    Enable/disable logging traffic accepted by this policy.
    name str
    Policy name.
    protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat str
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snat_ip str
    IPv4 address to be used as the source address for NATed traffic.
    start_port int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status str
    Enable/disable this policy. Valid values: enable, disable.
    traffic_shaper str
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utm_status str
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid str
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    dstaddrs List<Property Map>
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf String
    Destination interface name.
    srcaddrs List<Property Map>
    Source address objects. The structure of srcaddr block is documented below.
    srcintf String
    Source interface name.
    action String
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload String
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments String
    Comment.
    dnat String
    IPv4 DNAT address used for multicast destination addresses.
    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 ].
    endPort Number
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid Number
    Policy ID.
    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.
    ipsSensor String
    Name of an existing IPS sensor.
    logtraffic String
    Enable/disable logging traffic accepted by this policy.
    name String
    Policy name.
    protocol Number
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat String
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp String
    IPv4 address to be used as the source address for NATed traffic.
    startPort Number
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status String
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper String
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus String
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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 Multicastpolicy 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 Multicastpolicy Resource

    Get an existing Multicastpolicy 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?: MulticastpolicyState, opts?: CustomResourceOptions): Multicastpolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        auto_asic_offload: Optional[str] = None,
        comments: Optional[str] = None,
        dnat: Optional[str] = None,
        dstaddrs: Optional[Sequence[MulticastpolicyDstaddrArgs]] = None,
        dstintf: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        end_port: Optional[int] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        ips_sensor: Optional[str] = None,
        logtraffic: Optional[str] = None,
        name: Optional[str] = None,
        protocol: Optional[int] = None,
        snat: Optional[str] = None,
        snat_ip: Optional[str] = None,
        srcaddrs: Optional[Sequence[MulticastpolicySrcaddrArgs]] = None,
        srcintf: Optional[str] = None,
        start_port: Optional[int] = None,
        status: Optional[str] = None,
        traffic_shaper: Optional[str] = None,
        utm_status: Optional[str] = None,
        uuid: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Multicastpolicy
    func GetMulticastpolicy(ctx *Context, name string, id IDInput, state *MulticastpolicyState, opts ...ResourceOption) (*Multicastpolicy, error)
    public static Multicastpolicy Get(string name, Input<string> id, MulticastpolicyState? state, CustomResourceOptions? opts = null)
    public static Multicastpolicy get(String name, Output<String> id, MulticastpolicyState 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:
    Action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    AutoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    Comments string
    Comment.
    Dnat string
    IPv4 DNAT address used for multicast destination addresses.
    Dstaddrs List<Pulumiverse.Fortios.Firewall.Inputs.MulticastpolicyDstaddr>
    Destination address objects. The structure of dstaddr block is documented below.
    Dstintf string
    Destination interface name.
    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 ].
    EndPort int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Fosid int
    Policy ID.
    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.
    IpsSensor string
    Name of an existing IPS sensor.
    Logtraffic string
    Enable/disable logging traffic accepted by this policy.
    Name string
    Policy name.
    Protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    Snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    SnatIp string
    IPv4 address to be used as the source address for NATed traffic.
    Srcaddrs List<Pulumiverse.Fortios.Firewall.Inputs.MulticastpolicySrcaddr>
    Source address objects. The structure of srcaddr block is documented below.
    Srcintf string
    Source interface name.
    StartPort int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Status string
    Enable/disable this policy. Valid values: enable, disable.
    TrafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    UtmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    Action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    AutoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    Comments string
    Comment.
    Dnat string
    IPv4 DNAT address used for multicast destination addresses.
    Dstaddrs []MulticastpolicyDstaddrArgs
    Destination address objects. The structure of dstaddr block is documented below.
    Dstintf string
    Destination interface name.
    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 ].
    EndPort int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Fosid int
    Policy ID.
    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.
    IpsSensor string
    Name of an existing IPS sensor.
    Logtraffic string
    Enable/disable logging traffic accepted by this policy.
    Name string
    Policy name.
    Protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    Snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    SnatIp string
    IPv4 address to be used as the source address for NATed traffic.
    Srcaddrs []MulticastpolicySrcaddrArgs
    Source address objects. The structure of srcaddr block is documented below.
    Srcintf string
    Source interface name.
    StartPort int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    Status string
    Enable/disable this policy. Valid values: enable, disable.
    TrafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    UtmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    Uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    action String
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload String
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments String
    Comment.
    dnat String
    IPv4 DNAT address used for multicast destination addresses.
    dstaddrs List<MulticastpolicyDstaddr>
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf String
    Destination interface name.
    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 ].
    endPort Integer
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid Integer
    Policy ID.
    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.
    ipsSensor String
    Name of an existing IPS sensor.
    logtraffic String
    Enable/disable logging traffic accepted by this policy.
    name String
    Policy name.
    protocol Integer
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat String
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp String
    IPv4 address to be used as the source address for NATed traffic.
    srcaddrs List<MulticastpolicySrcaddr>
    Source address objects. The structure of srcaddr block is documented below.
    srcintf String
    Source interface name.
    startPort Integer
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status String
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper String
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus String
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    action string
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload string
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments string
    Comment.
    dnat string
    IPv4 DNAT address used for multicast destination addresses.
    dstaddrs MulticastpolicyDstaddr[]
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf string
    Destination interface name.
    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 ].
    endPort number
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid number
    Policy ID.
    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.
    ipsSensor string
    Name of an existing IPS sensor.
    logtraffic string
    Enable/disable logging traffic accepted by this policy.
    name string
    Policy name.
    protocol number
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat string
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp string
    IPv4 address to be used as the source address for NATed traffic.
    srcaddrs MulticastpolicySrcaddr[]
    Source address objects. The structure of srcaddr block is documented below.
    srcintf string
    Source interface name.
    startPort number
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status string
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper string
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus string
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid string
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    action str
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    auto_asic_offload str
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments str
    Comment.
    dnat str
    IPv4 DNAT address used for multicast destination addresses.
    dstaddrs Sequence[MulticastpolicyDstaddrArgs]
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf str
    Destination interface name.
    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 ].
    end_port int
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid int
    Policy ID.
    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.
    ips_sensor str
    Name of an existing IPS sensor.
    logtraffic str
    Enable/disable logging traffic accepted by this policy.
    name str
    Policy name.
    protocol int
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat str
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snat_ip str
    IPv4 address to be used as the source address for NATed traffic.
    srcaddrs Sequence[MulticastpolicySrcaddrArgs]
    Source address objects. The structure of srcaddr block is documented below.
    srcintf str
    Source interface name.
    start_port int
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status str
    Enable/disable this policy. Valid values: enable, disable.
    traffic_shaper str
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utm_status str
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid str
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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.
    action String
    Accept or deny traffic matching the policy. Valid values: accept, deny.
    autoAsicOffload String
    Enable/disable offloading policy traffic for hardware acceleration. Valid values: enable, disable.
    comments String
    Comment.
    dnat String
    IPv4 DNAT address used for multicast destination addresses.
    dstaddrs List<Property Map>
    Destination address objects. The structure of dstaddr block is documented below.
    dstintf String
    Destination interface name.
    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 ].
    endPort Number
    Integer value for ending TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    fosid Number
    Policy ID.
    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.
    ipsSensor String
    Name of an existing IPS sensor.
    logtraffic String
    Enable/disable logging traffic accepted by this policy.
    name String
    Policy name.
    protocol Number
    Integer value for the protocol type as defined by IANA (0 - 255, default = 0).
    snat String
    Enable/disable substitution of the outgoing interface IP address for the original source IP address (called source NAT or SNAT). Valid values: enable, disable.
    snatIp String
    IPv4 address to be used as the source address for NATed traffic.
    srcaddrs List<Property Map>
    Source address objects. The structure of srcaddr block is documented below.
    srcintf String
    Source interface name.
    startPort Number
    Integer value for starting TCP/UDP/SCTP destination port in range (1 - 65535, default = 1).
    status String
    Enable/disable this policy. Valid values: enable, disable.
    trafficShaper String
    Traffic shaper to apply to traffic forwarded by the multicast policy.
    utmStatus String
    Enable to add an IPS security profile to the policy. Valid values: enable, disable.
    uuid String
    Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
    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

    MulticastpolicyDstaddr, MulticastpolicyDstaddrArgs

    Name string
    Destination address objects.
    Name string
    Destination address objects.
    name String
    Destination address objects.
    name string
    Destination address objects.
    name str
    Destination address objects.
    name String
    Destination address objects.

    MulticastpolicySrcaddr, MulticastpolicySrcaddrArgs

    Name string
    Source address objects.
    Name string
    Source address objects.
    name String
    Source address objects.
    name string
    Source address objects.
    name str
    Source address objects.
    name String
    Source address objects.

    Import

    Firewall MulticastPolicy can be imported using any of these accepted formats:

    $ pulumi import fortios:firewall/multicastpolicy:Multicastpolicy labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:firewall/multicastpolicy:Multicastpolicy labelname {{fosid}}

    $ 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