{ "openapi": "3.0.0", "info": { "title": "POWER-ETHERNET-MIB MIB API", "version": "1.0.0", "description": "The MIB module for managing Power Source Equipment\n (PSE) working according to the IEEE 802.af Powered\n Ethernet (DTE Power via MDI) standard.\n \n The following terms are used throughout this\n MIB module. For complete formal definitions,\n the IEEE 802.3 standards should be consulted\n wherever possible:\n \n Group - A recommended, but optional, entity\n defined by the IEEE 802.3 management standard,\n in order to support a modular numbering scheme.\n The classical example allows an implementor to\n represent field-replaceable units as groups of\n ports, with the port numbering matching the\n modular hardware implementation.\n \n Port - This entity identifies the port within the group\n for which this entry contains information. The numbering\n scheme for ports is implementation specific.\n \n Copyright (c) The Internet Society (2003). This version\n of this MIB module is part of RFC 3621; See the RFC\n 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 POWER-ETHERNET-MIB structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/POWER-ETHERNET-MIB.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "POWER-ETHERNET-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/POWER-ETHERNET-MIB:pethPsePortTable": { "get": { "summary": "Get pethPsePortTable data", "description": "Retrieve pethPsePortTable operational data from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of objects that display and control the power\n characteristics of power Ethernet ports on a Power Source\n Entity (PSE) device. This group will be implemented in\n managed power Ethernet switches and mid-span devices.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethPsePortEntry": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function." }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute." }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use." }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above." }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority." }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower." }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "POWER-ETHERNET-MIB:pethPsePortTable": { "pethPsePortEntry": [ { "pethPsePortGroupIndex": 1, "pethPsePortIndex": 1, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 }, { "pethPsePortGroupIndex": 2, "pethPsePortIndex": 2, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 }, { "pethPsePortGroupIndex": 3, "pethPsePortIndex": 3, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethPsePortTable", "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": "/pethPsePortTable", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethPsePortTable/pethPsePortEntry": { "get": { "summary": "Get pethPsePortEntry list", "description": "Retrieve list of pethPsePortEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function." }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute." }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use." }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above." }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority." }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower." }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "POWER-ETHERNET-MIB:pethPsePortEntry": [ { "pethPsePortGroupIndex": 1, "pethPsePortIndex": 1, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethPsePortEntry", "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": "/pethPsePortTable/pethPsePortEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethMainPseTable": { "get": { "summary": "Get pethMainPseTable data", "description": "Retrieve pethMainPseTable operational data from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of objects that display and control attributes\n of the main power source in a PSE device. Ethernet\n switches are one example of boxes that would support\n these objects.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethMainPseEntry": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE." }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647 } } } } } }, "example": { "POWER-ETHERNET-MIB:pethMainPseTable": { "pethMainPseEntry": [ { "pethMainPseGroupIndex": 1, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 }, { "pethMainPseGroupIndex": 2, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 }, { "pethMainPseGroupIndex": 3, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethMainPseTable", "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": "/pethMainPseTable", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethMainPseTable/pethMainPseEntry": { "get": { "summary": "Get pethMainPseEntry list", "description": "Retrieve list of pethMainPseEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE." }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "POWER-ETHERNET-MIB:pethMainPseEntry": [ { "pethMainPseGroupIndex": 1, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethMainPseEntry", "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": "/pethMainPseTable/pethMainPseEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethMainPseTable/pethMainPseEntry={pethMainPseGroupIndex}": { "get": { "summary": "Get pethMainPseEntry entry", "description": "Retrieve specific pethMainPseEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethMainPseGroupIndex", "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": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE." }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "POWER-ETHERNET-MIB:pethMainPseEntry": { "pethMainPseGroupIndex": 1, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethMainPseEntry-2" }, "x-yang-path": "/pethMainPseTable/pethMainPseEntry={pethMainPseGroupIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethMainPseGroupIndex" ] }, "/data/POWER-ETHERNET-MIB:pethNotificationControlTable": { "get": { "summary": "Get pethNotificationControlTable data", "description": "Retrieve pethNotificationControlTable operational data from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "A table of objects that display and control the\n Notification on a PSE device.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethNotificationControlEntry": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not." } } } } } }, "example": { "POWER-ETHERNET-MIB:pethNotificationControlTable": { "pethNotificationControlEntry": [ { "pethNotificationControlGroupIndex": 1, "pethNotificationControlEnable": true }, { "pethNotificationControlGroupIndex": 2, "pethNotificationControlEnable": true }, { "pethNotificationControlGroupIndex": 3, "pethNotificationControlEnable": true } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethNotificationControlTable", "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": "/pethNotificationControlTable", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethNotificationControlTable/pethNotificationControlEntry": { "get": { "summary": "Get pethNotificationControlEntry list", "description": "Retrieve list of pethNotificationControlEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not." } } } }, "example": { "POWER-ETHERNET-MIB:pethNotificationControlEntry": [ { "pethNotificationControlGroupIndex": 1, "pethNotificationControlEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethNotificationControlEntry", "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": "/pethNotificationControlTable/pethNotificationControlEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethNotificationControlTable/pethNotificationControlEntry={pethNotificationControlGroupIndex}": { "get": { "summary": "Get pethNotificationControlEntry entry", "description": "Retrieve specific pethNotificationControlEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethNotificationControlGroupIndex", "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": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not." } } }, "example": { "POWER-ETHERNET-MIB:pethNotificationControlEntry": { "pethNotificationControlGroupIndex": 1, "pethNotificationControlEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethNotificationControlEntry-2" }, "x-yang-path": "/pethNotificationControlTable/pethNotificationControlEntry={pethNotificationControlGroupIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethNotificationControlGroupIndex" ] }, "/data/POWER-ETHERNET-MIB:pethPsePortEntry": { "get": { "summary": "Get pethPsePortEntry list", "description": "Retrieve list of pethPsePortEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function." }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute." }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use." }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above." }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority." }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower." }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "POWER-ETHERNET-MIB:pethPsePortEntry": [ { "pethPsePortGroupIndex": 1, "pethPsePortIndex": 1, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethPsePortEntry-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": "/pethPsePortEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethMainPseEntry": { "get": { "summary": "Get pethMainPseEntry list", "description": "Retrieve list of pethMainPseEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE." }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647 } } } }, "example": { "POWER-ETHERNET-MIB:pethMainPseEntry": [ { "pethMainPseGroupIndex": 1, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethMainPseEntry-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": "/pethMainPseEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethMainPseEntry={pethMainPseGroupIndex}": { "get": { "summary": "Get pethMainPseEntry entry", "description": "Retrieve specific pethMainPseEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethMainPseGroupIndex", "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": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE." }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295 }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647 } } }, "example": { "POWER-ETHERNET-MIB:pethMainPseEntry": { "pethMainPseGroupIndex": 1, "pethMainPsePower": 0, "pethMainPseOperStatus": "up(1)", "pethMainPseConsumptionPower": 0, "pethMainPseUsageThreshold": -2147483648 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethMainPseEntry-4" }, "x-yang-path": "/pethMainPseEntry={pethMainPseGroupIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethMainPseGroupIndex" ] }, "/data/POWER-ETHERNET-MIB:pethNotificationControlEntry": { "get": { "summary": "Get pethNotificationControlEntry list", "description": "Retrieve list of pethNotificationControlEntry entries from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not." } } } }, "example": { "POWER-ETHERNET-MIB:pethNotificationControlEntry": [ { "pethNotificationControlGroupIndex": 1, "pethNotificationControlEnable": true } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethNotificationControlEntry-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": "/pethNotificationControlEntry", "x-restconf-kind": "container" }, "/data/POWER-ETHERNET-MIB:pethNotificationControlEntry={pethNotificationControlGroupIndex}": { "get": { "summary": "Get pethNotificationControlEntry entry", "description": "Retrieve specific pethNotificationControlEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethNotificationControlGroupIndex", "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": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not." } } }, "example": { "POWER-ETHERNET-MIB:pethNotificationControlEntry": { "pethNotificationControlGroupIndex": 1, "pethNotificationControlEnable": true } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethNotificationControlEntry-4" }, "x-yang-path": "/pethNotificationControlEntry={pethNotificationControlGroupIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethNotificationControlGroupIndex" ] }, "/data/POWER-ETHERNET-MIB:pethPsePortTable/pethPsePortEntry={pethPsePortGroupIndex},{pethPsePortIndex}": { "get": { "summary": "Get pethPsePortEntry entry", "description": "Retrieve specific pethPsePortEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethPsePortGroupIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pethPsePortIndex", "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": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function." }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute." }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use." }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above." }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority." }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower." }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "POWER-ETHERNET-MIB:pethPsePortEntry": { "pethPsePortGroupIndex": 1, "pethPsePortIndex": 1, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethPsePortEntry-2" }, "x-yang-path": "/pethPsePortTable/pethPsePortEntry={pethPsePortGroupIndex pethPsePortIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethPsePortGroupIndex pethPsePortIndex" ] }, "/data/POWER-ETHERNET-MIB:pethPsePortEntry={pethPsePortGroupIndex},{pethPsePortIndex}": { "get": { "summary": "Get pethPsePortEntry entry", "description": "Retrieve specific pethPsePortEntry entry by key from MIB", "tags": [ "POWER-ETHERNET-MIB" ], "parameters": [ { "name": "pethPsePortGroupIndex", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pethPsePortIndex", "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": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647 }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function." }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute." }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use." }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above." }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority." }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString" }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower." }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295 }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "POWER-ETHERNET-MIB:pethPsePortEntry": { "pethPsePortGroupIndex": 1, "pethPsePortIndex": 1, "pethPsePortAdminEnable": true, "pethPsePortPowerPairsControlAbility": true, "pethPsePortPowerPairs": "example-string", "pethPsePortDetectionStatus": "up(1)", "pethPsePortPowerPriority": "example-string", "pethPsePortMPSAbsentCounter": 1234567890, "pethPsePortType": "ethernetCsmacd(6)", "pethPsePortPowerClassifications": "example-string", "pethPsePortInvalidSignatureCounter": 1234567890, "pethPsePortPowerDeniedCounter": 1234567890, "pethPsePortOverLoadCounter": 1234567890, "pethPsePortShortCounter": 1234567890 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-pethPsePortEntry-4" }, "x-yang-path": "/pethPsePortEntry={pethPsePortGroupIndex pethPsePortIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "pethPsePortGroupIndex pethPsePortIndex" ] } }, "components": { "schemas": { "POWER-ETHERNET-MIB_POWER-ETHERNET-MIB": { "type": "object", "description": "A table of objects that display and control the power\n characteristics of power Ethernet ports on a Power Source\n Entity (PSE) device. This group will be implemented in\n managed power Ethernet switches and mid-span devices.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethPsePortEntry": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function.", "readOnly": true }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute.", "readOnly": true }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use.", "readOnly": true }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above.", "readOnly": true }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority.", "readOnly": true }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower.", "readOnly": true }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "pethMainPseEntry": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE.", "readOnly": true }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true }, "pethNotificationControlEntry": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not.", "readOnly": true } } }, "readOnly": true }, "pethPsePortTable": { "type": "object", "description": "A table of objects that display and control the power\n characteristics of power Ethernet ports on a Power Source\n Entity (PSE) device. This group will be implemented in\n managed power Ethernet switches and mid-span devices.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethPsePortEntry": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function.", "readOnly": true }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute.", "readOnly": true }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use.", "readOnly": true }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above.", "readOnly": true }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority.", "readOnly": true }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower.", "readOnly": true }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pethMainPseTable": { "type": "object", "description": "A table of objects that display and control attributes\n of the main power source in a PSE device. Ethernet\n switches are one example of boxes that would support\n these objects.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethMainPseEntry": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE.", "readOnly": true }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "pethNotificationControlTable": { "type": "object", "description": "A table of objects that display and control the\n Notification on a PSE device.\n Values of all read-write objects in this table are\n persistent at restart/reboot.", "properties": { "pethNotificationControlEntry": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "POWER-ETHERNET-MIB_object-1": { "type": "object", "description": "object-1", "properties": { "pethMainPseGroupIndex": { "type": "string", "description": "pethMainPseGroupIndex", "x-yang-type": "leafref", "readOnly": true }, "pethMainPseConsumptionPower": { "type": "string", "description": "pethMainPseConsumptionPower", "x-yang-type": "leafref", "readOnly": true } } }, "POWER-ETHERNET-MIB_pethPsePortEntry": { "type": "array", "description": "A set of objects that display and control the power\n characteristics of a power Ethernet PSE port.", "items": { "type": "object", "properties": { "pethPsePortGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group\n containing the port to which a power Ethernet PSE is\n connected. Group means box in the stack, module in a\n rack and the value 1 MUST be used for non-modular devices.\n Furthermore, the same value MUST be used in this variable,\n pethMainPseGroupIndex, and pethNotificationControlGroupIndex\n to refer to a given box in a stack or module in the rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortIndex": { "type": "integer", "description": "This variable uniquely identifies the power Ethernet PSE\n port within group pethPsePortGroupIndex to which the\n power Ethernet PSE entry is connected.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethPsePortAdminEnable": { "type": "boolean", "description": "true (1) An interface which can provide the PSE functions.\n false(2) The interface will act as it would if it had no PSE\n function.", "readOnly": true }, "pethPsePortPowerPairsControlAbility": { "type": "boolean", "description": "Describes the capability of controlling the power pairs\n functionality to switch pins for sourcing power.\n The value true indicate that the device has the capability\n to control the power pairs. When false the PSE Pinout\n Alternative used cannot be controlled through the\n PethPsePortAdminEnable attribute.", "readOnly": true }, "pethPsePortPowerPairs": { "type": "string", "description": "Describes or controls the pairs in use. If the value of\n pethPsePortPowerPairsControl is true, this object is\n writable.\n A value of signal(1) means that the signal pairs\n only are in use.\n A value of spare(2) means that the spare pairs\n only are in use.", "readOnly": true }, "pethPsePortDetectionStatus": { "type": "string", "description": "Describes the operational status of the port PD detection.\n A value of disabled(1)- indicates that the PSE State diagram\n is in the state DISABLED.\n A value of deliveringPower(3) - indicates that the PSE State\n diagram is in the state POWER_ON for a duration greater than\n tlim max (see IEEE Std 802.3af Table 33-5 tlim).\n A value of fault(4) - indicates that the PSE State diagram is\n in the state TEST_ERROR.\n A value of test(5) - indicates that the PSE State diagram is\n in the state TEST_MODE.\n A value of otherFault(6) - indicates that the PSE State\n diagram is in the state IDLE due to the variable\n error_conditions.\n A value of searching(2)- indicates the PSE State diagram is\n in a state other than those listed above.", "readOnly": true }, "pethPsePortPowerPriority": { "type": "string", "description": "This object controls the priority of the port from the point\n of view of a power management algorithm. The priority that\n is set by this variable could be used by a control mechanism\n that prevents over current situations by disconnecting first\n ports with lower power priority. Ports that connect devices\n critical to the operation of the network - like the E911\n telephones ports - should be set to higher priority.", "readOnly": true }, "pethPsePortMPSAbsentCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n transitions directly from the state POWER_ON to the\n state IDLE due to tmpdo_timer_done being asserted.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortType": { "type": "string", "description": "A manager will set the value of this variable to indicate\n the type of powered device that is connected to the port.\n The default value supplied by the agent if no value has\n ever been set should be a zero-length octet string.", "x-yang-type": "snmp-framework:SnmpAdminString", "readOnly": true }, "pethPsePortPowerClassifications": { "type": "string", "description": "Classification is a way to tag different terminals on the\n Power over LAN network according to their power consumption.\n Devices such as IP telephones, WLAN access points and others,\n will be classified according to their power requirements.\n \n The meaning of the classification labels is defined in the\n IEEE specification.\n \n This variable is valid only while a PD is being powered,\n that is, while the attribute pethPsePortDetectionStatus\n is reporting the enumeration deliveringPower.", "readOnly": true }, "pethPsePortInvalidSignatureCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state SIGNATURE_INVALID.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortPowerDeniedCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state POWER_DENIED.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortOverLoadCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_OVER.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethPsePortShortCounter": { "type": "integer", "description": "This counter is incremented when the PSE state diagram\n enters the state ERROR_DELAY_SHORT.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "POWER-ETHERNET-MIB_pethMainPseEntry": { "type": "array", "description": "A set of objects that display and control the Main\n power of a PSE.", "items": { "type": "object", "properties": { "pethMainPseGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group to which\n power Ethernet PSE is connected. Group means (box in\n the stack, module in a rack) and the value 1 MUST be\n used for non-modular devices. Furthermore, the same\n value MUST be used in this variable, pethPsePortGroupIndex,\n and pethNotificationControlGroupIndex to refer to a\n given box in a stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethMainPsePower": { "type": "integer", "description": "The nominal power of the PSE expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseOperStatus": { "type": "string", "description": "The operational status of the main PSE.", "readOnly": true }, "pethMainPseConsumptionPower": { "type": "integer", "description": "Measured usage power expressed in Watts.", "minimum": 0, "maximum": 4294967295, "readOnly": true }, "pethMainPseUsageThreshold": { "type": "integer", "description": "The usage threshold expressed in percents for\n comparing the measured power and initiating\n an alarm if the threshold is exceeded.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true } } } }, "POWER-ETHERNET-MIB_pethNotificationControlEntry": { "type": "array", "description": "A set of objects that control the Notification events.", "items": { "type": "object", "properties": { "pethNotificationControlGroupIndex": { "type": "integer", "description": "This variable uniquely identifies the group. Group\n means box in the stack, module in a rack and the value\n 1 MUST be used for non-modular devices. Furthermore,\n the same value MUST be used in this variable,\n pethPsePortGroupIndex, and\n pethMainPseGroupIndex to refer to a given box in a\n stack or module in a rack.", "minimum": -2147483648, "maximum": 2147483647, "readOnly": true }, "pethNotificationControlEnable": { "type": "boolean", "description": "This object controls, on a per-group basis, whether\n or not notifications from the agent are enabled. The\n value true(1) means that notifications are enabled; the\n value false(2) means that they are not.", "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": "POWER-ETHERNET-MIB", "description": "MIB operations for POWER-ETHERNET-MIB" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }