UNPKG

@itentialopensource/adapter-ciena_mcp

Version:

This adapter integrates with system described as: Ciena Mcp

519 lines 17.1 kB
{ "$id": "schema.json", "type": "object", "schema": "http://json-schema.org/draft-07/schema#", "translate": true, "dynamicfields": true, "properties": { "ph_request_type": { "type": "string", "description": "type of request (internal to adapter)", "default": "getAllFilters", "enum": [ "getAllFilters", "createFilter", "getNsaApiV20AlarmsFilterActiveAlarmCounts", "searchActiveAlarmsV2", "getAdditionalTexts", "getDeviceNames", "searchFilteredAlarms", "searchFilteredAlarmsWithBody", "getFilteredAlarm", "searchCorrelatedAlarms", "searchHistoricalAlarmsV2", "getIpAddresses", "getMacAddresses", "getNativeConditionTypes", "getResources", "getSubnetNames", "deleteFilter" ], "external_name": "ph_request_type" }, "filterSeverity": { "type": "string", "description": "Severity values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... **Example**: _CRITICAL,MAJOR,MINOR,W...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[severity]" }, "filterServiceAffecting": { "type": "string", "description": "Service affecting values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... **Example**: _SERVICE_AFFEC...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[serviceAffecting]" }, "filterDeviceType": { "type": "string", "description": "Device type values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... **Example**: _6500,OPENSTACK,NUAG...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[deviceType]" }, "filterAcknowledgeState": { "type": "array", "description": "Acknowledgment state values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... **Example**: _ACKNOWLEDG...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[acknowledgeState][]" }, "filterDeviceId": { "type": "string", "description": "Device id values as a comma separated list. **Example**: _ID1,ID2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[deviceId]" }, "filterDeviceName": { "type": "string", "description": "Case sensitive device name values as a comma separated list. **Example**: _NAME1,NAME2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[deviceName]" }, "filterIpAddress": { "type": "string", "description": "Partial IP address filter value with a minimum of 3 characters. **Example**: _192.168_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[ipAddress]" }, "filterMacAddress": { "type": "string", "description": "Partial MAC address filter value with a minimum of 3 characters. **Example**: _00-04-DC_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[macAddress]" }, "filterAdditionalText": { "type": "string", "description": "Additional text values as a comma separated list. **Example**: _TEXT1,TEXT2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[additionalText]" }, "filterAnnotation": { "type": "array", "description": "Annotation text values as a comma separated list. **Example**: _ANNOTATION1,ANNOTATION2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[annotation][]" }, "filterNativeConditionType": { "type": "string", "description": "Partial native condition type filter value with a minimum of 3 characters. **Example**: _TEX_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[nativeConditionType]" }, "filterResource": { "type": "string", "description": "Partial resource filter value with a minimum of 1 character. **Example**: _RES_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[resource]" }, "filterSubnetName": { "type": "string", "description": "Partial case sensitive subnet name filter value with a minimum of 3 characters. **Example**: _NAME1_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[subnetName]" }, "filterCardType": { "type": "string", "description": "Card type values as a comma separated list. **Example**: _SP-2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[cardType]" }, "filterClfi": { "type": "string", "description": "CLFI values as a comma separated list. **Example**: _CLFI01,CLFI02_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[clfi]" }, "filterFic": { "type": "string", "description": "FIC values as a comma separated list. **Example**: _FIC01,FIC02_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[fic]" }, "filterKeytext": { "type": "string", "description": "Key text, minimum 3 characters, to be present in the supported alarm fields. Supported fields include: _condition-severity, device-name, device-long-name, resource, ackno...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[keytext]" }, "filterLastRaisedTime": { "type": "string", "description": "Comma separated last raised time range in the format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Exam...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[lastRaisedTime]" }, "selectedAdditionalText": { "type": "array", "description": "Additional text values as a comma separated list. **Example**: _TEXT1,TEXT2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[additionalText][]" }, "filterContextState": { "type": "array", "description": "State values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... Results outside of this range will not ...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[contextState][]" }, "filterClearTime": { "type": "string", "description": "Comma separated clear time range in format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Example**: _19...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[clearTime]" }, "selectedDeviceName": { "type": "array", "description": "Case sensitive device name values as a comma separated list. **Example**: _NAME1,NAME2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[deviceName][]" }, "filterAlarmId": { "type": "array", "description": "Alarm id values as a comma separated list. **Example**: _ID1,ID2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[alarmId][]" }, "filterState": { "type": "array", "description": "State values as a comma separated list or in new lines. The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ... Results outside of this range will not ...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[state][]" }, "filterDeviceTag": { "type": "array", "description": "Device tag values as a comma separated list. **Example**: _Tag1,Tag2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[deviceTag][]" }, "filterResourceList": { "type": "string", "description": "Resource values as a comma separated list. **Example**: _RESOURCE1,RESOURCE2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[resourceList]" }, "filterResourceId": { "type": "array", "description": "Resource ID values as a comma separated list. **Example**: _RESOURCEID1,RESOURCEID2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[resourceId][]" }, "filterPartition": { "type": "array", "description": "Partition values as a comma separated list. "none" for alarms of NEs with no partition **Example**: _a08a7792-27a5-42d3-9169-2826d3d32b0c,3541ccf8-03d2-3c0a-a7e5-3b88ca7...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[partition][]" }, "filterLastRaisedTimeFrom": { "type": "string", "description": "Last raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Example**...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[lastRaisedTimeFrom]" }, "filterLastRaisedTimeTo": { "type": "string", "description": "Last raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Example*...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[lastRaisedTimeTo]" }, "filterClearTimeFrom": { "type": "string", "description": "Last clear time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Example**:...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[clearTimeFrom]" }, "filterClearTimeTo": { "type": "string", "description": "Last clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown in the context aggregations meta. **Example**...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[clearTimeTo]" }, "sort": { "type": "array", "description": "Alarm attribute that the response will be sorted on such as _raiseTime_, either in ascending (ASC) or descending (DESC) order. Values can be provided as a comma separated...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "sort[]" }, "filterRefinedRaisedTimeFrom": { "type": "string", "description": "Refined raised time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_. **Example**: _1900-01-01T00:00:00.000_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[refinedRaisedTimeFrom]" }, "filterRefinedRaisedTimeTo": { "type": "string", "description": "Refined raised time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_. **Example**: _2999-12-31T23:59:59.999_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[refinedRaisedTimeTo]" }, "filterRefinedClearTimeFrom": { "type": "string", "description": "Refined cleared time to be searched after in format: _yyyy-MM-ddTHH:mm:ss.SSS_. **Example**: _1900-01-01T00:00:00.000_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[refinedClearTimeFrom]" }, "filterRefinedClearTimeTo": { "type": "string", "description": "Refined clear time to be searched before in format: _yyyy-MM-ddTHH:mm:ss.SSS_. **Example**: _2999-12-31T23:59:59.999_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[refinedClearTimeTo]" }, "filterAllTime": { "type": "string", "description": "Comma separated time range to be searched in both active and historical alarms, in the format: _yyyy-MM-ddTHH:mm:ss.SSS_. Results outside of this range will not be shown ...(description truncated)", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "filter[allTime]" }, "id": { "type": "string", "description": "Requested alarm identifier.", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "Id" }, "selectedIpAddress": { "type": "array", "description": "IP address values as a comma separated list. **Example**: _192.168.42.2,192.168.42.3_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[ipAddress][]" }, "selectedMacAddress": { "type": "array", "description": "Case sensitive MAC address values as a comma separated list. **Example**: _00-04-DC-01-02-03, 00-04-DC-01-02-04_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[macAddress][]" }, "selectedNativeConditionType": { "type": "array", "description": "Native condition type values as a comma separated list. **Example**: _TYPE1,TYPE2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[nativeConditionType][]" }, "selectedResource": { "type": "array", "description": "Resource values as a comma separated list. **Example**: _RESOURCE1,RESOURCE2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[resource][]" }, "selectedSubnetName": { "type": "array", "description": "Case sensitive subnet name values as a comma separated list. **Example**: _NAME1,NAME2_", "parse": false, "encode": false, "encrypt": { "type": "AES", "key": "" }, "external_name": "selected[subnetName][]" } }, "definitions": {} }