Resource - DSCRoutingSearchUtility
About this Resource
Defines an DSCRoutingSearchUtility managed object.
REST API Methods for this Resource
- GET DSCRoutingSearchUtility
- PUT DSCRoutingSearchUtility
- PUT DSCRoutingSearchUtility - action ClearSearchCriteria
- PUT DSCRoutingSearchUtility - action PerformSearch
Resource Schema
Configuration
| Parameter Name | Required | Create | Read-Only | Data Type | Description |
|---|---|---|---|---|---|
| DSCNodeName | No | No | No | string | Name used to logically identify the DSC Node. The attribute is mandatory and is used to identify the DSC Node where the routing search is performed. The Node Name value must be defined on the DSC instance of the Search Utility. TL1Name: NODE_NAME |
| RequestIncomingADNName | No | No | No | string | Incoming Adjacent Diameter Node Name for Request Message. The attribute is mandatory and is used to identify the Request Message DSC Incoming ADN where the TEST message is received. For Answer Test Message, this represents the incoming ADN of the original Request Message. The ADN DID value must be defined on the input DSC Node and must have at least one connection. TL1Name: REQUEST_INC_ADN_NAME |
| AnswerIncomingADNName | No | No | No | string | Incoming Adjacent Diameter Node Name for Answer Message. The attribute is mandatory for Answer Message but is not required for REQUEST Message. It is used to identify the Answer Message Incoming ADN where the TEST message is received. The ADN DID value must be defined on the input DSC Node diameter ID and must have at least one connection. TL1Name: ANSWER_INC_ADN_NAME |
| InitialRoutingTableName | No | No | No | string | Initial Routing Table Name to Test. The Test Message will be routed starting from this routing table. The Initial Routing Table Name must be defined on the search interface instance routing table. If not supplied, it will use the Initial Routing Table Name of the input node for Request message. For Answer message, this will return INVALID INPUT result TL1Name: TEST_ROUTING_TABLE |
| Result | No | No | Yes | string | Routing Test Result of the message (MESSAGE TESTED SUCCESSFULLY, RETURN ERROR, DISCARD MESSAGE, INVALID INPUT, MESSAGE TESTED NOT COMPLETED). TL1Name: OUTPUT_DSC_RESULT |
| DiagnosticMessage | No | No | Yes | string | The Diagnostic Message will display the header of the test message for user to confirm the test message content. It will also capture the message path of the test message. if an error is detected in the search criteria, this will alert the user on what is specifically wrong with the data. TL1Name: DIAGNOSTIC_MESSAGE |
Overview
Content Tools