{ "openapi": "3.0.0", "info": { "title": "CISCO-FTP-CLIENT-MIB MIB API", "version": "1.0.0", "description": "The MIB module for invoking Internet File Transfer Protocol\n (FTP) operations for network management purposes.\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-FTP-CLIENT-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-FTP-CLIENT-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-FTP-CLIENT-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-FTP-CLIENT-MIB:cfcRequest": { "get": { "summary": "Get cfcRequest data", "description": "Retrieve cfcRequest operational data from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cfcRequest", "properties": { "cfcRequestMaximum": { "type": "integer", "description": "The maximum number of requests this system can hold in\n cfcRequestTable. A value of 0 indicates no configured limit.\n \n This object may be read-only on some systems.\n \n When an attempt is made to create a new entry but the table\n is full, the oldest completed entry is bumped out and\n cfcRequestsBumped is incremented.\n \n Changing this number does not disturb existing requests that\n are not completed and bumps completed requests as necessary.", "minimum": 0, "maximum": 4294967295 }, "cfcRequests": { "type": "integer", "description": "The current number of requests in cfcRequestTable.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestsHigh": { "type": "integer", "description": "The highest number of requests in cfcRequestTable since this\n system was last initialized.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestsBumped": { "type": "integer", "description": "The number of requests in cfcRequestTable that were bumped\n out to make room for a new request.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequest": { "cfcRequestMaximum": 0, "cfcRequests": 0, "cfcRequestsHigh": 0, "cfcRequestsBumped": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequest", "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": "/cfcRequest", "x-restconf-kind": "container" }, "/data/CISCO-FTP-CLIENT-MIB:cfcRequestTable": { "get": { "summary": "Get cfcRequestTable data", "description": "Retrieve cfcRequestTable operational data from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of FTP client requests.", "properties": { "cfcRequestEntry": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed." }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation." }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp" }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready." }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'." }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequestTable": { "cfcRequestEntry": [ { "cfcRequestIndex": 1, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" }, { "cfcRequestIndex": 2, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" }, { "cfcRequestIndex": 3, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequestTable", "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": "/cfcRequestTable", "x-restconf-kind": "container" }, "/data/CISCO-FTP-CLIENT-MIB:cfcRequestTable/cfcRequestEntry": { "get": { "summary": "Get cfcRequestEntry list", "description": "Retrieve list of cfcRequestEntry entries from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed." }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation." }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp" }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready." }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'." }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequestEntry": [ { "cfcRequestIndex": 1, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequestEntry", "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": "/cfcRequestTable/cfcRequestEntry", "x-restconf-kind": "container" }, "/data/CISCO-FTP-CLIENT-MIB:cfcRequestTable/cfcRequestEntry={cfcRequestIndex}": { "get": { "summary": "Get cfcRequestEntry entry", "description": "Retrieve specific cfcRequestEntry entry by key from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "parameters": [ { "name": "cfcRequestIndex", "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": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed." }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation." }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp" }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready." }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'." }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequestEntry": { "cfcRequestIndex": 1, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequestEntry-2" }, "x-yang-path": "/cfcRequestTable/cfcRequestEntry={cfcRequestIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cfcRequestIndex" ] }, "/data/CISCO-FTP-CLIENT-MIB:cfcRequestEntry": { "get": { "summary": "Get cfcRequestEntry list", "description": "Retrieve list of cfcRequestEntry entries from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed." }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation." }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp" }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready." }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'." }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequestEntry": [ { "cfcRequestIndex": 1, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequestEntry-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": "/cfcRequestEntry", "x-restconf-kind": "container" }, "/data/CISCO-FTP-CLIENT-MIB:cfcRequestEntry={cfcRequestIndex}": { "get": { "summary": "Get cfcRequestEntry entry", "description": "Retrieve specific cfcRequestEntry entry by key from MIB", "tags": [ "CISCO-FTP-CLIENT-MIB" ], "parameters": [ { "name": "cfcRequestIndex", "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": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295 }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed." }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString" }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation." }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp" }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready." }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'." }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-FTP-CLIENT-MIB:cfcRequestEntry": { "cfcRequestIndex": 1, "cfcRequestOperation": "example-string", "cfcRequestLocalFile": "example-string", "cfcRequestRemoteFile": "example-string", "cfcRequestServer": "example-string", "cfcRequestUser": "example-string", "cfcRequestPassword": "example-string", "cfcRequestResult": "example-string", "cfcRequestCompletionTime": "example-string", "cfcRequestStop": "example-string", "cfcRequestOperationState": "up(1)", "cfcRequestEntryStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cfcRequestEntry-4" }, "x-yang-path": "/cfcRequestEntry={cfcRequestIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cfcRequestIndex" ] } }, "components": { "schemas": { "CISCO-FTP-CLIENT-MIB_CISCO-FTP-CLIENT-MIB": { "type": "object", "description": "CISCO-FTP-CLIENT-MIB", "properties": { "cfcRequestEntry": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed.", "readOnly": true }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation.", "readOnly": true }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready.", "readOnly": true }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'.", "readOnly": true }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "cfcRequest": { "type": "object", "description": "cfcRequest", "properties": { "cfcRequestMaximum": { "type": "integer", "description": "The maximum number of requests this system can hold in\n cfcRequestTable. A value of 0 indicates no configured limit.\n \n This object may be read-only on some systems.\n \n When an attempt is made to create a new entry but the table\n is full, the oldest completed entry is bumped out and\n cfcRequestsBumped is incremented.\n \n Changing this number does not disturb existing requests that\n are not completed and bumps completed requests as necessary.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequests": { "type": "integer", "description": "The current number of requests in cfcRequestTable.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequestsHigh": { "type": "integer", "description": "The highest number of requests in cfcRequestTable since this\n system was last initialized.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequestsBumped": { "type": "integer", "description": "The number of requests in cfcRequestTable that were bumped\n out to make room for a new request.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "cfcRequestTable": { "type": "object", "description": "A table of FTP client requests.", "properties": { "cfcRequestEntry": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed.", "readOnly": true }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation.", "readOnly": true }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready.", "readOnly": true }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'.", "readOnly": true }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-FTP-CLIENT-MIB_cfcRequestEntry": { "type": "array", "description": "cfcRequestEntry", "items": { "type": "object", "properties": { "cfcRequestIndex": { "type": "integer", "description": "An arbitrary integer to uniquely identify this entry. To\n create an entry a management application should pick a\n random number.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cfcRequestOperation": { "type": "string", "description": "The FTP operation to be performed.", "readOnly": true }, "cfcRequestLocalFile": { "type": "string", "description": "The local file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestRemoteFile": { "type": "string", "description": "The remote file on which the operation is to be performed.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestServer": { "type": "string", "description": "The domain name or IP address of the FTP server to use.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestUser": { "type": "string", "description": "The user name to use at the FTP server.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestPassword": { "type": "string", "description": "The password to use at the FTP server.\n \n When read this object always returns a zero-length string.", "x-yang-type": "snmpv2-tc:DisplayString", "readOnly": true }, "cfcRequestResult": { "type": "string", "description": "The result of the FTP operation.", "readOnly": true }, "cfcRequestCompletionTime": { "type": "string", "description": "The value of sysUpTime when the operation completed. For\n an incomplete operation this value is zero.", "x-yang-type": "yang:timestamp", "readOnly": true }, "cfcRequestStop": { "type": "string", "description": "The action control to stop a running request. Setting this to\n 'stop' will begin the process of stopping the request. Setting\n it to 'ready' or setting it to 'stop' more than once have no\n effect. When read this object always returns ready.", "readOnly": true }, "cfcRequestOperationState": { "type": "string", "description": "The operational state of the file transfer. To short-terminate\n the transfer set cfcRequestStop to 'stop'.", "readOnly": true }, "cfcRequestEntryStatus": { "type": "string", "description": "The control that allows modification, creation, and deletion\n of entries. For detailed rules see the DESCRIPTION for\n cfcRequestEntry.", "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-FTP-CLIENT-MIB", "description": "MIB operations for CISCO-FTP-CLIENT-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }