{ "openapi": "3.0.0", "info": { "title": "DISMAN-EXPRESSION-MIB MIB API", "version": "1.0.0", "description": "The MIB module for defining expressions of MIB objects for\n management purposes.\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 DISMAN-EXPRESSION-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/DISMAN-EXPRESSION-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "DISMAN-EXPRESSION-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/DISMAN-EXPRESSION-MIB:expResource": { "get": { "summary": "Get expResource data", "description": "Retrieve expResource operational data from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "expResource", "properties": { "expResourceDeltaMinimum": { "type": "integer", "description": "The minimum expExpressionDeltaInterval this system will\n accept. A system may use the larger values of this minimum to\n lessen the impact of constantly computing deltas. For larger\n delta sampling intervals the system samples less often and\n suffers less overhead. This object provides a way to enforce\n such lower overhead for all expressions created after it is\n set.\n \n The value -1 indicates that expResourceDeltaMinimum is\n irrelevant as the system will not accept 'deltaValue' as a\n value for expObjectSampleType.\n \n Unless explicitly resource limited, a system's value for\n this object should be 1, allowing as small as a 1 second\n interval for ongoing delta sampling.\n \n Changing this value will not invalidate an existing setting\n of expObjectSampleType.", "minimum": -2147483648, "maximum": 2147483647 }, "expResourceDeltaWildcardInstanceMaximum": { "type": "integer", "description": "For every instance of a deltaValue object, one dynamic instance\n entry is needed for holding the instance value from the previous\n sample, i.e. to maintain state.\n \n This object limits maximum number of dynamic instance entries\n this system will support for wildcarded delta objects in\n expressions. For a given delta expression, the number of\n dynamic instances is the number of values that meet all criteria\n to exist times the number of delta values in the expression.\n \n A value of 0 indicates no preset limit, that is, the limit\n is dynamic based on system operation and resources.\n \n Unless explicitly resource limited, a system's value for\n this object should be 0.\n \n Changing this value will not eliminate or inhibit existing delta\n wildcard instance objects but will prevent the creation of more\n such objects.\n \n An attempt to allocate beyond the limit results in expErrorCode\n being tooManyWildcardValues for that evaluation attempt.", "minimum": 0, "maximum": 4294967295 }, "expResourceDeltaWildcardInstances": { "type": "integer", "description": "The number of currently active instance entries as\n defined for expResourceDeltaWildcardInstanceMaximum.", "minimum": 0, "maximum": 4294967295 }, "expResourceDeltaWildcardInstancesHigh": { "type": "integer", "description": "The highest value of expResourceDeltaWildcardInstances\n that has occurred since initialization of the managed\n system.", "minimum": 0, "maximum": 4294967295 }, "expResourceDeltaWildcardInstanceResourceLacks": { "type": "integer", "description": "The number of times this system could not evaluate an\n expression because that would have created a value instance in\n excess of expResourceDeltaWildcardInstanceMaximum.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "DISMAN-EXPRESSION-MIB:expResource": { "expResourceDeltaMinimum": -2147483648, "expResourceDeltaWildcardInstanceMaximum": 0, "expResourceDeltaWildcardInstances": 0, "expResourceDeltaWildcardInstancesHigh": 0, "expResourceDeltaWildcardInstanceResourceLacks": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expResource", "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": "/expResource", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expExpressionTable": { "get": { "summary": "Get expExpressionTable data", "description": "Retrieve expExpressionTable operational data from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of expression definitions.", "properties": { "expExpressionEntry": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary" }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur." }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647 }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128" }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295 }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "DISMAN-EXPRESSION-MIB:expExpressionTable": { "expExpressionEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expExpressionTable", "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": "/expExpressionTable", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expExpressionTable/expExpressionEntry": { "get": { "summary": "Get expExpressionEntry list", "description": "Retrieve list of expExpressionEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary" }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur." }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647 }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128" }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295 }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expExpressionEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expExpressionEntry", "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": "/expExpressionTable/expExpressionEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expErrorTable": { "get": { "summary": "Get expErrorTable data", "description": "Retrieve expErrorTable operational data from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of expression errors.", "properties": { "expErrorEntry": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp" }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647 }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'." }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128" } } } } } }, "example": { "DISMAN-EXPRESSION-MIB:expErrorTable": { "expErrorEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 1, "expErrorCode": "example-string", "expErrorInstance": "example-string" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 2, "expErrorCode": "example-string", "expErrorInstance": "example-string" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 3, "expErrorCode": "example-string", "expErrorInstance": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expErrorTable", "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": "/expErrorTable", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expErrorTable/expErrorEntry": { "get": { "summary": "Get expErrorEntry list", "description": "Retrieve list of expErrorEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp" }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647 }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'." }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expErrorEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 1, "expErrorCode": "example-string", "expErrorInstance": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expErrorEntry", "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": "/expErrorTable/expErrorEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expObjectTable": { "get": { "summary": "Get expObjectTable data", "description": "Retrieve expObjectTable operational data from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "expObjectTable", "properties": { "expObjectEntry": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295 }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128" }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period." }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128" }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'." }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128" }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "DISMAN-EXPRESSION-MIB:expObjectTable": { "expObjectEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 1, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 2, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 3, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expObjectTable", "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": "/expObjectTable", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expObjectTable/expObjectEntry": { "get": { "summary": "Get expObjectEntry list", "description": "Retrieve list of expObjectEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295 }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128" }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period." }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128" }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'." }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128" }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expObjectEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 1, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expObjectEntry", "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": "/expObjectTable/expObjectEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expValueTable": { "get": { "summary": "Get expValueTable data", "description": "Retrieve expValueTable operational data from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of values from evaluated expressions.", "properties": { "expValueEntry": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295 }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295 }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks" }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647 }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address" }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary" }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0 } } } } } }, "example": { "DISMAN-EXPRESSION-MIB:expValueTable": { "expValueEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 }, { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expValueTable", "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": "/expValueTable", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expValueTable/expValueEntry": { "get": { "summary": "Get expValueEntry list", "description": "Retrieve list of expValueEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295 }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295 }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks" }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647 }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address" }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary" }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0 } } } }, "example": { "DISMAN-EXPRESSION-MIB:expValueEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expValueEntry", "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": "/expValueTable/expValueEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expExpressionEntry": { "get": { "summary": "Get expExpressionEntry list", "description": "Retrieve list of expExpressionEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary" }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur." }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647 }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128" }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295 }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expExpressionEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expExpressionEntry-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": "/expExpressionEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expErrorEntry": { "get": { "summary": "Get expErrorEntry list", "description": "Retrieve list of expErrorEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp" }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647 }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'." }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expErrorEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 1, "expErrorCode": "example-string", "expErrorInstance": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expErrorEntry-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": "/expErrorEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expObjectEntry": { "get": { "summary": "Get expObjectEntry list", "description": "Retrieve list of expObjectEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295 }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128" }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period." }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128" }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'." }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128" }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "DISMAN-EXPRESSION-MIB:expObjectEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 1, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expObjectEntry-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": "/expObjectEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expValueEntry": { "get": { "summary": "Get expValueEntry list", "description": "Retrieve list of expValueEntry entries from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295 }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295 }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks" }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647 }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address" }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary" }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0 } } } }, "example": { "DISMAN-EXPRESSION-MIB:expValueEntry": [ { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expValueEntry-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": "/expValueEntry", "x-restconf-kind": "container" }, "/data/DISMAN-EXPRESSION-MIB:expExpressionTable/expExpressionEntry={expExpressionOwner},{expExpressionName}": { "get": { "summary": "Get expExpressionEntry entry", "description": "Retrieve specific expExpressionEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary" }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur." }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647 }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128" }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295 }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DISMAN-EXPRESSION-MIB:expExpressionEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expExpressionEntry-2" }, "x-yang-path": "/expExpressionTable/expExpressionEntry={expExpressionOwner expExpressionName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName" ] }, "/data/DISMAN-EXPRESSION-MIB:expErrorTable/expErrorEntry={expExpressionOwner},{expExpressionName}": { "get": { "summary": "Get expErrorEntry entry", "description": "Retrieve specific expErrorEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp" }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647 }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'." }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128" } } }, "example": { "DISMAN-EXPRESSION-MIB:expErrorEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 1, "expErrorCode": "example-string", "expErrorInstance": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expErrorEntry-2" }, "x-yang-path": "/expErrorTable/expErrorEntry={expExpressionOwner expExpressionName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName" ] }, "/data/DISMAN-EXPRESSION-MIB:expObjectTable/expObjectEntry={expExpressionOwner},{expExpressionName},{expObjectIndex}": { "get": { "summary": "Get expObjectEntry entry", "description": "Retrieve specific expObjectEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expObjectIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295 }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128" }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period." }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128" }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'." }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128" }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DISMAN-EXPRESSION-MIB:expObjectEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 1, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expObjectEntry-2" }, "x-yang-path": "/expObjectTable/expObjectEntry={expExpressionOwner expExpressionName expObjectIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName expObjectIndex" ] }, "/data/DISMAN-EXPRESSION-MIB:expValueTable/expValueEntry={expExpressionOwner},{expExpressionName},{expValueInstance}": { "get": { "summary": "Get expValueEntry entry", "description": "Retrieve specific expValueEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expValueInstance", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295 }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295 }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks" }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647 }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address" }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary" }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0 } } }, "example": { "DISMAN-EXPRESSION-MIB:expValueEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expValueEntry-2" }, "x-yang-path": "/expValueTable/expValueEntry={expExpressionOwner expExpressionName expValueInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName expValueInstance" ] }, "/data/DISMAN-EXPRESSION-MIB:expExpressionEntry={expExpressionOwner},{expExpressionName}": { "get": { "summary": "Get expExpressionEntry entry", "description": "Retrieve specific expExpressionEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary" }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur." }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647 }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128" }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295 }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DISMAN-EXPRESSION-MIB:expExpressionEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expExpression": "example-string", "expExpressionValueType": "ethernetCsmacd(6)", "expExpressionComment": "example-string", "expExpressionDeltaInterval": -2147483648, "expExpressionPrefix": "example-string", "expExpressionErrors": 0, "expExpressionEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expExpressionEntry-4" }, "x-yang-path": "/expExpressionEntry={expExpressionOwner expExpressionName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName" ] }, "/data/DISMAN-EXPRESSION-MIB:expErrorEntry={expExpressionOwner},{expExpressionName}": { "get": { "summary": "Get expErrorEntry entry", "description": "Retrieve specific expErrorEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp" }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647 }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'." }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128" } } }, "example": { "DISMAN-EXPRESSION-MIB:expErrorEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expErrorTime": "example-string", "expErrorIndex": 1, "expErrorCode": "example-string", "expErrorInstance": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expErrorEntry-4" }, "x-yang-path": "/expErrorEntry={expExpressionOwner expExpressionName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName" ] }, "/data/DISMAN-EXPRESSION-MIB:expObjectEntry={expExpressionOwner},{expExpressionName},{expObjectIndex}": { "get": { "summary": "Get expObjectEntry entry", "description": "Retrieve specific expObjectEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expObjectIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295 }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128" }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period." }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128" }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'." }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128" }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards." }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "DISMAN-EXPRESSION-MIB:expObjectEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expObjectIndex": 1, "expObjectID": "example-string", "expObjectIDWildcard": true, "expObjectSampleType": "ethernetCsmacd(6)", "expObjectDeltaDiscontinuityID": "example-string", "expObjectDiscontinuityIDWildcard": true, "expObjectDiscontinuityIDType": "ethernetCsmacd(6)", "expObjectConditional": "example-string", "expObjectConditionalWildcard": true, "expObjectEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expObjectEntry-4" }, "x-yang-path": "/expObjectEntry={expExpressionOwner expExpressionName expObjectIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName expObjectIndex" ] }, "/data/DISMAN-EXPRESSION-MIB:expValueEntry={expExpressionOwner},{expExpressionName},{expValueInstance}": { "get": { "summary": "Get expValueEntry entry", "description": "Retrieve specific expValueEntry entry by key from MIB", "tags": [ "DISMAN-EXPRESSION-MIB" ], "parameters": [ { "name": "expExpressionOwner", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expExpressionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "expValueInstance", "in": "path", "required": true, "schema": { "type": "string" } }, { "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": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref" }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref" }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295 }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295 }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks" }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647 }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address" }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary" }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128" }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0 } } }, "example": { "DISMAN-EXPRESSION-MIB:expValueEntry": { "expExpressionOwner": "example-string", "expExpressionName": "interface-1", "expValueInstance": "example-string", "expValueCounter32Val": 1234567890, "expValueUnsigned32Val": 0, "expValueTimeTicksVal": "example-string", "expValueInteger32Val": -2147483648, "expValueIpAddressVal": "192.168.1.1", "expValueOctetStringVal": "example-string", "expValueOidVal": "1.3.6.1.2.1.1", "expValueCounter64Val": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-expValueEntry-4" }, "x-yang-path": "/expValueEntry={expExpressionOwner expExpressionName expValueInstance}", "x-restconf-kind": "list-instance", "x-list-keys": [ "expExpressionOwner expExpressionName expValueInstance" ] } }, "components": { "schemas": { "DISMAN-EXPRESSION-MIB_DISMAN-EXPRESSION-MIB": { "type": "object", "description": "DISMAN-EXPRESSION-MIB", "properties": { "expExpressionEntry": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary", "readOnly": true }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur.", "readOnly": true }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "expErrorEntry": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp", "readOnly": true }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'.", "readOnly": true }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } }, "readOnly": true }, "expObjectEntry": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period.", "readOnly": true }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.", "readOnly": true }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "expValueEntry": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks", "readOnly": true }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address", "readOnly": true }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary", "readOnly": true }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0, "readOnly": true } } }, "readOnly": true }, "expResource": { "type": "object", "description": "expResource", "properties": { "expResourceDeltaMinimum": { "type": "integer", "description": "The minimum expExpressionDeltaInterval this system will\n accept. A system may use the larger values of this minimum to\n lessen the impact of constantly computing deltas. For larger\n delta sampling intervals the system samples less often and\n suffers less overhead. This object provides a way to enforce\n such lower overhead for all expressions created after it is\n set.\n \n The value -1 indicates that expResourceDeltaMinimum is\n irrelevant as the system will not accept 'deltaValue' as a\n value for expObjectSampleType.\n \n Unless explicitly resource limited, a system's value for\n this object should be 1, allowing as small as a 1 second\n interval for ongoing delta sampling.\n \n Changing this value will not invalidate an existing setting\n of expObjectSampleType.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expResourceDeltaWildcardInstanceMaximum": { "type": "integer", "description": "For every instance of a deltaValue object, one dynamic instance\n entry is needed for holding the instance value from the previous\n sample, i.e. to maintain state.\n \n This object limits maximum number of dynamic instance entries\n this system will support for wildcarded delta objects in\n expressions. For a given delta expression, the number of\n dynamic instances is the number of values that meet all criteria\n to exist times the number of delta values in the expression.\n \n A value of 0 indicates no preset limit, that is, the limit\n is dynamic based on system operation and resources.\n \n Unless explicitly resource limited, a system's value for\n this object should be 0.\n \n Changing this value will not eliminate or inhibit existing delta\n wildcard instance objects but will prevent the creation of more\n such objects.\n \n An attempt to allocate beyond the limit results in expErrorCode\n being tooManyWildcardValues for that evaluation attempt.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expResourceDeltaWildcardInstances": { "type": "integer", "description": "The number of currently active instance entries as\n defined for expResourceDeltaWildcardInstanceMaximum.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expResourceDeltaWildcardInstancesHigh": { "type": "integer", "description": "The highest value of expResourceDeltaWildcardInstances\n that has occurred since initialization of the managed\n system.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expResourceDeltaWildcardInstanceResourceLacks": { "type": "integer", "description": "The number of times this system could not evaluate an\n expression because that would have created a value instance in\n excess of expResourceDeltaWildcardInstanceMaximum.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "expExpressionTable": { "type": "object", "description": "A table of expression definitions.", "properties": { "expExpressionEntry": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary", "readOnly": true }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur.", "readOnly": true }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "expErrorTable": { "type": "object", "description": "A table of expression errors.", "properties": { "expErrorEntry": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp", "readOnly": true }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'.", "readOnly": true }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "expObjectTable": { "type": "object", "description": "expObjectTable", "properties": { "expObjectEntry": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period.", "readOnly": true }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.", "readOnly": true }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "expValueTable": { "type": "object", "description": "A table of values from evaluated expressions.", "properties": { "expValueEntry": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks", "readOnly": true }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address", "readOnly": true }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary", "readOnly": true }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0, "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "DISMAN-EXPRESSION-MIB_expExpressionEntry": { "type": "array", "description": "expExpressionEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "The owner of this entry. The exact semantics of this\n string are subject to the security policy defined by the\n security administrator.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionName": { "type": "string", "description": "The name of the expression. This is locally unique, within\n the scope of an expExpressionOwner.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpression": { "type": "string", "description": "The expression to be evaluated. This object is the same\n as a DisplayString (RFC 1903) except for its maximum length.\n \n Except for the variable names the expression is in ANSI C\n syntax. Only the subset of ANSI C operators and functions\n listed here is allowed.\n \n Variables are expressed as a dollar sign ('$') and an\n integer that corresponds to an expObjectIndex. An\n example of a valid expression is:\n \n ($1-$5)*100\n \n Expressions must not be recursive, that is although an expression\n may use the results of another expression, it must not contain\n any variable that is directly or indirectly a result of its own\n evaluation. The managed system must check for recursive\n expressions.\n \n The only allowed operators are:\n \n ( )\n - (unary)\n + - * / %\n & | ^ << >> ~\n ! && || == != > >= < <=\n \n Note the parentheses are included for parenthesizing the\n expression, not for casting data types.\n \n The only constant types defined are:\n \n int (32-bit signed)\n long (64-bit signed)\n unsigned int\n unsigned long\n hexadecimal\n character\n string\n oid\n \n The default type for a positive integer is int unless it is too\n large in which case it is long.\n \n All but oid are as defined for ANSI C. Note that a\n hexadecimal constant may end up as a scalar or an array of\n 8-bit integers. A string constant is enclosed in double\n quotes and may contain back-slashed individual characters\n as in ANSI C.\n \n An oid constant comprises 32-bit, unsigned integers and at\n least one period, for example:\n \n 0.\n .0\n 1.3.6.1\n \n No additional leading or trailing subidentifiers are automatically\n added to an OID constant. The constant is taken as expressed.\n \n Integer-typed objects are treated as 32- or 64-bit, signed\n or unsigned integers, as appropriate. The results of\n mixing them are as for ANSI C, including the type of the\n result. Note that a 32-bit value is thus promoted to 64 bits\n only in an operation with a 64-bit value. There is no\n provision for larger values to handle overflow.\n \n Relative to SNMP data types, a resulting value becomes\n unsigned when calculating it uses any unsigned value,\n including a counter. To force the final value to be of\n data type counter the expression must explicitly use the\n counter32() or counter64() function (defined below).\n \n OCTET STRINGS and OBJECT IDENTIFIERs are treated as\n one-dimensioned arrays of unsigned 8-bit integers and\n unsigned 32-bit integers, respectively.\n \n IpAddresses are treated as 32-bit, unsigned integers in\n network byte order, that is, the hex version of 255.0.0.0 is\n 0xff000000.\n \n Conditional expressions result in a 32-bit, unsigned integer\n of value 0 for false or 1 for true. When an arbitrary value\n is used as a boolean 0 is false and non-zero is true.\n \n Rules for the resulting data type from an operation, based on\n the operator:\n \n For << and >> the result is the same as the left hand operand.\n \n For &&, ||, ==, !=, <, <=, >, and >= the result is always\n Unsigned32.\n \n For unary - the result is always Integer32.\n \n For +, -, *, /, %, &, |, and ^ the result is promoted according\n to the following rules, in order from most to least preferred:\n \n If left hand and right hand operands are the same type,\n use that.\n \n If either side is Counter64, use that.\n \n If either side is IpAddress, use that.\n \n If either side is TimeTicks, use that.\n \n If either side is Counter32, use that.\n \n Otherwise use Unsigned32.\n \n The following rules say what operators apply with what data\n types. Any combination not explicitly defined does not work.\n \n For all operators any of the following can be the left hand or\n right hand operand: Integer32, Counter32, Unsigned32, Counter64.\n \n The operators +, -, *, /, %, <, <=, >, and >= work with\n TimeTicks.\n \n The operators &, |, and ^ work with IpAddress.\n \n The operators << and >> work with IpAddress but only as the\n left hand operand.\n \n The + operator performs a concatenation of two OCTET STRINGs or\n two OBJECT IDENTIFIERs.\n \n The operators &, | perform bitwise operations on OCTET STRINGs.\n If the OCTET STRING happens to be a DisplayString the results\n may be meaningless, but the agent system does not check this as\n some such systems do not have this information.\n \n The operators << and >> perform bitwise operations on OCTET\n STRINGs appearing as the left hand operand.\n \n The only functions defined are:\n \n counter32\n counter64\n arraySection\n stringBegins\n stringEnds\n stringContains\n oidBegins\n oidEnds\n oidContains\n average\n maximum\n minimum\n sum\n exists\n \n The following function definitions indicate their parameters by\n naming the data type of the parameter in the parameter's position\n in the parameter list. The parameter must be of the type indicated\n and generally may be a constant, a MIB object, a function, or an\n expression.\n \n counter32(integer) - wrapped around an integer value counter32\n forces Counter32 as a data type.\n \n counter64(integer) - similar to counter32 except that the\n resulting data type is 'counter64'.\n \n arraySection(array, integer, integer) - selects a piece of an\n array (i.e. part of an OCTET STRING or OBJECT IDENTIFIER). The\n integer arguments are in the range 0 to 4,294,967,295. The\n first is an initial array index (one-dimensioned) and the second\n is an ending array index. A value of 0 indicates first or last\n element, respectively. If the first element is larger than the\n array length the result is 0 length. If the second integer is\n less than or equal to the first, the result is 0 length. If the\n second is larger than the array length it indicates last\n element.\n \n stringBegins/Ends/Contains(octetString, octetString) - looks for\n the second string (which can be a string constant) in the first\n and returns the one-dimensioned arrayindex where the match began.\n A return value of 0 indicates no match (i.e. boolean false).\n \n oidBegins/Ends/Contains(oid, oid) - looks for the second OID\n (which can be an OID constant) in the first and returns the\n the one-dimensioned index where the match began. A return value\n of 0 indicates no match (i.e. boolean false).\n \n average/maximum/minimum(integer) - calculates the average,\n minimum, or maximum value of the integer valued object over\n multiple sample times. If the object disappears for any\n sample period, the accumulation and the resulting value object\n cease to exist until the object reappears at which point the\n calculation starts over.\n \n sum(integerObject*) - sums all available values of the\n wildcarded integer object, resulting in an integer scalar. Must\n be used with caution as it wraps on overflow with no\n notification.\n \n exists(anyTypeObject) - verifies the object instance exists. A\n return value of 0 indicates NoSuchInstance (i.e. boolean\n false).", "format": "binary", "readOnly": true }, "expExpressionValueType": { "type": "string", "description": "The type of the expression value. One and only one of the\n value objects in expValueTable will be instantiated to match\n this type.\n \n If the result of the expression can not be made into this type,\n an invalidOperandType error will occur.", "readOnly": true }, "expExpressionComment": { "type": "string", "description": "A comment to explain the use or meaning of the expression.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "expExpressionDeltaInterval": { "type": "integer", "description": "Sampling interval for objects in this expression with\n expObjectSampleType 'deltaValue'.\n \n This object has no effect if the the expression has no\n deltaValue objects.\n \n A value of 0 indicates no automated sampling. In this case\n the delta is the difference from the last time the expression\n was evaluated. Note that this is subject to unpredictable\n delta times in the face of retries or multiple managers.\n \n A value greater than zero is the number of seconds between\n automated samples.\n \n Until the delta interval has expired once the delta for the\n object is effectively not instantiated and evaluating\n the expression has results as if the object itself were not\n instantiated.\n \n Note that delta values potentially consume large amounts of\n system CPU and memory. Delta state and processing must\n continue constantly even if the expression is not being used.\n That is, the expression is being evaluated every delta interval,\n even if no application is reading those values. For wildcarded\n objects this can be substantial overhead.\n \n Note that delta intervals, external expression value sampling\n intervals and delta intervals for expressions within other\n expressions can have unusual interactions as they are impossible\n to synchronize accurately. In general one interval embedded\n below another must be enough shorter that the higher sample\n sees relatively smooth, predictable behavior. So, for example,\n to avoid the higher level getting the same sample twice, the\n lower level should sample at least twice as fast as the higher\n level does.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expExpressionPrefix": { "type": "string", "description": "An object prefix to assist an application in determining\n the instance indexing to use in expValueTable, relieving the\n application of the need to scan the expObjectTable to\n determine such a prefix.\n \n See expObjectTable for information on wildcarded objects.\n \n If the expValueInstance portion of the value OID may\n be treated as a scalar (that is, normally, 0) the value of\n expExpressionPrefix is zero length, that is, no OID at all.\n Note that zero length implies a null OID, not the OID 0.0.\n \n Otherwise, the value of expExpressionPrefix is the expObjectID\n value of any one of the wildcarded objects for the expression.\n This is sufficient, as the remainder, that is, the instance\n fragment relevant to instancing the values, must be the same for\n all wildcarded objects in the expression.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expExpressionErrors": { "type": "integer", "description": "The number of errors encountered while evaluating this\n expression.\n \n Note that an object in the expression not being accessible,\n is not considered an error. An example of an inaccessible\n object is when the object is excluded from the view of the\n user whose security credentials are used in the expression\n evaluation. In such cases, it is a legitimate condition\n that causes the corresponding expression value not to be\n instantiated.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expExpressionEntryStatus": { "type": "string", "description": "The control that allows creation and deletion of entries.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "DISMAN-EXPRESSION-MIB_expErrorEntry": { "type": "array", "description": "Information about errors in processing an expression.\n \n Entries appear in this table only when there is a matching\n expExpressionEntry and then only when there has been an\n error for that expression as reflected by the error codes\n defined for expErrorCode.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expErrorTime": { "type": "string", "description": "The value of sysUpTime the last time an error caused a\n failure to evaluate this expression.", "x-yang-type": "yang:timestamp", "readOnly": true }, "expErrorIndex": { "type": "integer", "description": "The one-dimensioned character array index into\n expExpression for where the error occurred. The value\n zero indicates irrelevance.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expErrorCode": { "type": "string", "description": "The error that occurred. In the following explanations the\n expected timing of the error is in parentheses. 'S' means\n the error occurs on a Set request. 'E' means the error\n occurs on the attempt to evaluate the expression either due to\n Get from expValueTable or in ongoing delta processing.\n \n invalidSyntax the value sent for expExpression is not\n valid Expression MIB expression syntax\n (S)\n undefinedObjectIndex an object reference ($n) in\n expExpression does not have a matching\n instance in expObjectTable (E)\n unrecognizedOperator the value sent for expExpression held an\n unrecognized operator (S)\n unrecognizedFunction the value sent for expExpression held an\n unrecognized function name (S)\n invalidOperandType an operand in expExpression is not the\n right type for the associated operator\n or result (SE)\n unmatchedParenthesis the value sent for expExpression is not\n correctly parenthesized (S)\n tooManyWildcardValues evaluating the expression exceeded the\n limit set by\n expResourceDeltaWildcardInstanceMaximum\n (E)\n recursion through some chain of embedded\n expressions the expression invokes itself\n (E)\n deltaTooShort the delta for the next evaluation passed\n before the system could evaluate the\n present sample (E)\n resourceUnavailable some resource, typically dynamic memory,\n was unavailable (SE)\n divideByZero an attempt to divide by zero occurred\n (E)\n \n For the errors that occur when the attempt is made to set\n expExpression Set request fails with the SNMP error code\n 'wrongValue'. Such failures refer to the most recent failure to\n Set expExpression, not to the present value of expExpression\n which must be either unset or syntactically correct.\n \n Errors that occur during evaluation for a Get* operation return\n the SNMP error code 'genErr' except for 'tooManyWildcardValues'\n and 'resourceUnavailable' which return the SNMP error code\n 'resourceUnavailable'.", "readOnly": true }, "expErrorInstance": { "type": "string", "description": "The expValueInstance being evaluated when the error\n occurred. A zero-length indicates irrelevance.", "x-yang-type": "yang:object-identifier-128", "readOnly": true } } } }, "DISMAN-EXPRESSION-MIB_expObjectEntry": { "type": "array", "description": "Information about an object. An application uses\n expObjectEntryStatus to create entries in this table while\n in the process of defining an expression.\n \n Values of read-create objects in this table may be\n changed at any time.", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expObjectIndex": { "type": "integer", "description": "Within an expression, a unique, numeric identification for an\n object. Prefixed with a dollar sign ('$') this is used to\n reference the object in the corresponding expExpression.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expObjectID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of this object. The OID may be\n fully qualified, meaning it includes a complete instance\n identifier part (e.g., ifInOctets.1 or sysUpTime.0), or it\n may not be fully qualified, meaning it may lack all or part\n of the instance identifier. If the expObjectID is not fully\n qualified, then expObjectWildcard must be set to true(1).\n The value of the expression will be multiple\n values, as if done for a GetNext sweep of the object.\n \n An object here may itself be the result of an expression but\n recursion is not allowed.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjecID of this row is a wildcard\n object. False indicates that expObjectID is fully instanced.\n If all expObjectWildcard values for a given expression are FALSE,\n expExpressionPrefix will reflect a scalar object (i.e. will\n be 0.0).\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectSampleType": { "type": "string", "description": "The method of sampling the selected variable.\n \n An 'absoluteValue' is simply the present value of the object.\n \n A 'deltaValue' is the present value minus the previous value,\n which was sampled expExpressionDeltaInterval seconds ago.\n This is intended primarily for use with SNMP counters, which are\n meaningless as an 'absoluteValue', but may be used with any\n integer-based value.\n \n A 'changedValue' is a boolean for whether the present value is\n different from the previous value. It is applicable to any data\n type and results in an Unsigned32 with value 1 if the object's\n value is changed and 0 if not. In all other respects it is as a\n 'deltaValue' and all statements and operation regarding delta\n values apply to changed values.\n \n When an expression contains both delta and absolute values\n the absolute values are obtained at the end of the delta\n period.", "readOnly": true }, "expObjectDeltaDiscontinuityID": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of a TimeTicks, TimeStamp, or\n DateAndTime object that indicates a discontinuity in the value\n at expObjectID.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n The OID may be for a leaf object (e.g. sysUpTime.0) or may\n be wildcarded to match expObjectID.\n \n This object supports normal checking for a discontinuity in a\n counter. Note that if this object does not point to sysUpTime\n discontinuity checking must still check sysUpTime for an overall\n discontinuity.\n \n If the object identified is not accessible no discontinuity\n check will be made.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectDiscontinuityIDWildcard": { "type": "boolean", "description": "A true value indicates the expObjectDeltaDiscontinuityID of\n this row is a wildcard object. False indicates that\n expObjectDeltaDiscontinuityID is fully instanced.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectDiscontinuityIDType": { "type": "string", "description": "The value 'timeTicks' indicates the expObjectDeltaDiscontinuityID\n of this row is of syntax TimeTicks. The value 'timeStamp' indicates\n syntax TimeStamp. The value 'dateAndTime indicates syntax\n DateAndTime.\n \n This object is instantiated only if expObjectSampleType is\n 'deltaValue' or 'changedValue'.", "readOnly": true }, "expObjectConditional": { "type": "string", "description": "The OBJECT IDENTIFIER (OID) of an object that overrides\n whether the instance of expObjectID is to be considered\n usable. If the value of the object at expObjectConditional\n is 0 or not instantiated, the object at expObjectID is\n treated as if it is not instantiated. In other words,\n expObjectConditional is a filter that controls whether or\n not to use the value at expObjectID.\n \n The OID may be for a leaf object (e.g. sysObjectID.0) or may be\n wildcarded to match expObjectID. If expObject is wildcarded and\n expObjectID in the same row is not, the wild portion of\n expObjectConditional must match the wildcarding of the rest of\n the expression. If no object in the expression is wildcarded\n but expObjectConditional is, use the lexically first instance\n (if any) of expObjectConditional.\n \n If the value of expObjectConditional is 0.0 operation is\n as if the value pointed to by expObjectConditional is a\n non-zero (true) value.\n \n Note that expObjectConditional can not trivially use an object\n of syntax TruthValue, since the underlying value is not 0 or 1.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expObjectConditionalWildcard": { "type": "boolean", "description": "A true value indicates the expObjectConditional of this row is\n a wildcard object. False indicates that expObjectConditional is\n fully instanced.\n \n NOTE: The simplest implementations of this MIB may not allow\n wildcards.", "readOnly": true }, "expObjectEntryStatus": { "type": "string", "description": "The control that allows creation/deletion of entries.\n \n Objects in this table may be changed while\n expObjectEntryStatus is in any state.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "DISMAN-EXPRESSION-MIB_expValueEntry": { "type": "array", "description": "expValueEntry", "items": { "type": "object", "properties": { "expExpressionOwner": { "type": "string", "description": "expExpressionOwner", "x-yang-type": "leafref", "readOnly": true }, "expExpressionName": { "type": "string", "description": "expExpressionName", "x-yang-type": "leafref", "readOnly": true }, "expValueInstance": { "type": "string", "description": "The final instance portion of a value's OID according to\n the wildcarding in instances of expObjectID for the\n expression. The prefix of this OID fragment is 0.0,\n leading to the following behavior.\n \n If there is no wildcarding, the value is 0.0.0. In other\n words, there is one value which standing alone would have\n been a scalar with a 0 at the end of its OID.\n \n If there is wildcarding, the value is 0.0 followed by\n a value that the wildcard can take, thus defining one value\n instance for each real, possible value of the wildcard.\n So, for example, if the wildcard worked out to be an ifIndex,\n there is an expValueInstance for each applicable ifIndex.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueUnsigned32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'unsigned32'.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "expValueTimeTicksVal": { "type": "string", "description": "The value when expExpressionValueType is 'timeTicks'.", "x-yang-type": "yang:timeticks", "readOnly": true }, "expValueInteger32Val": { "type": "integer", "description": "The value when expExpressionValueType is 'integer32'.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "expValueIpAddressVal": { "type": "string", "description": "The value when expExpressionValueType is 'ipAddress'.", "format": "inet:ipv4-address", "readOnly": true }, "expValueOctetStringVal": { "type": "string", "description": "The value when expExpressionValueType is 'octetString'.", "format": "binary", "readOnly": true }, "expValueOidVal": { "type": "string", "description": "The value when expExpressionValueType is 'objectId'.", "x-yang-type": "yang:object-identifier-128", "readOnly": true }, "expValueCounter64Val": { "type": "integer", "description": "The value when expExpressionValueType is 'counter64'.", "minimum": 0, "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": "DISMAN-EXPRESSION-MIB", "description": "MIB operations for DISMAN-EXPRESSION-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }