{ "openapi": "3.0.0", "info": { "title": "CISCO-IPSLA-JITTER-MIB MIB API", "version": "1.0.0", "description": "This MIB module defines templates for IP SLA operations of UDP\n Jitter and ICMP Jitter. \n \n The UDP Jitter operation is designed to measure the delay \n variance and packet loss in IP networks by generating synthetic \n UDP traffic. \n \n The ICMP Jitter operation provides capability to measure metrics \n such as RTT (Round Trip Time), jitter, packet loss, one-way \n latency by sending ICMP Timestamp stream to the destination \n devices.\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-JITTER-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IPSLA-JITTER-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IPSLA-JITTER-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-JITTER-MIB:cipslaUdpJitterTmplTable": { "get": { "summary": "Get cipslaUdpJitterTmplTable data", "description": "Retrieve cipslaUdpJitterTmplTable operational data from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that contains UDP jitter template specific definitions.", "properties": { "cipslaUdpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplControlEnable": { "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." }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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." }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType" }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpJitterTmplSrcPort": { "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" }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds." }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority." }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value." }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB:cipslaUdpJitterTmplTable": { "cipslaUdpJitterTmplEntry": [ { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" }, { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" }, { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpJitterTmplTable", "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": "/cipslaUdpJitterTmplTable", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaUdpJitterTmplTable/cipslaUdpJitterTmplEntry": { "get": { "summary": "Get cipslaUdpJitterTmplEntry list", "description": "Retrieve list of cipslaUdpJitterTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplControlEnable": { "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." }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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." }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType" }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpJitterTmplSrcPort": { "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" }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds." }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority." }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value." }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB:cipslaUdpJitterTmplEntry": [ { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpJitterTmplEntry", "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": "/cipslaUdpJitterTmplTable/cipslaUdpJitterTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaUdpJitterTmplTable/cipslaUdpJitterTmplEntry={cipslaUdpJitterTmplName}": { "get": { "summary": "Get cipslaUdpJitterTmplEntry entry", "description": "Retrieve specific cipslaUdpJitterTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "parameters": [ { "name": "cipslaUdpJitterTmplName", "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": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplControlEnable": { "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." }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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." }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType" }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpJitterTmplSrcPort": { "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" }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds." }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority." }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value." }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB:cipslaUdpJitterTmplEntry": { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpJitterTmplEntry-2" }, "x-yang-path": "/cipslaUdpJitterTmplTable/cipslaUdpJitterTmplEntry={cipslaUdpJitterTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaUdpJitterTmplName" ] }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaIcmpJitterTmplTable": { "get": { "summary": "Get cipslaIcmpJitterTmplTable data", "description": "Retrieve cipslaIcmpJitterTmplTable operational data from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table that contains ICMP jitter template specific definitions.", "properties": { "cipslaIcmpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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." }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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-JITTER-MIB:cipslaIcmpJitterTmplTable": { "cipslaIcmpJitterTmplEntry": [ { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" }, { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" }, { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpJitterTmplTable", "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": "/cipslaIcmpJitterTmplTable", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaIcmpJitterTmplTable/cipslaIcmpJitterTmplEntry": { "get": { "summary": "Get cipslaIcmpJitterTmplEntry list", "description": "Retrieve list of cipslaIcmpJitterTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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." }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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-JITTER-MIB:cipslaIcmpJitterTmplEntry": [ { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpJitterTmplEntry", "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": "/cipslaIcmpJitterTmplTable/cipslaIcmpJitterTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaIcmpJitterTmplTable/cipslaIcmpJitterTmplEntry={cipslaIcmpJitterTmplName}": { "get": { "summary": "Get cipslaIcmpJitterTmplEntry entry", "description": "Retrieve specific cipslaIcmpJitterTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "parameters": [ { "name": "cipslaIcmpJitterTmplName", "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": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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." }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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-JITTER-MIB:cipslaIcmpJitterTmplEntry": { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpJitterTmplEntry-2" }, "x-yang-path": "/cipslaIcmpJitterTmplTable/cipslaIcmpJitterTmplEntry={cipslaIcmpJitterTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaIcmpJitterTmplName" ] }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaUdpJitterTmplEntry": { "get": { "summary": "Get cipslaUdpJitterTmplEntry list", "description": "Retrieve list of cipslaUdpJitterTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplControlEnable": { "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." }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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." }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType" }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpJitterTmplSrcPort": { "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" }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds." }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority." }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value." }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB:cipslaUdpJitterTmplEntry": [ { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpJitterTmplEntry-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": "/cipslaUdpJitterTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaUdpJitterTmplEntry={cipslaUdpJitterTmplName}": { "get": { "summary": "Get cipslaUdpJitterTmplEntry entry", "description": "Retrieve specific cipslaUdpJitterTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "parameters": [ { "name": "cipslaUdpJitterTmplName", "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": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplControlEnable": { "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." }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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." }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType" }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaUdpJitterTmplSrcPort": { "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" }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds." }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority." }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value." }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB:cipslaUdpJitterTmplEntry": { "cipslaUdpJitterTmplName": "192.168.1.1", "cipslaUdpJitterTmplDescription": "192.168.1.1", "cipslaUdpJitterTmplControlEnable": true, "cipslaUdpJitterTmplTimeOut": 0, "cipslaUdpJitterTmplVerifyData": true, "cipslaUdpJitterTmplCodecType": "192.168.1.1", "cipslaUdpJitterTmplCodecInterval": 0, "cipslaUdpJitterTmplCodecPayload": 0, "cipslaUdpJitterTmplCodecNumPkts": 0, "cipslaUdpJitterTmplInterval": 0, "cipslaUdpJitterTmplNumPkts": 0, "cipslaUdpJitterTmplSrcAddrType": "192.168.1.1", "cipslaUdpJitterTmplSrcAddr": "192.168.1.1", "cipslaUdpJitterTmplSrcPort": "192.168.1.1", "cipslaUdpJitterTmplPrecision": "192.168.1.1", "cipslaUdpJitterTmplReqDataSize": 0, "cipslaUdpJitterTmplPktPriority": "192.168.1.1", "cipslaUdpJitterTmplTOS": 0, "cipslaUdpJitterTmplVrfName": "192.168.1.1", "cipslaUdpJitterTmplThreshold": 0, "cipslaUdpJitterTmplNTPTolAbs": 0, "cipslaUdpJitterTmplNTPTolPct": 0, "cipslaUdpJitterTmplNTPTolType": "192.168.1.1", "cipslaUdpJitterTmplIcpifFactor": 0, "cipslaUdpJitterTmplStatsHours": 0, "cipslaUdpJitterTmplDistBuckets": 0, "cipslaUdpJitterTmplDistInterval": 0, "cipslaUdpJitterTmplStorageType": "192.168.1.1", "cipslaUdpJitterTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaUdpJitterTmplEntry-4" }, "x-yang-path": "/cipslaUdpJitterTmplEntry={cipslaUdpJitterTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaUdpJitterTmplName" ] }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaIcmpJitterTmplEntry": { "get": { "summary": "Get cipslaIcmpJitterTmplEntry list", "description": "Retrieve list of cipslaIcmpJitterTmplEntry entries from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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." }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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-JITTER-MIB:cipslaIcmpJitterTmplEntry": [ { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpJitterTmplEntry-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": "/cipslaIcmpJitterTmplEntry", "x-restconf-kind": "container" }, "/data/CISCO-IPSLA-JITTER-MIB:cipslaIcmpJitterTmplEntry={cipslaIcmpJitterTmplName}": { "get": { "summary": "Get cipslaIcmpJitterTmplEntry entry", "description": "Retrieve specific cipslaIcmpJitterTmplEntry entry by key from MIB", "tags": [ "CISCO-IPSLA-JITTER-MIB" ], "parameters": [ { "name": "cipslaIcmpJitterTmplName", "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": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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." }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType" }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress" }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295 }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType" }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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-JITTER-MIB:cipslaIcmpJitterTmplEntry": { "cipslaIcmpJitterTmplName": "192.168.1.1", "cipslaIcmpJitterTmplDescription": "192.168.1.1", "cipslaIcmpJitterTmplTimeOut": 0, "cipslaIcmpJitterTmplVerifyData": true, "cipslaIcmpJitterTmplNumPkts": 0, "cipslaIcmpJitterTmplInterval": 0, "cipslaIcmpJitterTmplSrcAddrType": "192.168.1.1", "cipslaIcmpJitterTmplSrcAddr": "192.168.1.1", "cipslaIcmpJitterTmplTOS": 0, "cipslaIcmpJitterTmplVrfName": "192.168.1.1", "cipslaIcmpJitterTmplThreshold": 0, "cipslaIcmpJitterTmplStatsHours": 0, "cipslaIcmpJitterTmplDistBuckets": 0, "cipslaIcmpJitterTmplDistInterval": 0, "cipslaIcmpJitterTmplStorageType": "192.168.1.1", "cipslaIcmpJitterTmplRowStatus": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cipslaIcmpJitterTmplEntry-4" }, "x-yang-path": "/cipslaIcmpJitterTmplEntry={cipslaIcmpJitterTmplName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cipslaIcmpJitterTmplName" ] } }, "components": { "schemas": { "CISCO-IPSLA-JITTER-MIB_CISCO-IPSLA-JITTER-MIB": { "type": "object", "description": "A table that contains UDP jitter template specific definitions.", "properties": { "cipslaUdpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplControlEnable": { "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 }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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 }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType", "readOnly": true }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpJitterTmplSrcPort": { "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 }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds.", "readOnly": true }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority.", "readOnly": true }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value.", "readOnly": true }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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 }, "cipslaIcmpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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 }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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 }, "cipslaUdpJitterTmplTable": { "type": "object", "description": "A table that contains UDP jitter template specific definitions.", "properties": { "cipslaUdpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplControlEnable": { "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 }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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 }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType", "readOnly": true }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpJitterTmplSrcPort": { "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 }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds.", "readOnly": true }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority.", "readOnly": true }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value.", "readOnly": true }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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 }, "cipslaIcmpJitterTmplTable": { "type": "object", "description": "A table that contains ICMP jitter template specific definitions.", "properties": { "cipslaIcmpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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 }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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 } } }, "CISCO-IPSLA-JITTER-MIB_cipslaUdpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IPSLA UDP jitter template.", "items": { "type": "object", "properties": { "cipslaUdpJitterTmplName": { "type": "string", "description": "A string which specifies the UDP Jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplDescription": { "type": "string", "description": "A string which provides description of UDP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplControlEnable": { "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 }, "cipslaUdpJitterTmplTimeOut": { "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 }, "cipslaUdpJitterTmplVerifyData": { "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 }, "cipslaUdpJitterTmplCodecType": { "type": "string", "description": "Specifies the codec type to be used with UDP jitter operation.\n \n If codec-type is configured the following parameters cannot be \n configured.\n cipslaUdpJitterReqDataSize\n cipslaUdpJitterInterval\n cipslaUdpJitterNumPkts", "x-yang-type": "cisco-ipsla:IpSlaCodecType", "readOnly": true }, "cipslaUdpJitterTmplCodecInterval": { "type": "integer", "description": "This field represents the inter-packet delay between\n packets and is in milliseconds. This object is applicable\n only to UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecPayload": { "type": "integer", "description": "This object represents the number of octets that needs to be\n placed into the Data portion of the message. This value is\n used only for UDP jitter operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplCodecNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to\n be transmitted. This value is used only for UDP jitter \n operation which uses codec type.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaUdpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaUdpJitterTmplSrcAddr": { "type": "string", "description": "This field specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaUdpJitterTmplSrcPort": { "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 }, "cipslaUdpJitterTmplPrecision": { "type": "string", "description": "This object specifies the accuracy of jitter statistics in\n rttMonJitterStatsTable that needs to be calculated.\n milliseconds(1) - The accuracy of stats will be of milliseconds.\n microseconds(2) - The accuracy of stats will be in microseconds.", "readOnly": true }, "cipslaUdpJitterTmplReqDataSize": { "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 }, "cipslaUdpJitterTmplPktPriority": { "type": "string", "description": "This object specifies the priority that will be assigned\n to operation packet.\n \n normal(1) - The packet is of normal priority.\n high(2) - The packet is of high priority.", "readOnly": true }, "cipslaUdpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaUdpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then\n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolAbs": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of\n NTP offsets on source and responder. The value specified is \n microseconds. This value can be set only for UDP jitter operation \n with precision of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolPct": { "type": "integer", "description": "This object specifies the total clock synchronization error\n on source and responder that is considered tolerable for \n oneway measurement when NTP is used as clock synchronization \n mechanism. The total clock synchronization error is sum of \n NTP offsets on source and responder. The value is expressed \n as the percentage of actual oneway latency that is measured. \n This value can be set only for UDP jitter operation with precision \n of microsecond.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplNTPTolType": { "type": "string", "description": "This object specifies whether the value specified for oneway\n NTP sync tolerance is absolute value or percent value.\n \n percent(1) - The value for oneway NTP sync tolerance is \n absolute value.\n absolute(2) - The value for oneway NTP sync tolerance is \n percent value.", "readOnly": true }, "cipslaUdpJitterTmplIcpifFactor": { "type": "integer", "description": "The advantage factor is dependant on the type of access and\n how the service is to be used.\n Conventional Wire-line 0\n Mobility within Building 5\n Mobility within geographic area 10\n Access to hard-to-reach location 20\n \n It is used when calculating the ICPIF value.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStatsHours": { "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 }, "cipslaUdpJitterTmplDistBuckets": { "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 cipslaUdpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaUdpJitterTmplDistBuckets = 5 buckets\n cipslaUdpJitterTmplDistInterval = 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 cipslaUdpJitterTmplDistBuckets = 1 buckets\n cipslaUdpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaUdpJitterTmplDistInterval does not apply when\n cipslaUdpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaUdpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaUdpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual UDP Jitter 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-JITTER-MIB_cipslaIcmpJitterTmplEntry": { "type": "array", "description": "A row entry representing an IP SLA ICMP Jitter template.", "items": { "type": "object", "properties": { "cipslaIcmpJitterTmplName": { "type": "string", "description": "A string which specifies the ICMP jitter template name.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplDescription": { "type": "string", "description": "A string which provides description of ICMP Jitter\n template.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplTimeOut": { "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 }, "cipslaIcmpJitterTmplVerifyData": { "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 }, "cipslaIcmpJitterTmplNumPkts": { "type": "integer", "description": "This value represents the number of packets that need to be\n transmitted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplInterval": { "type": "integer", "description": "This value represents the inter-packet delay between packets\n and is in milliseconds.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplSrcAddrType": { "type": "string", "description": "An enumerated value which specifies the IP address type\n of the source. It must be used along with the\n cipslaIcmpJitterTmplSrcAddr object.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cipslaIcmpJitterTmplSrcAddr": { "type": "string", "description": "A string which specifies the IP address of the source.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cipslaIcmpJitterTmplTOS": { "type": "integer", "description": "This object represents the type of service octet in an\n IP header.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplVrfName": { "type": "string", "description": "This field is used to specify the VRF name in\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 VPN routing Table for\n this operation.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cipslaIcmpJitterTmplThreshold": { "type": "integer", "description": "This object defines an administrative threshold limit.\n If the IP SLA operation time exceeds this limit, then \n one threshold crossing occurrence will be counted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStatsHours": { "type": "integer", "description": "The maximum number of hourss 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 }, "cipslaIcmpJitterTmplDistBuckets": { "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 cipslaIcmpJitterTmplDistBuckets will be kept.\n \n The last bucket will contain all entries from its \n distribution interval start point to infinity.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplDistInterval": { "type": "integer", "description": "The statistical distribution buckets interval.\n \n Distribution Bucket Example:\n \n cipslaIcmpJitterTmplDistBuckets = 5 buckets\n cipslaIcmpJitterTmplDistInterval = 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 cipslaIcmpJitterTmplDistBuckets = 1 buckets\n cipslaIcmpJitterTmplDistInterval = 10 milliseconds\n \n | Bucket 1 |\n | 0-Inf ms |\n \n Thus, this odd example shows that the value of\n cipslaIcmpJitterTmplDistInterval does not apply when\n cipslaIcmpJitterTmplDistBuckets is one.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cipslaIcmpJitterTmplStorageType": { "type": "string", "description": "The storage type of this conceptual row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "cipslaIcmpJitterTmplRowStatus": { "type": "string", "description": "The status of the conceptual ICMP jitter 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 } } } }, "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-JITTER-MIB", "description": "MIB operations for CISCO-IPSLA-JITTER-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }