pim.xrls

xorp源码hg

 *
 *  @param xrl_sender_name the XRL name of the originator of this XRL.
 *
 *  @param vif_name the name of the new vif.
 *
 *  @param vif_index the index of the new vif.
 *
 *  @param source the source address that has been joined/left.
 *
 *  @param group the group address that has been joined/left.
 */
finder://pim/mld6igmp_client/0.1/add_membership4?xrl_sender_name:txt&vif_name:txt&vif_index:u32&source:ipv4&group:ipv4

finder://pim/mld6igmp_client/0.1/add_membership6?xrl_sender_name:txt&vif_name:txt&vif_index:u32&source:ipv6&group:ipv6

finder://pim/mld6igmp_client/0.1/delete_membership4?xrl_sender_name:txt&vif_name:txt&vif_index:u32&source:ipv4&group:ipv4

finder://pim/mld6igmp_client/0.1/delete_membership6?xrl_sender_name:txt&vif_name:txt&vif_index:u32&source:ipv6&group:ipv6

/**
 *  Enable/disable/start/stop a PIM vif interface.
 *
 *  @param vif_name the name of the vif to enable/disable/start/stop.
 *
 *  @param enable if true, then enable the vif, otherwise disable it.
 */
finder://pim/pim/0.1/enable_vif?vif_name:txt&enable:bool

finder://pim/pim/0.1/start_vif?vif_name:txt

finder://pim/pim/0.1/stop_vif?vif_name:txt

/**
 *  Enable/disable/start/stop all PIM vif interfaces.
 *
 *  @param enable if true, then enable the vifs, otherwise disable them.
 */
finder://pim/pim/0.1/enable_all_vifs?enable:bool

finder://pim/pim/0.1/start_all_vifs

finder://pim/pim/0.1/stop_all_vifs

/**
 *  Enable/disable/start/stop the PIM protocol.
 *
 *  @param enable if true, then enable the PIM protocol, otherwise disable it.
 */
finder://pim/pim/0.1/enable_pim?enable:bool

finder://pim/pim/0.1/start_pim

finder://pim/pim/0.1/stop_pim

/**
 *  Enable/disable/start/stop the PIM CLI access.
 *
 *  @param enable if true, then enable the PIM CLI access, otherwise disable
 *  it.
 */
finder://pim/pim/0.1/enable_cli?enable:bool

finder://pim/pim/0.1/start_cli

finder://pim/pim/0.1/stop_cli

/**
 *  Enable/disable/start/stop BSR.
 *
 *  @param enable if true, then enable the BSR, otherwise disable it.
 */
finder://pim/pim/0.1/enable_bsr?enable:bool

finder://pim/pim/0.1/start_bsr

finder://pim/pim/0.1/stop_bsr

/**
 *  Add/delete scope zone.
 *
 *  @param scope_zone_id the ID of the configured zone.
 *
 *  @param vif_name the name of the vif to use as a bondary of the scope zone.
 */
finder://pim/pim/0.1/add_config_scope_zone_by_vif_name4?scope_zone_id:ipv4net&vif_name:txt

finder://pim/pim/0.1/add_config_scope_zone_by_vif_name6?scope_zone_id:ipv6net&vif_name:txt

finder://pim/pim/0.1/add_config_scope_zone_by_vif_addr4?scope_zone_id:ipv4net&vif_addr:ipv4

finder://pim/pim/0.1/add_config_scope_zone_by_vif_addr6?scope_zone_id:ipv6net&vif_addr:ipv6

finder://pim/pim/0.1/delete_config_scope_zone_by_vif_name4?scope_zone_id:ipv4net&vif_name:txt

finder://pim/pim/0.1/delete_config_scope_zone_by_vif_name6?scope_zone_id:ipv6net&vif_name:txt

finder://pim/pim/0.1/delete_config_scope_zone_by_vif_addr4?scope_zone_id:ipv4net&vif_addr:ipv4

finder://pim/pim/0.1/delete_config_scope_zone_by_vif_addr6?scope_zone_id:ipv6net&vif_addr:ipv6

/**
 *  Add/delete candidate-BSR configuration.
 *
 *  @param scope_zone_id the ID of the configured zone.
 *
 *  @param is_scope_zone true if configuring administratively scoped zone.
 *
 *  @param vif_name the name of the vif to use its address as a candidate-BSR.
 *
 *  @param vif_addr the address of the vif to use as a candidate-BSR.
 *
 *  @param bsr_priority the BSR priority (larger is better).
 *
 *  @param hash_mask_len the hash mask length.
 */
finder://pim/pim/0.1/add_config_cand_bsr4?scope_zone_id:ipv4net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv4&bsr_priority:u32&hash_mask_len:u32

finder://pim/pim/0.1/add_config_cand_bsr6?scope_zone_id:ipv6net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv6&bsr_priority:u32&hash_mask_len:u32

finder://pim/pim/0.1/delete_config_cand_bsr4?scope_zone_id:ipv4net&is_scope_zone:bool

finder://pim/pim/0.1/delete_config_cand_bsr6?scope_zone_id:ipv6net&is_scope_zone:bool

/**
 *  Add/delete Candidate-RP configuration.
 *
 *  @param group_prefix the group prefix of the configured zone.
 *
 *  @param is_scope_zone true if configuring administratively scoped zone.
 *
 *  @param vif_name the name of the vif to use its address as a candidate-RP.
 *
 *  @param vif_addr the address of the vif to use as a candidate-RP.
 *
 *  @param rp_priority the Cand-RP priority (smaller is better).
 *
 *  @param rp_holdtime the Cand-RP holdtime (in seconds).
 */
finder://pim/pim/0.1/add_config_cand_rp4?group_prefix:ipv4net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv4&rp_priority:u32&rp_holdtime:u32

finder://pim/pim/0.1/add_config_cand_rp6?group_prefix:ipv6net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv6&rp_priority:u32&rp_holdtime:u32

finder://pim/pim/0.1/delete_config_cand_rp4?group_prefix:ipv4net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv4

finder://pim/pim/0.1/delete_config_cand_rp6?group_prefix:ipv6net&is_scope_zone:bool&vif_name:txt&vif_addr:ipv6

/**
 *  Add/delete/complete static RP configuration.
 *
 *  @param group_prefix the group prefix for the RP.
 *
 *  @param rp_addr the RP address.
 *
 *  @param rp_priority the RP priority (smaller is better).
 *
 *  @param hash_mask_len the hash mask length used in computing an RP for a
 *  group. It should be same across all RPs. If set to zero, the default one
 *  will be used.
 */
finder://pim/pim/0.1/add_config_static_rp4?group_prefix:ipv4net&rp_addr:ipv4&rp_priority:u32&hash_mask_len:u32

finder://pim/pim/0.1/add_config_static_rp6?group_prefix:ipv6net&rp_addr:ipv6&rp_priority:u32&hash_mask_len:u32

finder://pim/pim/0.1/delete_config_static_rp4?group_prefix:ipv4net&rp_addr:ipv4

finder://pim/pim/0.1/delete_config_static_rp6?group_prefix:ipv6net&rp_addr:ipv6

finder://pim/pim/0.1/delete_config_all_static_group_prefixes_rp4?rp_addr:ipv4

finder://pim/pim/0.1/delete_config_all_static_group_prefixes_rp6?rp_addr:ipv6

finder://pim/pim/0.1/delete_config_all_static_rps

finder://pim/pim/0.1/config_static_rp_done

/**
 *  Get the configured protocol version per interface.
 *
 *  @param vif_name the name of the vif to apply to.
 *
 *  @param proto_version the protocol version.
 */
finder://pim/pim/0.1/get_vif_proto_version?vif_name:txt->proto_version:u32

/**
 *  Set the protocol version per interface.
 *
 *  @param vif_name the name of the vif to apply to.
 *
 *  @param proto_version the protocol version.
 */
finder://pim/pim/0.1/set_vif_proto_version?vif_name:txt&proto_version:u32

/**
 *  Reset the protocol version per interface to its default value.
 *
 *  @param vif_name the name of the vif to apply to.
 */
finder://pim/pim/0.1/reset_vif_proto_version?vif_name:txt

/**
 *  Get the IP Router Alert option check per interface for received packets.
 *
 *  @param vif_name the name of the vif to apply to.
 *
 *  @param enabled if true, then the IP Router Alert option check was enabled,
 *  otherwise it was disabled.
 */
finder://pim/pim/0.1/get_vif_ip_router_alert_option_check?vif_name:txt->enabled:bool

/**
 *  Set the IP Router Alert option check per interface for received packets.
 *
 *  @param vif_name the name of the vif to apply to.
 *
 *  @param enable if true, then enable the IP Router Alert option check,
 *  otherwise disable it.
 */
finder://pim/pim/0.1/set_vif_ip_router_alert_option_check?vif_name:txt&enable:bool

/**
 *  Reset the IP Router Alert option check per interface for received packets
 *  to its default value.
 *
 *  @param vif_name the name of the vif to apply to.
 */
finder://pim/pim/0.1/reset_vif_ip_router_alert_option_check?vif_name:txt

/**
 *  Configure PIM Hello-related metrics. The 'set_foo' XRLs set the particular
 *  values. The 'reset_foo' XRLs reset the metrics to their default values.
 *
 *  @param vif_name the name of the vif to configure.
 *
 *  @param hello_triggered_delay the Triggered_Hello_Delay (in seconds).
 */
finder://pim/pim/0.1/get_vif_hello_triggered_delay?vif_name:txt->hello_triggered_delay:u32

finder://pim/pim/0.1/set_vif_hello_triggered_delay?vif_name:txt&hello_triggered_delay:u32

finder://pim/pim/0.1/reset_vif_hello_triggered_delay?vif_name:txt

finder://pim/pim/0.1/get_vif_hello_period?vif_name:txt->hello_period:u32

finder://pim/pim/0.1/set_vif_hello_period?vif_name:txt&hello_period:u32

finder://pim/pim/0.1/reset_vif_hello_period?vif_name:txt

finder://pim/pim/0.1/get_vif_hello_holdtime?vif_name:txt->hello_holdtime:u32

finder://pim/pim/0.1/set_vif_hello_holdtime?vif_name:txt&hello_holdtime:u32

finder://pim/pim/0.1/reset_vif_hello_holdtime?vif_name:txt

finder://pim/pim/0.1/get_vif_dr_priority?vif_name:txt->dr_priority:u32

finder://pim/pim/0.1/set_vif_dr_priority?vif_name:txt&dr_priority:u32

finder://pim/pim/0.1/reset_vif_dr_priority?vif_name:txt

finder://pim/pim/0.1/get_vif_propagation_delay?vif_name:txt->propagation_delay:u32

finder://pim/pim/0.1/set_vif_propagation_delay?vif_name:txt&propagation_delay:u32

finder://pim/pim/0.1/reset_vif_propagation_delay?vif_name:txt

finder://pim/pim/0.1/get_vif_override_interval?vif_name:txt->override_interval:u32

finder://pim/pim/0.1/set_vif_override_interval?vif_name:txt&override_interval:u32

finder://pim/pim/0.1/reset_vif_override_interval?vif_name:txt

finder://pim/pim/0.1/get_vif_is_tracking_support_disabled?vif_name:txt->is_tracking_support_disabled:bool

finder://pim/pim/0.1/set_vif_is_tracking_support_disabled?vif_name:txt&is_tracking_support_disabled:bool

finder://pim/pim/0.1/reset_vif_is_tracking_support_disabled?vif_name:txt

finder://pim/pim/0.1/get_vif_accept_nohello_neighbors?vif_name:txt->accept_nohello_neighbors:bool

finder://pim/pim/0.1/set_vif_accept_nohello_neighbors?vif_name:txt&accept_nohello_neighbors:bool

finder://pim/pim/0.1/reset_vif_accept_nohello_neighbors?vif_name:txt

/**
 *  Configure PIM Join/Prune-related metrics. The 'set_foo' XRLs set the
 *  particular values. The 'reset_foo' XRLs reset the metrics to their default
 *  values.
 *
 *  @param vif_name the name of the vif to configure.
 *
 *  @param join_prune_period the period between Join/Prune messages.
 */
finder://pim/pim/0.1/get_vif_join_prune_period?vif_name:txt->join_prune_period:u32

finder://pim/pim/0.1/set_vif_join_prune_period?vif_name:txt&join_prune_period:u32

finder://pim/pim/0.1/reset_vif_join_prune_period?vif_name:txt

/**
 *  Configure SPT-switch threshold. The 'set_foo' XRLs set the particular
 *  values. The 'reset_foo' XRLs reset the metrics to their default values.
 *
 *  @param is_enabled if true, enable SPT-switch, otherwise disable it.
 *
 *  @param interval_sec if the SPT-switch is enabled, the interval (in number
 *  of seconds) to measure the bandwidth to consider whether to switch to the
 *  SPT.
 */
finder://pim/pim/0.1/get_switch_to_spt_threshold->is_enabled:bool&interval_sec:u32&bytes:u32

finder://pim/pim/0.1/set_switch_to_spt_threshold?is_enabled:bool&interval_sec:u32&bytes:u32

finder://pim/pim/0.1/reset_switch_to_spt_threshold

/**
 *  Add or delete an alternative subnet on a PIM vif. An alternative subnet is
 *  used to make incoming traffic with a non-local source address appear as it
 *  is coming from a local subnet. Note: add alternative subnets with extreme
 *  care, only if you know what you are really doing!
 *
 *  @param vif_name the name of the vif to add or delete an alternative subnet.
 *
 *  @param subnet the subnet address to add or delete.
 */
finder://pim/pim/0.1/add_alternative_subnet4?vif_name:txt&subnet:ipv4net

finder://pim/pim/0.1/add_alternative_subnet6?vif_name:txt&subnet:ipv6net

finder://pim/pim/0.1/delete_alternative_subnet4?vif_name:txt&subnet:ipv4net

finder://pim/pim/0.1/delete_alternative_subnet6?vif_name:txt&subnet:ipv6net

finder://pim/pim/0.1/remove_all_alternative_subnets?vif_name:txt

/**
 *  Enable/disable the PIM trace log for all operations.
 *
 *  @param enable if true, then enable the trace log, otherwise disable it.
 */
finder://pim/pim/0.1/log_trace_all?enable:bool

/**
 *  Test-related methods: add Join/Prune entries, and send them to a neighbor.
 */
finder://pim/pim/0.1/add_test_jp_entry4?source_addr:ipv4&group_addr:ipv4&group_mask_len:u32&mrt_entry_type:txt&action_jp:txt&holdtime:u32&is_new_group:bool

finder://pim/pim/0.1/add_test_jp_entry6?source_addr:ipv6&group_addr:ipv6&group_mask_len:u32&mrt_entry_type:txt&action_jp:txt&holdtime:u32&is_new_group:bool

finder://pim/pim/0.1/send_test_jp_entry4?vif_name:txt&nbr_addr:ipv4

finder://pim/pim/0.1/send_test_jp_entry6?vif_name:txt&nbr_addr:ipv6

/**
 *  Test-related methods: send an Assert message on an interface.
 *
 *  @param vif_name the name of the vif to send the Assert on.
 *
 *  @param source_addr the source address inside the Assert message.
 *
 *  @param group_addr the group address inside the Assert message.
 *
 *  @param rpt_bit the RPT-bit inside the Assert message.
 *
 *  @param metric_preference the metric preference inside the Assert message.
 *
 *  @param metric the metric inside the Assert message.
 */
finder://pim/pim/0.1/send_test_assert4?vif_name:txt&source_addr:ipv4&group_addr:ipv4&rpt_bit:bool&metric_preference:u32&metric:u32

finder://pim/pim/0.1/send_test_assert6?vif_name:txt&source_addr:ipv6&group_addr:ipv6&rpt_bit:bool&metric_preference:u32&metric:u32