{ "openapi": "3.0.0", "info": { "title": "CISCO-IP-LOCAL-POOL-MIB MIB API", "version": "1.0.0", "description": "This MIB defines the configuration and monitoring capabilities\n relating to local IP pools.\n \n Local IP pools have the following characteristics:\n \n - An IP local pool consists of one or more IP address ranges.\n \n - An IP pool group consists of one or more IP local pools.\n \n - An IP local pool can only belong to one IP pool group.\n \n - IP local pools that belong to different groups can have\n overlapping addresses.\n \n - IP local pool names are unique even when they belong to\n different groups.\n \n - Addresses within an IP pool group can not overlap.\n \n - IP local pools without an explicit group name are considered\n members of the base system group. In this MIB, the base\n system group is represented by a null IP pool group name.\n \n This MIB defines objects that expose the relationship between\n IP pool groups and IP local pools. There exist other objects\n that maintain statistics about the address usage of IP local\n pools.\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-IP-LOCAL-POOL-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/CISCO-IP-LOCAL-POOL-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "CISCO-IP-LOCAL-POOL-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-IP-LOCAL-POOL-MIB:cIpLocalPoolConfig": { "get": { "summary": "Get cIpLocalPoolConfig data", "description": "Retrieve cIpLocalPoolConfig operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "An indication of whether the notifications defined by the\n ciscoIpLocalPoolNotifGroup are enabled.", "properties": { "cIpLocalPoolNotificationsEnable": { "type": "boolean", "description": "An indication of whether the notifications defined by the\n ciscoIpLocalPoolNotifGroup are enabled." } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfig": { "cIpLocalPoolNotificationsEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfig", "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": "/cIpLocalPoolConfig", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigTable": { "get": { "summary": "Get cIpLocalPoolConfigTable data", "description": "Retrieve cIpLocalPoolConfigTable operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIpLocalPoolConfigTable", "properties": { "cIpLocalPoolConfigEntry": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigTable": { "cIpLocalPoolConfigEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfigTable", "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": "/cIpLocalPoolConfigTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigTable/cIpLocalPoolConfigEntry": { "get": { "summary": "Get cIpLocalPoolConfigEntry list", "description": "Retrieve list of cIpLocalPoolConfigEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfigEntry", "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": "/cIpLocalPoolConfigTable/cIpLocalPoolConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsTable": { "get": { "summary": "Get cIpLocalPoolGroupContainsTable data", "description": "Retrieve cIpLocalPoolGroupContainsTable operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIpLocalPoolGroupContainsTable", "properties": { "cIpLocalPoolGroupContainsEntry": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" } } } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsTable": { "cIpLocalPoolGroupContainsEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "1" }, { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "2" }, { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupContainsTable", "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": "/cIpLocalPoolGroupContainsTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsTable/cIpLocalPoolGroupContainsEntry": { "get": { "summary": "Get cIpLocalPoolGroupContainsEntry list", "description": "Retrieve list of cIpLocalPoolGroupContainsEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupContainsEntry", "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": "/cIpLocalPoolGroupContainsTable/cIpLocalPoolGroupContainsEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupTable": { "get": { "summary": "Get cIpLocalPoolGroupTable data", "description": "Retrieve cIpLocalPoolGroupTable operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table provides statistics for configured IP pool groups.\n \n Entries in this table are created as the result of adding a new\n IP pool group to the cIpLocalPoolConfigTable.\n \n Entries in this table are deleted as the result of removing all\n IP local pools that are contained in an IP pool group in the\n cIpLocalPoolConfigTable.\n \n An entry in this table is uniquely indexed by IP pool group\n name.", "properties": { "cIpLocalPoolGroupEntry": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref" }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupTable": { "cIpLocalPoolGroupEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 }, { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 }, { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupTable", "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": "/cIpLocalPoolGroupTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupTable/cIpLocalPoolGroupEntry": { "get": { "summary": "Get cIpLocalPoolGroupEntry list", "description": "Retrieve list of cIpLocalPoolGroupEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref" }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupEntry", "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": "/cIpLocalPoolGroupTable/cIpLocalPoolGroupEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupTable/cIpLocalPoolGroupEntry={cIpLocalPoolGroupName}": { "get": { "summary": "Get cIpLocalPoolGroupEntry entry", "description": "Retrieve specific cIpLocalPoolGroupEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolGroupName", "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": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref" }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry": { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupEntry-2" }, "x-yang-path": "/cIpLocalPoolGroupTable/cIpLocalPoolGroupEntry={cIpLocalPoolGroupName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolGroupName" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsTable": { "get": { "summary": "Get cIpLocalPoolStatsTable data", "description": "Retrieve cIpLocalPoolStatsTable operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIpLocalPoolStatsTable", "properties": { "cIpLocalPoolStatsEntry": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" } } } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsTable": { "cIpLocalPoolStatsEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolStatsTable", "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": "/cIpLocalPoolStatsTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsTable/cIpLocalPoolStatsEntry": { "get": { "summary": "Get cIpLocalPoolStatsEntry list", "description": "Retrieve list of cIpLocalPoolStatsEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolStatsEntry", "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": "/cIpLocalPoolStatsTable/cIpLocalPoolStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsTable/cIpLocalPoolStatsEntry={cIpLocalPoolName}": { "get": { "summary": "Get cIpLocalPoolStatsEntry entry", "description": "Retrieve specific cIpLocalPoolStatsEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "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": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolStatsEntry-2" }, "x-yang-path": "/cIpLocalPoolStatsTable/cIpLocalPoolStatsEntry={cIpLocalPoolName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocTable": { "get": { "summary": "Get cIpLocalPoolAllocTable data", "description": "Retrieve cIpLocalPoolAllocTable operational data from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "cIpLocalPoolAllocTable", "properties": { "cIpLocalPoolAllocEntry": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocTable": { "cIpLocalPoolAllocEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "1", "cIpLocalPoolAllocUser": "192.168.1.1" }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "2", "cIpLocalPoolAllocUser": "192.168.1.1" }, { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "3", "cIpLocalPoolAllocUser": "192.168.1.1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolAllocTable", "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": "/cIpLocalPoolAllocTable", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocTable/cIpLocalPoolAllocEntry": { "get": { "summary": "Get cIpLocalPoolAllocEntry list", "description": "Retrieve list of cIpLocalPoolAllocEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "192.168.1.1", "cIpLocalPoolAllocUser": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolAllocEntry", "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": "/cIpLocalPoolAllocTable/cIpLocalPoolAllocEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry": { "get": { "summary": "Get cIpLocalPoolConfigEntry list", "description": "Retrieve list of cIpLocalPoolConfigEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfigEntry-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": "/cIpLocalPoolConfigEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry": { "get": { "summary": "Get cIpLocalPoolGroupContainsEntry list", "description": "Retrieve list of cIpLocalPoolGroupContainsEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupContainsEntry-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": "/cIpLocalPoolGroupContainsEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry": { "get": { "summary": "Get cIpLocalPoolGroupEntry list", "description": "Retrieve list of cIpLocalPoolGroupEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref" }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry": [ { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupEntry-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": "/cIpLocalPoolGroupEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry={cIpLocalPoolGroupName}": { "get": { "summary": "Get cIpLocalPoolGroupEntry entry", "description": "Retrieve specific cIpLocalPoolGroupEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolGroupName", "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": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref" }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupEntry": { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolGroupFreeAddrs": 0, "cIpLocalPoolGroupInUseAddrs": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupEntry-4" }, "x-yang-path": "/cIpLocalPoolGroupEntry={cIpLocalPoolGroupName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolGroupName" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry": { "get": { "summary": "Get cIpLocalPoolStatsEntry list", "description": "Retrieve list of cIpLocalPoolStatsEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolStatsEntry-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": "/cIpLocalPoolStatsEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry={cIpLocalPoolName}": { "get": { "summary": "Get cIpLocalPoolStatsEntry entry", "description": "Retrieve specific cIpLocalPoolStatsEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "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": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolStatsEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolStatFreeAddrs": 0, "cIpLocalPoolStatInUseAddrs": 0, "cIpLocalPoolStatHiWaterUsedAddrs": 0, "cIpLocalPoolStatInUseAddrThldLo": 0, "cIpLocalPoolStatInUseAddrThldHi": 0, "cIpLocalPoolPercentAddrThldLo": "192.168.1.1", "cIpLocalPoolPercentAddrThldHi": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolStatsEntry-4" }, "x-yang-path": "/cIpLocalPoolStatsEntry={cIpLocalPoolName}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry": { "get": { "summary": "Get cIpLocalPoolAllocEntry list", "description": "Retrieve list of cIpLocalPoolAllocEntry entries from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry": [ { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "192.168.1.1", "cIpLocalPoolAllocUser": "192.168.1.1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolAllocEntry-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": "/cIpLocalPoolAllocEntry", "x-restconf-kind": "container" }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigTable/cIpLocalPoolConfigEntry={cIpLocalPoolName},{cIpLocalPoolAddrType},{cIpLocalPoolAddressLo}": { "get": { "summary": "Get cIpLocalPoolConfigEntry entry", "description": "Retrieve specific cIpLocalPoolConfigEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAddressLo", "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": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfigEntry-2" }, "x-yang-path": "/cIpLocalPoolConfigTable/cIpLocalPoolConfigEntry={cIpLocalPoolName cIpLocalPoolAddrType cIpLocalPoolAddressLo}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName cIpLocalPoolAddrType cIpLocalPoolAddressLo" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsTable/cIpLocalPoolGroupContainsEntry={cIpLocalPoolGroupName},{cIpLocalPoolChildIndex}": { "get": { "summary": "Get cIpLocalPoolGroupContainsEntry entry", "description": "Retrieve specific cIpLocalPoolGroupContainsEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolGroupName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolChildIndex", "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": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry": { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupContainsEntry-2" }, "x-yang-path": "/cIpLocalPoolGroupContainsTable/cIpLocalPoolGroupContainsEntry={cIpLocalPoolGroupName cIpLocalPoolChildIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolGroupName cIpLocalPoolChildIndex" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocTable/cIpLocalPoolAllocEntry={cIpLocalPoolName},{cIpLocalPoolAllocAddrType},{cIpLocalPoolAllocAddr}": { "get": { "summary": "Get cIpLocalPoolAllocEntry entry", "description": "Retrieve specific cIpLocalPoolAllocEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAllocAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAllocAddr", "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": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "192.168.1.1", "cIpLocalPoolAllocUser": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolAllocEntry-2" }, "x-yang-path": "/cIpLocalPoolAllocTable/cIpLocalPoolAllocEntry={cIpLocalPoolName cIpLocalPoolAllocAddrType cIpLocalPoolAllocAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName cIpLocalPoolAllocAddrType cIpLocalPoolAllocAddr" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry={cIpLocalPoolName},{cIpLocalPoolAddrType},{cIpLocalPoolAddressLo}": { "get": { "summary": "Get cIpLocalPoolConfigEntry entry", "description": "Retrieve specific cIpLocalPoolConfigEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAddressLo", "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": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295 }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus" }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolConfigEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAddrType": "192.168.1.1", "cIpLocalPoolAddressLo": "192.168.1.1", "cIpLocalPoolAddressHi": "192.168.1.1", "cIpLocalPoolFreeAddrs": 0, "cIpLocalPoolInUseAddrs": 0, "cIpLocalPoolGroupContainedIn": "192.168.1.1", "cIpLocalPoolRowStatus": "192.168.1.1", "cIpLocalPoolPriority": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolConfigEntry-4" }, "x-yang-path": "/cIpLocalPoolConfigEntry={cIpLocalPoolName cIpLocalPoolAddrType cIpLocalPoolAddressLo}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName cIpLocalPoolAddrType cIpLocalPoolAddressLo" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry={cIpLocalPoolGroupName},{cIpLocalPoolChildIndex}": { "get": { "summary": "Get cIpLocalPoolGroupContainsEntry entry", "description": "Retrieve specific cIpLocalPoolGroupContainsEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolGroupName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolChildIndex", "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": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull" }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolGroupContainsEntry": { "cIpLocalPoolGroupName": "192.168.1.1", "cIpLocalPoolChildIndex": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolGroupContainsEntry-4" }, "x-yang-path": "/cIpLocalPoolGroupContainsEntry={cIpLocalPoolGroupName cIpLocalPoolChildIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolGroupName cIpLocalPoolChildIndex" ] }, "/data/CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry={cIpLocalPoolName},{cIpLocalPoolAllocAddrType},{cIpLocalPoolAllocAddr}": { "get": { "summary": "Get cIpLocalPoolAllocEntry entry", "description": "Retrieve specific cIpLocalPoolAllocEntry entry by key from MIB", "tags": [ "CISCO-IP-LOCAL-POOL-MIB" ], "parameters": [ { "name": "cIpLocalPoolName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAllocAddrType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cIpLocalPoolAllocAddr", "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": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref" }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType" }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress" }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero" }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "CISCO-IP-LOCAL-POOL-MIB:cIpLocalPoolAllocEntry": { "cIpLocalPoolName": "192.168.1.1", "cIpLocalPoolAllocAddrType": "192.168.1.1", "cIpLocalPoolAllocAddr": "192.168.1.1", "cIpLocalPoolAllocIfIndex": "192.168.1.1", "cIpLocalPoolAllocUser": "192.168.1.1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-cIpLocalPoolAllocEntry-4" }, "x-yang-path": "/cIpLocalPoolAllocEntry={cIpLocalPoolName cIpLocalPoolAllocAddrType cIpLocalPoolAllocAddr}", "x-restconf-kind": "list-instance", "x-list-keys": [ "cIpLocalPoolName cIpLocalPoolAllocAddrType cIpLocalPoolAllocAddr" ] } }, "components": { "schemas": { "CISCO-IP-LOCAL-POOL-MIB_CISCO-IP-LOCAL-POOL-MIB": { "type": "object", "description": "An indication of whether the notifications defined by the\n ciscoIpLocalPoolNotifGroup are enabled.", "properties": { "cIpLocalPoolConfigEntry": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cIpLocalPoolGroupContainsEntry": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true } } }, "readOnly": true }, "cIpLocalPoolGroupEntry": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "cIpLocalPoolStatsEntry": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true } } }, "readOnly": true }, "cIpLocalPoolAllocEntry": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "cIpLocalPoolConfig": { "type": "object", "description": "An indication of whether the notifications defined by the\n ciscoIpLocalPoolNotifGroup are enabled.", "properties": { "cIpLocalPoolNotificationsEnable": { "type": "boolean", "description": "An indication of whether the notifications defined by the\n ciscoIpLocalPoolNotifGroup are enabled.", "readOnly": true } }, "readOnly": true }, "cIpLocalPoolConfigTable": { "type": "object", "description": "cIpLocalPoolConfigTable", "properties": { "cIpLocalPoolConfigEntry": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cIpLocalPoolGroupContainsTable": { "type": "object", "description": "cIpLocalPoolGroupContainsTable", "properties": { "cIpLocalPoolGroupContainsEntry": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cIpLocalPoolGroupTable": { "type": "object", "description": "This table provides statistics for configured IP pool groups.\n \n Entries in this table are created as the result of adding a new\n IP pool group to the cIpLocalPoolConfigTable.\n \n Entries in this table are deleted as the result of removing all\n IP local pools that are contained in an IP pool group in the\n cIpLocalPoolConfigTable.\n \n An entry in this table is uniquely indexed by IP pool group\n name.", "properties": { "cIpLocalPoolGroupEntry": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cIpLocalPoolStatsTable": { "type": "object", "description": "cIpLocalPoolStatsTable", "properties": { "cIpLocalPoolStatsEntry": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "cIpLocalPoolAllocTable": { "type": "object", "description": "cIpLocalPoolAllocTable", "properties": { "cIpLocalPoolAllocEntry": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "CISCO-IP-LOCAL-POOL-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolStatFreeAddrs": { "type": "string", "description": "cIpLocalPoolStatFreeAddrs", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IP-LOCAL-POOL-MIB_object-2": { "type": "object", "description": "object-2", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolStatInUseAddrs": { "type": "string", "description": "cIpLocalPoolStatInUseAddrs", "x-yang-type": "leafref", "readOnly": true } } }, "CISCO-IP-LOCAL-POOL-MIB_cIpLocalPoolConfigEntry": { "type": "array", "description": "Each entry provides information about a particular IP local\n pool, including the number of free and used addresses and its priority.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "An arbitrary non-empty string that uniquely identifies the IP\n local pool. This name must be unique among all the local IP\n pools even when they belong to different pool groups.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true }, "cIpLocalPoolAddrType": { "type": "string", "description": "This object specifies the address type of cIpLocalPoolAddressLo\n and cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAddressLo": { "type": "string", "description": "This object specifies the first IP address of the range of IP\n addresses contained by this pool entry. The address type of\n this object is described by cIpLocalPoolAddrType.\n \n This address must be less than or equal to the address in\n cIpLocalPoolAddressHi.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAddressHi": { "type": "string", "description": "This object specifies the last IP address of the range of IP\n addresses mapped by this pool entry. The address type of this\n object is described by cIpLocalPoolAddrType. If only a single\n address is being mapped, the value of this object is equal to\n the value of cIpLocalPoolAddressLo.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the range of\n IP addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in the range of IP\n addresses.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupContainedIn": { "type": "string", "description": "This object relates an IP local pool to its IP pool group.\n \n A null string indicates this IP local pool is not contained in a\n named IP pool group, but that it is contained in the base IP\n pool group. An IP local pool can only belong to one IP pool\n group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolRowStatus": { "type": "string", "description": "This object facilitates the creation, or deletion of a\n conceptual row in this table.", "x-yang-type": "snmpv2-tc:RowStatus", "readOnly": true }, "cIpLocalPoolPriority": { "type": "integer", "description": "This object specifies priority of the IP local pool,\n where smaller value indicates the lower priority.\n The priority value is used in assigning IP Address \n from local pools.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-IP-LOCAL-POOL-MIB_cIpLocalPoolGroupContainsEntry": { "type": "array", "description": "Each entry describes single container/'containee'\n relationship.\n \n Pool names can only be associated with one group. Pools carry\n implicit group identifiers because pool names can only be\n associated with one group. An entry in this table describes\n such an association.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "A unique group name that identifies the IP pool group. The\n null string represents the base IP pool group.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolGroupNameOrNull", "readOnly": true }, "cIpLocalPoolChildIndex": { "type": "string", "description": "The value of cIpLocalPoolName for the contained IP local pool.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolName", "readOnly": true } } } }, "CISCO-IP-LOCAL-POOL-MIB_cIpLocalPoolGroupEntry": { "type": "array", "description": "Each entry provides information about a particular IP pool\n group and the number of free and used addresses in an IP pool\n group.", "items": { "type": "object", "properties": { "cIpLocalPoolGroupName": { "type": "string", "description": "cIpLocalPoolGroupName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolGroupFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in the IP pool\n group.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolGroupInUseAddrs": { "type": "integer", "description": "The number of IP addresses that have been allocated from the\n IP pool group.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "CISCO-IP-LOCAL-POOL-MIB_cIpLocalPoolStatsEntry": { "type": "array", "description": "Each entry provides statistical information about a particular\n IP local pool, and the total number of free and used addresses\n of all the ranges in an IP local pool.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolStatFreeAddrs": { "type": "integer", "description": "The number of IP addresses available for use in this IP local\n pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrs": { "type": "integer", "description": "The number of IP addresses being used in this IP local pool.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatHiWaterUsedAddrs": { "type": "integer", "description": "This object contains the high water mark of used addresses\n in an IP local pool since pool creation, since the system was\n restarted, or since this object was reset, whichever occurred\n last. This object can only be set to zero, and by doing so, it\n is reset to the value of cIpLocalPoolStatInUseAddrs.\n \n Since the number of addresses in a pool can be reduced (e.g. by\n deleting one of its ranges), the value of this object may be\n greater than the sum of cIpLocalPoolStatFreeAddrs and\n cIpLocalPoolStatInUseAddrs.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldLo": { "type": "integer", "description": "When the number of used addresses in an IP local pool falls\n below this threshold value, the ciscoIpLocalPoolInUseAddrNoti\n notification will be rearmed.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolStatInUseAddrThldHi.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolStatInUseAddrThldHi": { "type": "integer", "description": "When the number of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n ciscoIpLocalPoolInUseAddrNoti notification will be generated.\n Once this notification is generated, it will be disarmed and it\n will not be generated again until the number of used address\n falls below the value indicated by\n cIpLocalPoolStatInUseAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolStatInUseAddrThldLo.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "cIpLocalPoolPercentAddrThldLo": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n falls below this threshold value, a cilpPercentAddrUsedLoNotif\n notification will be generated. Once the notification is\n generated, it will be disarmed and it will not be generated\n again until the number of used addresses equals or exceeds the\n value indicated by cIpLocalPoolPercentAddrThldHi.\n \n The value of this object should never be greater than the value\n of cIpLocalPoolPercentAddrThldHi.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true }, "cIpLocalPoolPercentAddrThldHi": { "type": "string", "description": "When the percentage of used addresses in an IP local pool\n is equal or exceeds this threshold value, a\n cilpPercentAddrUsedHiNotif notification will be generated. Once\n the notification is generated, it will be disarmed and it will\n not be generated again until the number of used addresses falls\n below the value indicated by cIpLocalPoolPercentAddrThldLo.\n \n The value of this object should never be smaller than the value\n of cIpLocalPoolPercentAddrThldLo.", "x-yang-type": "CISCO-IP-LOCAL-POOL-MIB:CIpLocalPoolPercentage", "readOnly": true } } } }, "CISCO-IP-LOCAL-POOL-MIB_cIpLocalPoolAllocEntry": { "type": "array", "description": "Each entry refers to conceptual row that associates an IP\n addresses with the interface where the request was received, and\n the user that requested the address.", "items": { "type": "object", "properties": { "cIpLocalPoolName": { "type": "string", "description": "cIpLocalPoolName", "x-yang-type": "leafref", "readOnly": true }, "cIpLocalPoolAllocAddrType": { "type": "string", "description": "This object specifies the address type of\n cIpLocalPoolAllocAddr.", "x-yang-type": "inet-address:InetAddressType", "readOnly": true }, "cIpLocalPoolAllocAddr": { "type": "string", "description": "This object specifies the allocated IP address. The address\n type of this object is described by cIpLocalPoolAllocAddrType.", "x-yang-type": "inet-address:InetAddress", "readOnly": true }, "cIpLocalPoolAllocIfIndex": { "type": "string", "description": "This object indicates the interface from which the allocation\n message was sent.\n \n In the case that the interface can not be determined, the value\n of this object will be zero.", "x-yang-type": "if-mib:InterfaceIndexOrZero", "readOnly": true }, "cIpLocalPoolAllocUser": { "type": "string", "description": "This object indicates the user name of the person from whom the\n allocation message was sent.\n \n In the case that the user name can not be determined, the value\n of this object will the null string.", "x-yang-type": "snmp-framework:SnmpAdminString", "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-IP-LOCAL-POOL-MIB", "description": "MIB operations for CISCO-IP-LOCAL-POOL-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }