{ "openapi": "3.0.0", "info": { "title": "CISCO-FLASH-MIB MIB API", "version": "1.0.0", "description": "This MIB provides for the management of Cisco\n Flash Devices.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-FLASH-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-FLASH-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-FLASH-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-FLASH-MIB:ciscoFlashDevice": { "get": { "summary": "Get ciscoFlashDevice data", "description": "Retrieve ciscoFlashDevice operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Number of Flash devices supported by the system.\n If the system does not support any Flash devices, this\n MIB will not be loaded on that system. The value of this\n object will therefore be atleast 1.", "properties": { "ciscoFlashDevicesSupported": { "type": "integer", "description": "Number of Flash devices supported by the system.\n If the system does not support any Flash devices, this\n MIB will not be loaded on that system. The value of this\n object will therefore be atleast 1.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDevice": { "ciscoFlashDevicesSupported": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDevice", "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": "/ciscoFlashDevice", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCfg": { "get": { "summary": "Get ciscoFlashCfg data", "description": "Retrieve ciscoFlashCfg operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ciscoFlashCfg", "properties": { "ciscoFlashCfgDevInsNotifEnable": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the insertion of a Flash device.\n \n If the value of this object is 'true' then the\n ciscoFlashDeviceInsertedNotif notification\n will be generated.\n \n If the value of this object is 'false' then the\n ciscoFlashDeviceInsertedNotif notification\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashCfgDevRemNotifEnable": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the removal of a Flash device.\n \n If the value of this object is 'true' then the\n ciscoFlashDeviceRemovedNotif notification\n will be generated.\n \n If the value of this object is 'false' then the\n ciscoFlashDeviceRemovedNotif notification\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitionLowSpaceNotifEnable": { "type": "boolean", "description": "This object specifies whether or not a notification should be\n generated when the free space falls below the threshold value on\n a flash partition and on recovery from low space.\n \n If the value of this object is 'true' then\n ciscoFlashPartitionLowSpaceNotif and\n ciscoFlashPartitionLowSpaceRecoveryNotif notifications will be\n generated.\n \n If the value of this object is 'false' then the\n ciscoFlashPartitionLowSpaceNotif and\n ciscoFlashPartitionLowSpaceRecoveryNotif notifications\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notifications to be delivered." } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCfg": { "ciscoFlashCfgDevInsNotifEnable": true, "ciscoFlashCfgDevRemNotifEnable": true, "ciscoFlashPartitionLowSpaceNotifEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCfg", "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": "/ciscoFlashCfg", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashDeviceTable": { "get": { "summary": "Get ciscoFlashDeviceTable data", "description": "Retrieve ciscoFlashDeviceTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "ciscoFlashDeviceTable", "properties": { "ciscoFlashDeviceEntry": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer" }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state." }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp" }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion." }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0 }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0 } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDeviceTable": { "ciscoFlashDeviceEntry": [ { "ciscoFlashDeviceIndex": 1, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "1", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 }, { "ciscoFlashDeviceIndex": 2, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "2", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 }, { "ciscoFlashDeviceIndex": 3, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "3", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDeviceTable", "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": "/ciscoFlashDeviceTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashDeviceTable/ciscoFlashDeviceEntry": { "get": { "summary": "Get ciscoFlashDeviceEntry list", "description": "Retrieve list of ciscoFlashDeviceEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer" }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state." }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp" }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion." }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0 }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0 } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDeviceEntry": [ { "ciscoFlashDeviceIndex": 1, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "example-string", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDeviceEntry", "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": "/ciscoFlashDeviceTable/ciscoFlashDeviceEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashDeviceTable/ciscoFlashDeviceEntry={ciscoFlashDeviceIndex}": { "get": { "summary": "Get ciscoFlashDeviceEntry entry", "description": "Retrieve specific ciscoFlashDeviceEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "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": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer" }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state." }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp" }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion." }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0 }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0 } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDeviceEntry": { "ciscoFlashDeviceIndex": 1, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "example-string", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDeviceEntry-2" }, "x-yang-path": "/ciscoFlashDeviceTable/ciscoFlashDeviceEntry={ciscoFlashDeviceIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashChipTable": { "get": { "summary": "Get ciscoFlashChipTable data", "description": "Retrieve ciscoFlashChipTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of Flash device chip properties for each\n initialized Flash device.\n This table is meant primarily for aiding error\n diagnosis.", "properties": { "ciscoFlashChipEntry": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashChipTable": { "ciscoFlashChipEntry": [ { "ciscoFlashDeviceIndex": "1", "ciscoFlashChipIndex": 1, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 }, { "ciscoFlashDeviceIndex": "2", "ciscoFlashChipIndex": 2, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 }, { "ciscoFlashDeviceIndex": "3", "ciscoFlashChipIndex": 3, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashChipTable", "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": "/ciscoFlashChipTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashChipTable/ciscoFlashChipEntry": { "get": { "summary": "Get ciscoFlashChipEntry list", "description": "Retrieve list of ciscoFlashChipEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashChipEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashChipIndex": 1, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashChipEntry", "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": "/ciscoFlashChipTable/ciscoFlashChipEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitionTable": { "get": { "summary": "Get ciscoFlashPartitionTable data", "description": "Retrieve ciscoFlashPartitionTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of flash device partition properties for each\n initialized flash partition. Whenever there is no\n explicit partitioning done, a single partition spanning\n the entire device will be assumed to exist. There will\n therefore always be atleast one partition on a device.", "properties": { "ciscoFlashPartitionEntry": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary." }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable." }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image." }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail." }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0 }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0 }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent" } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitionTable": { "ciscoFlashPartitionEntry": [ { "ciscoFlashDeviceIndex": "1", "ciscoFlashPartitionIndex": 1, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" }, { "ciscoFlashDeviceIndex": "2", "ciscoFlashPartitionIndex": 2, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" }, { "ciscoFlashDeviceIndex": "3", "ciscoFlashPartitionIndex": 3, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitionTable", "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": "/ciscoFlashPartitionTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitionTable/ciscoFlashPartitionEntry": { "get": { "summary": "Get ciscoFlashPartitionEntry list", "description": "Retrieve list of ciscoFlashPartitionEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary." }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable." }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image." }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail." }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0 }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0 }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitionEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": 1, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitionEntry", "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": "/ciscoFlashPartitionTable/ciscoFlashPartitionEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileTable": { "get": { "summary": "Get ciscoFlashFileTable data", "description": "Retrieve ciscoFlashFileTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information for files in a Flash partition.", "properties": { "ciscoFlashFileEntry": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid." }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType" }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileTable": { "ciscoFlashFileEntry": [ { "ciscoFlashDeviceIndex": "1", "ciscoFlashPartitionIndex": "1", "ciscoFlashFileIndex": 1, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" }, { "ciscoFlashDeviceIndex": "2", "ciscoFlashPartitionIndex": "2", "ciscoFlashFileIndex": 2, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" }, { "ciscoFlashDeviceIndex": "3", "ciscoFlashPartitionIndex": "3", "ciscoFlashFileIndex": 3, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileTable", "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": "/ciscoFlashFileTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileTable/ciscoFlashFileEntry": { "get": { "summary": "Get ciscoFlashFileEntry list", "description": "Retrieve list of ciscoFlashFileEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid." }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType" }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": 1, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileEntry", "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": "/ciscoFlashFileTable/ciscoFlashFileEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileByTypeTable": { "get": { "summary": "Get ciscoFlashFileByTypeTable data", "description": "Retrieve ciscoFlashFileByTypeTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "Table of information for files on the manageable\n flash devices sorted by File Types.", "properties": { "ciscoFlashFileByTypeEntry": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref" }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref" }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable." }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileByTypeTable": { "ciscoFlashFileByTypeEntry": [ { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "1", "ciscoFlashPartitionIndex": "1", "ciscoFlashFileIndex": "1", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" }, { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "2", "ciscoFlashPartitionIndex": "2", "ciscoFlashFileIndex": "2", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" }, { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "3", "ciscoFlashPartitionIndex": "3", "ciscoFlashFileIndex": "3", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileByTypeTable", "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": "/ciscoFlashFileByTypeTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileByTypeTable/ciscoFlashFileByTypeEntry": { "get": { "summary": "Get ciscoFlashFileByTypeEntry list", "description": "Retrieve list of ciscoFlashFileByTypeEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref" }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref" }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable." }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry": [ { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": "example-string", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileByTypeEntry", "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": "/ciscoFlashFileByTypeTable/ciscoFlashFileByTypeEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable": { "get": { "summary": "Get ciscoFlashCopyTable data", "description": "Retrieve ciscoFlashCopyTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of Flash copy operation entries. Each\n entry represents a Flash copy operation (to or\n from Flash) that has been initiated.", "properties": { "ciscoFlashCopyEntry": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)" }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command." }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address" }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString" } } } }, "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "ciscoFlashPartitioningTable": { "type": "object", "description": "A table of Flash partitioning operation entries. Each\n entry represents a Flash partitioning operation that\n has been initiated.", "properties": { "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "ciscoFlashMiscOpTable": { "type": "object", "description": "A table of misc Flash operation entries. Each\n entry represents a Flash operation that\n has been initiated.", "properties": { "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCopyTable": { "ciscoFlashCopyEntry": [ { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" }, { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" }, { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" } ], "ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ], "ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ], "ciscoFlashPartitioningTable": { "ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ] }, "ciscoFlashMiscOpTable": { "ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ] } } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCopyTable", "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": "/ciscoFlashCopyTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashPartitioningTable": { "get": { "summary": "Get ciscoFlashPartitioningTable data", "description": "Retrieve ciscoFlashPartitioningTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of Flash partitioning operation entries. Each\n entry represents a Flash partitioning operation that\n has been initiated.", "properties": { "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningTable": { "ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" }, { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningTable", "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": "/ciscoFlashCopyTable/ciscoFlashPartitioningTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashPartitioningTable/ciscoFlashPartitioningEntry": { "get": { "summary": "Get ciscoFlashPartitioningEntry list", "description": "Retrieve list of ciscoFlashPartitioningEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry", "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": "/ciscoFlashCopyTable/ciscoFlashPartitioningTable/ciscoFlashPartitioningEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashPartitioningTable/ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}": { "get": { "summary": "Get ciscoFlashPartitioningEntry entry", "description": "Retrieve specific ciscoFlashPartitioningEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashPartitioningSerialNumber", "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": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry-2" }, "x-yang-path": "/ciscoFlashCopyTable/ciscoFlashPartitioningTable/ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashPartitioningSerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashMiscOpTable": { "get": { "summary": "Get ciscoFlashMiscOpTable data", "description": "Retrieve ciscoFlashMiscOpTable operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of misc Flash operation entries. Each\n entry represents a Flash operation that\n has been initiated.", "properties": { "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpTable": { "ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" }, { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpTable", "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": "/ciscoFlashCopyTable/ciscoFlashMiscOpTable", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashMiscOpTable/ciscoFlashMiscOpEntry": { "get": { "summary": "Get ciscoFlashMiscOpEntry list", "description": "Retrieve list of ciscoFlashMiscOpEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry", "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": "/ciscoFlashCopyTable/ciscoFlashMiscOpTable/ciscoFlashMiscOpEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashMiscOpTable/ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}": { "get": { "summary": "Get ciscoFlashMiscOpEntry entry", "description": "Retrieve specific ciscoFlashMiscOpEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashMiscOpSerialNumber", "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": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry-2" }, "x-yang-path": "/ciscoFlashCopyTable/ciscoFlashMiscOpTable/ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashMiscOpSerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashCopyEntry": { "get": { "summary": "Get ciscoFlashCopyEntry list", "description": "Retrieve list of ciscoFlashCopyEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)" }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command." }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address" }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCopyEntry": [ { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCopyEntry", "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": "/ciscoFlashCopyTable/ciscoFlashCopyEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashCopyEntry={ciscoFlashCopySerialNumber}": { "get": { "summary": "Get ciscoFlashCopyEntry entry", "description": "Retrieve specific ciscoFlashCopyEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashCopySerialNumber", "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": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)" }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command." }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address" }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCopyEntry": { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCopyEntry-2" }, "x-yang-path": "/ciscoFlashCopyTable/ciscoFlashCopyEntry={ciscoFlashCopySerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashCopySerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashPartitioningEntry": { "get": { "summary": "Get ciscoFlashPartitioningEntry list", "description": "Retrieve list of ciscoFlashPartitioningEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry-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": "/ciscoFlashCopyTable/ciscoFlashPartitioningEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}": { "get": { "summary": "Get ciscoFlashPartitioningEntry entry", "description": "Retrieve specific ciscoFlashPartitioningEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashPartitioningSerialNumber", "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": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry-4" }, "x-yang-path": "/ciscoFlashCopyTable/ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashPartitioningSerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashMiscOpEntry": { "get": { "summary": "Get ciscoFlashMiscOpEntry list", "description": "Retrieve list of ciscoFlashMiscOpEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry-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": "/ciscoFlashCopyTable/ciscoFlashMiscOpEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyTable/ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}": { "get": { "summary": "Get ciscoFlashMiscOpEntry entry", "description": "Retrieve specific ciscoFlashMiscOpEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashMiscOpSerialNumber", "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": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry-4" }, "x-yang-path": "/ciscoFlashCopyTable/ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashMiscOpSerialNumber" ] }, "/data/CISCO-FLASH-MIB:object-1": { "get": { "summary": "Get object-1 data", "description": "Retrieve object-1 operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "object-1", "properties": { "ciscoFlashCopySerialNumber": { "type": "string", "description": "ciscoFlashCopySerialNumber", "x-yang-type": "leafref" }, "ciscoFlashCopyStatus": { "type": "string", "description": "ciscoFlashCopyStatus", "x-yang-type": "leafref" } } }, "example": { "CISCO-FLASH-MIB:object-1": { "ciscoFlashCopySerialNumber": "example-string", "ciscoFlashCopyStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-object-1", "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": "/object-1", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:object-2": { "get": { "summary": "Get object-2 data", "description": "Retrieve object-2 operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "object-2", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashDeviceName": { "type": "string", "description": "ciscoFlashDeviceName", "x-yang-type": "leafref" } } }, "example": { "CISCO-FLASH-MIB:object-2": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashDeviceName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-object-2", "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": "/object-2", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:object-3": { "get": { "summary": "Get object-3 data", "description": "Retrieve object-3 operational data from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "object-3", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "ciscoFlashPartitionLowSpaceNotifThreshold", "x-yang-type": "leafref" } } }, "example": { "CISCO-FLASH-MIB:object-3": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-object-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": "/object-3", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashDeviceEntry": { "get": { "summary": "Get ciscoFlashDeviceEntry list", "description": "Retrieve list of ciscoFlashDeviceEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer" }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state." }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp" }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion." }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0 }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0 } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDeviceEntry": [ { "ciscoFlashDeviceIndex": 1, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "example-string", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDeviceEntry-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": "/ciscoFlashDeviceEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashDeviceEntry={ciscoFlashDeviceIndex}": { "get": { "summary": "Get ciscoFlashDeviceEntry entry", "description": "Retrieve specific ciscoFlashDeviceEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "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": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer" }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state." }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp" }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion." }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0 }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0 } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashDeviceEntry": { "ciscoFlashDeviceIndex": 1, "ciscoFlashDeviceSize": 0, "ciscoFlashDeviceMinPartitionSize": 0, "ciscoFlashDeviceMaxPartitions": 0, "ciscoFlashDevicePartitions": 0, "ciscoFlashDeviceChipCount": -2147483648, "ciscoFlashDeviceName": "interface-1", "ciscoFlashDeviceDescr": "GigabitEthernet1/0/1", "ciscoFlashDeviceController": "example-string", "ciscoFlashDeviceCard": "example-string", "ciscoFlashDeviceProgrammingJumper": "example-string", "ciscoFlashDeviceInitTime": "example-string", "ciscoFlashDeviceRemovable": true, "ciscoFlashPhyEntIndex": "example-string", "ciscoFlashDeviceNameExtended": "interface-1", "ciscoFlashDeviceSizeExtended": 0, "ciscoFlashDeviceMinPartitionSizeExtended": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashDeviceEntry-4" }, "x-yang-path": "/ciscoFlashDeviceEntry={ciscoFlashDeviceIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashChipEntry": { "get": { "summary": "Get ciscoFlashChipEntry list", "description": "Retrieve list of ciscoFlashChipEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashChipEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashChipIndex": 1, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashChipEntry-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": "/ciscoFlashChipEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitionEntry": { "get": { "summary": "Get ciscoFlashPartitionEntry list", "description": "Retrieve list of ciscoFlashPartitionEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary." }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable." }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image." }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail." }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0 }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0 }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitionEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": 1, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitionEntry-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": "/ciscoFlashPartitionEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileEntry": { "get": { "summary": "Get ciscoFlashFileEntry list", "description": "Retrieve list of ciscoFlashFileEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid." }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType" }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileEntry": [ { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": 1, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileEntry-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": "/ciscoFlashFileEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry": { "get": { "summary": "Get ciscoFlashFileByTypeEntry list", "description": "Retrieve list of ciscoFlashFileByTypeEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref" }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref" }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable." }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry": [ { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": "example-string", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileByTypeEntry-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": "/ciscoFlashFileByTypeEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyEntry": { "get": { "summary": "Get ciscoFlashCopyEntry list", "description": "Retrieve list of ciscoFlashCopyEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)" }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command." }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address" }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCopyEntry": [ { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCopyEntry-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": "/ciscoFlashCopyEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashCopyEntry={ciscoFlashCopySerialNumber}": { "get": { "summary": "Get ciscoFlashCopyEntry entry", "description": "Retrieve specific ciscoFlashCopyEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashCopySerialNumber", "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": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)" }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command." }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address" }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashCopyEntry": { "ciscoFlashCopySerialNumber": -2147483648, "ciscoFlashCopyCommand": "example-string", "ciscoFlashCopyProtocol": "example-string", "ciscoFlashCopyServerAddress": "192.168.1.1", "ciscoFlashCopySourceName": "interface-1", "ciscoFlashCopyDestinationName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashCopyEntry-4" }, "x-yang-path": "/ciscoFlashCopyEntry={ciscoFlashCopySerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashCopySerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": { "get": { "summary": "Get ciscoFlashPartitioningEntry list", "description": "Retrieve list of ciscoFlashPartitioningEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": [ { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry-5", "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": "/ciscoFlashPartitioningEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}": { "get": { "summary": "Get ciscoFlashPartitioningEntry entry", "description": "Retrieve specific ciscoFlashPartitioningEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashPartitioningSerialNumber", "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": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)" }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown" }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitioningEntry": { "ciscoFlashPartitioningSerialNumber": -2147483648, "ciscoFlashPartitioningCommand": "example-string", "ciscoFlashPartitioningDestinationName": "interface-1", "ciscoFlashPartitioningPartitionCount": 0, "ciscoFlashPartitioningPartitionSizes": "example-string", "ciscoFlashPartitioningStatus": "up(1)", "ciscoFlashPartitioningNotifyOnCompletion": true, "ciscoFlashPartitioningTime": "example-string", "ciscoFlashPartitioningEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitioningEntry-6" }, "x-yang-path": "/ciscoFlashPartitioningEntry={ciscoFlashPartitioningSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashPartitioningSerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": { "get": { "summary": "Get ciscoFlashMiscOpEntry list", "description": "Retrieve list of ciscoFlashMiscOpEntry entries from MIB", "tags": [ "CISCO-FLASH-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": [ { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry-5", "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": "/ciscoFlashMiscOpEntry", "x-restconf-kind": "container" }, "/data/CISCO-FLASH-MIB:ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}": { "get": { "summary": "Get ciscoFlashMiscOpEntry entry", "description": "Retrieve specific ciscoFlashMiscOpEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashMiscOpSerialNumber", "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": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)" }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed" }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered." }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks" }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashMiscOpEntry": { "ciscoFlashMiscOpSerialNumber": -2147483648, "ciscoFlashMiscOpCommand": "example-string", "ciscoFlashMiscOpDestinationName": "interface-1", "ciscoFlashMiscOpStatus": "up(1)", "ciscoFlashMiscOpNotifyOnCompletion": true, "ciscoFlashMiscOpTime": "example-string", "ciscoFlashMiscOpEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashMiscOpEntry-6" }, "x-yang-path": "/ciscoFlashMiscOpEntry={ciscoFlashMiscOpSerialNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashMiscOpSerialNumber" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashChipTable/ciscoFlashChipEntry={ciscoFlashDeviceIndex},{ciscoFlashChipIndex}": { "get": { "summary": "Get ciscoFlashChipEntry entry", "description": "Retrieve specific ciscoFlashChipEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashChipIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashChipEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashChipIndex": 1, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashChipEntry-2" }, "x-yang-path": "/ciscoFlashChipTable/ciscoFlashChipEntry={ciscoFlashDeviceIndex ciscoFlashChipIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashChipIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitionTable/ciscoFlashPartitionEntry={ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex}": { "get": { "summary": "Get ciscoFlashPartitionEntry entry", "description": "Retrieve specific ciscoFlashPartitionEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary." }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable." }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image." }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail." }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0 }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0 }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitionEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": 1, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitionEntry-2" }, "x-yang-path": "/ciscoFlashPartitionTable/ciscoFlashPartitionEntry={ciscoFlashDeviceIndex ciscoFlashPartitionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashPartitionIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashFileTable/ciscoFlashFileEntry={ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex},{ciscoFlashFileIndex}": { "get": { "summary": "Get ciscoFlashFileEntry entry", "description": "Retrieve specific ciscoFlashFileEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashFileIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid." }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType" }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": 1, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileEntry-2" }, "x-yang-path": "/ciscoFlashFileTable/ciscoFlashFileEntry={ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashFileByTypeTable/ciscoFlashFileByTypeEntry={ciscoFlashFileType},{ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex},{ciscoFlashFileIndex}": { "get": { "summary": "Get ciscoFlashFileByTypeEntry entry", "description": "Retrieve specific ciscoFlashFileByTypeEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashFileType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashFileIndex", "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": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref" }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref" }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable." }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry": { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": "example-string", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileByTypeEntry-2" }, "x-yang-path": "/ciscoFlashFileByTypeTable/ciscoFlashFileByTypeEntry={ciscoFlashFileType ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashFileType ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashChipEntry={ciscoFlashDeviceIndex},{ciscoFlashChipIndex}": { "get": { "summary": "Get ciscoFlashChipEntry entry", "description": "Retrieve specific ciscoFlashChipEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashChipIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashChipEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashChipIndex": 1, "ciscoFlashChipCode": "192.168.1.1", "ciscoFlashChipDescr": "192.168.1.1", "ciscoFlashChipWriteRetries": 0, "ciscoFlashChipEraseRetries": 0, "ciscoFlashChipMaxWriteRetries": 0, "ciscoFlashChipMaxEraseRetries": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashChipEntry-4" }, "x-yang-path": "/ciscoFlashChipEntry={ciscoFlashDeviceIndex ciscoFlashChipIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashChipIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashPartitionEntry={ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex}": { "get": { "summary": "Get ciscoFlashPartitionEntry entry", "description": "Retrieve specific ciscoFlashPartitionEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary." }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable." }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image." }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail." }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647 }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0 }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0 }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashPartitionEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": 1, "ciscoFlashPartitionStartChip": -2147483648, "ciscoFlashPartitionEndChip": -2147483648, "ciscoFlashPartitionSize": 0, "ciscoFlashPartitionFreeSpace": 0, "ciscoFlashPartitionFileCount": 0, "ciscoFlashPartitionChecksumAlgorithm": "example-string", "ciscoFlashPartitionStatus": "up(1)", "ciscoFlashPartitionUpgradeMethod": "example-string", "ciscoFlashPartitionName": "interface-1", "ciscoFlashPartitionNeedErasure": true, "ciscoFlashPartitionFileNameLength": -2147483648, "ciscoFlashPartitionSizeExtended": 0, "ciscoFlashPartitionFreeSpaceExtended": 0, "ciscoFlashPartitionLowSpaceNotifThreshold": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashPartitionEntry-4" }, "x-yang-path": "/ciscoFlashPartitionEntry={ciscoFlashDeviceIndex ciscoFlashPartitionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashPartitionIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashFileEntry={ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex},{ciscoFlashFileIndex}": { "get": { "summary": "Get ciscoFlashFileEntry entry", "description": "Retrieve specific ciscoFlashFileEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashFileIndex", "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": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid." }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType" }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileEntry": { "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": 1, "ciscoFlashFileSize": 0, "ciscoFlashFileChecksum": "example-string", "ciscoFlashFileStatus": "up(1)", "ciscoFlashFileName": "interface-1", "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashFileDate": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileEntry-4" }, "x-yang-path": "/ciscoFlashFileEntry={ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex" ] }, "/data/CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry={ciscoFlashFileType},{ciscoFlashDeviceIndex},{ciscoFlashPartitionIndex},{ciscoFlashFileIndex}": { "get": { "summary": "Get ciscoFlashFileByTypeEntry entry", "description": "Retrieve specific ciscoFlashFileByTypeEntry entry by key from MIB", "tags": [ "CISCO-FLASH-MIB" ], "parameters": [ { "name": "ciscoFlashFileType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashDeviceIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashPartitionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ciscoFlashFileIndex", "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": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref" }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref" }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref" }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref" }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295 }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString" }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable." }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString" }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime" } } }, "example": { "CISCO-FLASH-MIB:ciscoFlashFileByTypeEntry": { "ciscoFlashFileType": "ethernetCsmacd(6)", "ciscoFlashDeviceIndex": "example-string", "ciscoFlashPartitionIndex": "example-string", "ciscoFlashFileIndex": "example-string", "ciscoFlashFileByTypeSize": 0, "ciscoFlashFileByTypeChecksum": "ethernetCsmacd(6)", "ciscoFlashFileByTypeStatus": "ethernetCsmacd(6)", "ciscoFlashFileByTypeName": "ethernetCsmacd(6)", "ciscoFlashFileByTypeDate": "ethernetCsmacd(6)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-ciscoFlashFileByTypeEntry-4" }, "x-yang-path": "/ciscoFlashFileByTypeEntry={ciscoFlashFileType ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ciscoFlashFileType ciscoFlashDeviceIndex ciscoFlashPartitionIndex ciscoFlashFileIndex" ] } }, "components": { "schemas": { "CISCO-FLASH-MIB_CISCO-FLASH-MIB": { "type": "object", "description": "Number of Flash devices supported by the system.\n If the system does not support any Flash devices, this\n MIB will not be loaded on that system. The value of this\n object will therefore be atleast 1.", "properties": { "ciscoFlashDeviceEntry": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer", "readOnly": true }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state.", "readOnly": true }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion.", "readOnly": true }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0, "readOnly": true }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0, "readOnly": true } } }, "readOnly": true }, "ciscoFlashChipEntry": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "ciscoFlashPartitionEntry": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary.", "readOnly": true }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable.", "readOnly": true }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image.", "readOnly": true }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail.", "readOnly": true }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent", "readOnly": true } } }, "readOnly": true }, "ciscoFlashFileEntry": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid.", "readOnly": true }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType", "readOnly": true }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true }, "ciscoFlashFileByTypeEntry": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable.", "readOnly": true }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true }, "ciscoFlashCopyEntry": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command.", "readOnly": true }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true } } }, "readOnly": true }, "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown", "readOnly": true }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed", "readOnly": true }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ciscoFlashDevice": { "type": "object", "description": "Number of Flash devices supported by the system.\n If the system does not support any Flash devices, this\n MIB will not be loaded on that system. The value of this\n object will therefore be atleast 1.", "properties": { "ciscoFlashDevicesSupported": { "type": "integer", "description": "Number of Flash devices supported by the system.\n If the system does not support any Flash devices, this\n MIB will not be loaded on that system. The value of this\n object will therefore be atleast 1.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "ciscoFlashCfg": { "type": "object", "description": "ciscoFlashCfg", "properties": { "ciscoFlashCfgDevInsNotifEnable": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the insertion of a Flash device.\n \n If the value of this object is 'true' then the\n ciscoFlashDeviceInsertedNotif notification\n will be generated.\n \n If the value of this object is 'false' then the\n ciscoFlashDeviceInsertedNotif notification\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashCfgDevRemNotifEnable": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the removal of a Flash device.\n \n If the value of this object is 'true' then the\n ciscoFlashDeviceRemovedNotif notification\n will be generated.\n \n If the value of this object is 'false' then the\n ciscoFlashDeviceRemovedNotif notification\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashPartitionLowSpaceNotifEnable": { "type": "boolean", "description": "This object specifies whether or not a notification should be\n generated when the free space falls below the threshold value on\n a flash partition and on recovery from low space.\n \n If the value of this object is 'true' then\n ciscoFlashPartitionLowSpaceNotif and\n ciscoFlashPartitionLowSpaceRecoveryNotif notifications will be\n generated.\n \n If the value of this object is 'false' then the\n ciscoFlashPartitionLowSpaceNotif and\n ciscoFlashPartitionLowSpaceRecoveryNotif notifications\n will not be generated.\n \n It is the responsibility of the management entity to\n ensure that the SNMP administrative model is\n configured in such a way as to allow the\n notifications to be delivered.", "readOnly": true } }, "readOnly": true }, "ciscoFlashDeviceTable": { "type": "object", "description": "ciscoFlashDeviceTable", "properties": { "ciscoFlashDeviceEntry": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer", "readOnly": true }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state.", "readOnly": true }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion.", "readOnly": true }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0, "readOnly": true }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashChipTable": { "type": "object", "description": "Table of Flash device chip properties for each\n initialized Flash device.\n This table is meant primarily for aiding error\n diagnosis.", "properties": { "ciscoFlashChipEntry": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashPartitionTable": { "type": "object", "description": "Table of flash device partition properties for each\n initialized flash partition. Whenever there is no\n explicit partitioning done, a single partition spanning\n the entire device will be assumed to exist. There will\n therefore always be atleast one partition on a device.", "properties": { "ciscoFlashPartitionEntry": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary.", "readOnly": true }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable.", "readOnly": true }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image.", "readOnly": true }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail.", "readOnly": true }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashFileTable": { "type": "object", "description": "Table of information for files in a Flash partition.", "properties": { "ciscoFlashFileEntry": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid.", "readOnly": true }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType", "readOnly": true }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashFileByTypeTable": { "type": "object", "description": "Table of information for files on the manageable\n flash devices sorted by File Types.", "properties": { "ciscoFlashFileByTypeEntry": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable.", "readOnly": true }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashCopyTable": { "type": "object", "description": "A table of Flash copy operation entries. Each\n entry represents a Flash copy operation (to or\n from Flash) that has been initiated.", "properties": { "ciscoFlashCopyEntry": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command.", "readOnly": true }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true } } }, "readOnly": true }, "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown", "readOnly": true }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed", "readOnly": true }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "ciscoFlashPartitioningTable": { "type": "object", "description": "A table of Flash partitioning operation entries. Each\n entry represents a Flash partitioning operation that\n has been initiated.", "properties": { "ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown", "readOnly": true }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "ciscoFlashMiscOpTable": { "type": "object", "description": "A table of misc Flash operation entries. Each\n entry represents a Flash operation that\n has been initiated.", "properties": { "ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed", "readOnly": true }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } }, "readOnly": true }, "object-1": { "type": "object", "description": "object-1", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionName": { "type": "string", "description": "ciscoFlashPartitionName", "x-yang-type": "leafref", "readOnly": true } }, "readOnly": true }, "object-2": { "type": "object", "description": "object-2", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "string", "description": "ciscoFlashPartitionFreeSpaceExtended", "x-yang-type": "leafref", "readOnly": true } }, "readOnly": true }, "object-3": { "type": "object", "description": "object-3", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "ciscoFlashPartitionLowSpaceNotifThreshold", "x-yang-type": "leafref", "readOnly": true } }, "readOnly": true } } }, "CISCO-FLASH-MIB_ciscoFlashDeviceEntry": { "type": "array", "description": "ciscoFlashDeviceEntry", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "integer", "description": "Flash device sequence number to index within the\n table of initialized flash devices.\n The lowest value should be 1. The highest should be\n less than or equal to the value of the\n ciscoFlashDevicesSupported object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceSize": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashDeviceSizeExtended must be used to report the\n flash device's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMinPartitionSize": { "type": "integer", "description": "This object will give the minimum partition size\n supported for this device. For systems that execute code\n directly out of Flash, the minimum partition size needs\n to be the bank size. (Bank size is equal to the size of a\n chip multiplied by the width of the device. In most cases,\n the device width is 4 bytes, and so the bank size would be\n four times the size of a chip). This has to be so because\n all programming commands affect the operation of an\n entire chip (in our case, an entire bank because all\n operations are done on the entire width of the device)\n even though the actual command may be localized to a small\n portion of each chip. So when executing code out of Flash,\n one needs to be able to write and erase some portion of\n Flash without affecting the code execution.\n For systems that execute code out of DRAM or ROM, it is\n possible to partition Flash with a finer granularity (for\n eg., at erase sector boundaries) if the system code supports\n such granularity.\n \n This object will let a management entity know the\n minimum partition size as defined by the system.\n If the system does not support partitioning, the value\n will be equal to the device size in ciscoFlashDeviceSize.\n The maximum number of partitions that could be configured\n will be equal to the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n \n If the total size of the flash device is greater than the\n maximum value reportable by this object then this object should\n report its maximum value(4,294,967,295) and\n ciscoFlashDeviceMinPartitionSizeExtended must be used to report\n the flash device's minimum partition size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceMaxPartitions": { "type": "integer", "description": "Max number of partitions supported by the system for\n this Flash device. Default will be 1, which actually\n means that partitioning is not supported. Note that\n this value will be defined by system limitations, not\n by the flash device itself (for eg., the system may\n impose a limit of 2 partitions even though the device\n may be large enough to be partitioned into 4 based on\n the smallest partition unit supported).\n On systems that execute code out of Flash, partitioning\n is a way of creating multiple file systems in the Flash\n device so that writing into or erasing of one file system\n can be done while executing code residing in another file\n system.\n For systems executing code out of DRAM, partitioning\n gives a way of sub-dividing a large Flash device for\n easier management of files.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDevicePartitions": { "type": "integer", "description": "Flash device partitions actually present. Number of\n partitions cannot exceed the minimum of\n ciscoFlashDeviceMaxPartitions\n and\n (ciscoFlashDeviceSize / ciscoFlashDeviceMinPartitionSize).\n Will be equal to at least 1, the case where the partition\n spans the entire device (actually no partitioning).\n A partition will contain one or more minimum partition\n units (where a minimum partition unit is defined by\n ciscoFlashDeviceMinPartitionSize).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashDeviceChipCount": { "type": "integer", "description": "Total number of chips within the Flash device.\n The purpose of this object is to provide information\n upfront to a management station on how much chip info\n to expect and possibly help double check the chip index\n against an upper limit when randomly retrieving chip\n info for a partition.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashDeviceName": { "type": "string", "description": "Flash device name. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case of\n multiple devices. The system directs an operation to the\n default device whenever a device name is not specified.\n The device name is therefore mandatory except when the\n operation is being done on the default device, or,\n the system supports only a single Flash device.\n The device name will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceDescr": { "type": "string", "description": "Description of a Flash device. The description is meant\n to explain what the Flash device and its purpose is.\n Current values are:\n System flash - for the primary Flash used to store full\n system images.\n Boot flash - for the secondary Flash used to store\n bootstrap images.\n The ciscoFlashDeviceDescr, ciscoFlashDeviceController\n (if applicable), and ciscoFlashPhyEntIndex objects are\n expected to collectively give all information about a\n Flash device.\n The device description will always be available for a\n removable device, even when the device has been removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceController": { "type": "string", "description": "Flash device controller. The h/w card that actually\n controls Flash read/write/erase. Relevant for the AGS+\n systems where Flash may be controlled by the MC+, STR or\n the ENVM cards, cards that may not actually contain the\n Flash chips.\n For systems that have removable PCMCIA flash cards that\n are controlled by a PCMCIA controller chip, this object\n may contain a description of that controller chip.\n Where irrelevant (Flash is a direct memory mapped device\n accessed directly by the main processor), this object will\n have an empty (NULL) string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceCard": { "type": "string", "description": "This object will point to an instance of a card entry\n in the cardTable. The card entry will give details about\n the card on which the Flash device is actually located.\n For most systems, this is usually the main processor board.\n On the AGS+ systems, Flash is located on a separate multibus\n card such as the MC.\n This object will therefore be used to essentially index\n into cardTable to retrieve details about the card such as\n cardDescr, cardSlotNumber, etc.", "x-yang-type": "snmpv2-tc:InstancePointer", "readOnly": true }, "ciscoFlashDeviceProgrammingJumper": { "type": "string", "description": "This object gives the state of a jumper (if present and can be\n determined) that controls the programming voltage called Vpp\n to the Flash device. Vpp is required for programming (erasing\n and writing) Flash. For certain older technology chips it is\n also required for identifying the chips (which in turn is\n required to identify which programming algorithms to use;\n different chips require different algorithms and commands).\n The purpose of the jumper, on systems where it is available,\n is to write protect a Flash device.\n On most of the newer remote access routers, this jumper is\n unavailable since users are not expected to visit remote sites\n just to install and remove the jumpers when upgrading software\n in the Flash device. The unknown(3) value will be returned for\n such systems and can be interpreted to mean that a programming\n jumper is not present or not required on those systems.\n On systems where the programming jumper state can be read back\n via a hardware register, the installed(1) or notInstalled(2)\n value will be returned.\n This object is expected to be used in conjunction with the\n ciscoFlashPartitionStatus object whenever that object has\n the readOnly(1) value. In such a case, this object will\n indicate whether the programming jumper is a possible reason\n for the readOnly state.", "readOnly": true }, "ciscoFlashDeviceInitTime": { "type": "string", "description": "System time at which device was initialized.\n For fixed devices, this will be the system time at\n boot up.\n For removable devices, it will be the time at which\n the device was inserted, which may be boot up time,\n or a later time (if device was inserted later).\n If a device (fixed or removable) was repartitioned,\n it will be the time of repartitioning.\n The purpose of this object is to help a management\n station determine if a removable device has been\n changed. The application should retrieve this\n object prior to any operation and compare with\n the previously retrieved value.\n Note that this time will not be real time but a\n running time maintained by the system. This running\n time starts from zero when the system boots up.\n For a removable device that has been removed, this\n value will be zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "ciscoFlashDeviceRemovable": { "type": "boolean", "description": "Whether Flash device is removable. Generally, only PCMCIA\n Flash cards will be treated as removable. Socketed Flash\n chips and Flash SIMM modules will not be treated as removable.\n Simply put, only those Flash devices that can be inserted\n or removed without opening the hardware casing will be\n considered removable.\n Further, removable Flash devices are expected to have\n the necessary hardware support -\n 1. on-line removal and insertion\n 2. interrupt generation on removal or insertion.", "readOnly": true }, "ciscoFlashPhyEntIndex": { "type": "string", "description": "This object indicates the physical entity index of a\n physical entity in entPhysicalTable which the flash\n device actually located.", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "ciscoFlashDeviceNameExtended": { "type": "string", "description": "Extended Flash device name whose size can be upto\n 255 characters. This name is used to refer to the\n device within the system. Flash operations get directed\n to a device based on this name.\n The system has a concept of a default device.\n This would be the primary or most used device in case\n of multiple devices. The system directs an operation\n to the default device whenever a device name is not\n specified. The device name is therefore mandatory\n except when the operation is being done on the\n default device, or, the system supports only a single\n Flash device. The device name will always be available\n for a removable device, even when the device has been\n removed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashDeviceSizeExtended": { "type": "integer", "description": "Total size of the Flash device.\n For a removable device, the size will be zero if\n the device has been removed.\n \n This object is a 64-bit version of ciscoFlashDeviceSize.", "minimum": 0, "readOnly": true }, "ciscoFlashDeviceMinPartitionSizeExtended": { "type": "integer", "description": "This object provides the minimum partition size supported for\n this device. This object is a 64-bit version of \n ciscoFlashDeviceMinPatitionSize.", "minimum": 0, "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashChipEntry": { "type": "array", "description": "An entry in the table of chip info for each\n flash device initialized in the system.\n An entry is indexed by two objects - the\n device index and the chip index within that\n device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashChipIndex": { "type": "integer", "description": "Chip sequence number within selected flash device.\n Used to index within chip info table.\n Value starts from 1 and should not be greater than\n ciscoFlashDeviceChipCount for that device.\n When retrieving chip information for chips within a\n partition, the sequence number should lie between\n ciscoFlashPartitionStartChip & ciscoFlashPartitionEndChip\n (both inclusive).", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashChipCode": { "type": "string", "description": "Manufacturer and device code for a chip.\n Lower byte will contain the device code.\n Upper byte will contain the manufacturer code.\n If a chip code is unknown because it could not\n be queried out of the chip, the value of this\n object will be 00:00.\n Since programming algorithms differ from chip type to\n chip type, this chip code should be used to determine\n which algorithms to use (and thereby whether the chip\n is supported in the first place).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipDescr": { "type": "string", "description": "Flash chip name corresponding to the chip code.\n The name will contain the manufacturer and the\n chip type. It will be of the form :\n Intel 27F008SA.\n In the case where a chip code is unknown, this\n object will be an empty (NULL) string.\n In the case where the chip code is known but the\n chip is not supported by the system, this object\n will be an empty (NULL) string.\n A management station is therefore expected to use the\n chip code and the chip description in conjunction\n to provide additional information whenever the\n ciscoFlashPartitionStatus object has the readOnly(1)\n value.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashChipWriteRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of write retries that were done in the chip.\n If no writes have been done to Flash, the count\n will be zero. Typically, a maximum of 25 retries are\n done on a single location before flagging a write\n error.\n A management station is expected to get this object\n for each chip in a partition after a write failure\n in that partition. To keep a track of retries for\n a given write operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any write operation.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipEraseRetries": { "type": "integer", "description": "This object will provide a cumulative count\n (since last system boot up or initialization) of\n the number of erase retries that were done in the chip.\n Typically, a maximum of 2000 retries are done in a\n single erase zone (which may be a full chip or a\n portion, depending on the chip technology) before\n flagging an erase error.\n A management station is expected to get this object\n for each chip in a partition after an erase failure\n in that partition. To keep a track of retries for\n a given erase operation, the management station would\n have to retrieve the values for the concerned chips\n before and after any erase operation.\n Note that erase may be done through an independent\n command, or through a copy-to-flash command.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxWriteRetries": { "type": "integer", "description": "The maximum number of write retries done at any\n single location before declaring a write failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashChipMaxEraseRetries": { "type": "integer", "description": "The maximum number of erase retries done within\n an erase sector before declaring an erase failure.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashPartitionEntry": { "type": "array", "description": "An entry in the table of flash partition properties\n for each initialized flash partition. Each entry\n will be indexed by a device number and a partition\n number within the device.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "integer", "description": "Flash partition sequence number used to index within\n table of initialized flash partitions.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionStartChip": { "type": "integer", "description": "Chip sequence number of first chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionEndChip": { "type": "integer", "description": "Chip sequence number of last chip in partition.\n Used as an index into the chip table.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSize": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n If the size of the flash partition is greater than the\n maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionSizeExtended must be used to report the\n flash partition's size.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFreeSpace": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n If the free space within a flash partition is greater than\n the maximum value reportable by this object then this object\n should report its maximum value(4,294,967,295) and\n ciscoFlashPartitionFreeSpaceExtended\n must be used to report the flash partition's free space.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionFileCount": { "type": "integer", "description": "Count of all files in a flash partition. Both\n good and bad (deleted or invalid checksum) files\n will be included in this count.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitionChecksumAlgorithm": { "type": "string", "description": "Checksum algorithm identifier for checksum method\n used by the file system. Normally, this would be\n fixed for a particular file system. When a file\n system writes a file to Flash, it checksums the\n data written. The checksum then serves as a way\n to validate the data read back whenever the file\n is opened for reading.\n Since there is no way, when using TFTP, to guarantee\n that a network download has been error free (since\n UDP checksums may not have been enabled), this\n object together with the ciscoFlashFileChecksum\n object provides a method for any management station\n to regenerate the checksum of the original file\n on the server and compare checksums to ensure that\n the file download to Flash was error free.\n simpleChecksum represents a simple 1s complement\n addition of short word values. Other algorithm\n values will be added as necessary.", "readOnly": true }, "ciscoFlashPartitionStatus": { "type": "string", "description": "Flash partition status can be :\n \n * readOnly if device is not programmable either because\n chips could not be recognized or an erroneous mismatch\n of chips was detected. Chip recognition may fail either\n because the chips are not supported by the system,\n or because the Vpp voltage required to identify chips\n has been disabled via the programming jumper.\n The ciscoFlashDeviceProgrammingJumper, ciscoFlashChipCode,\n and ciscoFlashChipDescr objects can be examined to get\n more details on the cause of this status\n * runFromFlash (RFF) if current image is running from\n this partition.\n The ciscoFlashPartitionUpgradeMethod object will then\n indicate whether the Flash Load Helper can be used\n to write a file to this partition or not.\n \n * readWrite if partition is programmable.", "readOnly": true }, "ciscoFlashPartitionUpgradeMethod": { "type": "string", "description": "Flash partition upgrade method, ie., method by which\n new files can be downloaded into the partition.\n FLH stands for Flash Load Helper, a feature provided\n on run-from-Flash systems for upgrading Flash. This\n feature uses the bootstrap code in ROMs to help in\n automatic download.\n This object should be retrieved if the partition\n status is runFromFlash(2).\n If the partition status is readOnly(1), the upgrade\n method would depend on the reason for the readOnly\n status. For eg., it may simply be a matter of installing\n the programming jumper, or it may require execution of a\n later version of software that supports the Flash chips.\n \n unknown - the current system image does not know\n how Flash can be programmed. A possible\n method would be to reload the ROM image\n and perform the upgrade manually.\n rxbootFLH - the Flash Load Helper is available to\n download files to Flash. A copy-to-flash\n command can be used and this system image\n will automatically reload the Rxboot image\n in ROM and direct it to carry out the\n download request.\n direct - will be done directly by this image.", "readOnly": true }, "ciscoFlashPartitionName": { "type": "string", "description": "Flash partition name used to refer to a partition\n by the system. This can be any alpha-numeric character\n string of the form AAAAAAAAnn, where A represents an\n optional alpha character and n a numeric character.\n Any numeric characters must always form the trailing\n part of the string. The system will strip off the alpha\n characters and use the numeric portion to map to a\n partition index.\n Flash operations get directed to a device partition\n based on this name.\n The system has a concept of a default partition. This\n would be the first partition in the device. The system\n directs an operation to the default partition whenever\n a partition name is not specified.\n The partition name is therefore mandatory except when\n the operation is being done on the default partition, or\n the device has just one partition (is not partitioned).", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitionNeedErasure": { "type": "boolean", "description": "This object indicates whether a partition requires\n erasure before any write operations can be done in it.\n A management station should therefore retrieve this\n object prior to attempting any write operation.\n A partition requires erasure after it becomes full\n free space left is less than or equal to the\n (filesystem file header size).\n A partition also requires erasure if the system does\n not find the existence of any file system when it\n boots up.\n The partition may be erased explicitly through the\n erase(5) command, or by using the copyToFlashWithErase(1)\n command.\n If a copyToFlashWithoutErase(2) command is issued\n when this object has the TRUE value, the command\n will fail.", "readOnly": true }, "ciscoFlashPartitionFileNameLength": { "type": "integer", "description": "Maximum file name length supported by the file\n system.\n Max file name length will depend on the file\n system implemented. Today, all file systems\n support a max length of at least 48 bytes.\n A management entity must use this object when\n prompting a user for, or deriving the Flash file\n name length.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitionSizeExtended": { "type": "integer", "description": "Flash partition size. It should be an integral\n multiple of ciscoFlashDeviceMinPartitionSize.\n If there is a single partition, this size will be equal\n to ciscoFlashDeviceSize.\n \n This object is a 64-bit version of ciscoFlashPartitionSize", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionFreeSpaceExtended": { "type": "integer", "description": "Free space within a Flash partition.\n Note that the actual size of a file in Flash includes\n a small overhead that represents the file system's\n file header.\n Certain file systems may also have a partition or\n device header overhead to be considered when\n computing the free space.\n Free space will be computed as total partition size\n less size of all existing files (valid/invalid/deleted\n files and including file header of each file),\n less size of any partition header, less size of\n header of next file to be copied in. In short, this\n object will give the size of the largest file that\n can be copied in. The management entity will not be\n expected to know or use any overheads such as file\n and partition header lengths, since such overheads\n may vary from file system to file system.\n Deleted files in Flash do not free up space.\n A partition may have to be erased in order to reclaim\n the space occupied by files.\n \n This object is a 64-bit version of ciscoFlashPartitionFreeSpace", "minimum": 0, "readOnly": true }, "ciscoFlashPartitionLowSpaceNotifThreshold": { "type": "string", "description": "This object specifies the minimum threshold value in percentage\n of free space for each partition. If the free space available\n goes below this threshold value and if\n ciscoFlashPartionLowSpaceNotifEnable is set to true,\n ciscoFlashPartitionLowSpaceNotif will be generated. When the\n available free space comes back to the threshold value\n ciscoFlashPartionLowSpaceRecoveryNotif will be generated.", "x-yang-type": "cisco-qos:Percent", "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashFileEntry": { "type": "array", "description": "An entry in the table of Flash file properties\n for each initialized Flash partition. Each entry\n represents a file and gives details about the file.\n An entry is indexed using the device number,\n partition number within the device, and file\n number within the partition.", "items": { "type": "object", "properties": { "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "integer", "description": "Flash file sequence number used to index within\n a Flash partition directory table.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileSize": { "type": "integer", "description": "Size of the file in bytes. Note that this size does\n not include the size of the filesystem file header.\n File size will always be non-zero.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileChecksum": { "type": "string", "description": "File checksum stored in the file header. This\n checksum is computed and stored when the file is\n written into Flash. It serves to validate the data\n written into Flash.\n Whereas the system will generate and store the checksum\n internally in hexadecimal form, this object will\n provide the checksum in a string form.\n The checksum will be available for all valid and\n invalid-checksum files.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileStatus": { "type": "string", "description": "Status of a file.\n A file could be explicitly deleted if the file system\n supports such a user command facility. Alternately,\n an existing good file would be automatically deleted\n if another good file with the same name were copied in.\n Note that deleted files continue to occupy prime\n Flash real estate.\n \n A file is marked as having an invalid checksum if any\n checksum mismatch was detected while writing or reading\n the file. Incomplete files (files truncated either\n because of lack of free space, or a network download\n failure) are also written with a bad checksum and\n marked as invalid.", "readOnly": true }, "ciscoFlashFileName": { "type": "string", "description": "Flash file name as specified by the user copying in\n the file. The name should not include the colon (:)\n character as it is a special separator character used\n to delineate the device name, partition name, and the\n file name.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileType": { "type": "string", "description": "Type of the file.", "x-yang-type": "CISCO-FLASH-MIB:FlashFileType", "readOnly": true }, "ciscoFlashFileDate": { "type": "string", "description": "The time at which this file was created.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashFileByTypeEntry": { "type": "array", "description": "ciscoFlashFileByTypeEntry", "items": { "type": "object", "properties": { "ciscoFlashFileType": { "type": "string", "description": "ciscoFlashFileType", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashDeviceIndex": { "type": "string", "description": "ciscoFlashDeviceIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashPartitionIndex": { "type": "string", "description": "ciscoFlashPartitionIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileIndex": { "type": "string", "description": "ciscoFlashFileIndex", "x-yang-type": "leafref", "readOnly": true }, "ciscoFlashFileByTypeSize": { "type": "integer", "description": "This object represents exactly the\n same info as ciscoFlashFileSize\n object in ciscoFlashFileTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashFileByTypeChecksum": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileChecksum\n object in ciscoFlashFileTable.", "x-yang-type": "CISCO-FLASH-MIB:ChecksumString", "readOnly": true }, "ciscoFlashFileByTypeStatus": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileStatus\n object in ciscoFlashFileTable.", "readOnly": true }, "ciscoFlashFileByTypeName": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileName\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashFileByTypeDate": { "type": "string", "description": "This object represents exactly the\n same info as ciscoFlashFileDate\n object in ciscoFlashFileTable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashCopyEntry": { "type": "array", "description": "ciscoFlashCopyEntry", "items": { "type": "object", "properties": { "ciscoFlashCopySerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n copy operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashCopyEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashCopyCommand": { "type": "string", "description": "The copy command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the invalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n copyToFlashWithErase Copy a file to flash; erase\n flash before copy.\n Use the TFTP or rcp protocol.\n copyToFlashWithoutErase Copy a file to flash; do not\n erase.\n Note that this command will fail\n if the PartitionNeedErasure\n object specifies that the\n partition being copied to needs\n erasure.\n Use the TFTP or rcp protocol.\n copyFromFlash Copy a file from flash using\n the TFTP, rcp or lex protocol.\n Note that the lex protocol\n can only be used to copy to a\n lex device.\n copyFromFlhLog Copy contents of FLH log to\n server using TFTP protocol.\n \n \n Command table Parameters\n copyToFlashWithErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyToFlashWithoutErase CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlash CopyProtocol\n CopyServerAddress\n CopySourceName\n CopyDestinationName (opt)\n CopyRemoteUserName (opt)\n CopyNotifyOnCompletion (opt)\n copyFromFlhLog CopyProtocol\n CopyServerAddress\n CopyDestinationName\n CopyNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashCopyProtocol": { "type": "string", "description": "The protocol to be used for any copy. Optional.\n Will default to tftp if not specified.\n \n Since feature support depends on a software release,\n version number within the release, platform, and\n maybe the image type (subset type), a management\n station would be expected to somehow determine\n the protocol support for a command.", "readOnly": true }, "ciscoFlashCopyServerAddress": { "type": "string", "description": "The server address to be used for any copy. Optional.\n Will default to 'FFFFFFFF'H (or 255.255.255.255).\n \n Since this object can just hold only IPv4 Transport\n type, it is deprecated and replaced by\n ciscoFlashCopyServerAddrRev1.", "format": "inet:ipv4-address", "readOnly": true }, "ciscoFlashCopySourceName": { "type": "string", "description": "Source file name, either in Flash or on a server,\n depending on the type of copy command. Mandatory.\n \n For a copy from Flash:\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For a copy to Flash, the file name will be as per\n the file naming conventions and path to the file on\n the server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashCopyDestinationName": { "type": "string", "description": "Destination file name.\n \n For a copy to Flash:\n File name must be of the form\n {device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is any character string that does not have\n embedded colon characters.\n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n If is not specified, it will default to \n specified in ciscoFlashCopySourceName.\n \n For a copy from Flash via tftp or rcp, the file name will be\n as per the file naming conventions and destination sub-directory\n on the server. If not specified, from the source\n file name will be used.\n For a copy from Flash via lex, this string will consist\n of numeric characters specifying the interface on the\n lex box that will receive the source flash image.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashPartitioningEntry": { "type": "array", "description": "ciscoFlashPartitioningEntry", "items": { "type": "object", "properties": { "ciscoFlashPartitioningSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the partitioning\n operations table. A management station wishing to initiate\n a partitioning operation should use a pseudo-random value\n for this object when creating or modifying an instance of\n a ciscoFlashPartitioningEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashPartitioningCommand": { "type": "string", "description": "The partitioning command to be executed. Mandatory.\n If the command is unsupported, the\n partitioningInvalidOperation\n error will be reported in the operation status.\n \n Command Remarks\n partition Partition a Flash device.\n All the prerequisites for\n partitioning must be met for\n this command to succeed.\n \n Command table Parameters\n 1) partition PartitioningDestinationName\n PartitioningPartitionCount\n PartitioningPartitionSizes (opt)\n PartitioningNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashPartitioningDestinationName": { "type": "string", "description": "Destination device name. This name will be the value\n obtained from FlashDeviceName.\n If the name is not specified, the default Flash device\n will be assumed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningPartitionCount": { "type": "integer", "description": "This object is used to specify the number of\n partitions to be created. Its value cannot exceed\n the value of ciscoFlashDeviceMaxPartitions.\n \n To undo partitioning (revert to a single partition),\n this object must have the value 1.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "ciscoFlashPartitioningPartitionSizes": { "type": "string", "description": "This object is used to explicitly specify the size\n of each partition to be created.\n The size of each partition will be in units of\n ciscoFlashDeviceMinPartitionSize.\n The value of this object will be in the form:\n :...:\n \n If partition sizes are not specified, the system\n will calculate default sizes based on the partition\n count, the minimum partition size, and the device\n size. Partition size need not be specified when\n undoing partitioning (partition count is 1).\n If partition sizes are specified, the number of\n sizes specified must exactly match the partition\n count. If not, the partitioning command will be\n rejected with the invalidPartitionSizes error .", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashPartitioningStatus": { "type": "string", "description": "The status of the specified partitioning operation.\n partitioningInProgress :\n specified operation is active\n \n partitioningOperationSuccess :\n specified operation is supported and completed\n successfully\n \n partitioningInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n partitioningInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n partitioningInvalidPartitionCount :\n invalid partition count specified for the\n partitioning command\n \n partitioningInvalidPartitionSizes :\n invalid partition size, or invalid count of\n partition sizes\n \n partitioningDeviceBusy :\n specified device is in use and locked by\n another process\n \n partitioningDeviceOpenError :\n invalid device name\n \n partitioningDeviceError :\n device read, write or erase error\n \n partitioningNoMemory :\n system running low on memory\n \n partitioningUnknownFailure :\n failure unknown", "readOnly": true }, "ciscoFlashPartitioningNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of the partitioning operation.\n If specified, ciscoFlashPartitioningCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashPartitioningTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashPartitioningEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "CISCO-FLASH-MIB_ciscoFlashMiscOpEntry": { "type": "array", "description": "ciscoFlashMiscOpEntry", "items": { "type": "object", "properties": { "ciscoFlashMiscOpSerialNumber": { "type": "integer", "description": "Object which specifies a unique entry in the\n table. A management station wishing to initiate a\n flash operation should use a pseudo-random value for\n this object when creating or modifying an instance of\n a ciscoFlashMiscOpEntry.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "ciscoFlashMiscOpCommand": { "type": "string", "description": "The command to be executed. Mandatory.\n Note that it is possible for a system to support\n multiple file systems (different file systems on\n different Flash devices, or different file systems\n on different partitions within a device). Each such\n file system may support only a subset of these commands.\n If a command is unsupported, the miscOpInvalidOperation(3)\n error will be reported in the operation status.\n \n Command Remarks\n erase Erase flash.\n verify Verify flash file checksum.\n delete Delete a file.\n undelete Revive a deleted file .\n Note that there are limits on\n the number of times a file can\n be deleted and undeleted. When\n this limit is exceeded, the\n system will return the appropriate\n error.\n squeeze Recover space occupied by\n deleted files. This command\n preserves the good files, erases\n out the file system, then restores\n the preserved good files.\n format Format a flash device.\n \n Command table Parameters\n erase MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n verify MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n delete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n undelete MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n squeeze MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)\n format MiscOpDestinationName\n MiscOpNotifyOnCompletion (opt)", "readOnly": true }, "ciscoFlashMiscOpDestinationName": { "type": "string", "description": "Destination file, or partition name.\n File name must be of the form\n [device>:][:]\n where is a value obtained from FlashDeviceName,\n is obtained from FlashPartitionName\n and is the name of a file in Flash.\n While leading and/or trailing whitespaces are acceptable,\n no whitespaces are allowed within the path itself.\n \n A management station could derive its own partition name\n as per the description for the ciscoFlashPartitionName\n object.\n If is not specified, the default Flash device\n will be assumed.\n If is not specified, the default partition\n will be assumed. If a device is not partitioned into 2\n or more partitions, this value may be left out.\n \n For an operation on a partition, eg., the erase\n command, this object would specify the partition name\n in the form:\n [device>:][:]", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "ciscoFlashMiscOpStatus": { "type": "string", "description": "The status of the specified operation.\n miscOpInProgress :\n specified operation is active\n \n miscOpOperationSuccess :\n specified operation is supported and completed\n successfully\n \n miscOpInvalidOperation :\n command invalid or command-protocol-device\n combination unsupported\n \n miscOpInvalidDestName :\n invalid target name (file or partition or\n device name) specified\n \n miscOpDeviceBusy :\n specified device is in use and locked by another\n process\n \n miscOpDeviceOpenError :\n invalid device name\n \n miscOpDeviceError :\n device read, write or erase error\n \n miscOpDeviceNotProgrammable :\n device is read-only but a write or erase\n operation was specified\n \n miscOpFileOpenError :\n invalid file name; file not found in partition\n \n miscOpFileDeleteFailure :\n file could not be deleted; delete count exceeded\n \n miscOpFileUndeleteFailure :\n file could not be undeleted; undelete count\n exceeded\n \n miscOpFileChecksumError :\n file has a bad checksum\n \n miscOpNoMemory :\n system running low on memory\n \n miscOpUnknownFailure :\n failure unknown\n \n miscOpSqueezeFailure :\n the squeeze operation failed\n \n miscOpNoSuchFile :\n a valid but nonexistent file name was specified\n \n miscOpFormatFailure :\n the format operation failed", "readOnly": true }, "ciscoFlashMiscOpNotifyOnCompletion": { "type": "boolean", "description": "Specifies whether or not a notification should be\n generated on the completion of an operation.\n If specified, ciscoFlashMiscOpCompletionTrap\n will be generated. It is the responsibility of the\n management entity to ensure that the SNMP administrative\n model is configured in such a way as to allow the\n notification to be delivered.", "readOnly": true }, "ciscoFlashMiscOpTime": { "type": "string", "description": "Time taken for the operation. This object will\n be like a stopwatch, starting when the operation\n starts, stopping when the operation completes.\n If a management entity keeps a database of completion\n times for various operations, it can then use the\n stopwatch capability to display percentage completion\n time.", "x-yang-type": "yang:timeticks", "readOnly": true }, "ciscoFlashMiscOpEntryStatus": { "type": "string", "description": "The status of this table entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } } }, "restconf-error": { "type": "object", "description": "Standard RESTCONF error response (RFC 8040 Section 7.1)", "properties": { "ietf-restconf:errors": { "type": "object", "properties": { "error": { "type": "array", "items": { "type": "object", "properties": { "error-type": { "type": "string", "enum": [ "transport", "rpc", "protocol", "application" ], "description": "Layer where the error occurred" }, "error-tag": { "type": "string", "description": "Enumerated error tag (e.g. invalid-value, data-missing, access-denied)" }, "error-severity": { "type": "string", "enum": [ "error", "warning" ], "description": "Error severity" }, "error-app-tag": { "type": "string", "description": "Application-specific error tag" }, "error-path": { "type": "string", "description": "YANG instance-identifier of the error node" }, "error-message": { "type": "string", "description": "Human-readable error description" } }, "required": [ "error-type", "error-tag" ] } } } } }, "example": { "ietf-restconf:errors": { "error": [ { "error-type": "protocol", "error-tag": "invalid-value", "error-severity": "error", "error-message": "Invalid input parameter" } ] } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "tags": [ { "name": "CISCO-FLASH-MIB", "description": "MIB operations for CISCO-FLASH-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }