generic
IncrementalContext


This structure is used to configure the generic.GenericObject.triggerIncrementalRequest() method.


public struct IncrementalContext

Properties
jmsClientId This is JMS client ID. If this is set then events are only send to this JMS client. Otherwise events are broadcast to all JMS clients. The format is String@number

type=string

handlerName The name of the application handler to run.

type=string

Valid Values:

    RE_EVAL_MSAPS_ON_MSAP_POLICY
    This action is used to issue a request to re-evaluate all the MSAPs that are based on a msappolicy.Policy.
    Expected results:
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with a boolean as the payload to indicate the success status of the action.

    ACL_RADIUS_FILTERENTRY_RESYNC

    MOVE_SITES
    Incrementally moves a set of sites.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of service.ResultType
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    STATIC_PORT_FORWARDING_SYNC
    This action is used to issue a request to sync a list of SPF (STATIC PORT FORWARDING) to the given node and routing instance
    Expected results:
    • If the action failed for any SPF entry, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with the list of FilterEntries as the payload.

    ARP_HOST_RESYNC
    This action is used to retrieve ARP hosts.
    Expected results:
    • In case of success, an event is sent with a payload of arp.ArpHost.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    MPR_SEPARATE_TOPOLOGIES
    This action is used to perform the separation of Backhaul Sites under a Backhual Service based on the site's Topology ID.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of , containing a partial result of the separation operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    HOST_TRACKING_INFO_RESYNC_PER_SUBSCRIBER
    This action is used to retrieve host tracking info per subscriber instance.
    Expected results:
    • In case of success, an event is sent with a payload of ressubscr.HostTrackingInfoPerSubscriber.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    ACL_CREDIT_CONTROL_FILTERENTRY_RESYNC

    SERVICE_SITE_COPY_MOVE
    This action is used to perform a Service Site Copy/Move based on the input parameters, e.g. source node and port, destination node and port, service type, etc.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of service.SvcCopyMoveIncrementResult, containing a partial result of the copy/move operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    The complete results is contained in the union of all instances service.SvcCopyMoveIncrementResult in the incremental events.

    REDISOCOVER_COMPOSITE_SERVICES
    Incrementally rediscovers composite services.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of service.RediscoverResult, containing a partial result of the discovery operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    The complete results of the discovery is contained in the union of all instances service.RediscoverResult in the incremental events.

    RESYNC_WLAN_GW_SOFTGRETUNNEL_TABLE
    This action is used to issue a request to resync from the network the WLAN Gateway Soft GRE Tunnel table: tmnxWlanGwSoftGreTuTable.
    Expected results:
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with a boolean as the payload to indicate the success status of the action.

    RESYNC_L2TP_TUNNELSTATUS_TABLE
    This action is used to issue a request to resync from the network the L2TP Tunnel Status table: tmnxL2tpTuStatusEntry.
    Expected results:
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with a boolean as the payload to indicate the success status of the action.

    GEN_COMPARE_OBJECTS
    Incrementally compares two objects for differences.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of generic.CompareResult, containing a partial result of the compare operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    The complete results of the compare is contained in the union of all instances generic.CompareResult in the incremental events.

    HOST_TRACKING_INFO_RESYNC_PER_SAP
    This action is used to retrieve host tracking info per SAP.
    Expected results:
    • In case of success, an event is sent with a payload of ressubscr.HostTrackingInfoPerSap.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    RESYNC_L2AWARE_SUBSCRIBER_TABLE
    This action is used to issue a request to resync from the network the NAT L2 Aware Subscriber table: tmnxNatL2AwSubEntry.
    Expected results:
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with a boolean as the payload to indicate the success status of the action.

    CAC_SYS_AUDIT
    Incrementally performs a system wide CAC Audit.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of cac.SysAuditResult, containing a partial result of the audit operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    The complete results of the audit is contained in the union of all instances cac.SysAuditResult in the incremental events.

    MPR_CONNECT_SERVICE
    This action is used to perform the connection of Backhaul Services to determine topology correctness.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of , containing a partial result of the connect operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    LI_HOST_RADIUS_RESYNC
    This action is used to retrieve information of LI source subscriber host activated via RADIUS.
    Expected results:
    • In case of success, an event is sent with a payload of mirrorli.LISubHostRadius.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    RE_EVAL_PWTEMPLATE_POLICY
    This action is used to issue a request to re-evaluate all the VPLS that are based on a PWTemplate.Policy.
    Expected results:
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    • After the action finished, an event will be sent back with a boolean as the payload to indicate the success status of the action.

    RESYNC_SECURITY_POLICY_ZONEOUTBOUNDSESSIONS_TABLE
    This action is used to issue a request to resync from the network the Zone Inbound Sessions table: aluZoneInboundSessionEntry.
    HOST_TRACKING_STATUS_RESYNC
    This action is used to retrieve host tracking status.
    Expected results:
    • In case of success, an event is sent with a payload of ressubscr.HostTrackingStatus.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    ETH_RING_AUDIT
    Incrementally performs a Global Ethernet Ring Audit.
    Expected results:
    • A start message is sent with no payload.
    • Incremental messages are sent with a payload of the element FDN currently being considered.
    • An end message is sent with no payload.
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    SVC_CAC_BW_KBPS
    This action is used to issue a request convert all CAC BW units to KBPS.
    Expected results:
    • A start message is sent with no payload
    • Incremental messages are sent with a payload of cac.SvcConvertCacBwKbpsResult, containing a partial result of the audit operation
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.
    The complete results of the Coversion is contained in the union of all instances cac.SvcConvertCacBwKbpsResult in the incremental events.

    DISCOVER_SERVICE_TUNNELS
    Incrementally discover service tunnels for a service or a composite service.
    Expected results:
    • A start message is sent with no payload
    • An end message is sent with no payload
    • If the action failed for any reason, an event will be sent back with a TiException as the payload.

    RESYNC_SECURITY_POLICY_ZONEINBOUNDSESSIONS_TABLE
    This action is used to issue a request to resync from the network the Zone Inbound Sessions table: aluZoneInboundSessionEntry.
appDefinedContext Information for the handler.

type=Any

Valid Type For Each Handler:

    MOVE_SITES
    This structure encapsulates all the necessary parameters required to move service sites.
    type=generic.MoveServiceSitesStruct

    ACL_RADIUS_FILTERENTRY_RESYNC
    This string specifies the Object fullname of the IP/IPv6 required to retrieve RADIUS filter entries from the given Ip/IPv6 filter.
    type=string

    RESYNC_SECURITY_POLICY_ZONEOUTBOUNDSESSIONS_TABLE

    type=generic.ResyncZoneSessionsStruct

    RE_EVAL_PWTEMPLATE_POLICY
    The full name of the PW template should be passes in as the appDefinedContext.
    type=string

    ARP_HOST_RESYNC
    Reuse the struct for ARP host retrieval. The mandatory fields are siteID, serviceId, sapId, innerEncap, and outerEncap.
    type=pppoe.RetrievingSessionStruct

    MPR_SEPARATE_TOPOLOGIES
    This string specifies the fullname of the Backhaul Service to separate the topology for.
    type=string

    GEN_COMPARE_OBJECTS
    Specifies the parameters used in the compare operation.
    type=generic.ComparisonParam

    ACL_CREDIT_CONTROL_FILTERENTRY_RESYNC
    This string specifies the Object fullname of the IP/IPv6 filter required to retrieve Credit Control entries from the given IP/IPv6 filter.
    type=string

    CAC_SYS_AUDIT
    N/A

    SERVICE_SITE_COPY_MOVE

    type=service.SvcCopyMoveInput

    HOST_TRACKING_INFO_RESYNC_PER_SAP
    The full name of the service.AccessInterface should be passed in as the appDefinedContext.
    type=string

    RESYNC_L2TP_TUNNELSTATUS_TABLE
    A string list, containing the System Address of the NE to be resync, and the Virtual Routing Instance where the tunnels are created should be passed in as the appDefinedContext.
    type=generic.ResyncTunnelStatusStruct

    ETH_RING_AUDIT
    N/A

    HOST_TRACKING_INFO_RESYNC_PER_SUBSCRIBER
    The full name of the ressubscr.ResidentialSubscriberInstance should be passed in as the appDefinedContext.
    type=string

    SVC_CAC_BW_KBPS
    N/A

    HOST_TRACKING_STATUS_RESYNC
    The full name of the ressubscr.ResidentialSubscriberInstance should be passed in as the appDefinedContext.
    type=string

    STATIC_PORT_FORWARDING_SYNC
    A struct contains 1. the sync target, which is a routing instance full name 2. A map that contains the pairs of full name of the SPF to be resynced and the new timeout.
    type=generic.SpfSyncRequest

    RESYNC_SECURITY_POLICY_ZONEINBOUNDSESSIONS_TABLE

    type=generic.ResyncZoneSessionsStruct

    MPR_CONNECT_SERVICE

    type=mpr.ConnectSvcInput

    RE_EVAL_MSAPS_ON_MSAP_POLICY
    The full name of the msappolicy.Policy should be passed in as the appDefinedContext.
    type=string

    LI_HOST_RADIUS_RESYNC
    This structure encapsulates all the necessary parameters required to retrieve LISubHostRadius. The siteId and mirrorSvcId are mandatory. The timeOut is optional. The default timeOut is 5 minutes.
    type=mirrorli.LISubHostRadiusRtrvStruct

    DISCOVER_SERVICE_TUNNELS
    This structure encapsulates all the necessary parameters required to discover service tunnels
    type=generic.DiscoverServiceTunnelsStruct

    REDISOCOVER_COMPOSITE_SERVICES
    There are three values 0 - Rediscover the Spoke, CCAG, SCP, RVPLS connectors 1 - Rediscover the Route Target connections
    type=int

    RESYNC_WLAN_GW_SOFTGRETUNNEL_TABLE
    A string list, containing the System Address of the NE to be resync, and the Virtual Routing Instance where the tunnels are created should be passed in as the appDefinedContext.
    type=generic.ResyncSoftGreTunnelsStruct

    RESYNC_L2AWARE_SUBSCRIBER_TABLE
    It contains siteId.
    type=nat.ResyncL2AwSubscribersStruct