{ "openapi": "3.0.0", "info": { "title": "ENTITY-MIB MIB API", "version": "1.0.0", "description": "The MIB module for representing multiple logical\n entities supported by a single SNMP agent.\n \n Copyright (C) The Internet Society (2005). This\n version of this MIB module is part of RFC 4133; see\n the RFC itself for full legal notices.\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 ENTITY-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/ENTITY-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "ENTITY-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/ENTITY-MIB:entityGeneral": { "get": { "summary": "Get entityGeneral data", "description": "Retrieve entityGeneral operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The value of sysUpTime at the time a conceptual row is\n created, modified, or deleted in any of these tables:\n - entPhysicalTable\n - entLogicalTable\n - entLPMappingTable\n - entAliasMappingTable\n \n \n - entPhysicalContainsTable", "properties": { "entLastChangeTime": { "type": "string", "description": "The value of sysUpTime at the time a conceptual row is\n created, modified, or deleted in any of these tables:\n - entPhysicalTable\n - entLogicalTable\n - entLPMappingTable\n - entAliasMappingTable\n \n \n - entPhysicalContainsTable", "x-yang-type": "yang:timestamp" } } }, "example": { "ENTITY-MIB:entityGeneral": { "entLastChangeTime": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entityGeneral", "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": "/entityGeneral", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalTable": { "get": { "summary": "Get entPhysicalTable data", "description": "Retrieve entPhysicalTable operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains one row per physical entity. There is\n always at least one row for an 'overall' physical entity.", "properties": { "entPhysicalEntry": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero" }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass" }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647 }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object." }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary" } } } } } }, "example": { "ENTITY-MIB:entPhysicalTable": { "entPhysicalEntry": [ { "entPhysicalIndex": "1", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" }, { "entPhysicalIndex": "2", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" }, { "entPhysicalIndex": "3", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalTable", "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": "/entPhysicalTable", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalTable/entPhysicalEntry": { "get": { "summary": "Get entPhysicalEntry list", "description": "Retrieve list of entPhysicalEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero" }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass" }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647 }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object." }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary" } } } }, "example": { "ENTITY-MIB:entPhysicalEntry": [ { "entPhysicalIndex": "example-string", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalEntry", "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": "/entPhysicalTable/entPhysicalEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalTable/entPhysicalEntry={entPhysicalIndex}": { "get": { "summary": "Get entPhysicalEntry entry", "description": "Retrieve specific entPhysicalEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero" }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass" }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647 }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object." }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary" } } }, "example": { "ENTITY-MIB:entPhysicalEntry": { "entPhysicalIndex": "example-string", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalEntry-2" }, "x-yang-path": "/entPhysicalTable/entPhysicalEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/ENTITY-MIB:entLogicalTable": { "get": { "summary": "Get entLogicalTable data", "description": "Retrieve entLogicalTable operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains one row per logical entity. For agents\n that implement more than one naming scope, at least one\n entry must exist. Agents which instantiate all MIB objects\n within a single naming scope are not required to implement\n this table.", "properties": { "entLogicalEntry": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647 }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary" }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress" }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain" }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone" }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } } } }, "example": { "ENTITY-MIB:entLogicalTable": { "entLogicalEntry": [ { "entLogicalIndex": 1, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" }, { "entLogicalIndex": 2, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" }, { "entLogicalIndex": 3, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLogicalTable", "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": "/entLogicalTable", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entLogicalTable/entLogicalEntry": { "get": { "summary": "Get entLogicalEntry list", "description": "Retrieve list of entLogicalEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647 }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary" }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress" }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain" }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone" }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "ENTITY-MIB:entLogicalEntry": [ { "entLogicalIndex": 1, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLogicalEntry", "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": "/entLogicalTable/entLogicalEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entLogicalTable/entLogicalEntry={entLogicalIndex}": { "get": { "summary": "Get entLogicalEntry entry", "description": "Retrieve specific entLogicalEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entLogicalIndex", "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": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647 }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary" }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress" }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain" }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone" }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "ENTITY-MIB:entLogicalEntry": { "entLogicalIndex": 1, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLogicalEntry-2" }, "x-yang-path": "/entLogicalTable/entLogicalEntry={entLogicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entLogicalIndex" ] }, "/data/ENTITY-MIB:entLPMappingTable": { "get": { "summary": "Get entLPMappingTable data", "description": "Retrieve entLPMappingTable operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "entLPMappingTable", "properties": { "entLPMappingEntry": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref" }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } } } }, "example": { "ENTITY-MIB:entLPMappingTable": { "entLPMappingEntry": [ { "entLogicalIndex": "1", "entLPPhysicalIndex": "1" }, { "entLogicalIndex": "2", "entLPPhysicalIndex": "2" }, { "entLogicalIndex": "3", "entLPPhysicalIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLPMappingTable", "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": "/entLPMappingTable", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entLPMappingTable/entLPMappingEntry": { "get": { "summary": "Get entLPMappingEntry list", "description": "Retrieve list of entLPMappingEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref" }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } }, "example": { "ENTITY-MIB:entLPMappingEntry": [ { "entLogicalIndex": "example-string", "entLPPhysicalIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLPMappingEntry", "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": "/entLPMappingTable/entLPMappingEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entAliasMappingTable": { "get": { "summary": "Get entAliasMappingTable data", "description": "Retrieve entAliasMappingTable operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "This table contains zero or more rows, representing\n mappings of logical entity and physical component to\n external MIB identifiers. Each physical port in the system\n may be associated with a mapping to an external identifier,\n which itself is associated with a particular logical\n entity's naming scope. A 'wildcard' mechanism is provided\n to indicate that an identifier is associated with more than\n one logical entity.", "properties": { "entAliasMappingEntry": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647 }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer" } } } } } }, "example": { "ENTITY-MIB:entAliasMappingTable": { "entAliasMappingEntry": [ { "entPhysicalIndex": "1", "entAliasLogicalIndexOrZero": 1, "entAliasMappingIdentifier": "example-string" }, { "entPhysicalIndex": "2", "entAliasLogicalIndexOrZero": 2, "entAliasMappingIdentifier": "example-string" }, { "entPhysicalIndex": "3", "entAliasLogicalIndexOrZero": 3, "entAliasMappingIdentifier": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entAliasMappingTable", "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": "/entAliasMappingTable", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entAliasMappingTable/entAliasMappingEntry": { "get": { "summary": "Get entAliasMappingEntry list", "description": "Retrieve list of entAliasMappingEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647 }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer" } } } }, "example": { "ENTITY-MIB:entAliasMappingEntry": [ { "entPhysicalIndex": "example-string", "entAliasLogicalIndexOrZero": 1, "entAliasMappingIdentifier": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entAliasMappingEntry", "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": "/entAliasMappingTable/entAliasMappingEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalContainsTable": { "get": { "summary": "Get entPhysicalContainsTable data", "description": "Retrieve entPhysicalContainsTable operational data from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "entPhysicalContainsTable", "properties": { "entPhysicalContainsEntry": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } } } }, "example": { "ENTITY-MIB:entPhysicalContainsTable": { "entPhysicalContainsEntry": [ { "entPhysicalIndex": "1", "entPhysicalChildIndex": "1" }, { "entPhysicalIndex": "2", "entPhysicalChildIndex": "2" }, { "entPhysicalIndex": "3", "entPhysicalChildIndex": "3" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalContainsTable", "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": "/entPhysicalContainsTable", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalContainsTable/entPhysicalContainsEntry": { "get": { "summary": "Get entPhysicalContainsEntry list", "description": "Retrieve list of entPhysicalContainsEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } }, "example": { "ENTITY-MIB:entPhysicalContainsEntry": [ { "entPhysicalIndex": "example-string", "entPhysicalChildIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalContainsEntry", "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": "/entPhysicalContainsTable/entPhysicalContainsEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalEntry": { "get": { "summary": "Get entPhysicalEntry list", "description": "Retrieve list of entPhysicalEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero" }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass" }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647 }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object." }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary" } } } }, "example": { "ENTITY-MIB:entPhysicalEntry": [ { "entPhysicalIndex": "example-string", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalEntry-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": "/entPhysicalEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalEntry={entPhysicalIndex}": { "get": { "summary": "Get entPhysicalEntry entry", "description": "Retrieve specific entPhysicalEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero" }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass" }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647 }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object." }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime" }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary" } } }, "example": { "ENTITY-MIB:entPhysicalEntry": { "entPhysicalIndex": "example-string", "entPhysicalDescr": "GigabitEthernet1/0/1", "entPhysicalVendorType": "ethernetCsmacd(6)", "entPhysicalContainedIn": "example-string", "entPhysicalClass": "example-string", "entPhysicalParentRelPos": -2147483648, "entPhysicalName": "interface-1", "entPhysicalHardwareRev": "example-string", "entPhysicalFirmwareRev": "example-string", "entPhysicalSoftwareRev": "example-string", "entPhysicalSerialNum": "example-string", "entPhysicalMfgName": "interface-1", "entPhysicalModelName": "interface-1", "entPhysicalAlias": "example-string", "entPhysicalAssetID": "example-string", "entPhysicalIsFRU": true, "entPhysicalMfgDate": "example-string", "entPhysicalUris": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalEntry-4" }, "x-yang-path": "/entPhysicalEntry={entPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex" ] }, "/data/ENTITY-MIB:entLogicalEntry": { "get": { "summary": "Get entLogicalEntry list", "description": "Retrieve list of entLogicalEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647 }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary" }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress" }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain" }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone" }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString" } } } }, "example": { "ENTITY-MIB:entLogicalEntry": [ { "entLogicalIndex": 1, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLogicalEntry-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": "/entLogicalEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entLogicalEntry={entLogicalIndex}": { "get": { "summary": "Get entLogicalEntry entry", "description": "Retrieve specific entLogicalEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entLogicalIndex", "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": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647 }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType" }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary" }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress" }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain" }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone" }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString" } } }, "example": { "ENTITY-MIB:entLogicalEntry": { "entLogicalIndex": 1, "entLogicalDescr": "GigabitEthernet1/0/1", "entLogicalType": "ethernetCsmacd(6)", "entLogicalCommunity": "example-string", "entLogicalTAddress": "192.168.1.1", "entLogicalTDomain": "example-string", "entLogicalContextEngineID": "example-string", "entLogicalContextName": "interface-1" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLogicalEntry-4" }, "x-yang-path": "/entLogicalEntry={entLogicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entLogicalIndex" ] }, "/data/ENTITY-MIB:entLPMappingEntry": { "get": { "summary": "Get entLPMappingEntry list", "description": "Retrieve list of entLPMappingEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref" }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } }, "example": { "ENTITY-MIB:entLPMappingEntry": [ { "entLogicalIndex": "example-string", "entLPPhysicalIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLPMappingEntry-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": "/entLPMappingEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entAliasMappingEntry": { "get": { "summary": "Get entAliasMappingEntry list", "description": "Retrieve list of entAliasMappingEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647 }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer" } } } }, "example": { "ENTITY-MIB:entAliasMappingEntry": [ { "entPhysicalIndex": "example-string", "entAliasLogicalIndexOrZero": 1, "entAliasMappingIdentifier": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entAliasMappingEntry-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": "/entAliasMappingEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entPhysicalContainsEntry": { "get": { "summary": "Get entPhysicalContainsEntry list", "description": "Retrieve list of entPhysicalContainsEntry entries from MIB", "tags": [ "ENTITY-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } } }, "example": { "ENTITY-MIB:entPhysicalContainsEntry": [ { "entPhysicalIndex": "example-string", "entPhysicalChildIndex": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalContainsEntry-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": "/entPhysicalContainsEntry", "x-restconf-kind": "container" }, "/data/ENTITY-MIB:entLPMappingTable/entLPMappingEntry={entLogicalIndex},{entLPPhysicalIndex}": { "get": { "summary": "Get entLPMappingEntry entry", "description": "Retrieve specific entLPMappingEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entLogicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entLPPhysicalIndex", "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": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref" }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } }, "example": { "ENTITY-MIB:entLPMappingEntry": { "entLogicalIndex": "example-string", "entLPPhysicalIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLPMappingEntry-2" }, "x-yang-path": "/entLPMappingTable/entLPMappingEntry={entLogicalIndex entLPPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entLogicalIndex entLPPhysicalIndex" ] }, "/data/ENTITY-MIB:entAliasMappingTable/entAliasMappingEntry={entPhysicalIndex},{entAliasLogicalIndexOrZero}": { "get": { "summary": "Get entAliasMappingEntry entry", "description": "Retrieve specific entAliasMappingEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entAliasLogicalIndexOrZero", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647 }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer" } } }, "example": { "ENTITY-MIB:entAliasMappingEntry": { "entPhysicalIndex": "example-string", "entAliasLogicalIndexOrZero": 1, "entAliasMappingIdentifier": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entAliasMappingEntry-2" }, "x-yang-path": "/entAliasMappingTable/entAliasMappingEntry={entPhysicalIndex entAliasLogicalIndexOrZero}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex entAliasLogicalIndexOrZero" ] }, "/data/ENTITY-MIB:entPhysicalContainsTable/entPhysicalContainsEntry={entPhysicalIndex},{entPhysicalChildIndex}": { "get": { "summary": "Get entPhysicalContainsEntry entry", "description": "Retrieve specific entPhysicalContainsEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entPhysicalChildIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } }, "example": { "ENTITY-MIB:entPhysicalContainsEntry": { "entPhysicalIndex": "example-string", "entPhysicalChildIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalContainsEntry-2" }, "x-yang-path": "/entPhysicalContainsTable/entPhysicalContainsEntry={entPhysicalIndex entPhysicalChildIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex entPhysicalChildIndex" ] }, "/data/ENTITY-MIB:entLPMappingEntry={entLogicalIndex},{entLPPhysicalIndex}": { "get": { "summary": "Get entLPMappingEntry entry", "description": "Retrieve specific entLPMappingEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entLogicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entLPPhysicalIndex", "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": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref" }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } }, "example": { "ENTITY-MIB:entLPMappingEntry": { "entLogicalIndex": "example-string", "entLPPhysicalIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entLPMappingEntry-4" }, "x-yang-path": "/entLPMappingEntry={entLogicalIndex entLPPhysicalIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entLogicalIndex entLPPhysicalIndex" ] }, "/data/ENTITY-MIB:entAliasMappingEntry={entPhysicalIndex},{entAliasLogicalIndexOrZero}": { "get": { "summary": "Get entAliasMappingEntry entry", "description": "Retrieve specific entAliasMappingEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entAliasLogicalIndexOrZero", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647 }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer" } } }, "example": { "ENTITY-MIB:entAliasMappingEntry": { "entPhysicalIndex": "example-string", "entAliasLogicalIndexOrZero": 1, "entAliasMappingIdentifier": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entAliasMappingEntry-4" }, "x-yang-path": "/entAliasMappingEntry={entPhysicalIndex entAliasLogicalIndexOrZero}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex entAliasLogicalIndexOrZero" ] }, "/data/ENTITY-MIB:entPhysicalContainsEntry={entPhysicalIndex},{entPhysicalChildIndex}": { "get": { "summary": "Get entPhysicalContainsEntry entry", "description": "Retrieve specific entPhysicalContainsEntry entry by key from MIB", "tags": [ "ENTITY-MIB" ], "parameters": [ { "name": "entPhysicalIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entPhysicalChildIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "required": false, "description": "RESTCONF response media type (RFC 8040)", "schema": { "type": "string", "default": "application/yang-data+json", "enum": [ "application/yang-data+json", "application/yang-data+xml" ] } }, { "name": "depth", "in": "query", "required": false, "description": "Limit the depth of returned sub-tree data (RFC 8040 Section 4.8.2). Use 'unbounded' for full depth.", "schema": { "type": "string", "default": "unbounded" } }, { "name": "fields", "in": "query", "required": false, "description": "Select specific fields to return (RFC 8040 Section 4.8.3). Example: fields=name;status", "schema": { "type": "string" } }, { "name": "content", "in": "query", "required": false, "description": "Filter by config state: 'config' (config true only), 'nonconfig' (config false only), or 'all'.", "schema": { "type": "string", "enum": [ "config", "nonconfig", "all" ], "default": "all" } } ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref" }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex" } } }, "example": { "ENTITY-MIB:entPhysicalContainsEntry": { "entPhysicalIndex": "example-string", "entPhysicalChildIndex": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-entPhysicalContainsEntry-4" }, "x-yang-path": "/entPhysicalContainsEntry={entPhysicalIndex entPhysicalChildIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "entPhysicalIndex entPhysicalChildIndex" ] } }, "components": { "schemas": { "ENTITY-MIB_ENTITY-MIB": { "type": "object", "description": "ENTITY-MIB", "properties": { "entPhysicalEntry": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero", "readOnly": true }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass", "readOnly": true }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object.", "readOnly": true }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "entLogicalEntry": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary", "readOnly": true }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone", "readOnly": true }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true }, "entLPMappingEntry": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true } } }, "readOnly": true }, "entAliasMappingEntry": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true } } }, "readOnly": true }, "entPhysicalContainsEntry": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true } } }, "readOnly": true }, "entityGeneral": { "type": "object", "description": "The value of sysUpTime at the time a conceptual row is\n created, modified, or deleted in any of these tables:\n - entPhysicalTable\n - entLogicalTable\n - entLPMappingTable\n - entAliasMappingTable\n \n \n - entPhysicalContainsTable", "properties": { "entLastChangeTime": { "type": "string", "description": "The value of sysUpTime at the time a conceptual row is\n created, modified, or deleted in any of these tables:\n - entPhysicalTable\n - entLogicalTable\n - entLPMappingTable\n - entAliasMappingTable\n \n \n - entPhysicalContainsTable", "x-yang-type": "yang:timestamp", "readOnly": true } }, "readOnly": true }, "entPhysicalTable": { "type": "object", "description": "This table contains one row per physical entity. There is\n always at least one row for an 'overall' physical entity.", "properties": { "entPhysicalEntry": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero", "readOnly": true }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass", "readOnly": true }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object.", "readOnly": true }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "entLogicalTable": { "type": "object", "description": "This table contains one row per logical entity. For agents\n that implement more than one naming scope, at least one\n entry must exist. Agents which instantiate all MIB objects\n within a single naming scope are not required to implement\n this table.", "properties": { "entLogicalEntry": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary", "readOnly": true }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone", "readOnly": true }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "entLPMappingTable": { "type": "object", "description": "entLPMappingTable", "properties": { "entLPMappingEntry": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "entAliasMappingTable": { "type": "object", "description": "This table contains zero or more rows, representing\n mappings of logical entity and physical component to\n external MIB identifiers. Each physical port in the system\n may be associated with a mapping to an external identifier,\n which itself is associated with a particular logical\n entity's naming scope. A 'wildcard' mechanism is provided\n to indicate that an identifier is associated with more than\n one logical entity.", "properties": { "entAliasMappingEntry": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "entPhysicalContainsTable": { "type": "object", "description": "entPhysicalContainsTable", "properties": { "entPhysicalContainsEntry": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "ENTITY-MIB_entPhysicalEntry": { "type": "array", "description": "Information about a particular physical entity.\n \n Each entry provides objects (entPhysicalDescr,\n entPhysicalVendorType, and entPhysicalClass) to help an NMS\n identify and characterize the entry, and objects\n (entPhysicalContainedIn and entPhysicalParentRelPos) to help\n an NMS relate the particular entry to other entries in this\n table.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "The index for this entry.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true }, "entPhysicalDescr": { "type": "string", "description": "A textual description of physical entity. This object\n should contain a string that identifies the manufacturer's\n name for the physical entity, and should be set to a\n distinct value for each version or model of the physical\n entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalVendorType": { "type": "string", "description": "An indication of the vendor-specific hardware type of the\n physical entity. Note that this is different from the\n definition of MIB-II's sysObjectID.\n \n An agent should set this object to an enterprise-specific\n registration identifier value indicating the specific\n equipment type in detail. The associated instance of\n entPhysicalClass is used to indicate the general type of\n hardware device.\n \n If no vendor-specific registration identifier exists for\n this physical entity, or the value is unknown by this agent,\n then the value { 0 0 } is returned.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entPhysicalContainedIn": { "type": "string", "description": "The value of entPhysicalIndex for the physical entity which\n 'contains' this physical entity. A value of zero indicates\n this physical entity is not contained in any other physical\n entity. Note that the set of 'containment' relationships\n define a strict hierarchy; that is, recursion is not\n allowed.\n \n In the event that a physical entity is contained by more\n than one physical entity (e.g., double-wide modules), this\n object should identify the containing entity with the lowest\n value of entPhysicalIndex.", "x-yang-type": "ENTITY-MIB:PhysicalIndexOrZero", "readOnly": true }, "entPhysicalClass": { "type": "string", "description": "An indication of the general hardware type of the physical\n entity.\n \n An agent should set this object to the standard enumeration\n value that most accurately indicates the general class of\n the physical entity, or the primary class if there is more\n than one entity.\n \n If no appropriate standard registration identifier exists\n for this physical entity, then the value 'other(1)' is\n returned. If the value is unknown by this agent, then the\n value 'unknown(2)' is returned.", "x-yang-type": "ENTITY-MIB:PhysicalClass", "readOnly": true }, "entPhysicalParentRelPos": { "type": "integer", "description": "An indication of the relative position of this 'child'\n component among all its 'sibling' components. Sibling\n components are defined as entPhysicalEntries that share the\n same instance values of each of the entPhysicalContainedIn\n and entPhysicalClass objects.\n \n An NMS can use this object to identify the relative ordering\n for all sibling components of a particular parent\n (identified by the entPhysicalContainedIn instance in each\n sibling entry).\n \n If possible, this value should match any external labeling\n of the physical component. For example, for a container\n (e.g., card slot) labeled as 'slot #3',\n entPhysicalParentRelPos should have the value '3'. Note\n that the entPhysicalEntry for the module plugged in slot 3\n should have an entPhysicalParentRelPos value of '1'.\n \n If the physical position of this component does not match\n any external numbering or clearly visible ordering, then\n user documentation or other external reference material\n should be used to determine the parent-relative position.\n If this is not possible, then the agent should assign a\n consistent (but possibly arbitrary) ordering to a given set\n of 'sibling' components, perhaps based on internal\n representation of the components.\n \n \n If the agent cannot determine the parent-relative position\n for some reason, or if the associated value of\n entPhysicalContainedIn is '0', then the value '-1' is\n returned. Otherwise, a non-negative integer is returned,\n indicating the parent-relative position of this physical\n entity.\n \n Parent-relative ordering normally starts from '1' and\n continues to 'N', where 'N' represents the highest\n positioned child entity. However, if the physical entities\n (e.g., slots) are labeled from a starting position of zero,\n then the first sibling should be associated with an\n entPhysicalParentRelPos value of '0'. Note that this\n ordering may be sparse or dense, depending on agent\n implementation.\n \n The actual values returned are not globally meaningful, as\n each 'parent' component may use different numbering\n algorithms. The ordering is only meaningful among siblings\n of the same parent component.\n \n The agent should retain parent-relative position values\n across reboots, either through algorithmic assignment or use\n of non-volatile storage.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entPhysicalName": { "type": "string", "description": "The textual name of the physical entity. The value of this\n object should be the name of the component as assigned by\n the local device and should be suitable for use in commands\n entered at the device's `console'. This might be a text\n name (e.g., `console') or a simple component number (e.g.,\n port or module number, such as `1'), depending on the\n physical component naming syntax of the device.\n \n If there is no local name, or if this object is otherwise\n not applicable, then this object contains a zero-length\n string.\n \n Note that the value of entPhysicalName for two physical\n entities will be the same in the event that the console\n interface does not distinguish between them, e.g., slot-1\n and the card in slot-1.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalHardwareRev": { "type": "string", "description": "The vendor-specific hardware revision string for the\n physical entity. The preferred value is the hardware\n revision identifier actually printed on the component itself\n (if present).\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific hardware revision string is associated with\n the physical component, or if this information is unknown to\n the agent, then this object will contain a zero-length\n string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalFirmwareRev": { "type": "string", "description": "The vendor-specific firmware revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific firmware programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSoftwareRev": { "type": "string", "description": "The vendor-specific software revision string for the\n physical entity.\n \n Note that if revision information is stored internally in a\n \n \n non-printable (e.g., binary) format, then the agent must\n convert such information to a printable format, in an\n implementation-specific manner.\n \n If no specific software programs are associated with the\n physical component, or if this information is unknown to the\n agent, then this object will contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalSerialNum": { "type": "string", "description": "The vendor-specific serial number string for the physical\n entity. The preferred value is the serial number string\n actually printed on the component itself (if present).\n \n On the first instantiation of an physical entity, the value\n of entPhysicalSerialNum associated with that entity is set\n to the correct vendor-assigned serial number, if this\n information is available to the agent. If a serial number\n is unknown or non-existent, the entPhysicalSerialNum will be\n set to a zero-length string instead.\n \n Note that implementations that can correctly identify the\n serial numbers of all installed physical entities do not\n need to provide write access to the entPhysicalSerialNum\n object. Agents which cannot provide non-volatile storage\n for the entPhysicalSerialNum strings are not required to\n implement write access for this object.\n \n Not every physical component will have a serial number, or\n even need one. Physical entities for which the associated\n value of the entPhysicalIsFRU object is equal to 'false(2)'\n (e.g., the repeater ports within a repeater module), do not\n need their own unique serial number. An agent does not have\n to provide write access for such entities, and may return a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalSerialNum, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalSerialNum instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n \n \n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalMfgName": { "type": "string", "description": "The name of the manufacturer of this physical component.\n The preferred value is the manufacturer name string actually\n printed on the component itself (if present).\n \n Note that comparisons between instances of the\n entPhysicalModelName, entPhysicalFirmwareRev,\n entPhysicalSoftwareRev, and the entPhysicalSerialNum\n objects, are only meaningful amongst entPhysicalEntries with\n the same value of entPhysicalMfgName.\n \n If the manufacturer name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalModelName": { "type": "string", "description": "The vendor-specific model name identifier string associated\n with this physical component. The preferred value is the\n customer-visible part number, which may be printed on the\n component itself.\n \n If the model name string associated with the physical\n component is unknown to the agent, then this object will\n contain a zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAlias": { "type": "string", "description": "This object is an 'alias' name for the physical entity, as\n specified by a network manager, and provides a non-volatile\n 'handle' for the physical entity.\n \n On the first instantiation of a physical entity, the value\n \n \n of entPhysicalAlias associated with that entity is set to\n the zero-length string. However, the agent may set the\n value to a locally unique default value, instead of a\n zero-length string.\n \n If write access is implemented for an instance of\n entPhysicalAlias, and a value is written into the instance,\n the agent must retain the supplied value in the\n entPhysicalAlias instance (associated with the same physical\n entity) for as long as that entity remains instantiated.\n This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalAssetID": { "type": "string", "description": "This object is a user-assigned asset tracking identifier\n (as specified by a network manager) for the physical entity,\n and provides non-volatile storage of this information.\n \n On the first instantiation of a physical entity, the value\n of entPhysicalAssetID associated with that entity is set to\n the zero-length string.\n \n Not every physical component will have an asset tracking\n identifier, or even need one. Physical entities for which\n the associated value of the entPhysicalIsFRU object is equal\n to 'false(2)' (e.g., the repeater ports within a repeater\n module), do not need their own unique asset tracking\n identifier. An agent does not have to provide write access\n for such entities, and may instead return a zero-length\n string.\n \n If write access is implemented for an instance of\n entPhysicalAssetID, and a value is written into the\n instance, the agent must retain the supplied value in the\n entPhysicalAssetID instance (associated with the same\n physical entity) for as long as that entity remains\n instantiated. This includes instantiations across all\n re-initializations/reboots of the network management system,\n including those resulting in a change of the physical\n entity's entPhysicalIndex value.\n \n \n If no asset tracking information is associated with the\n physical component, then this object will contain a\n zero-length string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entPhysicalIsFRU": { "type": "boolean", "description": "This object indicates whether or not this physical entity\n is considered a 'field replaceable unit' by the vendor. If\n this object contains the value 'true(1)' then this\n entPhysicalEntry identifies a field replaceable unit. For\n all entPhysicalEntries that represent components\n permanently contained within a field replaceable unit, the\n value 'false(2)' should be returned for this object.", "readOnly": true }, "entPhysicalMfgDate": { "type": "string", "description": "This object contains the date of manufacturing of the\n managed entity. If the manufacturing date is unknown or not\n supported, the object is not instantiated. The special\n value '0000000000000000'H may also be returned in this\n case.", "x-yang-type": "snmpv2-tc:DateAndTime", "readOnly": true }, "entPhysicalUris": { "type": "string", "description": "This object contains additional identification information\n about the physical entity. The object contains URIs and,\n therefore, the syntax of this object must conform to RFC\n 3986, section 2.\n \n Multiple URIs may be present and are separated by white\n space characters. Leading and trailing white space\n characters are ignored.\n \n If no additional identification information is known\n about the physical entity or supported, the object is not\n instantiated. A zero length octet string may also be\n \n \n returned in this case.", "format": "binary", "readOnly": true } } } }, "ENTITY-MIB_entLogicalEntry": { "type": "array", "description": "Information about a particular logical entity. Entities\n may be managed by this agent or other SNMP agents (possibly)\n in the same chassis.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "integer", "description": "The value of this object uniquely identifies the logical\n entity. The value should be a small positive integer; index\n values for different logical entities are not necessarily\n contiguous.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entLogicalDescr": { "type": "string", "description": "A textual description of the logical entity. This object\n should contain a string that identifies the manufacturer's\n name for the logical entity, and should be set to a distinct\n value for each version of the logical entity.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "entLogicalType": { "type": "string", "description": "An indication of the type of logical entity. This will\n typically be the OBJECT IDENTIFIER name of the node in the\n SMI's naming hierarchy which represents the major MIB\n module, or the majority of the MIB modules, supported by the\n logical entity. For example:\n a logical entity of a regular host/router -> mib-2\n a logical entity of a 802.1d bridge -> dot1dBridge\n a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt\n If an appropriate node in the SMI's naming hierarchy cannot\n be identified, the value 'mib-2' should be used.", "x-yang-type": "snmpv2-tc:AutonomousType", "readOnly": true }, "entLogicalCommunity": { "type": "string", "description": "An SNMPv1 or SNMPv2C community-string, which can be used to\n access detailed management information for this logical\n entity. The agent should allow read access with this\n community string (to an appropriate subset of all managed\n objects) and may also return a community string based on the\n privileges of the request used to read this object. Note\n that an agent may return a community string with read-only\n privileges, even if this object is accessed with a\n read-write community string. However, the agent must take\n \n \n care not to return a community string that allows more\n privileges than the community string used to access this\n object.\n \n A compliant SNMP agent may wish to conserve naming scopes by\n representing multiple logical entities in a single 'default'\n naming scope. This is possible when the logical entities,\n represented by the same value of entLogicalCommunity, have\n no object instances in common. For example, 'bridge1' and\n 'repeater1' may be part of the main naming scope, but at\n least one additional community string is needed to represent\n 'bridge2' and 'repeater2'.\n \n Logical entities 'bridge1' and 'repeater1' would be\n represented by sysOREntries associated with the 'default'\n naming scope.\n \n For agents not accessible via SNMPv1 or SNMPv2C, the value\n of this object is the empty string. This object may also\n contain an empty string if a community string has not yet\n been assigned by the agent, or if no community string with\n suitable access rights can be returned for a particular SNMP\n request.\n \n Note that this object is deprecated. Agents which implement\n SNMPv3 access should use the entLogicalContextEngineID and\n entLogicalContextName objects to identify the context\n associated with each logical entity. SNMPv3 agents may\n return a zero-length string for this object, or may continue\n to return a community string (e.g., tri-lingual agent\n support).", "format": "binary", "readOnly": true }, "entLogicalTAddress": { "type": "string", "description": "The transport service address by which the logical entity\n receives network management traffic, formatted according to\n the corresponding value of entLogicalTDomain.\n \n For snmpUDPDomain, a TAddress is 6 octets long: the initial\n 4 octets contain the IP-address in network-byte order and\n the last 2 contain the UDP port in network-byte order.\n Consult 'Transport Mappings for the Simple Network\n Management Protocol' (STD 62, RFC 3417 [RFC3417]) for\n further information on snmpUDPDomain.", "x-yang-type": "snmpv2-tc:TAddress", "readOnly": true }, "entLogicalTDomain": { "type": "string", "description": "Indicates the kind of transport service by which the\n logical entity receives network management traffic.\n Possible values for this object are presently found in the\n Transport Mappings for Simple Network Management Protocol'\n (STD 62, RFC 3417 [RFC3417]).", "x-yang-type": "snmpv2-tc:TDomain", "readOnly": true }, "entLogicalContextEngineID": { "type": "string", "description": "The authoritative contextEngineID that can be used to send\n an SNMP message concerning information held by this logical\n entity, to the address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextName object, defines the context associated\n with a particular logical entity, and allows access to SNMP\n engines identified by a contextEngineId and contextName\n pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "ENTITY-MIB:SnmpEngineIdOrNone", "readOnly": true }, "entLogicalContextName": { "type": "string", "description": "The contextName that can be used to send an SNMP message\n concerning information held by this logical entity, to the\n address specified by the associated\n 'entLogicalTAddress/entLogicalTDomain' pair.\n \n This object, together with the associated\n entLogicalContextEngineID object, defines the context\n associated with a particular logical entity, and allows\n \n \n access to SNMP engines identified by a contextEngineId and\n contextName pair.\n \n If no value has been configured by the agent, a zero-length\n string is returned, or the agent may choose not to\n instantiate this object at all.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true } } } }, "ENTITY-MIB_entLPMappingEntry": { "type": "array", "description": "Information about a particular logical entity to physical\n equipment association. Note that the nature of the\n association is not specifically identified in this entry.\n It is expected that sufficient information exists in the\n MIBs used to manage a particular logical entity to infer how\n physical component information is utilized.", "items": { "type": "object", "properties": { "entLogicalIndex": { "type": "string", "description": "entLogicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entLPPhysicalIndex": { "type": "string", "description": "The value of this object identifies the index value of a\n particular entPhysicalEntry associated with the indicated\n entLogicalEntity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "readOnly": true } } } }, "ENTITY-MIB_entAliasMappingEntry": { "type": "array", "description": "entAliasMappingEntry", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entAliasLogicalIndexOrZero": { "type": "integer", "description": "The value of this object identifies the logical entity\n that defines the naming scope for the associated instance\n of the 'entAliasMappingIdentifier' object.\n \n If this object has a non-zero value, then it identifies the\n logical entity named by the same value of entLogicalIndex.\n \n If this object has a value of zero, then the mapping between\n the physical component and the alias identifier for this\n entAliasMapping entry is associated with all unspecified\n logical entities. That is, a value of zero (the default\n mapping) identifies any logical entity that does not have\n an explicit entry in this table for a particular\n entPhysicalIndex/entAliasMappingIdentifier pair.\n \n For example, to indicate that a particular interface (e.g.,\n physical component 33) is identified by the same value of\n ifIndex for all logical entities, the following instance\n might exist:\n \n entAliasMappingIdentifier.33.0 = ifIndex.5\n \n In the event an entPhysicalEntry is associated differently\n for some logical entities, additional entAliasMapping\n entries may exist, e.g.:\n \n \n entAliasMappingIdentifier.33.0 = ifIndex.6\n entAliasMappingIdentifier.33.4 = ifIndex.1\n entAliasMappingIdentifier.33.5 = ifIndex.1\n entAliasMappingIdentifier.33.10 = ifIndex.12\n \n Note that entries with non-zero entAliasLogicalIndexOrZero\n index values have precedence over zero-indexed entries. In\n this example, all logical entities except 4, 5, and 10,\n associate physical entity 33 with ifIndex.6.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "entAliasMappingIdentifier": { "type": "string", "description": "The value of this object identifies a particular conceptual\n row associated with the indicated entPhysicalIndex and\n entLogicalIndex pair.\n \n Because only physical ports are modeled in this table, only\n entries that represent interfaces or ports are allowed. If\n an ifEntry exists on behalf of a particular physical port,\n then this object should identify the associated 'ifEntry'.\n For repeater ports, the appropriate row in the\n 'rptrPortGroupTable' should be identified instead.\n \n For example, suppose a physical port was represented by\n entPhysicalEntry.3, entLogicalEntry.15 existed for a\n repeater, and entLogicalEntry.22 existed for a bridge. Then\n there might be two related instances of\n entAliasMappingIdentifier:\n entAliasMappingIdentifier.3.15 == rptrPortGroupIndex.5.2\n entAliasMappingIdentifier.3.22 == ifIndex.17\n It is possible that other mappings (besides interfaces and\n repeater ports) may be defined in the future, as required.\n \n Bridge ports are identified by examining the Bridge MIB and\n appropriate ifEntries associated with each 'dot1dBasePort',\n and are thus not represented in this table.", "x-yang-type": "snmpv2-tc:RowPointer", "readOnly": true } } } }, "ENTITY-MIB_entPhysicalContainsEntry": { "type": "array", "description": "A single container/'containee' relationship.", "items": { "type": "object", "properties": { "entPhysicalIndex": { "type": "string", "description": "entPhysicalIndex", "x-yang-type": "leafref", "readOnly": true }, "entPhysicalChildIndex": { "type": "string", "description": "The value of entPhysicalIndex for the contained physical\n entity.", "x-yang-type": "ENTITY-MIB:PhysicalIndex", "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": "ENTITY-MIB", "description": "MIB operations for ENTITY-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }