Fortios v0.0.5, Apr 9 24

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.router.getMulticast

Explore with Pulumi AI

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

Using getMulticast

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMulticast(args: GetMulticastArgs, opts?: InvokeOptions): Promise<GetMulticastResult>
function getMulticastOutput(args: GetMulticastOutputArgs, opts?: InvokeOptions): Output<GetMulticastResult>

def get_multicast(vdomparam: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetMulticastResult
def get_multicast_output(vdomparam: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetMulticastResult]

func LookupMulticast(ctx *Context, args *LookupMulticastArgs, opts ...InvokeOption) (*LookupMulticastResult, error)
func LookupMulticastOutput(ctx *Context, args *LookupMulticastOutputArgs, opts ...InvokeOption) LookupMulticastResultOutput

> Note: This function is named LookupMulticast in the Go SDK.

public static class GetMulticast 
{
    public static Task<GetMulticastResult> InvokeAsync(GetMulticastArgs args, InvokeOptions? opts = null)
    public static Output<GetMulticastResult> Invoke(GetMulticastInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMulticastResult> getMulticast(GetMulticastArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: fortios:router/getMulticast:getMulticast
  arguments:
    # arguments dictionary

The following arguments are supported:

Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam String: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam string: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam str: Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

vdomparam String: Specifies the vdom to which the data source 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.

getMulticast Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Interfaces List<Pulumiverse.Fortios.Router.Outputs.GetMulticastInterface>: PIM interfaces. The structure of interface block is documented below.
MulticastRouting string: Enable/disable IP multicast routing.
PimSmGlobals List<Pulumiverse.Fortios.Router.Outputs.GetMulticastPimSmGlobal>: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
RouteLimit int: Maximum number of multicast routes.
RouteThreshold int: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
Vdomparam string

Id string: The provider-assigned unique ID for this managed resource.
Interfaces []GetMulticastInterface: PIM interfaces. The structure of interface block is documented below.
MulticastRouting string: Enable/disable IP multicast routing.
PimSmGlobals []GetMulticastPimSmGlobal: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
RouteLimit int: Maximum number of multicast routes.
RouteThreshold int: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
Vdomparam string

id String: The provider-assigned unique ID for this managed resource.
interfaces List<GetMulticastInterface>: PIM interfaces. The structure of interface block is documented below.
multicastRouting String: Enable/disable IP multicast routing.
pimSmGlobals List<GetMulticastPimSmGlobal>: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
routeLimit Integer: Maximum number of multicast routes.
routeThreshold Integer: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
vdomparam String

id string: The provider-assigned unique ID for this managed resource.
interfaces GetMulticastInterface[]: PIM interfaces. The structure of interface block is documented below.
multicastRouting string: Enable/disable IP multicast routing.
pimSmGlobals GetMulticastPimSmGlobal[]: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
routeLimit number: Maximum number of multicast routes.
routeThreshold number: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
vdomparam string

id str: The provider-assigned unique ID for this managed resource.
interfaces Sequence[GetMulticastInterface]: PIM interfaces. The structure of interface block is documented below.
multicast_routing str: Enable/disable IP multicast routing.
pim_sm_globals Sequence[GetMulticastPimSmGlobal]: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
route_limit int: Maximum number of multicast routes.
route_threshold int: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
vdomparam str

id String: The provider-assigned unique ID for this managed resource.
interfaces List<Property Map>: PIM interfaces. The structure of interface block is documented below.
multicastRouting String: Enable/disable IP multicast routing.
pimSmGlobals List<Property Map>: PIM sparse-mode global settings. The structure of pim_sm_global block is documented below.
routeLimit Number: Maximum number of multicast routes.
routeThreshold Number: Generate warnings when the number of multicast routes exceeds this number, must not be greater than route-limit.
vdomparam String

Supporting Types

GetMulticastInterface

Bfd string: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
CiscoExcludeGenid string: Exclude GenID from hello packets (compatibility with old Cisco IOS).
DrPriority int: DR election priority.
HelloHoldtime int: Time before old neighbor information expires (0 - 65535 sec, default = 105).
HelloInterval int: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
Igmps List<Pulumiverse.Fortios.Router.Inputs.GetMulticastInterfaceIgmp>: IGMP configuration options. The structure of igmp block is documented below.
JoinGroups List<Pulumiverse.Fortios.Router.Inputs.GetMulticastInterfaceJoinGroup>: Join multicast groups. The structure of join_group block is documented below.
MulticastFlow string: Acceptable source for multicast group.
Name string: Interface name.
NeighbourFilter string: Routers acknowledged as neighbor routers.
Passive string: Enable/disable listening to IGMP but not participating in PIM.
PimMode string: PIM operation mode.
PropagationDelay int: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
RpCandidate string: Enable/disable compete to become RP in elections.
RpCandidateGroup string: Multicast groups managed by this RP.
RpCandidateInterval int: RP candidate advertisement interval (1 - 16383 sec, default = 60).
RpCandidatePriority int: Router's priority as RP.
RpfNbrFailBack string: Enable/disable fail back for RPF neighbor query.
RpfNbrFailBackFilter string: Filter for fail back RPF neighbors.
StateRefreshInterval int: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
StaticGroup string: Statically set multicast groups to forward out.
TtlThreshold int: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

Bfd string: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
CiscoExcludeGenid string: Exclude GenID from hello packets (compatibility with old Cisco IOS).
DrPriority int: DR election priority.
HelloHoldtime int: Time before old neighbor information expires (0 - 65535 sec, default = 105).
HelloInterval int: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
Igmps []GetMulticastInterfaceIgmp: IGMP configuration options. The structure of igmp block is documented below.
JoinGroups []GetMulticastInterfaceJoinGroup: Join multicast groups. The structure of join_group block is documented below.
MulticastFlow string: Acceptable source for multicast group.
Name string: Interface name.
NeighbourFilter string: Routers acknowledged as neighbor routers.
Passive string: Enable/disable listening to IGMP but not participating in PIM.
PimMode string: PIM operation mode.
PropagationDelay int: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
RpCandidate string: Enable/disable compete to become RP in elections.
RpCandidateGroup string: Multicast groups managed by this RP.
RpCandidateInterval int: RP candidate advertisement interval (1 - 16383 sec, default = 60).
RpCandidatePriority int: Router's priority as RP.
RpfNbrFailBack string: Enable/disable fail back for RPF neighbor query.
RpfNbrFailBackFilter string: Filter for fail back RPF neighbors.
StateRefreshInterval int: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
StaticGroup string: Statically set multicast groups to forward out.
TtlThreshold int: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

bfd String: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
ciscoExcludeGenid String: Exclude GenID from hello packets (compatibility with old Cisco IOS).
drPriority Integer: DR election priority.
helloHoldtime Integer: Time before old neighbor information expires (0 - 65535 sec, default = 105).
helloInterval Integer: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
igmps List<GetMulticastInterfaceIgmp>: IGMP configuration options. The structure of igmp block is documented below.
joinGroups List<GetMulticastInterfaceJoinGroup>: Join multicast groups. The structure of join_group block is documented below.
multicastFlow String: Acceptable source for multicast group.
name String: Interface name.
neighbourFilter String: Routers acknowledged as neighbor routers.
passive String: Enable/disable listening to IGMP but not participating in PIM.
pimMode String: PIM operation mode.
propagationDelay Integer: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
rpCandidate String: Enable/disable compete to become RP in elections.
rpCandidateGroup String: Multicast groups managed by this RP.
rpCandidateInterval Integer: RP candidate advertisement interval (1 - 16383 sec, default = 60).
rpCandidatePriority Integer: Router's priority as RP.
rpfNbrFailBack String: Enable/disable fail back for RPF neighbor query.
rpfNbrFailBackFilter String: Filter for fail back RPF neighbors.
stateRefreshInterval Integer: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
staticGroup String: Statically set multicast groups to forward out.
ttlThreshold Integer: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

bfd string: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
ciscoExcludeGenid string: Exclude GenID from hello packets (compatibility with old Cisco IOS).
drPriority number: DR election priority.
helloHoldtime number: Time before old neighbor information expires (0 - 65535 sec, default = 105).
helloInterval number: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
igmps GetMulticastInterfaceIgmp[]: IGMP configuration options. The structure of igmp block is documented below.
joinGroups GetMulticastInterfaceJoinGroup[]: Join multicast groups. The structure of join_group block is documented below.
multicastFlow string: Acceptable source for multicast group.
name string: Interface name.
neighbourFilter string: Routers acknowledged as neighbor routers.
passive string: Enable/disable listening to IGMP but not participating in PIM.
pimMode string: PIM operation mode.
propagationDelay number: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
rpCandidate string: Enable/disable compete to become RP in elections.
rpCandidateGroup string: Multicast groups managed by this RP.
rpCandidateInterval number: RP candidate advertisement interval (1 - 16383 sec, default = 60).
rpCandidatePriority number: Router's priority as RP.
rpfNbrFailBack string: Enable/disable fail back for RPF neighbor query.
rpfNbrFailBackFilter string: Filter for fail back RPF neighbors.
stateRefreshInterval number: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
staticGroup string: Statically set multicast groups to forward out.
ttlThreshold number: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

bfd str: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
cisco_exclude_genid str: Exclude GenID from hello packets (compatibility with old Cisco IOS).
dr_priority int: DR election priority.
hello_holdtime int: Time before old neighbor information expires (0 - 65535 sec, default = 105).
hello_interval int: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
igmps Sequence[GetMulticastInterfaceIgmp]: IGMP configuration options. The structure of igmp block is documented below.
join_groups Sequence[GetMulticastInterfaceJoinGroup]: Join multicast groups. The structure of join_group block is documented below.
multicast_flow str: Acceptable source for multicast group.
name str: Interface name.
neighbour_filter str: Routers acknowledged as neighbor routers.
passive str: Enable/disable listening to IGMP but not participating in PIM.
pim_mode str: PIM operation mode.
propagation_delay int: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
rp_candidate str: Enable/disable compete to become RP in elections.
rp_candidate_group str: Multicast groups managed by this RP.
rp_candidate_interval int: RP candidate advertisement interval (1 - 16383 sec, default = 60).
rp_candidate_priority int: Router's priority as RP.
rpf_nbr_fail_back str: Enable/disable fail back for RPF neighbor query.
rpf_nbr_fail_back_filter str: Filter for fail back RPF neighbors.
state_refresh_interval int: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
static_group str: Statically set multicast groups to forward out.
ttl_threshold int: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

bfd String: Enable/disable Protocol Independent Multicast (PIM) Bidirectional Forwarding Detection (BFD).
ciscoExcludeGenid String: Exclude GenID from hello packets (compatibility with old Cisco IOS).
drPriority Number: DR election priority.
helloHoldtime Number: Time before old neighbor information expires (0 - 65535 sec, default = 105).
helloInterval Number: Interval between sending PIM hello messages (0 - 65535 sec, default = 30).
igmps List<Property Map>: IGMP configuration options. The structure of igmp block is documented below.
joinGroups List<Property Map>: Join multicast groups. The structure of join_group block is documented below.
multicastFlow String: Acceptable source for multicast group.
name String: Interface name.
neighbourFilter String: Routers acknowledged as neighbor routers.
passive String: Enable/disable listening to IGMP but not participating in PIM.
pimMode String: PIM operation mode.
propagationDelay Number: Delay flooding packets on this interface (100 - 5000 msec, default = 500).
rpCandidate String: Enable/disable compete to become RP in elections.
rpCandidateGroup String: Multicast groups managed by this RP.
rpCandidateInterval Number: RP candidate advertisement interval (1 - 16383 sec, default = 60).
rpCandidatePriority Number: Router's priority as RP.
rpfNbrFailBack String: Enable/disable fail back for RPF neighbor query.
rpfNbrFailBackFilter String: Filter for fail back RPF neighbors.
stateRefreshInterval Number: Interval between sending state-refresh packets (1 - 100 sec, default = 60).
staticGroup String: Statically set multicast groups to forward out.
ttlThreshold Number: Minimum TTL of multicast packets that will be forwarded (applied only to new multicast routes) (1 - 255, default = 1).

GetMulticastInterfaceIgmp

AccessGroup string: Groups IGMP hosts are allowed to join.
ImmediateLeaveGroup string: Groups to drop membership for immediately after receiving IGMPv2 leave.
LastMemberQueryCount int: Number of group specific queries before removing group (2 - 7, default = 2).
LastMemberQueryInterval int: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
QueryInterval int: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
QueryMaxResponseTime int: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
QueryTimeout int: Timeout between queries before becoming querier for network (60 - 900, default = 255).
RouterAlertCheck string: Enable/disable require IGMP packets contain router alert option.
Version string: Maximum version of IGMP to support.

AccessGroup string: Groups IGMP hosts are allowed to join.
ImmediateLeaveGroup string: Groups to drop membership for immediately after receiving IGMPv2 leave.
LastMemberQueryCount int: Number of group specific queries before removing group (2 - 7, default = 2).
LastMemberQueryInterval int: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
QueryInterval int: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
QueryMaxResponseTime int: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
QueryTimeout int: Timeout between queries before becoming querier for network (60 - 900, default = 255).
RouterAlertCheck string: Enable/disable require IGMP packets contain router alert option.
Version string: Maximum version of IGMP to support.

accessGroup String: Groups IGMP hosts are allowed to join.
immediateLeaveGroup String: Groups to drop membership for immediately after receiving IGMPv2 leave.
lastMemberQueryCount Integer: Number of group specific queries before removing group (2 - 7, default = 2).
lastMemberQueryInterval Integer: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
queryInterval Integer: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
queryMaxResponseTime Integer: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
queryTimeout Integer: Timeout between queries before becoming querier for network (60 - 900, default = 255).
routerAlertCheck String: Enable/disable require IGMP packets contain router alert option.
version String: Maximum version of IGMP to support.

accessGroup string: Groups IGMP hosts are allowed to join.
immediateLeaveGroup string: Groups to drop membership for immediately after receiving IGMPv2 leave.
lastMemberQueryCount number: Number of group specific queries before removing group (2 - 7, default = 2).
lastMemberQueryInterval number: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
queryInterval number: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
queryMaxResponseTime number: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
queryTimeout number: Timeout between queries before becoming querier for network (60 - 900, default = 255).
routerAlertCheck string: Enable/disable require IGMP packets contain router alert option.
version string: Maximum version of IGMP to support.

access_group str: Groups IGMP hosts are allowed to join.
immediate_leave_group str: Groups to drop membership for immediately after receiving IGMPv2 leave.
last_member_query_count int: Number of group specific queries before removing group (2 - 7, default = 2).
last_member_query_interval int: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
query_interval int: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
query_max_response_time int: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
query_timeout int: Timeout between queries before becoming querier for network (60 - 900, default = 255).
router_alert_check str: Enable/disable require IGMP packets contain router alert option.
version str: Maximum version of IGMP to support.

accessGroup String: Groups IGMP hosts are allowed to join.
immediateLeaveGroup String: Groups to drop membership for immediately after receiving IGMPv2 leave.
lastMemberQueryCount Number: Number of group specific queries before removing group (2 - 7, default = 2).
lastMemberQueryInterval Number: Timeout between IGMPv2 leave and removing group (1 - 65535 msec, default = 1000).
queryInterval Number: Interval between queries to IGMP hosts (1 - 65535 sec, default = 125).
queryMaxResponseTime Number: Maximum time to wait for a IGMP query response (1 - 25 sec, default = 10).
queryTimeout Number: Timeout between queries before becoming querier for network (60 - 900, default = 255).
routerAlertCheck String: Enable/disable require IGMP packets contain router alert option.
version String: Maximum version of IGMP to support.

GetMulticastInterfaceJoinGroup

Address string: Multicast group IP address.

Address string: Multicast group IP address.

address String: Multicast group IP address.

address string: Multicast group IP address.

address str: Multicast group IP address.

address String: Multicast group IP address.

GetMulticastPimSmGlobal

AcceptRegisterList string: Sources allowed to register packets with this Rendezvous Point (RP).
AcceptSourceList string: Sources allowed to send multicast traffic.
BsrAllowQuickRefresh string: Enable/disable accept BSR quick refresh packets from neighbors.
BsrCandidate string: Enable/disable allowing this router to become a bootstrap router (BSR).
BsrHash int: BSR hash length (0 - 32, default = 10).
BsrInterface string: Interface to advertise as candidate BSR.
BsrPriority int: BSR priority (0 - 255, default = 0).
CiscoCrpPrefix string: Enable/disable making candidate RP compatible with old Cisco IOS.
CiscoIgnoreRpSetPriority string: Use only hash for RP selection (compatibility with old Cisco IOS).
CiscoRegisterChecksum string: Checksum entire register packet(for old Cisco IOS compatibility).
CiscoRegisterChecksumGroup string: Cisco register checksum only these groups.
JoinPruneHoldtime int: Join/prune holdtime (1 - 65535, default = 210).
MessageInterval int: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
NullRegisterRetries int: Maximum retries of null register (1 - 20, default = 1).
PimUseSdwan string: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
RegisterRateLimit int: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
RegisterRpReachability string: Enable/disable check RP is reachable before registering packets.
RegisterSource string: Override source address in register packets.
RegisterSourceInterface string: Override with primary interface address.
RegisterSourceIp string: Override with local IP address.
RegisterSupression int: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
RpAddresses List<Pulumiverse.Fortios.Router.Inputs.GetMulticastPimSmGlobalRpAddress>: Statically configure RP addresses. The structure of rp_address block is documented below.
RpRegisterKeepalive int: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
SptThreshold string: Enable/disable switching to source specific trees.
SptThresholdGroup string: Groups allowed to switch to source tree.
Ssm string: Enable/disable source specific multicast.
SsmRange string: Groups allowed to source specific multicast.

AcceptRegisterList string: Sources allowed to register packets with this Rendezvous Point (RP).
AcceptSourceList string: Sources allowed to send multicast traffic.
BsrAllowQuickRefresh string: Enable/disable accept BSR quick refresh packets from neighbors.
BsrCandidate string: Enable/disable allowing this router to become a bootstrap router (BSR).
BsrHash int: BSR hash length (0 - 32, default = 10).
BsrInterface string: Interface to advertise as candidate BSR.
BsrPriority int: BSR priority (0 - 255, default = 0).
CiscoCrpPrefix string: Enable/disable making candidate RP compatible with old Cisco IOS.
CiscoIgnoreRpSetPriority string: Use only hash for RP selection (compatibility with old Cisco IOS).
CiscoRegisterChecksum string: Checksum entire register packet(for old Cisco IOS compatibility).
CiscoRegisterChecksumGroup string: Cisco register checksum only these groups.
JoinPruneHoldtime int: Join/prune holdtime (1 - 65535, default = 210).
MessageInterval int: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
NullRegisterRetries int: Maximum retries of null register (1 - 20, default = 1).
PimUseSdwan string: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
RegisterRateLimit int: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
RegisterRpReachability string: Enable/disable check RP is reachable before registering packets.
RegisterSource string: Override source address in register packets.
RegisterSourceInterface string: Override with primary interface address.
RegisterSourceIp string: Override with local IP address.
RegisterSupression int: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
RpAddresses []GetMulticastPimSmGlobalRpAddress: Statically configure RP addresses. The structure of rp_address block is documented below.
RpRegisterKeepalive int: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
SptThreshold string: Enable/disable switching to source specific trees.
SptThresholdGroup string: Groups allowed to switch to source tree.
Ssm string: Enable/disable source specific multicast.
SsmRange string: Groups allowed to source specific multicast.

acceptRegisterList String: Sources allowed to register packets with this Rendezvous Point (RP).
acceptSourceList String: Sources allowed to send multicast traffic.
bsrAllowQuickRefresh String: Enable/disable accept BSR quick refresh packets from neighbors.
bsrCandidate String: Enable/disable allowing this router to become a bootstrap router (BSR).
bsrHash Integer: BSR hash length (0 - 32, default = 10).
bsrInterface String: Interface to advertise as candidate BSR.
bsrPriority Integer: BSR priority (0 - 255, default = 0).
ciscoCrpPrefix String: Enable/disable making candidate RP compatible with old Cisco IOS.
ciscoIgnoreRpSetPriority String: Use only hash for RP selection (compatibility with old Cisco IOS).
ciscoRegisterChecksum String: Checksum entire register packet(for old Cisco IOS compatibility).
ciscoRegisterChecksumGroup String: Cisco register checksum only these groups.
joinPruneHoldtime Integer: Join/prune holdtime (1 - 65535, default = 210).
messageInterval Integer: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
nullRegisterRetries Integer: Maximum retries of null register (1 - 20, default = 1).
pimUseSdwan String: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
registerRateLimit Integer: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
registerRpReachability String: Enable/disable check RP is reachable before registering packets.
registerSource String: Override source address in register packets.
registerSourceInterface String: Override with primary interface address.
registerSourceIp String: Override with local IP address.
registerSupression Integer: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
rpAddresses List<GetMulticastPimSmGlobalRpAddress>: Statically configure RP addresses. The structure of rp_address block is documented below.
rpRegisterKeepalive Integer: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
sptThreshold String: Enable/disable switching to source specific trees.
sptThresholdGroup String: Groups allowed to switch to source tree.
ssm String: Enable/disable source specific multicast.
ssmRange String: Groups allowed to source specific multicast.

acceptRegisterList string: Sources allowed to register packets with this Rendezvous Point (RP).
acceptSourceList string: Sources allowed to send multicast traffic.
bsrAllowQuickRefresh string: Enable/disable accept BSR quick refresh packets from neighbors.
bsrCandidate string: Enable/disable allowing this router to become a bootstrap router (BSR).
bsrHash number: BSR hash length (0 - 32, default = 10).
bsrInterface string: Interface to advertise as candidate BSR.
bsrPriority number: BSR priority (0 - 255, default = 0).
ciscoCrpPrefix string: Enable/disable making candidate RP compatible with old Cisco IOS.
ciscoIgnoreRpSetPriority string: Use only hash for RP selection (compatibility with old Cisco IOS).
ciscoRegisterChecksum string: Checksum entire register packet(for old Cisco IOS compatibility).
ciscoRegisterChecksumGroup string: Cisco register checksum only these groups.
joinPruneHoldtime number: Join/prune holdtime (1 - 65535, default = 210).
messageInterval number: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
nullRegisterRetries number: Maximum retries of null register (1 - 20, default = 1).
pimUseSdwan string: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
registerRateLimit number: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
registerRpReachability string: Enable/disable check RP is reachable before registering packets.
registerSource string: Override source address in register packets.
registerSourceInterface string: Override with primary interface address.
registerSourceIp string: Override with local IP address.
registerSupression number: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
rpAddresses GetMulticastPimSmGlobalRpAddress[]: Statically configure RP addresses. The structure of rp_address block is documented below.
rpRegisterKeepalive number: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
sptThreshold string: Enable/disable switching to source specific trees.
sptThresholdGroup string: Groups allowed to switch to source tree.
ssm string: Enable/disable source specific multicast.
ssmRange string: Groups allowed to source specific multicast.

accept_register_list str: Sources allowed to register packets with this Rendezvous Point (RP).
accept_source_list str: Sources allowed to send multicast traffic.
bsr_allow_quick_refresh str: Enable/disable accept BSR quick refresh packets from neighbors.
bsr_candidate str: Enable/disable allowing this router to become a bootstrap router (BSR).
bsr_hash int: BSR hash length (0 - 32, default = 10).
bsr_interface str: Interface to advertise as candidate BSR.
bsr_priority int: BSR priority (0 - 255, default = 0).
cisco_crp_prefix str: Enable/disable making candidate RP compatible with old Cisco IOS.
cisco_ignore_rp_set_priority str: Use only hash for RP selection (compatibility with old Cisco IOS).
cisco_register_checksum str: Checksum entire register packet(for old Cisco IOS compatibility).
cisco_register_checksum_group str: Cisco register checksum only these groups.
join_prune_holdtime int: Join/prune holdtime (1 - 65535, default = 210).
message_interval int: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
null_register_retries int: Maximum retries of null register (1 - 20, default = 1).
pim_use_sdwan str: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
register_rate_limit int: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
register_rp_reachability str: Enable/disable check RP is reachable before registering packets.
register_source str: Override source address in register packets.
register_source_interface str: Override with primary interface address.
register_source_ip str: Override with local IP address.
register_supression int: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
rp_addresses Sequence[GetMulticastPimSmGlobalRpAddress]: Statically configure RP addresses. The structure of rp_address block is documented below.
rp_register_keepalive int: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
spt_threshold str: Enable/disable switching to source specific trees.
spt_threshold_group str: Groups allowed to switch to source tree.
ssm str: Enable/disable source specific multicast.
ssm_range str: Groups allowed to source specific multicast.

acceptRegisterList String: Sources allowed to register packets with this Rendezvous Point (RP).
acceptSourceList String: Sources allowed to send multicast traffic.
bsrAllowQuickRefresh String: Enable/disable accept BSR quick refresh packets from neighbors.
bsrCandidate String: Enable/disable allowing this router to become a bootstrap router (BSR).
bsrHash Number: BSR hash length (0 - 32, default = 10).
bsrInterface String: Interface to advertise as candidate BSR.
bsrPriority Number: BSR priority (0 - 255, default = 0).
ciscoCrpPrefix String: Enable/disable making candidate RP compatible with old Cisco IOS.
ciscoIgnoreRpSetPriority String: Use only hash for RP selection (compatibility with old Cisco IOS).
ciscoRegisterChecksum String: Checksum entire register packet(for old Cisco IOS compatibility).
ciscoRegisterChecksumGroup String: Cisco register checksum only these groups.
joinPruneHoldtime Number: Join/prune holdtime (1 - 65535, default = 210).
messageInterval Number: Period of time between sending periodic PIM join/prune messages in seconds (1 - 65535, default = 60).
nullRegisterRetries Number: Maximum retries of null register (1 - 20, default = 1).
pimUseSdwan String: Enable/disable use of SDWAN when checking RPF neighbor and sending of REG packet.
registerRateLimit Number: Limit of packets/sec per source registered through this RP (0 - 65535, default = 0 which means unlimited).
registerRpReachability String: Enable/disable check RP is reachable before registering packets.
registerSource String: Override source address in register packets.
registerSourceInterface String: Override with primary interface address.
registerSourceIp String: Override with local IP address.
registerSupression Number: Period of time to honor register-stop message (1 - 65535 sec, default = 60).
rpAddresses List<Property Map>: Statically configure RP addresses. The structure of rp_address block is documented below.
rpRegisterKeepalive Number: Timeout for RP receiving data on (S,G) tree (1 - 65535 sec, default = 185).
sptThreshold String: Enable/disable switching to source specific trees.
sptThresholdGroup String: Groups allowed to switch to source tree.
ssm String: Enable/disable source specific multicast.
ssmRange String: Groups allowed to source specific multicast.

GetMulticastPimSmGlobalRpAddress

Group string: Groups to use this RP.
Id int: ID.
IpAddress string: RP router address.

Group string: Groups to use this RP.
Id int: ID.
IpAddress string: RP router address.

group String: Groups to use this RP.
id Integer: ID.
ipAddress String: RP router address.

group string: Groups to use this RP.
id number: ID.
ipAddress string: RP router address.

group str: Groups to use this RP.
id int: ID.
ip_address str: RP router address.

group String: Groups to use this RP.
id Number: ID.
ipAddress String: RP router address.

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.router.getMulticast

On this page

On this page

Using getMulticast

getMulticast Result

Supporting Types

GetMulticastInterface

GetMulticastInterfaceIgmp

GetMulticastInterfaceJoinGroup

GetMulticastPimSmGlobal

GetMulticastPimSmGlobalRpAddress

Package Details

On this page

On this page