{ "openapi": "3.0.0", "info": { "title": "CISCO-LICENSE-MGMT-MIB MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View CISCO-LICENSE-MGMT-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-LICENSE-MGMT-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-LICENSE-MGMT-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-LICENSE-MGMT-MIB:clmgmtLicenseConfiguration": { "get": { "summary": "Get clmgmtLicenseConfiguration data", "description": "Retrieve clmgmtLicenseConfiguration operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtLicenseConfiguration", "properties": { "clmgmtNextFreeLicenseActionIndex": { "type": "integer", "description": "This object contains appropriate value for\n clmgmtLicenseActionIndex that can be used to create\n an entry in clmgmtLicenseActionTable. The management application\n should read this object first and then use this as the\n value for clmgmtLicenseActionIndex to avoid collisions\n when creating entries in clmgmtLicenseActionTable.\n Following this approach does not guarantee collision free\n row creation, but will reduce the probability. The\n collision will happen if two management applications read this\n object at the same time and attempt to create an entry\n with this value at the same time. In this case, the\n management application whose request is processed after the first\n request will get an error and the process of reading this object\n and entry creation needs to be repeated.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseConfiguration": { "clmgmtNextFreeLicenseActionIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseConfiguration", "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": "/clmgmtLicenseConfiguration", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInformation": { "get": { "summary": "Get clmgmtLicenseDeviceInformation data", "description": "Retrieve clmgmtLicenseDeviceInformation operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtLicenseDeviceInformation", "properties": { "clmgmtNextFreeDevCredExportActionIndex": { "type": "integer", "description": "This object contains appropriate value for\n clmgmtDevCredExportActionIndex that can be used to create\n an entry in clmgmtDevCredExportActionTable. The management\n application should read this object first and then use this\n as the value for clmgmtDevCredExportActionIndex to avoid\n collisions when creating entries in\n clmgmtDevCredExportActionTable. Following this approach does\n not guarantee collision free row creation, but will reduce\n the probability. The collision will happen if two\n management applications read this object at the same time and\n attempt to create an entry with this value at the same time.\n In this case, the management application whose request is\n processed after the first request will get an error and the\n process of reading this object and entry creation needs to be\n repeated.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInformation": { "clmgmtNextFreeDevCredExportActionIndex": 1 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInformation", "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": "/clmgmtLicenseDeviceInformation", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseNotifObjects": { "get": { "summary": "Get clmgmtLicenseNotifObjects data", "description": "Retrieve clmgmtLicenseNotifObjects operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtLicenseNotifObjects", "properties": { "clmgmtLicenseUsageNotifEnable": { "type": "boolean", "description": "This object indicates whether the device should generate\n the notifications related to usage of licenses. This object\n enables/disables sending following notifications:\n clmgmtLicenseExpired \n clmgmtLicenseExpiryWarning\n clmgmtLicenseUsageCountExceeded\n clmgmtLicenseUsageCountAboutToExceed\n clmgmtLicenseSubscriptionExpiryWarning\n clmgmtLicenseSubscriptionExtExpiryWarning\n clmgmtLicenseSubscriptionExpired\n clmgmtLicenseEvalRTUTransitionWarning\n clmgmtLicenseEvalRTUTransition" }, "clmgmtLicenseDeploymentNotifEnable": { "type": "boolean", "description": "This object indicates whether the device should generate\n notifications related to license deployment. This object\n enables/disables sending following notifications:\n clmgmtLicenseInstalled\n clmgmtLicenseCleared\n clmgmtLicenseRevoked\n clmgmtLicenseEULAAccepted" }, "clmgmtLicenseErrorNotifEnable": { "type": "string", "description": "This object indicates whether the device should generate\n notifications related to error conditions in enforcing\n licensing. This object enables/disables sending following\n notifications:\n clmgmtLicenseNotEnforced" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseNotifObjects": { "clmgmtLicenseUsageNotifEnable": true, "clmgmtLicenseDeploymentNotifEnable": true, "clmgmtLicenseErrorNotifEnable": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseNotifObjects", "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": "/clmgmtLicenseNotifObjects", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionTable": { "get": { "summary": "Get clmgmtLicenseActionTable data", "description": "Retrieve clmgmtLicenseActionTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtLicenseActionTable", "properties": { "clmgmtLicenseActionEntry": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero" }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action." }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file." }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus" }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance." }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionTable": { "clmgmtLicenseActionEntry": [ { "clmgmtLicenseActionIndex": 1, "clmgmtLicenseActionEntPhysicalIndex": "1", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "1", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" }, { "clmgmtLicenseActionIndex": 2, "clmgmtLicenseActionEntPhysicalIndex": "2", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "2", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" }, { "clmgmtLicenseActionIndex": 3, "clmgmtLicenseActionEntPhysicalIndex": "3", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "3", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionTable", "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": "/clmgmtLicenseActionTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionTable/clmgmtLicenseActionEntry": { "get": { "summary": "Get clmgmtLicenseActionEntry list", "description": "Retrieve list of clmgmtLicenseActionEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero" }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action." }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file." }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus" }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance." }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry": [ { "clmgmtLicenseActionIndex": 1, "clmgmtLicenseActionEntPhysicalIndex": "example-string", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "example-string", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionEntry", "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": "/clmgmtLicenseActionTable/clmgmtLicenseActionEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionTable/clmgmtLicenseActionEntry={clmgmtLicenseActionIndex}": { "get": { "summary": "Get clmgmtLicenseActionEntry entry", "description": "Retrieve specific clmgmtLicenseActionEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtLicenseActionIndex", "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": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero" }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action." }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file." }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus" }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance." }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry": { "clmgmtLicenseActionIndex": 1, "clmgmtLicenseActionEntPhysicalIndex": "example-string", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "example-string", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionEntry-2" }, "x-yang-path": "/clmgmtLicenseActionTable/clmgmtLicenseActionEntry={clmgmtLicenseActionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtLicenseActionIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultTable": { "get": { "summary": "Get clmgmtLicenseActionResultTable data", "description": "Retrieve clmgmtLicenseActionResultTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains results of license action if the\n license action involves multiple licenses. Entries in this\n table are not created for actions where there is\n only license that is subject of the action. For\n example, if there are 3 licenses in a license file\n when executing license install action, 3 entries will\n be created in this table, one for each license.", "properties": { "clmgmtLicenseActionResultEntry": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref" }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultTable": { "clmgmtLicenseActionResultEntry": [ { "clmgmtLicenseActionIndex": "1", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" }, { "clmgmtLicenseActionIndex": "2", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" }, { "clmgmtLicenseActionIndex": "3", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionResultTable", "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": "/clmgmtLicenseActionResultTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultTable/clmgmtLicenseActionResultEntry": { "get": { "summary": "Get clmgmtLicenseActionResultEntry list", "description": "Retrieve list of clmgmtLicenseActionResultEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref" }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry": [ { "clmgmtLicenseActionIndex": "example-string", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionResultEntry", "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": "/clmgmtLicenseActionResultTable/clmgmtLicenseActionResultEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoTable": { "get": { "summary": "Get clmgmtLicenseStoreInfoTable data", "description": "Retrieve clmgmtLicenseStoreInfoTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information about all the license\n stores allocated on the device.", "properties": { "clmgmtLicenseStoreInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoTable": { "clmgmtLicenseStoreInfoEntry": [ { "entPhysicalIndex": "1", "clmgmtLicenseStoreIndex": 1, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 }, { "entPhysicalIndex": "2", "clmgmtLicenseStoreIndex": 2, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 }, { "entPhysicalIndex": "3", "clmgmtLicenseStoreIndex": 3, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseStoreInfoTable", "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": "/clmgmtLicenseStoreInfoTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoTable/clmgmtLicenseStoreInfoEntry": { "get": { "summary": "Get clmgmtLicenseStoreInfoEntry list", "description": "Retrieve list of clmgmtLicenseStoreInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreIndex": 1, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseStoreInfoEntry", "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": "/clmgmtLicenseStoreInfoTable/clmgmtLicenseStoreInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoTable": { "get": { "summary": "Get clmgmtLicenseDeviceInfoTable data", "description": "Retrieve clmgmtLicenseDeviceInfoTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains objects that provide licensing related\n information at the device level. Entries will exist\n only for entities that support licensing. For example,\n if it is a stand alone device and supports licensing,\n then there will be only one entry in this table. If\n it is stackable switch then there will be multiple\n entries with one entry for each device in the stack.", "properties": { "clmgmtLicenseDeviceInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoTable": { "clmgmtLicenseDeviceInfoEntry": [ { "entPhysicalIndex": "1", "clmgmtDefaultLicenseStore": 0 }, { "entPhysicalIndex": "2", "clmgmtDefaultLicenseStore": 0 }, { "entPhysicalIndex": "3", "clmgmtDefaultLicenseStore": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInfoTable", "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": "/clmgmtLicenseDeviceInfoTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoTable/clmgmtLicenseDeviceInfoEntry": { "get": { "summary": "Get clmgmtLicenseDeviceInfoEntry list", "description": "Retrieve list of clmgmtLicenseDeviceInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtDefaultLicenseStore": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInfoEntry", "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": "/clmgmtLicenseDeviceInfoTable/clmgmtLicenseDeviceInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoTable/clmgmtLicenseDeviceInfoEntry={entPhysicalIndex}": { "get": { "summary": "Get clmgmtLicenseDeviceInfoEntry entry", "description": "Retrieve specific clmgmtLicenseDeviceInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtDefaultLicenseStore": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInfoEntry-2" }, "x-yang-path": "/clmgmtLicenseDeviceInfoTable/clmgmtLicenseDeviceInfoEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoTable": { "get": { "summary": "Get clmgmtLicenseInfoTable data", "description": "Retrieve clmgmtLicenseInfoTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains information about all the licenses\n installed on the device.", "properties": { "clmgmtLicenseInfoEntry": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex" }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time." }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license" }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted" }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license." }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoTable": { "clmgmtLicenseInfoEntry": [ { "entPhysicalIndex": "1", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "1", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 }, { "entPhysicalIndex": "2", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "2", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 }, { "entPhysicalIndex": "3", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "3", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseInfoTable", "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": "/clmgmtLicenseInfoTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoTable/clmgmtLicenseInfoEntry": { "get": { "summary": "Get clmgmtLicenseInfoEntry list", "description": "Retrieve list of clmgmtLicenseInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex" }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time." }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license" }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted" }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license." }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "example-string", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseInfoEntry", "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": "/clmgmtLicenseInfoTable/clmgmtLicenseInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureTable": { "get": { "summary": "Get clmgmtLicensableFeatureTable data", "description": "Retrieve clmgmtLicensableFeatureTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtLicensableFeatureTable", "properties": { "clmgmtLicensableFeatureEntry": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureTable": { "clmgmtLicensableFeatureEntry": [ { "entPhysicalIndex": "1", "clmgmtFeatureIndex": 1, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 }, { "entPhysicalIndex": "2", "clmgmtFeatureIndex": 2, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 }, { "entPhysicalIndex": "3", "clmgmtFeatureIndex": 3, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicensableFeatureTable", "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": "/clmgmtLicensableFeatureTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureTable/clmgmtLicensableFeatureEntry": { "get": { "summary": "Get clmgmtLicensableFeatureEntry list", "description": "Retrieve list of clmgmtLicensableFeatureEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry": [ { "entPhysicalIndex": "example-string", "clmgmtFeatureIndex": 1, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicensableFeatureEntry", "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": "/clmgmtLicensableFeatureTable/clmgmtLicensableFeatureEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionTable": { "get": { "summary": "Get clmgmtDevCredExportActionTable data", "description": "Retrieve clmgmtDevCredExportActionTable operational data from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "clmgmtDevCredExportActionTable", "properties": { "clmgmtDevCredExportActionEntry": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials" }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid." }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionTable": { "clmgmtDevCredExportActionEntry": [ { "clmgmtDevCredExportActionIndex": 1, "clmgmtDevCredEntPhysicalIndex": "1", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" }, { "clmgmtDevCredExportActionIndex": 2, "clmgmtDevCredEntPhysicalIndex": "2", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" }, { "clmgmtDevCredExportActionIndex": 3, "clmgmtDevCredEntPhysicalIndex": "3", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtDevCredExportActionTable", "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": "/clmgmtDevCredExportActionTable", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionTable/clmgmtDevCredExportActionEntry": { "get": { "summary": "Get clmgmtDevCredExportActionEntry list", "description": "Retrieve list of clmgmtDevCredExportActionEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials" }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid." }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry": [ { "clmgmtDevCredExportActionIndex": 1, "clmgmtDevCredEntPhysicalIndex": "example-string", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtDevCredExportActionEntry", "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": "/clmgmtDevCredExportActionTable/clmgmtDevCredExportActionEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionTable/clmgmtDevCredExportActionEntry={clmgmtDevCredExportActionIndex}": { "get": { "summary": "Get clmgmtDevCredExportActionEntry entry", "description": "Retrieve specific clmgmtDevCredExportActionEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtDevCredExportActionIndex", "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": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials" }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid." }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry": { "clmgmtDevCredExportActionIndex": 1, "clmgmtDevCredEntPhysicalIndex": "example-string", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtDevCredExportActionEntry-2" }, "x-yang-path": "/clmgmtDevCredExportActionTable/clmgmtDevCredExportActionEntry={clmgmtDevCredExportActionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtDevCredExportActionIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry": { "get": { "summary": "Get clmgmtLicenseActionEntry list", "description": "Retrieve list of clmgmtLicenseActionEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero" }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action." }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file." }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus" }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance." }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry": [ { "clmgmtLicenseActionIndex": 1, "clmgmtLicenseActionEntPhysicalIndex": "example-string", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "example-string", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionEntry-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": "/clmgmtLicenseActionEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry={clmgmtLicenseActionIndex}": { "get": { "summary": "Get clmgmtLicenseActionEntry entry", "description": "Retrieve specific clmgmtLicenseActionEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtLicenseActionIndex", "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": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero" }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action." }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file." }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus" }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance." }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionEntry": { "clmgmtLicenseActionIndex": 1, "clmgmtLicenseActionEntPhysicalIndex": "example-string", "clmgmtLicenseActionTransferProtocol": "example-string", "clmgmtLicenseServerAddressType": "192.168.1.1", "clmgmtLicenseServerAddress": "192.168.1.1", "clmgmtLicenseServerUsername": "interface-1", "clmgmtLicenseServerPassword": "example-string", "clmgmtLicenseFile": "example-string", "clmgmtLicenseStore": 0, "clmgmtLicenseActionLicenseIndex": "example-string", "clmgmtLicensePermissionTicketFile": "example-string", "clmgmtLicenseRehostTicketFile": "example-string", "clmgmtLicenseBackupFile": "example-string", "clmgmtLicenseStopOnFailure": true, "clmgmtLicenseAction": "example-string", "clmgmtLicenseActionState": "up(1)", "clmgmtLicenseJobQPosition": 0, "clmgmtLicenseActionFailCause": "example-string", "clmgmtLicenseActionStorageType": "ethernetCsmacd(6)", "clmgmtLicenseActionRowStatus": "up(1)", "clmgmtLicenseAcceptEULA": true, "clmgmtLicenseEULAFile": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionEntry-4" }, "x-yang-path": "/clmgmtLicenseActionEntry={clmgmtLicenseActionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtLicenseActionIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry": { "get": { "summary": "Get clmgmtLicenseActionResultEntry list", "description": "Retrieve list of clmgmtLicenseActionResultEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref" }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry": [ { "clmgmtLicenseActionIndex": "example-string", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionResultEntry-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": "/clmgmtLicenseActionResultEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry": { "get": { "summary": "Get clmgmtLicenseStoreInfoEntry list", "description": "Retrieve list of clmgmtLicenseStoreInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreIndex": 1, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseStoreInfoEntry-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": "/clmgmtLicenseStoreInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry": { "get": { "summary": "Get clmgmtLicenseDeviceInfoEntry list", "description": "Retrieve list of clmgmtLicenseDeviceInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtDefaultLicenseStore": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInfoEntry-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": "/clmgmtLicenseDeviceInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry={entPhysicalIndex}": { "get": { "summary": "Get clmgmtLicenseDeviceInfoEntry entry", "description": "Retrieve specific clmgmtLicenseDeviceInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseDeviceInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtDefaultLicenseStore": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseDeviceInfoEntry-4" }, "x-yang-path": "/clmgmtLicenseDeviceInfoEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry": { "get": { "summary": "Get clmgmtLicenseInfoEntry list", "description": "Retrieve list of clmgmtLicenseInfoEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex" }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time." }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license" }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted" }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license." }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry": [ { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "example-string", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseInfoEntry-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": "/clmgmtLicenseInfoEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry": { "get": { "summary": "Get clmgmtLicensableFeatureEntry list", "description": "Retrieve list of clmgmtLicensableFeatureEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry": [ { "entPhysicalIndex": "example-string", "clmgmtFeatureIndex": 1, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicensableFeatureEntry-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": "/clmgmtLicensableFeatureEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry": { "get": { "summary": "Get clmgmtDevCredExportActionEntry list", "description": "Retrieve list of clmgmtDevCredExportActionEntry entries from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials" }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid." }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry": [ { "clmgmtDevCredExportActionIndex": 1, "clmgmtDevCredEntPhysicalIndex": "example-string", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtDevCredExportActionEntry-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": "/clmgmtDevCredExportActionEntry", "x-restconf-kind": "container" }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry={clmgmtDevCredExportActionIndex}": { "get": { "summary": "Get clmgmtDevCredExportActionEntry entry", "description": "Retrieve specific clmgmtDevCredExportActionEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtDevCredExportActionIndex", "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": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295 }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero" }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol" }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType" }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress" }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials" }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid." }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType" }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtDevCredExportActionEntry": { "clmgmtDevCredExportActionIndex": 1, "clmgmtDevCredEntPhysicalIndex": "example-string", "clmgmtDevCredTransferProtocol": "example-string", "clmgmtDevCredServerAddressType": "192.168.1.1", "clmgmtDevCredServerAddress": "192.168.1.1", "clmgmtDevCredServerUsername": "interface-1", "clmgmtDevCredServerPassword": "example-string", "clmgmtDevCredExportFile": "example-string", "clmgmtDevCredCommand": "example-string", "clmgmtDevCredCommandState": "up(1)", "clmgmtDevCredCommandFailCause": "example-string", "clmgmtDevCredStorageType": "ethernetCsmacd(6)", "clmgmtDevCredRowStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtDevCredExportActionEntry-4" }, "x-yang-path": "/clmgmtDevCredExportActionEntry={clmgmtDevCredExportActionIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtDevCredExportActionIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultTable/clmgmtLicenseActionResultEntry={clmgmtLicenseActionIndex},{clmgmtLicenseNumber}": { "get": { "summary": "Get clmgmtLicenseActionResultEntry entry", "description": "Retrieve specific clmgmtLicenseActionResultEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtLicenseActionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseNumber", "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": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref" }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry": { "clmgmtLicenseActionIndex": "example-string", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionResultEntry-2" }, "x-yang-path": "/clmgmtLicenseActionResultTable/clmgmtLicenseActionResultEntry={clmgmtLicenseActionIndex clmgmtLicenseNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtLicenseActionIndex clmgmtLicenseNumber" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoTable/clmgmtLicenseStoreInfoEntry={entPhysicalIndex},{clmgmtLicenseStoreIndex}": { "get": { "summary": "Get clmgmtLicenseStoreInfoEntry entry", "description": "Retrieve specific clmgmtLicenseStoreInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseStoreIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreIndex": 1, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseStoreInfoEntry-2" }, "x-yang-path": "/clmgmtLicenseStoreInfoTable/clmgmtLicenseStoreInfoEntry={entPhysicalIndex clmgmtLicenseStoreIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtLicenseStoreIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoTable/clmgmtLicenseInfoEntry={entPhysicalIndex},{clmgmtLicenseStoreUsed},{clmgmtLicenseIndex}": { "get": { "summary": "Get clmgmtLicenseInfoEntry entry", "description": "Retrieve specific clmgmtLicenseInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseStoreUsed", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex" }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time." }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license" }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted" }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license." }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "example-string", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseInfoEntry-2" }, "x-yang-path": "/clmgmtLicenseInfoTable/clmgmtLicenseInfoEntry={entPhysicalIndex clmgmtLicenseStoreUsed clmgmtLicenseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtLicenseStoreUsed clmgmtLicenseIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureTable/clmgmtLicensableFeatureEntry={entPhysicalIndex},{clmgmtFeatureIndex}": { "get": { "summary": "Get clmgmtLicensableFeatureEntry entry", "description": "Retrieve specific clmgmtLicensableFeatureEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtFeatureIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry": { "entPhysicalIndex": "example-string", "clmgmtFeatureIndex": 1, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicensableFeatureEntry-2" }, "x-yang-path": "/clmgmtLicensableFeatureTable/clmgmtLicensableFeatureEntry={entPhysicalIndex clmgmtFeatureIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtFeatureIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry={clmgmtLicenseActionIndex},{clmgmtLicenseNumber}": { "get": { "summary": "Get clmgmtLicenseActionResultEntry entry", "description": "Retrieve specific clmgmtLicenseActionResultEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "clmgmtLicenseActionIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseNumber", "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": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref" }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState" }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause" } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseActionResultEntry": { "clmgmtLicenseActionIndex": "example-string", "clmgmtLicenseNumber": 0, "clmgmtLicenseIndivActionState": "up(1)", "clmgmtLicenseIndivActionFailCause": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseActionResultEntry-4" }, "x-yang-path": "/clmgmtLicenseActionResultEntry={clmgmtLicenseActionIndex clmgmtLicenseNumber}", "x-restconf-kind": "list-instance", "x-list-keys": [ "clmgmtLicenseActionIndex clmgmtLicenseNumber" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry={entPhysicalIndex},{clmgmtLicenseStoreIndex}": { "get": { "summary": "Get clmgmtLicenseStoreInfoEntry entry", "description": "Retrieve specific clmgmtLicenseStoreInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseStoreIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseStoreInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreIndex": 1, "clmgmtLicenseStoreName": "interface-1", "clmgmtLicenseStoreTotalSize": 0, "clmgmtLicenseStoreSizeRemaining": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseStoreInfoEntry-4" }, "x-yang-path": "/clmgmtLicenseStoreInfoEntry={entPhysicalIndex clmgmtLicenseStoreIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtLicenseStoreIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry={entPhysicalIndex},{clmgmtLicenseStoreUsed},{clmgmtLicenseIndex}": { "get": { "summary": "Get clmgmtLicenseInfoEntry entry", "description": "Retrieve specific clmgmtLicenseInfoEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseStoreUsed", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtLicenseIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex" }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time." }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license" }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295 }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted" }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license." }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicenseInfoEntry": { "entPhysicalIndex": "example-string", "clmgmtLicenseStoreUsed": 0, "clmgmtLicenseIndex": "example-string", "clmgmtLicenseFeatureName": "interface-1", "clmgmtLicenseFeatureVersion": "example-string", "clmgmtLicenseType": "ethernetCsmacd(6)", "clmgmtLicenseCounted": true, "clmgmtLicenseValidityPeriod": 0, "clmgmtLicenseValidityPeriodRemaining": 0, "clmgmtLicenseExpiredPeriod": 0, "clmgmtLicenseMaxUsageCount": 0, "clmgmtLicenseUsageCountRemaining": 0, "clmgmtLicenseEULAStatus": true, "clmgmtLicenseComments": "example-string", "clmgmtLicenseStatus": "up(1)", "clmgmtLicenseStartDate": "example-string", "clmgmtLicenseEndDate": "example-string", "clmgmtLicensePeriodUsed": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicenseInfoEntry-4" }, "x-yang-path": "/clmgmtLicenseInfoEntry={entPhysicalIndex clmgmtLicenseStoreUsed clmgmtLicenseIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtLicenseStoreUsed clmgmtLicenseIndex" ] }, "/data/CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry={entPhysicalIndex},{clmgmtFeatureIndex}": { "get": { "summary": "Get clmgmtLicensableFeatureEntry entry", "description": "Retrieve specific clmgmtLicensableFeatureEntry entry by key from MIB", "tags": [ "CISCO-LICENSE-MGMT-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clmgmtFeatureIndex", "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": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295 }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-LICENSE-MGMT-MIB:clmgmtLicensableFeatureEntry": { "entPhysicalIndex": "example-string", "clmgmtFeatureIndex": 1, "clmgmtFeatureName": "interface-1", "clmgmtFeatureVersion": "example-string", "clmgmtFeatureValidityPeriodRemaining": 0, "clmgmtFeatureWhatIsCounted": "example-string", "clmgmtFeatureStartDate": "example-string", "clmgmtFeatureEndDate": "example-string", "clmgmtFeaturePeriodUsed": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-clmgmtLicensableFeatureEntry-4" }, "x-yang-path": "/clmgmtLicensableFeatureEntry={entPhysicalIndex clmgmtFeatureIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex clmgmtFeatureIndex" ] } }, "components": { "schemas": { "CISCO-LICENSE-MGMT-MIB_CISCO-LICENSE-MGMT-MIB": { "type": "object", "description": "CISCO-LICENSE-MGMT-MIB", "properties": { "clmgmtLicenseActionEntry": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero", "readOnly": true }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action.", "readOnly": true }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file.", "readOnly": true }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance.", "readOnly": true }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "clmgmtLicenseActionResultEntry": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true } } }, "readOnly": true }, "clmgmtLicenseStoreInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "clmgmtLicenseDeviceInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "clmgmtLicenseInfoEntry": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex", "readOnly": true }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time.", "readOnly": true }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license", "readOnly": true }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted", "readOnly": true }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license.", "readOnly": true }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "clmgmtLicensableFeatureEntry": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "clmgmtDevCredExportActionEntry": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials", "readOnly": true }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid.", "readOnly": true }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true }, "clmgmtLicenseConfiguration": { "type": "object", "description": "clmgmtLicenseConfiguration", "properties": { "clmgmtNextFreeLicenseActionIndex": { "type": "integer", "description": "This object contains appropriate value for\n clmgmtLicenseActionIndex that can be used to create\n an entry in clmgmtLicenseActionTable. The management application\n should read this object first and then use this as the\n value for clmgmtLicenseActionIndex to avoid collisions\n when creating entries in clmgmtLicenseActionTable.\n Following this approach does not guarantee collision free\n row creation, but will reduce the probability. The\n collision will happen if two management applications read this\n object at the same time and attempt to create an entry\n with this value at the same time. In this case, the\n management application whose request is processed after the first\n request will get an error and the process of reading this object\n and entry creation needs to be repeated.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseDeviceInformation": { "type": "object", "description": "clmgmtLicenseDeviceInformation", "properties": { "clmgmtNextFreeDevCredExportActionIndex": { "type": "integer", "description": "This object contains appropriate value for\n clmgmtDevCredExportActionIndex that can be used to create\n an entry in clmgmtDevCredExportActionTable. The management\n application should read this object first and then use this\n as the value for clmgmtDevCredExportActionIndex to avoid\n collisions when creating entries in\n clmgmtDevCredExportActionTable. Following this approach does\n not guarantee collision free row creation, but will reduce\n the probability. The collision will happen if two\n management applications read this object at the same time and\n attempt to create an entry with this value at the same time.\n In this case, the management application whose request is\n processed after the first request will get an error and the\n process of reading this object and entry creation needs to be\n repeated.", "minimum": 0, "maximum": 4294967295, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseNotifObjects": { "type": "object", "description": "clmgmtLicenseNotifObjects", "properties": { "clmgmtLicenseUsageNotifEnable": { "type": "boolean", "description": "This object indicates whether the device should generate\n the notifications related to usage of licenses. This object\n enables/disables sending following notifications:\n clmgmtLicenseExpired \n clmgmtLicenseExpiryWarning\n clmgmtLicenseUsageCountExceeded\n clmgmtLicenseUsageCountAboutToExceed\n clmgmtLicenseSubscriptionExpiryWarning\n clmgmtLicenseSubscriptionExtExpiryWarning\n clmgmtLicenseSubscriptionExpired\n clmgmtLicenseEvalRTUTransitionWarning\n clmgmtLicenseEvalRTUTransition", "readOnly": true }, "clmgmtLicenseDeploymentNotifEnable": { "type": "boolean", "description": "This object indicates whether the device should generate\n notifications related to license deployment. This object\n enables/disables sending following notifications:\n clmgmtLicenseInstalled\n clmgmtLicenseCleared\n clmgmtLicenseRevoked\n clmgmtLicenseEULAAccepted", "readOnly": true }, "clmgmtLicenseErrorNotifEnable": { "type": "string", "description": "This object indicates whether the device should generate\n notifications related to error conditions in enforcing\n licensing. This object enables/disables sending following\n notifications:\n clmgmtLicenseNotEnforced", "readOnly": true } }, "readOnly": true }, "clmgmtLicenseActionTable": { "type": "object", "description": "clmgmtLicenseActionTable", "properties": { "clmgmtLicenseActionEntry": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero", "readOnly": true }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action.", "readOnly": true }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file.", "readOnly": true }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance.", "readOnly": true }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseActionResultTable": { "type": "object", "description": "This table contains results of license action if the\n license action involves multiple licenses. Entries in this\n table are not created for actions where there is\n only license that is subject of the action. For\n example, if there are 3 licenses in a license file\n when executing license install action, 3 entries will\n be created in this table, one for each license.", "properties": { "clmgmtLicenseActionResultEntry": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseStoreInfoTable": { "type": "object", "description": "This table contains information about all the license\n stores allocated on the device.", "properties": { "clmgmtLicenseStoreInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseDeviceInfoTable": { "type": "object", "description": "This table contains objects that provide licensing related\n information at the device level. Entries will exist\n only for entities that support licensing. For example,\n if it is a stand alone device and supports licensing,\n then there will be only one entry in this table. If\n it is stackable switch then there will be multiple\n entries with one entry for each device in the stack.", "properties": { "clmgmtLicenseDeviceInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtLicenseInfoTable": { "type": "object", "description": "This table contains information about all the licenses\n installed on the device.", "properties": { "clmgmtLicenseInfoEntry": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex", "readOnly": true }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time.", "readOnly": true }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license", "readOnly": true }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted", "readOnly": true }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license.", "readOnly": true }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtLicensableFeatureTable": { "type": "object", "description": "clmgmtLicensableFeatureTable", "properties": { "clmgmtLicensableFeatureEntry": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "clmgmtDevCredExportActionTable": { "type": "object", "description": "clmgmtDevCredExportActionTable", "properties": { "clmgmtDevCredExportActionEntry": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials", "readOnly": true }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid.", "readOnly": true }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this entry.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "string", "description": "clmgmtFeatureIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureName": { "type": "string", "description": "clmgmtFeatureName", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "string", "description": "clmgmtFeatureIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureVersion": { "type": "string", "description": "clmgmtFeatureVersion", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-3": { "type": "object", "description": "object-3", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "string", "description": "clmgmtFeatureIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureValidityPeriodRemaining": { "type": "string", "description": "clmgmtFeatureValidityPeriodRemaining", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-4": { "type": "object", "description": "object-4", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreUsed": { "type": "string", "description": "clmgmtLicenseStoreUsed", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseIndex": { "type": "string", "description": "clmgmtLicenseIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseComments": { "type": "string", "description": "clmgmtLicenseComments", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-5": { "type": "object", "description": "object-5", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "string", "description": "clmgmtFeatureIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "clmgmtFeatureWhatIsCounted", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_object-6": { "type": "object", "description": "object-6", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreUsed": { "type": "string", "description": "clmgmtLicenseStoreUsed", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseIndex": { "type": "string", "description": "clmgmtLicenseIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseComments": { "type": "string", "description": "clmgmtLicenseComments", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicenseActionEntry": { "type": "array", "description": "clmgmtLicenseActionEntry", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtLicenseActionTable. The management application should choose\n this value by reading clmgmtNextFreeLicenseActionIndex\n while creating an entry in this table. If an entry already\n exists with this index, the creation of the entry will not\n continue and error will be returned. The management application\n should read the value of clmgmtNextFreeLicenseActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n where the action is being executed. This object is mainly\n used in devices where one device is acting as a master and\n rest of the devices as slaves. The master device is\n responsible for SNMP communication with the management\n application. Examples include stackable switches, devices\n with route processor and line card configuration. If this\n object is not set, the license action will be executed on\n the master device. Note: This object need not be set if\n there is a stand alone device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtLicenseActionTransferProtocol": { "type": "string", "description": "This object represents the transfer protocol to be used\n when copying files as specified in the following objects.\n 1. clmgmtLicenseFile\n 2. clmgmtLicensePermissionTicketFile\n 3. clmgmtLicenseRehostTicketFile\n 4. clmgmtLicenseBackupFile\n \n Note: This object need not be set if the all the files\n required for the action are in device's local file system.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtLicenseServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtLicenseServerAddress object.\n This must be set when clmgmtLicenseActionTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtLicenseServerAddress": { "type": "string", "description": "This object indicates the ip address of the server from\n which the files must be read or written to if\n clmgmtLicenseActionTransferProtocol is not none(1) or\n local(2).\n \n All bits as 0s or 1s for clmgmtLicenseServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtLicenseServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtLicenseServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object must\n be set when the clmgmtLicenseActionTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtLicenseActionTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server.\n This object must be set when the\n clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)\n or sftp(8). Reading it returns a zero-length string for\n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFile": { "type": "string", "description": "This object represents the location of the license file\n on the server identified by clmgmtLicenseServerAddress. This\n object MUST be set to a valid value before or concurrently\n with setting the value of the clmgmtLicenseAction object to\n install(2). For other operations, the value of this\n object is not considered, it is irrelevant.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStore": { "type": "integer", "description": "This object represents the clmgmtLicenseStoreIndex of the\n license store to use within the device. The license store\n can be a local disk or flash. A device can have more than\n one license stores. If this object is not set, the license\n will be stored in the default license store as exposed by\n clmgmtDefaultLicenseStore object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionLicenseIndex": { "type": "string", "description": "This object indicates the the license index of the license\n that is the subject of this action. This is used for\n identifying a license for performing actions specific to\n that license. This object need to be set only if\n clmgmtLicenseAction is set to clear(4). The value of this\n object is same as the clmgmtLicenseIndex object in\n clmgmtLicenseInfoEntry for license that is subject of this\n action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndexOrZero", "readOnly": true }, "clmgmtLicensePermissionTicketFile": { "type": "string", "description": "This object indicates the file name of the permission\n ticket. This object need to be set only if\n clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions. The permission\n ticket is obtained from Cisco licensing portal to revoke\n a license. The management application must set this object\n to valid value before invoking the action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseRehostTicketFile": { "type": "string", "description": "This object indicates the file where the rehost ticket\n generated by the device need to be exported to. The rehost\n ticket is generated as a result of processPermissionTicket\n and regenerateLastRehostTicket actions. After generating\n the rehost ticket, the device exports the rehost ticket\n contents to this file. This object need to be set only\n if clmgmtLicenseAction is set to processPermissionTicket(4)\n or regenerateLastRehostTicket(5) actions.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseBackupFile": { "type": "string", "description": "This object indicates the file where all the licenses in\n the device need to be backed up. This object need to be set\n only if clmgmtLicenseAction is set to backup(6) and the\n management application must set the value of this object\n to valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStopOnFailure": { "type": "boolean", "description": "This object indicates whether the license action should\n stop if the action on a license fails. This object is\n applicable only if there are more than one licenses\n involved in an action.", "readOnly": true }, "clmgmtLicenseAction": { "type": "string", "description": "This object indicates the the command/action to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n install(2) Installs the license.\n \n clear(3) Clears the license.\n \n processPermissionTicket(4) Processes thee permission\n ticket and generates and\n exports rehost ticket.\n \n regenerateLastRehostTicket(5) Generates and exports the\n last generated rehost\n ticket.\n \n backup(6) Backs up all the licenses\n installed currently onto a\n backup store.\n \n generateEULA(7) Checks whether the licenses\n in the license file need EULA\n acceptance and uploads the\n needed EULA contents to a file.", "readOnly": true }, "clmgmtLicenseActionState": { "type": "string", "description": "This object indicates the state of this license action.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseJobQPosition": { "type": "integer", "description": "This object represents the position of the action\n in the license action job queue that is maintained\n internally. Only actions in pending(2) state will\n be put in the queue until they are executed. By\n reading this object, the management application can make\n intelligent decision on whether to execute another\n action that it is planning on. For example, if there\n is already a license clear action in the queue in\n pending(2) state, management application can choose to\n defer its license back up action to a later time. This\n object will return a value of 0 if the action is not in\n pending(2) state.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseActionFailCause": { "type": "string", "description": "This object indicates the reason for this license action\n failure. The value of this object is valid only when\n clmgmtLicenseActionState is failed(6).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true }, "clmgmtLicenseActionStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtLicenseActionRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtLicenseConfigCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row. It is recommended that the management application\n should delete entries in this table after reading\n the result. In order to prevent old entries from\n clogging the table, entries will be aged out, but an\n entry will never be deleted within 5 minutes of\n completion", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "clmgmtLicenseAcceptEULA": { "type": "boolean", "description": "This object indicates whether the End User License Agreement\n needed for installing the licenses is accepted.\n \n true(1) - EULA is read and accepted\n false(2) - EULA is not accepted\n \n Management application should set this object to true(1) when\n installing licenses that need EULA acceptance.", "readOnly": true }, "clmgmtLicenseEULAFile": { "type": "string", "description": "This object indicates the file where all the End User License\n Agreements (EULAs) need to be exported to. This object need to\n be set only if clmgmtLicenseAction is set to generateEULA(7) and\n the management application must set the value of this object to\n valid value before invoking action.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicenseActionResultEntry": { "type": "array", "description": "An entry in clmgmtLicenseActionResultTable. Each entry\n contains result of the action for a single license.\n These entries are created immediately after action\n execution when the action involves multiple licenses.\n These entries get automatically deleted when the\n corresponding entry in clmgmtLicenseActionTable\n is deleted.", "items": { "type": "object", "properties": { "clmgmtLicenseActionIndex": { "type": "string", "description": "clmgmtLicenseActionIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseNumber": { "type": "integer", "description": "This object indicates the sequence number of this license\n in the list of licenses on which the action is executed.\n For example, if there are 3 licenses in a license file\n when executing license install action, this object will\n have values 1, 2 and 3 respectively as ordered in the\n license file.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndivActionState": { "type": "string", "description": "This object indicates the state of action on this\n individual license.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtLicenseIndivActionFailCause": { "type": "string", "description": "This object indicates the reason for action failure on this\n individual license", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionFailCause", "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicenseStoreInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseStoreInfoTable. Each entry\n contains information about a license store allocated\n on the device", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreIndex": { "type": "integer", "description": "This object uniquely identifies a license store within\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreName": { "type": "string", "description": "This object indicates the name of the license store\n within the device. It is a file in device's local file\n system i.e., either on a local disk or flash or some\n other storage media. For example, the value of this\n object can be 'disk1:lic_store_1.txt' or\n 'flash:lic_store_2.txt", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStoreTotalSize": { "type": "integer", "description": "This object indicates the total number of bytes that are\n allocated to the license store.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseStoreSizeRemaining": { "type": "integer", "description": "This object indicates the number of bytes still remaining\n to be used for new license installations in the license\n store.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicenseDeviceInfoEntry": { "type": "array", "description": "An entry in clmgmtLicenseDeviceInfoTable. Each entry\n contains device level licensing information for a device.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtDefaultLicenseStore": { "type": "integer", "description": "This object indicates the clmgmtLicenseStoreIndex of\n default store in the device. There will be only one\n default license store per device. If no license store\n is specified during license install, this default license\n store will be used.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicenseInfoEntry": { "type": "array", "description": "clmgmtLicenseInfoEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtLicenseStoreUsed": { "type": "integer", "description": "This object represents the license store that is used for\n storing this license. This object will have the same value\n as clmgmtLicenseStoreIndex in clmgmtLicenseStoreInfoEntry\n of the license store used.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseIndex": { "type": "string", "description": "This object uniquely identifies a license within\n the device.", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseIndex", "readOnly": true }, "clmgmtLicenseFeatureName": { "type": "string", "description": "This object indicates the name of the feature that is\n using or can use this license. A license can be used by\n only one feature. Examples of feature name are: 'IPBASE',\n 'ADVIPSERVICE'.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseFeatureVersion": { "type": "string", "description": "This object indicates the version of the feature that is\n using or can use this license. Examples of feature version\n are: '1.0', '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseType": { "type": "string", "description": "This object identifies type of license. Licenses may have\n validity period defined in terms of time duration that the\n license is valid for or it may be defined in terms of actual\n calendar dates. Subscription licenses are licenses that have\n validity period defined in terms of calendar dates.\n \n demo(1) - demo(evaluation license) license.\n extension(2) - Extension(expiring) license.\n gracePeriod(3) - Grace period license.\n permanent(4) - permanent license, the license has no\n expiry date.\n paidSubscription(5) - Paid subscription licenses are the\n licenses\n which are purchased by customers. These\n licenses have a start date and end date\n associated with them.\n evaluationSubscription(6)-Evaluation subscription licenses are\n the trial licenses. These licenses\n are node locked and it can be obtained\n only once for an UDI. They are valid\n based on calendar days. These licenses\n have a start date and an end date\n associated with them and are issued\n once per UDI.\n extensionSubscription(7)- Extension subscription licenses are\n similar to evaluation subscription\n licenses but these licenses are issued\n based on customer request. There are\n no restrictions on the number of\n licenses available for a UDI.\n evalRightToUse(8) - Evaluation Right to use (RTU)\n license.\n rightToUse(9) - Right to use (RTU) license.\n permanentRightToUse(10) ? Right To Use license right after it is configured \n and is valid for the lifetime of the product. \n This is a Right To Use license which is not in \n evaluation mode for a limited time.", "readOnly": true }, "clmgmtLicenseCounted": { "type": "boolean", "description": "This object indicates whether the license is counted\n license.\n true(1) - counted license\n false(2) - uncounted license", "readOnly": true }, "clmgmtLicenseValidityPeriod": { "type": "integer", "description": "This object indicates the time period the license is valid for.\n This object is applicable only if clmgmtLicenseType is demo(1),\n or extension(2) or gracePeriod(3) or evalRightToUse(8). The\n object will return 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before the\n license expires or transitions to rightToUse(9) license. This\n object is applicable only if clmgmtLicenseType is demo(1), or\n extension(2) or gracePeriod(3) or evalRightToUse(8). The object\n will contain 0 for other license types.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseExpiredPeriod": { "type": "integer", "description": "This object indicates the elapsed time period since the license\n expired. This object is applicable only if clmgmtLicenseType\n is demo(1), or extension(2) or gracePeriod(3). Also, this\n value of this object will be valid only after the license\n expires. The object will return 0 for other license types\n or before the license expiry.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseMaxUsageCount": { "type": "integer", "description": "This object indicates the maximum number of entities that\n can use this license. This object is applicable only if\n clmgmtLicenseCounted is true(1). The entity that is being\n counted can be anything and it depends on the licensable\n feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseUsageCountRemaining": { "type": "integer", "description": "This object indicates the number of entities that can\n still use this license. This object is applicable only\n if clmgmtLicenseCounted is true(1).", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtLicenseEULAStatus": { "type": "boolean", "description": "This object indicates whether the user accepted\n End User License Agreement for this license.\n \n true(1) - EULA accpeted\n false(2) - EULA not accepted", "readOnly": true }, "clmgmtLicenseComments": { "type": "string", "description": "This object represents the user modifiable comments\n about the license. This object is initially populated\n with comments from the license file.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtLicenseStatus": { "type": "string", "description": "This object represents status of the license.\n \n inactive(1) - license is installed, but\n not active.\n notInUse(2) - license is installed and\n available for use.\n inUse(3) - the license is being used (by\n a feature).\n expiredInUse(4) - license is expired but still\n being held by the feature.\n expiredNotInUse(5) - license is expired and not being\n held by any feature.\n usageCountConsumed(6) - number of entities using this\n licenses has reached the allowed\n limit, no new entities are allowed\n to use this license.", "readOnly": true }, "clmgmtLicenseStartDate": { "type": "string", "description": "This object indicates the start date for a subscription\n license. It is optional for subscription linceses to have a\n start date associated with them, they may only have an end\n date associated with them. This object may be applicable only\n when clmgmtLicenseType is paidSubscription(5),\n evaluationSubscription(6) or extensionSubscription (7). \n The object will contain an octet string of length 0 when it is\n not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicenseEndDate": { "type": "string", "description": "This object indicates the end date for a subscription license.\n This object is applicable only when clmgmtLicenseType is\n paidSubscription(5), evaluationSubscription(6) or\n extensionSubscription (7). The object will contain an octet\n string of length 0 when it is not applicable.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtLicensePeriodUsed": { "type": "integer", "description": "This object indicates the time period used for the\n Right to use (RTU) licenses. This object is applicable for all\n RTU licenses.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtLicensableFeatureEntry": { "type": "array", "description": "An entry in clmgmtLicensableFeatureTable. Each entry represents\n a licensable feature.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "clmgmtFeatureIndex": { "type": "integer", "description": "This object uniquely identifies a licensable feature in\n the device.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureName": { "type": "string", "description": "This object indicates the name of the licensable feature\n in the device. Examples of feature names are: 'IPBASE',\n 'ADVIPSERVICE'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureVersion": { "type": "string", "description": "This object indicates the version of the licensable\n feature in the device. Examples of feature versions\n are: '1.0' or '2.0'", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureValidityPeriodRemaining": { "type": "integer", "description": "This object indicates the time period remaining before\n the feature's license expires or transitions. This object is\n applicable only if clmgmtLicenseType of the license used by\n this feature is demo(1), or extension(2) or gracePeriod(3) or\n evalRightToUse(8).\n \n The object will contain 0 if other types of license is used\n or if the feature does not use any license. If the\n feature is using multiple licenses, this period will\n represent the cumulative period remaining from all the\n licenses used by this feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtFeatureWhatIsCounted": { "type": "string", "description": "This object represents the entity that is being counted\n by this feature. Examples of entities are IP Phones, number\n of sessions etc. This object is only applicable for\n features that use counting licenses. For other features,\n this object will return empty string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtFeatureStartDate": { "type": "string", "description": "This object indicates the license start date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid start date. The start date will\n be the earliest of the valid start dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid start date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeatureEndDate": { "type": "string", "description": "This object indicates the license end date of the feature.\n This object is applicable if at least one of the licenses used\n for this feature has a valid end date. The end date will\n be the latest of the valid end dates of all the licenses\n used for this feature. If none of the licenses used for this\n feature have a valid end date then this object will contain an\n octet string of length 0.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "clmgmtFeaturePeriodUsed": { "type": "integer", "description": "This object indicates the license period used for the feature.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-LICENSE-MGMT-MIB_clmgmtDevCredExportActionEntry": { "type": "array", "description": "clmgmtDevCredExportActionEntry", "items": { "type": "object", "properties": { "clmgmtDevCredExportActionIndex": { "type": "integer", "description": "This object uniquely identifies a row in\n clmgmtDevCredExportActionTable. The management application\n chooses this value by reading\n clmgmtNextFreeDevCredExportActionIndex while creating an\n entry in this table. If an entry already exists with this\n index, the creation of the entry will not continue and\n error will be returned. The management application should\n read the value of clmgmtNextFreeDevCredExportActionIndex\n again and retry with the new value for this object.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "clmgmtDevCredEntPhysicalIndex": { "type": "string", "description": "This object represents the entPhysicalIndex of the device\n for which the device credentials are being retrieved. This\n object is mainly used in devices where one device is acting\n as a master and rest of the devices as slaves. The master\n device is responsible for SNMP communication with the\n manager. Examples include stackable switches, devices with\n router processor and line cards.\n \n Note: This object need not be set if it is a stand alone\n device", "x-yang-type": "entity-mib:PhysicalIndexOrZero", "readOnly": true }, "clmgmtDevCredTransferProtocol": { "type": "string", "description": "This object indicates the transfer protocol to be used when\n copying files as specified in the following objects.\n 1. clmgmtDevCredExportFile\n .", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseTransferProtocol", "readOnly": true }, "clmgmtDevCredServerAddressType": { "type": "string", "description": "This object indicates the transport type of the\n address contained in clmgmtDevCredServerAddress object.\n This must be set when clmgmtDevCredTransferProtocol\n is not none(1) or local(2).", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "clmgmtDevCredServerAddress": { "type": "string", "description": "This object indicates the the ip address of the server\n from which the files must be read or written to if \n clmgmtDevCredTransferProtocol is not none(1) or local(2).\n \n All bits as 0s or 1s for clmgmtDevCredServerAddress are not\n allowed.\n \n The format of this address depends on the value of the\n clmgmtDevCredServerAddressType object", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "clmgmtDevCredServerUsername": { "type": "string", "description": "This object indicates the remote user name for accessing\n files via ftp, rcp, sftp or scp protocols. This object\n must be set when the clmgmtDevCredTransferProtocol is\n ftp(4), rcp(5), scp(7) or sftp(8). If\n clmgmtDevCredTransferProtocol is rcp(5), the remote\n username is sent as the server username in an rcp command\n request sent by the system to a remote rcp server.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredServerPassword": { "type": "string", "description": "This object indicates the password used by ftp, sftp or\n scp for copying a file to/from an ftp/sftp/scp server. \n This object must be set when the\n clmgmtDevCredTransferProtocol is ftp(4) or scp(7) or\n sftp(8). Reading it returns a zero-length string for \n security reasons.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredExportFile": { "type": "string", "description": "This object represents file where device credentials needs\n to be exported to.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "clmgmtDevCredCommand": { "type": "string", "description": "This object indicates the the command to be executed.\n \n Command Remarks\n ------- -------\n noOp(1) No operation will be\n performed.\n \n getDeviceCredentials(2) Exports device credentials", "readOnly": true }, "clmgmtDevCredCommandState": { "type": "string", "description": "This object indicates the state of the action that is\n executed as a result of setting clmgmtDevCredRowStatus\n to active(1).", "x-yang-type": "CISCO-LICENSE-MGMT-MIB:ClmgmtLicenseActionState", "readOnly": true }, "clmgmtDevCredCommandFailCause": { "type": "string", "description": "This object indicates the the reason for device\n credentials export operation failure.\n \n The value of this object is valid only when\n clmgmtDevCredCommandState is failed(6).\n \n none(1) - action execution has not started yet.\n If the action is completed and the \n action is successful, then also\n none(1) is returned to indicate that\n there are no errors.\n unknownError(2) - reason for failure is unknown,\n operation failed, no operation is\n performed\n transferProtocolNotSupported(3) - clmgmtDevCredTransferProtocol\n given is not supported.\n fileServerNotReachable(4) - file server is not reachable.\n unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not\n valid\n invalidFile(6) - The target file specified is not valid.", "readOnly": true }, "clmgmtDevCredStorageType": { "type": "string", "description": "This object indicates the storage type for this conceptual\n row. Conceptual rows having the value 'permanent' need not\n allow write-access to any columnar objects in the row.", "x-yang-type": "snmpv2-tc:StorageType", "readOnly": true }, "clmgmtDevCredRowStatus": { "type": "string", "description": "This object indicates the the status of this table entry.\n Once the entry status is set to active(1), the associated\n entry cannot be modified until the action completes\n (clmgmtDevCredCommandStatus is set to a value\n other than inProgress(3)). Once the action completes\n the only operation possible after this is to delete\n the row.\n \n clmgmtDevCredExportFile is a mandatory object to be\n set when creating this 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-LICENSE-MGMT-MIB", "description": "MIB operations for CISCO-LICENSE-MGMT-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }