{ "openapi": "3.0.0", "info": { "title": "CISCO-DATA-COLLECTION-MIB MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-DATA-COLLECTION-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-DATA-COLLECTION-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-DATA-COLLECTION-MIB", "x-model-type": "mib" }, "servers": [ { "url": "https://{device}/restconf", "description": "RESTCONF server", "variables": { "device": { "default": "10.1.1.1", "description": "Device hostname or IP address" } } } ], "paths": { "/data/CISCO-DATA-COLLECTION-MIB:cdcVFile": { "get": { "summary": "Get cdcVFile data", "description": "Retrieve cdcVFile operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This object's value reads 'true', if the agent\n implementation of this MIB supports placement of VFiles in\n application specified persistent storage locations. Otherwise \n the value is 'false'.", "properties": { "cdcVFilePersistentStorage": { "type": "boolean", "description": "This object's value reads 'true', if the agent\n implementation of this MIB supports placement of VFiles in\n application specified persistent storage locations. Otherwise \n the value is 'false'." }, "cdcVFileMaxSizeHitsLimit": { "type": "integer", "description": "A global limit for the number of consecutive times the\n maximum VFile size (cdcVFileMaxSize) is exceeded for a\n given VFile. When this limit is exceeded the offending\n cdcVFileEntry is moved to the error state (see\n cdcVFileOperStatus).", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFile": { "cdcVFilePersistentStorage": true, "cdcVFileMaxSizeHitsLimit": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFile", "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": "/cdcVFile", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileTable": { "get": { "summary": "Get cdcVFileTable data", "description": "Retrieve cdcVFileTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table for setting up VFiles for collecting data.", "properties": { "cdcVFileEntry": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode)." }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat" }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state." }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table." }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry." }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory." }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error." }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileTable": { "cdcVFileEntry": [ { "cdcVFileIndex": 1, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" }, { "cdcVFileIndex": 2, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" }, { "cdcVFileIndex": 3, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileTable", "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": "/cdcVFileTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileTable/cdcVFileEntry": { "get": { "summary": "Get cdcVFileEntry list", "description": "Retrieve list of cdcVFileEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode)." }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat" }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state." }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table." }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry." }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory." }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error." }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileEntry": [ { "cdcVFileIndex": 1, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileEntry", "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": "/cdcVFileTable/cdcVFileEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileTable/cdcVFileEntry={cdcVFileIndex}": { "get": { "summary": "Get cdcVFileEntry entry", "description": "Retrieve specific cdcVFileEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode)." }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat" }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state." }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table." }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry." }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory." }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error." }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileEntry": { "cdcVFileIndex": 1, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileEntry-2" }, "x-yang-path": "/cdcVFileTable/cdcVFileEntry={cdcVFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtTable": { "get": { "summary": "Get cdcVFileMgmtTable data", "description": "Retrieve cdcVFileMgmtTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table to manage frozen VFiles.", "properties": { "cdcVFileMgmtEntry": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer." }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus" }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtTable": { "cdcVFileMgmtEntry": [ { "cdcVFileIndex": "1", "cdcVFileMgmtIndex": 1, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" }, { "cdcVFileIndex": "2", "cdcVFileMgmtIndex": 2, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" }, { "cdcVFileIndex": "3", "cdcVFileMgmtIndex": 3, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileMgmtTable", "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": "/cdcVFileMgmtTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtTable/cdcVFileMgmtEntry": { "get": { "summary": "Get cdcVFileMgmtEntry list", "description": "Retrieve list of cdcVFileMgmtEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer." }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus" }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry": [ { "cdcVFileIndex": "example-string", "cdcVFileMgmtIndex": 1, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileMgmtEntry", "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": "/cdcVFileMgmtTable/cdcVFileMgmtEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGTable": { "get": { "summary": "Get cdcDGTable data", "description": "Retrieve cdcDGTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table for specifying data groups.", "properties": { "cdcDGEntry": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'." }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue" }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer" }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295 }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGTable": { "cdcDGEntry": [ { "cdcDGIndex": 1, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 1, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 1, "cdcDGInstGrpIndex": 1, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" }, { "cdcDGIndex": 2, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 2, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 2, "cdcDGInstGrpIndex": 2, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" }, { "cdcDGIndex": 3, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 3, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 3, "cdcDGInstGrpIndex": 3, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGTable", "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": "/cdcDGTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGTable/cdcDGEntry": { "get": { "summary": "Get cdcDGEntry list", "description": "Retrieve list of cdcDGEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'." }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue" }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer" }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295 }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGEntry": [ { "cdcDGIndex": 1, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 1, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 1, "cdcDGInstGrpIndex": 1, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGEntry", "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": "/cdcDGTable/cdcDGEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGTable/cdcDGEntry={cdcDGIndex}": { "get": { "summary": "Get cdcDGEntry entry", "description": "Retrieve specific cdcDGEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'." }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue" }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer" }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295 }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGEntry": { "cdcDGIndex": 1, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 1, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 1, "cdcDGInstGrpIndex": 1, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGEntry-2" }, "x-yang-path": "/cdcDGTable/cdcDGEntry={cdcDGIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectTable": { "get": { "summary": "Get cdcDGBaseObjectTable data", "description": "Retrieve cdcDGBaseObjectTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table specifying the base objects of a 'table' type\n data group.", "properties": { "cdcDGBaseObjectEntry": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree" }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList" }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectTable": { "cdcDGBaseObjectEntry": [ { "cdcDGBaseObjectGrpIndex": 1, "cdcDGBaseObjectIndex": 1, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" }, { "cdcDGBaseObjectGrpIndex": 2, "cdcDGBaseObjectIndex": 2, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" }, { "cdcDGBaseObjectGrpIndex": 3, "cdcDGBaseObjectIndex": 3, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGBaseObjectTable", "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": "/cdcDGBaseObjectTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectTable/cdcDGBaseObjectEntry": { "get": { "summary": "Get cdcDGBaseObjectEntry list", "description": "Retrieve list of cdcDGBaseObjectEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree" }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList" }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry": [ { "cdcDGBaseObjectGrpIndex": 1, "cdcDGBaseObjectIndex": 1, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGBaseObjectEntry", "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": "/cdcDGBaseObjectTable/cdcDGBaseObjectEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGInstanceTable": { "get": { "summary": "Get cdcDGInstanceTable data", "description": "Retrieve cdcDGInstanceTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Identifies the instances of the base objects that need to\n be fetched for a 'table' type data group.\n \n The agent is not responsible for verifying that the instances\n specified for a data group do not overlap.", "properties": { "cdcDGInstanceEntry": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'." }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer" }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGInstanceTable": { "cdcDGInstanceEntry": [ { "cdcDGInstanceGrpIndex": 1, "cdcDGInstanceIndex": 1, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" }, { "cdcDGInstanceGrpIndex": 2, "cdcDGInstanceIndex": 2, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" }, { "cdcDGInstanceGrpIndex": 3, "cdcDGInstanceIndex": 3, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGInstanceTable", "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": "/cdcDGInstanceTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGInstanceTable/cdcDGInstanceEntry": { "get": { "summary": "Get cdcDGInstanceEntry list", "description": "Retrieve list of cdcDGInstanceEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'." }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer" }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry": [ { "cdcDGInstanceGrpIndex": 1, "cdcDGInstanceIndex": 1, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGInstanceEntry", "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": "/cdcDGInstanceTable/cdcDGInstanceEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcFileXferConfTable": { "get": { "summary": "Get cdcFileXferConfTable data", "description": "Retrieve cdcFileXferConfTable operational data from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table for configuring file transfer operations.", "properties": { "cdcFileXferConfEntry": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer." }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure." } } } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcFileXferConfTable": { "cdcFileXferConfEntry": [ { "cdcVFileIndex": "1", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true }, { "cdcVFileIndex": "2", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true }, { "cdcVFileIndex": "3", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcFileXferConfTable", "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": "/cdcFileXferConfTable", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcFileXferConfTable/cdcFileXferConfEntry": { "get": { "summary": "Get cdcFileXferConfEntry list", "description": "Retrieve list of cdcFileXferConfEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer." }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure." } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry": [ { "cdcVFileIndex": "example-string", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcFileXferConfEntry", "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": "/cdcFileXferConfTable/cdcFileXferConfEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcFileXferConfTable/cdcFileXferConfEntry={cdcVFileIndex}": { "get": { "summary": "Get cdcFileXferConfEntry entry", "description": "Retrieve specific cdcFileXferConfEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer." }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure." } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry": { "cdcVFileIndex": "example-string", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcFileXferConfEntry-2" }, "x-yang-path": "/cdcFileXferConfTable/cdcFileXferConfEntry={cdcVFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileEntry": { "get": { "summary": "Get cdcVFileEntry list", "description": "Retrieve list of cdcVFileEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode)." }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat" }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state." }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table." }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry." }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory." }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error." }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileEntry": [ { "cdcVFileIndex": 1, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileEntry-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": "/cdcVFileEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileEntry={cdcVFileIndex}": { "get": { "summary": "Get cdcVFileEntry entry", "description": "Retrieve specific cdcVFileEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode)." }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat" }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state." }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295 }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table." }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry." }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory." }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error." }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileEntry": { "cdcVFileIndex": 1, "cdcVFileName": "interface-1", "cdcVFileDescription": "192.168.1.1", "cdcVFileCommand": "example-string", "cdcVFileMaxSize": 0, "cdcVFileCurrentSize": 0, "cdcVFileFormat": "example-string", "cdcVFileCollectMode": "example-string", "cdcVFileCollectionPeriod": 0, "cdcVFileRetentionPeriod": 0, "cdcVFileAdminStatus": "up(1)", "cdcVFileOperStatus": "up(1)", "cdcVFileErrorCode": "example-string", "cdcVFileCollectionErrorEnable": true, "cdcVFileRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileEntry-4" }, "x-yang-path": "/cdcVFileEntry={cdcVFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry": { "get": { "summary": "Get cdcVFileMgmtEntry list", "description": "Retrieve list of cdcVFileMgmtEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer." }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus" }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry": [ { "cdcVFileIndex": "example-string", "cdcVFileMgmtIndex": 1, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileMgmtEntry-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": "/cdcVFileMgmtEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGEntry": { "get": { "summary": "Get cdcDGEntry list", "description": "Retrieve list of cdcDGEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'." }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue" }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer" }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295 }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGEntry": [ { "cdcDGIndex": 1, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 1, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 1, "cdcDGInstGrpIndex": 1, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGEntry-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": "/cdcDGEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGEntry={cdcDGIndex}": { "get": { "summary": "Get cdcDGEntry entry", "description": "Retrieve specific cdcDGEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'." }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue" }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer" }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295 }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGEntry": { "cdcDGIndex": 1, "cdcDGComment": "example-string", "cdcDGType": "ethernetCsmacd(6)", "cdcDGVFileIndex": 1, "cdcDGTargetTag": "example-string", "cdcDGContextName": "interface-1", "cdcDGObject": "example-string", "cdcDGObjectGrpIndex": 1, "cdcDGInstGrpIndex": 1, "cdcDGPollPeriod": 0, "cdcDGRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGEntry-4" }, "x-yang-path": "/cdcDGEntry={cdcDGIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry": { "get": { "summary": "Get cdcDGBaseObjectEntry list", "description": "Retrieve list of cdcDGBaseObjectEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree" }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList" }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry": [ { "cdcDGBaseObjectGrpIndex": 1, "cdcDGBaseObjectIndex": 1, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGBaseObjectEntry-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": "/cdcDGBaseObjectEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry": { "get": { "summary": "Get cdcDGInstanceEntry list", "description": "Retrieve list of cdcDGInstanceEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'." }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer" }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry": [ { "cdcDGInstanceGrpIndex": 1, "cdcDGInstanceIndex": 1, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGInstanceEntry-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": "/cdcDGInstanceEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry": { "get": { "summary": "Get cdcFileXferConfEntry list", "description": "Retrieve list of cdcFileXferConfEntry entries from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer." }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure." } } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry": [ { "cdcVFileIndex": "example-string", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcFileXferConfEntry-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": "/cdcFileXferConfEntry", "x-restconf-kind": "container" }, "/data/CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry={cdcVFileIndex}": { "get": { "summary": "Get cdcFileXferConfEntry entry", "description": "Retrieve specific cdcFileXferConfEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295 }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer." }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure." } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcFileXferConfEntry": { "cdcVFileIndex": "example-string", "cdcFileXferConfPriUrl": "example-string", "cdcFileXferConfSecUrl": "example-string", "cdcFileXferConfRetryPeriod": 0, "cdcFileXferConfRetryCount": 0, "cdcFileXferConfSuccessEnable": true, "cdcFileXferConfFailureEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcFileXferConfEntry-4" }, "x-yang-path": "/cdcFileXferConfEntry={cdcVFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtTable/cdcVFileMgmtEntry={cdcVFileIndex},{cdcVFileMgmtIndex}": { "get": { "summary": "Get cdcVFileMgmtEntry entry", "description": "Retrieve specific cdcVFileMgmtEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcVFileMgmtIndex", "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": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer." }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus" }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry": { "cdcVFileIndex": "example-string", "cdcVFileMgmtIndex": 1, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileMgmtEntry-2" }, "x-yang-path": "/cdcVFileMgmtTable/cdcVFileMgmtEntry={cdcVFileIndex cdcVFileMgmtIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex cdcVFileMgmtIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectTable/cdcDGBaseObjectEntry={cdcDGBaseObjectGrpIndex},{cdcDGBaseObjectIndex}": { "get": { "summary": "Get cdcDGBaseObjectEntry entry", "description": "Retrieve specific cdcDGBaseObjectEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGBaseObjectGrpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcDGBaseObjectIndex", "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": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree" }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList" }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry": { "cdcDGBaseObjectGrpIndex": 1, "cdcDGBaseObjectIndex": 1, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGBaseObjectEntry-2" }, "x-yang-path": "/cdcDGBaseObjectTable/cdcDGBaseObjectEntry={cdcDGBaseObjectGrpIndex cdcDGBaseObjectIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGBaseObjectGrpIndex cdcDGBaseObjectIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGInstanceTable/cdcDGInstanceEntry={cdcDGInstanceGrpIndex},{cdcDGInstanceIndex}": { "get": { "summary": "Get cdcDGInstanceEntry entry", "description": "Retrieve specific cdcDGInstanceEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGInstanceGrpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcDGInstanceIndex", "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": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'." }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer" }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry": { "cdcDGInstanceGrpIndex": 1, "cdcDGInstanceIndex": 1, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGInstanceEntry-2" }, "x-yang-path": "/cdcDGInstanceTable/cdcDGInstanceEntry={cdcDGInstanceGrpIndex cdcDGInstanceIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGInstanceGrpIndex cdcDGInstanceIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry={cdcVFileIndex},{cdcVFileMgmtIndex}": { "get": { "summary": "Get cdcVFileMgmtEntry entry", "description": "Retrieve specific cdcVFileMgmtEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcVFileIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcVFileMgmtIndex", "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": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref" }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295 }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer." }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus" }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcVFileMgmtEntry": { "cdcVFileIndex": "example-string", "cdcVFileMgmtIndex": 1, "cdcVFileMgmtName": "interface-1", "cdcVFileMgmtTimestamp": "example-string", "cdcVFileMgmtTimeToLive": 0, "cdcVFileMgmtCommand": "example-string", "cdcVFileMgmtXferURL": "example-string", "cdcVFileMgmtLastXferStatus": "up(1)", "cdcVFileMgmtLastXferURL": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcVFileMgmtEntry-4" }, "x-yang-path": "/cdcVFileMgmtEntry={cdcVFileIndex cdcVFileMgmtIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcVFileIndex cdcVFileMgmtIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry={cdcDGBaseObjectGrpIndex},{cdcDGBaseObjectIndex}": { "get": { "summary": "Get cdcDGBaseObjectEntry entry", "description": "Retrieve specific cdcDGBaseObjectEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGBaseObjectGrpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcDGBaseObjectIndex", "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": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree" }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList" }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGBaseObjectEntry": { "cdcDGBaseObjectGrpIndex": 1, "cdcDGBaseObjectIndex": 1, "cdcDGBaseObjectSubtree": "example-string", "cdcDGBaseObjectList": "example-string", "cdcDGBaseObjectRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGBaseObjectEntry-4" }, "x-yang-path": "/cdcDGBaseObjectEntry={cdcDGBaseObjectGrpIndex cdcDGBaseObjectIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGBaseObjectGrpIndex cdcDGBaseObjectIndex" ] }, "/data/CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry={cdcDGInstanceGrpIndex},{cdcDGInstanceIndex}": { "get": { "summary": "Get cdcDGInstanceEntry entry", "description": "Retrieve specific cdcDGInstanceEntry entry by key from MIB", "tags": [ "CISCO-DATA-COLLECTION-MIB" ], "parameters": [ { "name": "cdcDGInstanceGrpIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cdcDGInstanceIndex", "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": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'." }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId" }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295 }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer" }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-DATA-COLLECTION-MIB:cdcDGInstanceEntry": { "cdcDGInstanceGrpIndex": 1, "cdcDGInstanceIndex": 1, "cdcDGInstanceType": "ethernetCsmacd(6)", "cdcDGInstanceOid": "1.3.6.1.2.1.1", "cdcDGInstanceOidEnd": "1.3.6.1.2.1.1", "cdcDGInstanceNumRepititions": 0, "cdcDGInstanceOtherPtr": "example-string", "cdcDGInstanceRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cdcDGInstanceEntry-4" }, "x-yang-path": "/cdcDGInstanceEntry={cdcDGInstanceGrpIndex cdcDGInstanceIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cdcDGInstanceGrpIndex cdcDGInstanceIndex" ] } }, "components": { "schemas": { "CISCO-DATA-COLLECTION-MIB_CISCO-DATA-COLLECTION-MIB": { "type": "object", "description": "This object's value reads 'true', if the agent\n implementation of this MIB supports placement of VFiles in\n application specified persistent storage locations. Otherwise \n the value is 'false'.", "properties": { "cdcVFileEntry": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode).", "readOnly": true }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat", "readOnly": true }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "readOnly": true }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table.", "readOnly": true }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry.", "readOnly": true }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory.", "readOnly": true }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error.", "readOnly": true }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cdcVFileMgmtEntry": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer.", "readOnly": true }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus", "readOnly": true }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true } } }, "readOnly": true }, "cdcDGEntry": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'.", "readOnly": true }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer", "readOnly": true }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cdcDGBaseObjectEntry": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree", "readOnly": true }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList", "readOnly": true }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cdcDGInstanceEntry": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'.", "readOnly": true }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cdcFileXferConfEntry": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer.", "readOnly": true }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure.", "readOnly": true } } }, "readOnly": true }, "cdcVFile": { "type": "object", "description": "This object's value reads 'true', if the agent\n implementation of this MIB supports placement of VFiles in\n application specified persistent storage locations. Otherwise \n the value is 'false'.", "properties": { "cdcVFilePersistentStorage": { "type": "boolean", "description": "This object's value reads 'true', if the agent\n implementation of this MIB supports placement of VFiles in\n application specified persistent storage locations. Otherwise \n the value is 'false'.", "readOnly": true }, "cdcVFileMaxSizeHitsLimit": { "type": "integer", "description": "A global limit for the number of consecutive times the\n maximum VFile size (cdcVFileMaxSize) is exceeded for a\n given VFile. When this limit is exceeded the offending\n cdcVFileEntry is moved to the error state (see\n cdcVFileOperStatus).", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cdcVFileTable": { "type": "object", "description": "A table for setting up VFiles for collecting data.", "properties": { "cdcVFileEntry": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode).", "readOnly": true }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat", "readOnly": true }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "readOnly": true }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table.", "readOnly": true }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry.", "readOnly": true }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory.", "readOnly": true }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error.", "readOnly": true }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdcVFileMgmtTable": { "type": "object", "description": "A table to manage frozen VFiles.", "properties": { "cdcVFileMgmtEntry": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer.", "readOnly": true }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus", "readOnly": true }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdcDGTable": { "type": "object", "description": "A table for specifying data groups.", "properties": { "cdcDGEntry": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'.", "readOnly": true }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer", "readOnly": true }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdcDGBaseObjectTable": { "type": "object", "description": "A table specifying the base objects of a 'table' type\n data group.", "properties": { "cdcDGBaseObjectEntry": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree", "readOnly": true }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList", "readOnly": true }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdcDGInstanceTable": { "type": "object", "description": "Identifies the instances of the base objects that need to\n be fetched for a 'table' type data group.\n \n The agent is not responsible for verifying that the instances\n specified for a data group do not overlap.", "properties": { "cdcDGInstanceEntry": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'.", "readOnly": true }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cdcFileXferConfTable": { "type": "object", "description": "A table for configuring file transfer operations.", "properties": { "cdcFileXferConfEntry": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer.", "readOnly": true }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-DATA-COLLECTION-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtIndex": { "type": "string", "description": "cdcVFileMgmtIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "cdcVFileMgmtLastXferStatus", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DATA-COLLECTION-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtIndex": { "type": "string", "description": "cdcVFileMgmtIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "cdcVFileMgmtLastXferURL", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-DATA-COLLECTION-MIB_cdcVFileEntry": { "type": "array", "description": "cdcVFileEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "integer", "description": "An arbitrary integer for uniquely identifying this\n entry. When creating a row, the application should pick a\n random number. \n \n If the configuration in this entry is persisted across\n system/agent restarts then the same value of cdcVFileIndex\n must be assigned to this entry after the restart.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileName": { "type": "string", "description": "The base-name of the VFiles (created by data collection\n operations corresponding to this entry) into which data is to\n be collected. \n \n When a VFile is created, it's full name is obtained by the\n concatentation of a suffix to this value. The suffix will be\n chosen by the agent such that the VFiles created for this\n entry have unique names. For e.g. the suffix could be a\n string representation of the date and time when the VFile was\n created. \n \n If VFiles are to be placed in the agent's local filesystem\n (provided the agent supports it) then this value should also\n contain the absolute path of the location as a prefix to the\n base name.\n \n An agent will respond with inconsistentValue to\n a management set operation which attempts to modify the value\n of this object to the same value as already held by another\n instance of cdcVFileName, or wrongValue if the new value \n is invalid for use as a file name on the local file \n system (e.g., many file systems do not support white \n space embedded in file names).\n \n This object's value may be modified at any time. However\n the new name will be used only when the next VFile is\n created for this entry.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileDescription": { "type": "string", "description": "A string that can be used for administrative purposes. \n This object's value may be modified at any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcVFileCommand": { "type": "string", "description": "An object for controlling collection of data.\n \n 'idle' Indicates that no command is in progress.\n \n 'swapToNewFile' When written, the current VFile is frozen,\n and a new VFile is created for collecting\n data.\n \t\t If the data collection mode is automatic\n (see cdcVFileCollectMode), then the current \n collection interval is stopped and a new\n collection interval is started \n \t\t (see cdcVFileCollectPeriod). \n \n 'collectNow' When written, base object values for\n all associated data groups are fetched \n and stored into the current VFile. This\n value can only be written when the\n collection mode is 'manual' (see \n cdcVFileCollectMode).", "readOnly": true }, "cdcVFileMaxSize": { "type": "integer", "description": "The maximum size of a VFile. \n \n The agent maintains an internal counter for each\n cdcVFileEntry. This counter counts the number of consecutive\n times the size of a VFile has exceeded the value of this\n object. When the value of this counter exceeds the value of\n cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'\n state (see cdcVFileOperStatus).\n However if the value of cdcVFileMaxSizeHitsLimit is not\n exceeded, then the current VFile is frozen, and a new VFile\n is created for data collection.\n \n If the data collection mode is automatic (see\n cdcVFileCollectMode), then the current collection interval is\n stopped and a new collection interval is started.\n \n This object's value may be modified at any time. The new\n size limit MUST be checked against the size of the current\n VFile at the time of modification, and appropriate action\n taken.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileCurrentSize": { "type": "integer", "description": "The size of the current VFile.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileFormat": { "type": "string", "description": "The format in which data is stored into the current VFile.\n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileFormat", "readOnly": true }, "cdcVFileCollectMode": { "type": "string", "description": "Determines the mode of data collection.\n \n 'auto' Data is periodically fetched for all data\n groups associated with this entry. This is\n done at data group specific periodic intervals\n (cdcDGPollPeriod).\n The data thus collected, is formatted and\n stored into the current VFile. \n In addition at regular intervals (see\n cdcVFileCollectPeriod) a new VFile \n is created to store data, and the current\n VFile is frozen and transferred.\n \n 'manual' Data for all data groups is fetched and\n collected into the current VFile only when \n cdcVFileCommand is set to 'collectNow'. \n \n This object's value cannot be modified while the entry\n is in the 'activated' state.", "readOnly": true }, "cdcVFileCollectionPeriod": { "type": "integer", "description": "Specifies the period of a collection interval. The value\n of this object is used only when the data collection mode is\n automatic (see cdcVFileCollectMode).\n \n A periodic timer (one per entry) is started when this\n entry is 'activated'. The time at which this entry is\n 'activated' is called the 'activation time' for this entry,\n and is internally maintained by the agent.\n \n When this periodic timer expires, the current VFile is\n frozen and a new VFile is created for data collection. \n Transfer is then initiated for the frozen VFile. \n In addition, the internally maintained counter for counting\n the number of consecutive times the size of a VFile has\n exceeded the maximum limit, is reset to zero. (See\n cdcVFileMaxSize) \n \n This object's value may be modified at any time, and the\n new value takes effect immediately. i.e setting a new\n value can cause the current collection interval to terminate\n and a new collection interval to start.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileRetentionPeriod": { "type": "integer", "description": "The time for which a frozen VFile is retained by the\n agent. When a VFile is frozen, a timer (one per frozen VFile)\n is started to keep track of the retention period for the\n VFile. Once this timer expires, the VFile is deleted.\n Till the expiry of the retention period, information \n about frozen VFiles is maintained in \n cdcVFileMgmtTable.\n \n This object's value may be modified at any time, however\n the new value will take effect only for new frozen VFiles.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileAdminStatus": { "type": "string", "description": "A control object to indicate the administratively desired\n state of data collection for this entry. On setting the value\n to 'disabled' data collection operations for this\n entry are stopped, the current VFile is frozen and it's\n transfer is initiated. \n \n Modifying the value of cdcVFileAdminStatus to 'disabled' does\n not remove or change the current configuration as represented\n by the active rows in this table.", "readOnly": true }, "cdcVFileOperStatus": { "type": "string", "description": "A status object to indicate the operational state of\n collection for this entry.\n \n When the value of cdcVFileAdminStatus is modified to be\n 'enabled', the value of this object will change to 'enabled'\n providing it is possible to begin collecting data. If at any\n point of time data cannot be collected because of some error,\n then the value of this object is changed to 'error' and all\n collection operations stop, as if cdcVFileAdminStatus has\n been set to 'disabled'. More information about the nature of\n the error can be obtained by retrieving the value of\n cdcVFileErrorCode. \n \n When the value of cdcVFileAdminStatus is modified to be\n 'disabled', the value of this object will change to\n 'disabled' and data collection operations are stopped for\n this entry.", "readOnly": true }, "cdcVFileErrorCode": { "type": "string", "description": "A value indicating the type of error that has occurred during\n data collection operations for this entry.\n \n noError The value is 'noError' when\n the corresponding value of\n cdcVFileOperStatus is not 'error'.\n \n otherError Any error other than one of the \n following listed errors.\n \n noSpace There is no space left to write into\n the current VFile. \n \n openError Could not open VFile for writing. One\n possible reason could be the existence\n of another file by the same name in\n the agent's filesystem. \n \n tooSmallMaxSize Indicates that cdcVFileMaxSize is \n too small for data collection. The \n cdcVFileMaxSize configured for this\n VFile is not sufficient even to hold \n the data collected in one poll.\n \n tooManyMaxSizeHits Indicates that data collection\n operations are stopped because\n the value of cdcVFileMaxSizeHitsLimit\n has been exceeded. \n \n noResource Some kind of resource was unavailable\n while collecting data. For\n e.g. unavailability of dynamic memory.", "readOnly": true }, "cdcVFileCollectionErrorEnable": { "type": "boolean", "description": "When set to 'true', cdcVFileCollectionError notification will\n be sent out in the event of a data collection error.", "readOnly": true }, "cdcVFileRowStatus": { "type": "string", "description": "The status of this conceptual row. \n A valid cdcVFileName is only mandatory object for setting\n this object to 'active'. But collection of data in to active\n vfile starts only on setting cdcVFileAdminStatus \n to 'enabled'.\n Setting this object to 'destroy' stops all data collection\n operations for this entry, deletes all VFiles and removes\n this entry from cdcVFileTable.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-DATA-COLLECTION-MIB_cdcVFileMgmtEntry": { "type": "array", "description": "cdcVFileMgmtEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcVFileMgmtIndex": { "type": "integer", "description": "This value is a running counter starting at 1,\n generated by the agent so that the combination of \n cdcVFileIndex and cdcVFileMgmtIndex uniquely\n identifies a frozen VFile. The deleted file indicies\n do not get reused.\n \n This object's value needs to be unique only across the\n set of frozen VFiles corresponding to a cdcVFileEntry\n (identified by cdcVFileIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtName": { "type": "string", "description": "The full name of the VFile. If the VFile is stored as a file\n in the agent's filesystem, then this value also contains the\n absolute path of the file.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cdcVFileMgmtTimestamp": { "type": "string", "description": "The timestamp when this VFile was created, in the date-time\n format.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "cdcVFileMgmtTimeToLive": { "type": "integer", "description": "The time left before this VFile is deleted (see\n cdcVFileRetentionPeriod).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcVFileMgmtCommand": { "type": "string", "description": "A control to manage VFiles. \n \n idle This value can be only be read. It indicates\n that no management action is currently being\n performed on this VFile.\n \n delete This value is only written, and is used to\n delete the frozen VFile. Writing this value\n will cause this entry to be removed from this\n table. \n \n transfer This value can be both read and written.\n When read it means that the VFile is in the\n process of being transferred. When written, it\n initiates a transfer for the VFile.\n \n abortTransfer This value can only be written, and is used\n to abort an ongoing transfer.", "readOnly": true }, "cdcVFileMgmtXferURL": { "type": "string", "description": "The complete URL of the destination to which this VFile will\n be transferred in the next attempt. The URL also includes the\n complete filename of the remote file that will be\n created. When the default value of this object is \n retained this VFile will be transferred to the URL \n specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,\n as the case may be.\n \n However an application can specify a different URL, in which\n case the VFile will be transferred to this new URL the next\n time transfer is initiated. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcVFileMgmtLastXferStatus": { "type": "string", "description": "Indicates the status of the last completed transfer.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcFileXferStatus", "readOnly": true }, "cdcVFileMgmtLastXferURL": { "type": "string", "description": "Indicates the URL of the destination to which the last\n (completed) transfer was initiated.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true } } } }, "CISCO-DATA-COLLECTION-MIB_cdcDGEntry": { "type": "array", "description": "cdcDGEntry", "items": { "type": "object", "properties": { "cdcDGIndex": { "type": "integer", "description": "An arbitrary integer used to uniquely identify this entry.\n When creating an entry, a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGComment": { "type": "string", "description": "A descriptive string. This object's value may be modified at\n any time.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGType": { "type": "string", "description": "Identifies the type of this data group.\n object Data is a single MIB object. The fully\n instantiated OID is specified in\n cdcDGBaseObject.\n \n table Data is a logical table. The columns of\n this table correspond to the base objects\n specified in cdcDGBaseObjectTable, and the\n rows correspond to the values of the instances\n specified in cdcDGInstanceTable.\n \n This object's value cannot be modified while the value of\n cdcDGRowStatus is 'active'.", "readOnly": true }, "cdcDGVFileIndex": { "type": "integer", "description": "Corresponds to a value of cdcVFileIndex.\n It is used to associate this data group with a\n cdcVFileEntry. The values of the base objects for \n this data group are stored into the current VFile of the\n associated cdcVFileEntry. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGTargetTag": { "type": "string", "description": "The tag for the target from which to obtain the data for\n this data group.\n \n A length of 0 indicates the local system. In this case,\n access to the objects of this data group is under\n the security credentials of the requester that set\n cdcDGRowStatus to 'active'. Those credentials are\n the input parameters for isAccessAllowed from the\n Architecture for Describing SNMP Management Frameworks.\n \n Otherwise a search is carried out for an entry in the\n snmpTargetAddrTable whose snmpTargetAddrTagList contains the\n tag specified by the value of this object. The security\n credentials (snmpTargetParamsEntry) of the first entry that\n satisfies the above criteria, are passed as input parameters\n for isAccessAllowed. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-target:SnmpTagValue", "readOnly": true }, "cdcDGContextName": { "type": "string", "description": "The management context from which to obtain data for this\n data group.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "cdcDGObject": { "type": "string", "description": "The fully instantiated name of the MIB object whose value\n needs to be fetched. This object's value is used only when\n cdcDGType is of type 'object'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:VariablePointer", "readOnly": true }, "cdcDGObjectGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGBaseObjectGrpIndex, thus\n identifying a set of entries in cdcDGBaseObjectTable, having\n this value of cdcDGBaseObjectGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n This set of entries in cdcDGBaseObjectTable in turn\n identifies the set of base objects, that makes up the columns\n of this 'table' type data group. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstGrpIndex": { "type": "integer", "description": "Corresponds to a value of cdcDGInstanceGrpIndex, thus\n identifying a set of entries in cdcDGInstanceTable, having\n this value of cdcDGInstanceGrpIndex. This object's value is\n used only when cdcDGType is of type 'table'. \n \n The set of entries in cdcDGInstanceTable, in turn identifies\n the set of instances of the base objects, whose values need\n to fetched. If the value is 0, then all instances of the base\n objects will be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGPollPeriod": { "type": "integer", "description": "Specifies the time intervals at which the data should be\n fetched for this data group.\n This object's value is used only when the collection\n mode of the associated cdcVFileEntry is automatic (see\n cdcVFileCollectMode). \n \n A periodic timer is started for this data group when\n cdcDGRowStatus is set to 'active', provided the associated\n cdcVFileEntry has already been 'activated', otherwise it is\n started when the associated cdcVFileEntry is finally\n activated. \n \n The time interval after which the first expiration of this\n timer should occur, is calculated as follows:\n \n (value of sysUpTime.0) + \n (value of cdcPollPeriod for this entry - \n (value of sysUpTime.0 - VFile activation time for the\n associated cdcVFileEntry) % cdcPollPeriod)\n \n Subsequent expirations of the periodic timer can occur as per\n the value specified in cdcDGPollPeriod. This helps in\n synchronizing periodic polling of the data groups with\n respect to the VFile activation time.\n \n This object's value may be modified at any time, and the\n change must take effect immediately. i.e. if the periodic\n timer has been started, it's expiry time may need to be\n re-adjusted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGVFileIndex & cdcDGColGrpIndex.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-DATA-COLLECTION-MIB_cdcDGBaseObjectEntry": { "type": "array", "description": "An individual entry in this table. Each entry is a \n {subtree, list} tuple. Each tuple identifies a set of \n base objects for the associated data group.", "items": { "type": "object", "properties": { "cdcDGBaseObjectGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of base\n objects for a data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGBaseObjectGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry in a group of\n entries (as identified by the value of\n cdcDGBaseObjectGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGBaseObjectSubtree": { "type": "string", "description": "The subtree component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionSubtree", "readOnly": true }, "cdcDGBaseObjectList": { "type": "string", "description": "The list component of a {subtree, list} tuple.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcCollectionList", "readOnly": true }, "cdcDGBaseObjectRowStatus": { "type": "string", "description": "The status of this conceptual row.\n \n This object cannot be set to 'active' until values have been\n assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-DATA-COLLECTION-MIB_cdcDGInstanceEntry": { "type": "array", "description": "An entry in this table. Each entry identifies one or more\n instances of the base objects that need to be fetched.\n An instance is represented by an OID fragment.", "items": { "type": "object", "properties": { "cdcDGInstanceGrpIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceIndex uniquely identifies an entry in\n this table. An application must use the same value (can\n be randomly picked) for this object while creating a group of\n entries that collectively identifies the set of instances for a\n data group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceIndex": { "type": "integer", "description": "This object's value when combined with the value of\n cdcDGInstanceGrpIndex uniquely identifies an entry in\n this table.\n \n A managment application can assign incremental values\n starting from one, when creating each entry within a group\n of entries (as identified by the value of\n cdcDGInstanceGrpIndex).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceType": { "type": "string", "description": "Specifies the way in which the instances are to be used while\n collecting data.\n \n \n individual The value of cdcDGInstanceOid is\n appended to each base object of the\n associated data group, thus giving the exact\n instance of the objects to be collected.\n \n range The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n starting object instance of the range.\n The value of cdcDGInstanceEndOid\n is appended to to each base object in the\n associated data group, thus giving the\n last object instances of the range. \n \n repititions The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus giving the\n first object instance of the next 'n'\n instances that need to be collected.\n The value of 'n' is set in\n cdcDGInstanceNumRepititions.\n \n subTree The value of cdcDGInstanceOid is\n appended to each base object in the\n associated data group, thus identifying the\n OBJECT IDENTFIFIER sub-tree, whose leaf\n instances need to be collected.\n \n other The value of cdcDGInstanceOtherPtr points to a\n row (in another MIB table) that contains MIB\n specific instance selection criteria. A MIB\n defined for such purposes should describe\n the selection criteria.\n \n This object's value cannot be modified while the value of\n cdcDGInstanceStatus is 'active'.", "readOnly": true }, "cdcDGInstanceOid": { "type": "string", "description": "Contains the OBJECT IDENTIFIER fragment that identifies the\n instances of the base objects that need to be collected.\n \n If cdcDGInstanceType is 'individual' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the fully instantiated OID to be fetched.\n \n If cdcDGInstanceType is 'range' then this value\n should be the OID fragment that, when appended to each base\n MIB object gives the start of a range of object instances\n that needs to be fetched.\n \n If cdcDGInstanceType is 'subTree' then this value\n should be the OID fragment that, when appended to each base\n MIB gives the sub-tree under which all leaf object instances\n need to be fetched.\n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceOidEnd": { "type": "string", "description": "Contains the OID fragment that, when appended to each base\n object gives the end of the range of object instances that\n needs to be fetched. \n This value is used only when the value of cdcDGInstanceType\n is of type 'range'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcRowInstanceId", "readOnly": true }, "cdcDGInstanceNumRepititions": { "type": "integer", "description": "Specifies the number of lexicographically consecutive object\n instances to fetch. \n This value is used only when the value of cdcDGInstanceType\n is of type 'repititions'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcDGInstanceOtherPtr": { "type": "string", "description": "Contains a pointer to a row in another MIB table that\n contains MIB specific criteria for selecting instances. \n This value is used only when the value of cdcDGInstanceType\n is of type 'other'. \n \n This object's value may be modified at any time. The change\n takes effect the next time data is fetched for this data\n group.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true }, "cdcDGInstanceRowStatus": { "type": "string", "description": "The status of this conceptual row.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-DATA-COLLECTION-MIB_cdcFileXferConfEntry": { "type": "array", "description": "cdcFileXferConfEntry", "items": { "type": "object", "properties": { "cdcVFileIndex": { "type": "string", "description": "cdcVFileIndex", "x-yang-type": "leafref", "readOnly": true }, "cdcFileXferConfPriUrl": { "type": "string", "description": "The URL which specifies the primary destination to which\n the file has to be transferred. The URL should contain the\n base-name of the remote file, the suffix will be carried over\n from the name of the VFile being tranferred, and will be\n automatically appended by the agent.\n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfSecUrl": { "type": "string", "description": "The URL which specifies the secondary destination to which\n the file has to be transferred if the transfer to the \n primary destination fails. Failure occurs when the file\n cannot be transferred in it's entirety to the specified\n destination for some reason. Some common reasons for such\n failures are listed out in CdcFileXferStatus. \n \n The specified URL should contain the base-name of the remote\n file, the suffix will be carried over from the name of the\n VFile being tranferred, and will be automatically appended by\n the agent. \n \n This object's value may be modified at any time.", "x-yang-type": "CISCO-DATA-COLLECTION-MIB:CdcUrl", "readOnly": true }, "cdcFileXferConfRetryPeriod": { "type": "integer", "description": "Specifies the time interval after which transfer has to be\n retried. Transfer needs to be retried only if in a previous\n attempt the file could not be successfully transferred to\n either the primary destination or the secondary destination.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfRetryCount": { "type": "integer", "description": "Maximum number of times, transfer has to be retried. If the\n retry count exceeds this value, then no further attempts will\n be made.\n \n This object's value may be modified at any time.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cdcFileXferConfSuccessEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a successful file transfer.", "readOnly": true }, "cdcFileXferConfFailureEnable": { "type": "boolean", "description": "When set to 'true', cdcFileXferComplete notification will\n be sent out in the event of a file transfer failure.", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-DATA-COLLECTION-MIB", "description": "MIB operations for CISCO-DATA-COLLECTION-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }