{ "openapi": "3.0.0", "info": { "title": "CISCO-IPSLA-ECHO-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines the templates for IP SLA operations of\n ICMP echo, UDP echo and TCP connect.\n \n The ICMP echo operation measures end-to-end response time between \n a Cisco router and any IP enabled device by computing the time\n taken between sending an ICMP echo request message to the \n destination and receiving an ICMP echo reply.\n \n \n The UDP echo operation measures end-to-end response time between \n a Cisco router and any IP enabled device by computing the time\n taken between sending an UDP echo request message to the \n destination and receiving an UDP echo reply.\n \n The TCP connect operation measures end-to-end response time between \n a Cisco router and any IP enabled device by computing the time\n taken to perform a TCP connect operation.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-IPSLA-ECHO-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IPSLA-ECHO-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IPSLA-ECHO-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplTable": { "get": { "summary": "Get cipslaIcmpEchoTmplTable data", "description": "Retrieve cipslaIcmpEchoTmplTable operational data from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that contains ICMP echo template definitions.", "properties": { "cipslaIcmpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplTable": { "cipslaIcmpEchoTmplEntry": [ { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" }, { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" }, { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpEchoTmplTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaIcmpEchoTmplTable", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplTable/cipslaIcmpEchoTmplEntry": { "get": { "summary": "Get cipslaIcmpEchoTmplEntry list", "description": "Retrieve list of cipslaIcmpEchoTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry": [ { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpEchoTmplEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaIcmpEchoTmplTable/cipslaIcmpEchoTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplTable/cipslaIcmpEchoTmplEntry={cipslaIcmpEchoTmplName}": { "get": { "summary": "Get cipslaIcmpEchoTmplEntry entry", "description": "Retrieve specific cipslaIcmpEchoTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaIcmpEchoTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry": { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpEchoTmplEntry-2" }, "x-yang-path": "/cipslaIcmpEchoTmplTable/cipslaIcmpEchoTmplEntry={cipslaIcmpEchoTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaIcmpEchoTmplName" ] }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplTable": { "get": { "summary": "Get cipslaUdpEchoTmplTable data", "description": "Retrieve cipslaUdpEchoTmplTable operational data from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that contains UDP echo template specific definitions.", "properties": { "cipslaUdpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplTable": { "cipslaUdpEchoTmplEntry": [ { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" }, { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" }, { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpEchoTmplTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaUdpEchoTmplTable", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplTable/cipslaUdpEchoTmplEntry": { "get": { "summary": "Get cipslaUdpEchoTmplEntry list", "description": "Retrieve list of cipslaUdpEchoTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry": [ { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpEchoTmplEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaUdpEchoTmplTable/cipslaUdpEchoTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplTable/cipslaUdpEchoTmplEntry={cipslaUdpEchoTmplName}": { "get": { "summary": "Get cipslaUdpEchoTmplEntry entry", "description": "Retrieve specific cipslaUdpEchoTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaUdpEchoTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry": { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpEchoTmplEntry-2" }, "x-yang-path": "/cipslaUdpEchoTmplTable/cipslaUdpEchoTmplEntry={cipslaUdpEchoTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaUdpEchoTmplName" ] }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplTable": { "get": { "summary": "Get cipslaTcpConnTmplTable data", "description": "Retrieve cipslaTcpConnTmplTable operational data from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that contains TCP connect template specific definitions.", "properties": { "cipslaTcpConnTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplTable": { "cipslaTcpConnTmplEntry": [ { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" }, { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" }, { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaTcpConnTmplTable", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaTcpConnTmplTable", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplTable/cipslaTcpConnTmplEntry": { "get": { "summary": "Get cipslaTcpConnTmplEntry list", "description": "Retrieve list of cipslaTcpConnTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry": [ { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaTcpConnTmplEntry", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaTcpConnTmplTable/cipslaTcpConnTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplTable/cipslaTcpConnTmplEntry={cipslaTcpConnTmplName}": { "get": { "summary": "Get cipslaTcpConnTmplEntry entry", "description": "Retrieve specific cipslaTcpConnTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaTcpConnTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry": { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaTcpConnTmplEntry-2" }, "x-yang-path": "/cipslaTcpConnTmplTable/cipslaTcpConnTmplEntry={cipslaTcpConnTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaTcpConnTmplName" ] }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry": { "get": { "summary": "Get cipslaIcmpEchoTmplEntry list", "description": "Retrieve list of cipslaIcmpEchoTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry": [ { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpEchoTmplEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaIcmpEchoTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry={cipslaIcmpEchoTmplName}": { "get": { "summary": "Get cipslaIcmpEchoTmplEntry entry", "description": "Retrieve specific cipslaIcmpEchoTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaIcmpEchoTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaIcmpEchoTmplEntry": { "cipslaIcmpEchoTmplName": "192.168.1.1", "cipslaIcmpEchoTmplDescription": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddrType": "192.168.1.1", "cipslaIcmpEchoTmplSrcAddr": "192.168.1.1", "cipslaIcmpEchoTmplTimeOut": 0, "cipslaIcmpEchoTmplVerifyData": true, "cipslaIcmpEchoTmplReqDataSize": 0, "cipslaIcmpEchoTmplTOS": 0, "cipslaIcmpEchoTmplVrfName": "192.168.1.1", "cipslaIcmpEchoTmplThreshold": 0, "cipslaIcmpEchoTmplHistLives": 0, "cipslaIcmpEchoTmplHistBuckets": 0, "cipslaIcmpEchoTmplHistFilter": "192.168.1.1", "cipslaIcmpEchoTmplStatsHours": 0, "cipslaIcmpEchoTmplDistBuckets": 0, "cipslaIcmpEchoTmplDistInterval": 0, "cipslaIcmpEchoTmplStorageType": "192.168.1.1", "cipslaIcmpEchoTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpEchoTmplEntry-4" }, "x-yang-path": "/cipslaIcmpEchoTmplEntry={cipslaIcmpEchoTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaIcmpEchoTmplName" ] }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry": { "get": { "summary": "Get cipslaUdpEchoTmplEntry list", "description": "Retrieve list of cipslaUdpEchoTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry": [ { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpEchoTmplEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaUdpEchoTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry={cipslaUdpEchoTmplName}": { "get": { "summary": "Get cipslaUdpEchoTmplEntry entry", "description": "Retrieve specific cipslaUdpEchoTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaUdpEchoTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaUdpEchoTmplEntry": { "cipslaUdpEchoTmplName": "192.168.1.1", "cipslaUdpEchoTmplDescription": "192.168.1.1", "cipslaUdpEchoTmplControlEnable": true, "cipslaUdpEchoTmplSrcAddrType": "192.168.1.1", "cipslaUdpEchoTmplSrcAddr": "192.168.1.1", "cipslaUdpEchoTmplSrcPort": "192.168.1.1", "cipslaUdpEchoTmplTimeOut": 0, "cipslaUdpEchoTmplVerifyData": true, "cipslaUdpEchoTmplReqDataSize": 0, "cipslaUdpEchoTmplTOS": 0, "cipslaUdpEchoTmplVrfName": "192.168.1.1", "cipslaUdpEchoTmplThreshold": 0, "cipslaUdpEchoTmplHistLives": 0, "cipslaUdpEchoTmplHistBuckets": 0, "cipslaUdpEchoTmplHistFilter": "192.168.1.1", "cipslaUdpEchoTmplStatsHours": 0, "cipslaUdpEchoTmplDistBuckets": 0, "cipslaUdpEchoTmplDistInterval": 0, "cipslaUdpEchoTmplStorageType": "192.168.1.1", "cipslaUdpEchoTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpEchoTmplEntry-4" }, "x-yang-path": "/cipslaUdpEchoTmplEntry={cipslaUdpEchoTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaUdpEchoTmplName" ] }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry": { "get": { "summary": "Get cipslaTcpConnTmplEntry list", "description": "Retrieve list of cipslaTcpConnTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry": [ { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaTcpConnTmplEntry-3", "parameters": [ { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ] }, "x-yang-path": "/cipslaTcpConnTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry={cipslaTcpConnTmplName}": { "get": { "summary": "Get cipslaTcpConnTmplEntry entry", "description": "Retrieve specific cipslaTcpConnTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-ECHO-MIB" ], "parameters": [ { "name": "cipslaTcpConnTmplName", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router." }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number" }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size." }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded." }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-IPSLA-ECHO-MIB:cipslaTcpConnTmplEntry": { "cipslaTcpConnTmplName": "192.168.1.1", "cipslaTcpConnTmplDescription": "192.168.1.1", "cipslaTcpConnTmplControlEnable": true, "cipslaTcpConnTmplSrcAddrType": "192.168.1.1", "cipslaTcpConnTmplSrcAddr": "192.168.1.1", "cipslaTcpConnTmplSrcPort": "192.168.1.1", "cipslaTcpConnTmplTimeOut": 0, "cipslaTcpConnTmplVerifyData": true, "cipslaTcpConnTmplTOS": 0, "cipslaTcpConnTmplThreshold": 0, "cipslaTcpConnTmplHistLives": 0, "cipslaTcpConnTmplHistBuckets": 0, "cipslaTcpConnTmplHistFilter": "192.168.1.1", "cipslaTcpConnTmplStatsHours": 0, "cipslaTcpConnTmplDistBuckets": 0, "cipslaTcpConnTmplDistInterval": 0, "cipslaTcpConnTmplStorageType": "192.168.1.1", "cipslaTcpConnTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaTcpConnTmplEntry-4" }, "x-yang-path": "/cipslaTcpConnTmplEntry={cipslaTcpConnTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaTcpConnTmplName" ] } }, "components": { "schemas": { "CISCO-IPSLA-ECHO-MIB_CISCO-IPSLA-ECHO-MIB": { "type": "object", "description": "A table that contains ICMP echo template definitions.", "properties": { "cipslaIcmpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cipslaUdpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cipslaTcpConnTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cipslaIcmpEchoTmplTable": { "type": "object", "description": "A table that contains ICMP echo template definitions.", "properties": { "cipslaIcmpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cipslaUdpEchoTmplTable": { "type": "object", "description": "A table that contains UDP echo template specific definitions.", "properties": { "cipslaUdpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cipslaTcpConnTmplTable": { "type": "object", "description": "A table that contains TCP connect template specific definitions.", "properties": { "cipslaTcpConnTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IPSLA-ECHO-MIB_cipslaIcmpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA ICMP echo template.", "items": { "type": "object", "properties": { "cipslaIcmpEchoTmplName": { "type": "string", "description": "This field is used to specify the ICMP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplDescription": { "type": "string", "description": "This field is used to provide description for the ICMP echo\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for a IP SLA operation\n completion. \n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaIcmpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' IP SLA request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaIcmpEchoTmplHistFilter is\n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value is set to the number of operations \n to keep per lifetime.\n \n After cipslaIcmpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaIcmpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaIcmpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaIcmpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaIcmpEchoTmplStatsNumDistBucket will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpEchoTmplDistBuckets = 5 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaIcmpEchoTmplDistBuckets = 1 buckets\n cipslaIcmpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpEchoTmplDistInterval does not apply when\n cipslaIcmpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP echo template control row.\n When the status is active, all the read-create objects in that \n row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-IPSLA-ECHO-MIB_cipslaUdpEchoTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP echo template.", "items": { "type": "object", "properties": { "cipslaUdpEchoTmplName": { "type": "string", "description": "A string which specifies the UDP echo template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplDescription": { "type": "string", "description": "A string which provides description to the UDP echo template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaUdpEchoTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpEchoTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpEchoTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpEchoTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaUdpEchoTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaUdpEchoTmplReqDataSize": { "type": "integer", "description": "This object represents the number of octets to be\n placed into the ARR Data portion of the request\n message, when using SNA protocols.\n \n For non-ARR protocols' RTT request/responses,\n this value represents the native payload size.\n \n REMEMBER: The ARR Header overhead is not included\n in this value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name with\n which the IP SLA operation will be used. For regular IP SLA\n operation this field should not be configured. The agent\n will use this field to identify the VRF routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpEchoTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaUdpEchoTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaUdpEchoTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaUdpEchoTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaUdpEchoTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaUdpEchoTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaUdpEchoTmplStatsNumDistBuckets will be kept.\n \n The last cipslaUdpEchoTmplStatsNumDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpEchoTmplDistBuckets = 5 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaUdpEchoTmplDistBuckets = 1 buckets\n cipslaUdpEchoTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpEchoTmplDistInterval does not apply when\n cipslaUdpEchoTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpEchoTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpEchoTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP echo template control row.\n When the status is active, all the read-create objects in \n that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-IPSLA-ECHO-MIB_cipslaTcpConnTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA TCP connect template.", "items": { "type": "object", "properties": { "cipslaTcpConnTmplName": { "type": "string", "description": "A string which specifies the TCP connect template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplDescription": { "type": "string", "description": "A string which provides description for the TCP connect template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaTcpConnTmplControlEnable": { "type": "boolean", "description": "If this object is enabled, then the IP SLA application\n will send control messages to a responder, residing on the\n target router to respond to the data request packets being\n sent by the source router.", "readOnly": true }, "cipslaTcpConnTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaTcpConnTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaTcpConnTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaTcpConnTmplSrcPort": { "type": "string", "description": "This object represents the source's port number. If this\n object is not specified, the application will get a\n port allocated by the system.", "format": "inet:port-number", "readOnly": true }, "cipslaTcpConnTmplTimeOut": { "type": "integer", "description": "Specifies the duration to wait for an IP SLA operation\n completion.\n \n For connection oriented protocols, this may cause the\n connection to be closed by the operation. Once closed, it\n will be assumed that the connection reestablishment\n will be performed. To prevent unwanted closure of\n connections, be sure to set this value to a realistic\n connection timeout.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplVerifyData": { "type": "boolean", "description": "When set to true, the resulting data in each IP SLA\n operation is compared with the expected data. This\n includes checking header information (if possible) and\n exact packet size.", "readOnly": true }, "cipslaTcpConnTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit and if the\n condition specified in cipslaTcpConnTmplHistFilter is \n satisfied, one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistLives": { "type": "integer", "description": "The maximum number of history lives to record. A life\n is defined by the countdown (or transition) to zero \n by the cipslaAutoGroupScheduleLife object. A new life is\n created when the same conceptual control row is\n restarted via the transition of the \n cipslaAutoGroupScheduleLife object and its subsequent \n countdown.\n \n The value of zero will shut off all data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistBuckets": { "type": "integer", "description": "The maximum number of history buckets to record.\n This value should be set to the number of operations \n to keep per lifetime.\n \n After cipslaTcpConnTmplHistBuckets are filled, the \n oldest entries are deleted and the most recent\n cipslaTcpConnTmplHistBuckets buckets are retained.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplHistFilter": { "type": "string", "description": "Defines a filter for adding RTT results to the history\n buffer:\n \n none(1) - no history is recorded\n all(2) - the results of all completion times \n and failed completions are recorded\n overThreshold(3) - the results of completion times\n over cipslaTcpConnTmplThreshold are \n recorded.\n failures(4) - the results of failed operations (only) \n are recorded.", "readOnly": true }, "cipslaTcpConnTmplStatsHours": { "type": "integer", "description": "The maximum number of hours for which statistics are\n maintained. Specifically this is the number of hourly \n groups to keep before rolling over.\n \n The value of one is not advisable because the hourly\n group will close and immediately be deleted before\n the network management station will have the\n opportunity to retrieve the statistics.\n \n The value of zero will shut off data collection.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistBuckets": { "type": "integer", "description": "The maximum number of statistical distribution\n buckets to accumulate.\n \n Since this index does not rollover, only the first\n cipslaTcpConnTmplDistBuckets will be kept.\n \n The last cipslaTcpConnTmplDistBuckets will\n contain all entries from its distribution interval\n start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaTcpConnTmplDistBuckets = 5 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5 |\n | 0-9 ms | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |\n \n Odd Example:\n \n cipslaTcpConnTmplDistBuckets = 1 buckets\n cipslaTcpConnTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaTcpConnTmplDistInterval does not apply when\n cipslaTcpConnTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaTcpConnTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaTcpConnTmplRowStatus": { "type": "string", "description": "The status of the conceptual tcp connect control row.\n When the status is active, all the read-create objects \n in that row can be modified.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-IPSLA-ECHO-MIB", "description": "MIB operations for CISCO-IPSLA-ECHO-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }