Skip to main content

Update Multicast Config (v2.1)

PUT 
/v2.1/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/multicastglobalconfigs/:config_id

Update the existing multicast global config.

Request​

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    ID of the site.

    element_id stringrequired

    ID of the element.

    config_id stringrequired

    The multicast config ID.

Body

Details of the Multicast config to be updated

    bsm_enabled boolean

    If enabled, receives and forwards of BSM on multicast enabled interfaces. BSM is a protocol by which the device learns RPs dynamically.

    dr_priority int64

    The probability of a PIM interface elected as a Designated Router (DR). For Static RP, the DR Priority advertised in a PIM Hello is 1.

    id string

    The ID of the multicast config.

    igmp_protocol_parameters MulticastIgmpProtocolConfig

    The Internet group management protocol (IGMP) version the routers regularly send queries to determine which groups are active/inactive in an appropriate LAN segment.

    last_member_query_count int64

    The number of times the ION device sent IGMP queries to the last known active host on the subnet. Default value is 3 secs.

    last_member_query_interval int64

    The time interval for the ION device to respond to the IGMP query from the last known active host on the subnet. Default value is 1 sec.

    query_interval int64

    The time interval between successive IGMP queries. Default value is 125 secs.

    query_max_response_time int64

    The maximum response time to the IGMP query. Default value is 100 secs.

    pim_protocol_parameters MulticastPimProtocolConfig

    The parameters of PIM protocol.

    hello_hold_time int64

    The time interval which a neighbor waits for a Hello message from a sender neighbor before pruning the neighbor. Default value is 105 secs.

    hello_interval int64

    The time interval between two PIM Hello packets. Default value is 30 secs.

    join_prune_interval int64

    The time interval between two Join/Prune messages sent to a neighbor. Default value is 60 secs.

    spt_switchover_enabled boolean

    Indicates that the first multicast packet is received i.e. the source address is received by the receiver, the DR at the receiver’s end and the RP choose the optimal path to relay information from the source to the receiver.

Responses​

Successful Operation

Schema
    bsm_enabled boolean

    If enabled, receives and forwards of BSM on multicast enabled interfaces. BSM is a protocol by which the device learns RPs dynamically.

    dr_priority int64

    The probability of a PIM interface elected as a Designated Router (DR). For Static RP, the DR Priority advertised in a PIM Hello is 1.

    id string

    The ID of the multicast config.

    igmp_protocol_parameters MulticastIgmpProtocolConfig

    The Internet group management protocol (IGMP) version the routers regularly send queries to determine which groups are active/inactive in an appropriate LAN segment.

    last_member_query_count int64

    The number of times the ION device sent IGMP queries to the last known active host on the subnet. Default value is 3 secs.

    last_member_query_interval int64

    The time interval for the ION device to respond to the IGMP query from the last known active host on the subnet. Default value is 1 sec.

    query_interval int64

    The time interval between successive IGMP queries. Default value is 125 secs.

    query_max_response_time int64

    The maximum response time to the IGMP query. Default value is 100 secs.

    pim_protocol_parameters MulticastPimProtocolConfig

    The parameters of PIM protocol.

    hello_hold_time int64

    The time interval which a neighbor waits for a Hello message from a sender neighbor before pruning the neighbor. Default value is 105 secs.

    hello_interval int64

    The time interval between two PIM Hello packets. Default value is 30 secs.

    join_prune_interval int64

    The time interval between two Join/Prune messages sent to a neighbor. Default value is 60 secs.

    spt_switchover_enabled boolean

    Indicates that the first multicast packet is received i.e. the source address is received by the receiver, the DR at the receiver’s end and the RP choose the optimal path to relay information from the source to the receiver.

Loading...