{ "openapi": "3.0.0", "info": { "title": "ETHER-WIS MIB API", "version": "1.0.0", "description": "SNMP MIB translated to YANG data model\n\nāš ļø **IMPORTANT - MIB DATA ACCESS**:\nThis YANG model exists for SMIv2-to-YANG translation purposes, but MIB data on IOS-XE devices is primarily accessed via **SNMP protocol**, not RESTCONF.\n\n**RESTCONF Limitation**: Many MIB paths may return 404 errors via RESTCONF `/data` endpoints because the device exposes MIB data through SNMP, not the YANG datastore.\n\n**Recommended Access Methods**:\n- Use SNMP (v2c/v3) to query MIB data directly\n- Use NETCONF `` operations for devices supporting YANG-modeled MIB access\n- Check device capabilities: some newer IOS-XE versions may support limited RESTCONF access to specific MIBs\n\n**YANG Model Purpose**: These YANG models define the structure of SNMP MIBs in YANG format for tooling compatibility, but do not guarantee RESTCONF data availability.\n\n\n**šŸ“Š YANG Tree:** [View ETHER-WIS structure](https://jeremycohoe.github.io/cisco-ios-xe-openapi-swagger/yang-trees/ETHER-WIS.html)", "contact": { "name": "Cisco DevNet", "url": "https://developer.cisco.com" }, "x-yang-module": "ETHER-WIS", "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/ETHER-WIS:etherWisDeviceTable": { "get": { "summary": "Get etherWisDeviceTable data", "description": "Retrieve etherWisDeviceTable operational data from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table for Ethernet WIS devices", "properties": { "etherWisDeviceEntry": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295 } } } } } }, "example": { "ETHER-WIS:etherWisDeviceTable": { "etherWisDeviceEntry": [ { "ifIndex": "1", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 }, { "ifIndex": "2", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 }, { "ifIndex": "3", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisDeviceTable", "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": "/etherWisDeviceTable", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisDeviceTable/etherWisDeviceEntry": { "get": { "summary": "Get etherWisDeviceEntry list", "description": "Retrieve list of etherWisDeviceEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "ETHER-WIS:etherWisDeviceEntry": [ { "ifIndex": "example-string", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisDeviceEntry", "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": "/etherWisDeviceTable/etherWisDeviceEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisDeviceTable/etherWisDeviceEntry={ifIndex}": { "get": { "summary": "Get etherWisDeviceEntry entry", "description": "Retrieve specific etherWisDeviceEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "ETHER-WIS:etherWisDeviceEntry": { "ifIndex": "example-string", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisDeviceEntry-2" }, "x-yang-path": "/etherWisDeviceTable/etherWisDeviceEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisSectionCurrentTable": { "get": { "summary": "Get etherWisSectionCurrentTable data", "description": "Retrieve etherWisSectionCurrentTable operational data from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table for the current state of Ethernet WIS sections.", "properties": { "etherWisSectionCurrentEntry": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary" } } } } } }, "example": { "ETHER-WIS:etherWisSectionCurrentTable": { "etherWisSectionCurrentEntry": [ { "ifIndex": "1", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" }, { "ifIndex": "2", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" }, { "ifIndex": "3", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisSectionCurrentTable", "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": "/etherWisSectionCurrentTable", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisSectionCurrentTable/etherWisSectionCurrentEntry": { "get": { "summary": "Get etherWisSectionCurrentEntry list", "description": "Retrieve list of etherWisSectionCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary" } } } }, "example": { "ETHER-WIS:etherWisSectionCurrentEntry": [ { "ifIndex": "example-string", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisSectionCurrentEntry", "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": "/etherWisSectionCurrentTable/etherWisSectionCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisSectionCurrentTable/etherWisSectionCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisSectionCurrentEntry entry", "description": "Retrieve specific etherWisSectionCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary" } } }, "example": { "ETHER-WIS:etherWisSectionCurrentEntry": { "ifIndex": "example-string", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisSectionCurrentEntry-2" }, "x-yang-path": "/etherWisSectionCurrentTable/etherWisSectionCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisPathCurrentTable": { "get": { "summary": "Get etherWisPathCurrentTable data", "description": "Retrieve etherWisPathCurrentTable operational data from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table for the current state of Ethernet WIS paths.", "properties": { "etherWisPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus." }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary" } } } } } }, "example": { "ETHER-WIS:etherWisPathCurrentTable": { "etherWisPathCurrentEntry": [ { "ifIndex": "1", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" }, { "ifIndex": "2", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" }, { "ifIndex": "3", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisPathCurrentTable", "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": "/etherWisPathCurrentTable", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisPathCurrentTable/etherWisPathCurrentEntry": { "get": { "summary": "Get etherWisPathCurrentEntry list", "description": "Retrieve list of etherWisPathCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus." }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary" } } } }, "example": { "ETHER-WIS:etherWisPathCurrentEntry": [ { "ifIndex": "example-string", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisPathCurrentEntry", "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": "/etherWisPathCurrentTable/etherWisPathCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisPathCurrentTable/etherWisPathCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisPathCurrentEntry entry", "description": "Retrieve specific etherWisPathCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus." }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary" } } }, "example": { "ETHER-WIS:etherWisPathCurrentEntry": { "ifIndex": "example-string", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisPathCurrentEntry-2" }, "x-yang-path": "/etherWisPathCurrentTable/etherWisPathCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisFarEndPathCurrentTable": { "get": { "summary": "Get etherWisFarEndPathCurrentTable data", "description": "Retrieve etherWisFarEndPathCurrentTable operational data from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "object", "description": "The table for the current far-end state of Ethernet WIS\n paths.", "properties": { "etherWisFarEndPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus." } } } } } }, "example": { "ETHER-WIS:etherWisFarEndPathCurrentTable": { "etherWisFarEndPathCurrentEntry": [ { "ifIndex": "1", "etherWisFarEndPathCurrentStatus": "up(1)" }, { "ifIndex": "2", "etherWisFarEndPathCurrentStatus": "up(1)" }, { "ifIndex": "3", "etherWisFarEndPathCurrentStatus": "up(1)" } ] } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisFarEndPathCurrentTable", "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": "/etherWisFarEndPathCurrentTable", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisFarEndPathCurrentTable/etherWisFarEndPathCurrentEntry": { "get": { "summary": "Get etherWisFarEndPathCurrentEntry list", "description": "Retrieve list of etherWisFarEndPathCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus." } } } }, "example": { "ETHER-WIS:etherWisFarEndPathCurrentEntry": [ { "ifIndex": "example-string", "etherWisFarEndPathCurrentStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisFarEndPathCurrentEntry", "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": "/etherWisFarEndPathCurrentTable/etherWisFarEndPathCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisFarEndPathCurrentTable/etherWisFarEndPathCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisFarEndPathCurrentEntry entry", "description": "Retrieve specific etherWisFarEndPathCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus." } } }, "example": { "ETHER-WIS:etherWisFarEndPathCurrentEntry": { "ifIndex": "example-string", "etherWisFarEndPathCurrentStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisFarEndPathCurrentEntry-2" }, "x-yang-path": "/etherWisFarEndPathCurrentTable/etherWisFarEndPathCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisDeviceEntry": { "get": { "summary": "Get etherWisDeviceEntry list", "description": "Retrieve list of etherWisDeviceEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295 } } } }, "example": { "ETHER-WIS:etherWisDeviceEntry": [ { "ifIndex": "example-string", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisDeviceEntry-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": "/etherWisDeviceEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisDeviceEntry={ifIndex}": { "get": { "summary": "Get etherWisDeviceEntry entry", "description": "Retrieve specific etherWisDeviceEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue." }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295 } } }, "example": { "ETHER-WIS:etherWisDeviceEntry": { "ifIndex": "example-string", "etherWisDeviceTxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternMode": "example-string", "etherWisDeviceRxTestPatternErrors": 0 } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisDeviceEntry-4" }, "x-yang-path": "/etherWisDeviceEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisSectionCurrentEntry": { "get": { "summary": "Get etherWisSectionCurrentEntry list", "description": "Retrieve list of etherWisSectionCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary" } } } }, "example": { "ETHER-WIS:etherWisSectionCurrentEntry": [ { "ifIndex": "example-string", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisSectionCurrentEntry-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": "/etherWisSectionCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisSectionCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisSectionCurrentEntry entry", "description": "Retrieve specific etherWisSectionCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary" } } }, "example": { "ETHER-WIS:etherWisSectionCurrentEntry": { "ifIndex": "example-string", "etherWisSectionCurrentJ0Transmitted": "example-string", "etherWisSectionCurrentJ0Received": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisSectionCurrentEntry-4" }, "x-yang-path": "/etherWisSectionCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisPathCurrentEntry": { "get": { "summary": "Get etherWisPathCurrentEntry list", "description": "Retrieve list of etherWisPathCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus." }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary" } } } }, "example": { "ETHER-WIS:etherWisPathCurrentEntry": [ { "ifIndex": "example-string", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisPathCurrentEntry-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": "/etherWisPathCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisPathCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisPathCurrentEntry entry", "description": "Retrieve specific etherWisPathCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus." }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary" }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary" } } }, "example": { "ETHER-WIS:etherWisPathCurrentEntry": { "ifIndex": "example-string", "etherWisPathCurrentStatus": "up(1)", "etherWisPathCurrentJ1Transmitted": "example-string", "etherWisPathCurrentJ1Received": "example-string" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisPathCurrentEntry-4" }, "x-yang-path": "/etherWisPathCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] }, "/data/ETHER-WIS:etherWisFarEndPathCurrentEntry": { "get": { "summary": "Get etherWisFarEndPathCurrentEntry list", "description": "Retrieve list of etherWisFarEndPathCurrentEntry entries from MIB", "tags": [ "ETHER-WIS" ], "responses": { "200": { "description": "Success", "content": { "application/yang-data+json": { "schema": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus." } } } }, "example": { "ETHER-WIS:etherWisFarEndPathCurrentEntry": [ { "ifIndex": "example-string", "etherWisFarEndPathCurrentStatus": "up(1)" } ] } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisFarEndPathCurrentEntry-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": "/etherWisFarEndPathCurrentEntry", "x-restconf-kind": "container" }, "/data/ETHER-WIS:etherWisFarEndPathCurrentEntry={ifIndex}": { "get": { "summary": "Get etherWisFarEndPathCurrentEntry entry", "description": "Retrieve specific etherWisFarEndPathCurrentEntry entry by key from MIB", "tags": [ "ETHER-WIS" ], "parameters": [ { "name": "ifIndex", "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": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref" }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus." } } }, "example": { "ETHER-WIS:etherWisFarEndPathCurrentEntry": { "ifIndex": "example-string", "etherWisFarEndPathCurrentStatus": "up(1)" } } } } }, "403": { "description": "Forbidden ā€” insufficient access rights (NACM)", "content": { "application/yang-data+json": { "schema": { "$ref": "#/components/schemas/restconf-error" } } } } }, "operationId": "get-etherWisFarEndPathCurrentEntry-4" }, "x-yang-path": "/etherWisFarEndPathCurrentEntry={ifIndex}", "x-restconf-kind": "list-instance", "x-list-keys": [ "ifIndex" ] } }, "components": { "schemas": { "ETHER-WIS_ETHER-WIS": { "type": "object", "description": "The table for Ethernet WIS devices", "properties": { "etherWisDeviceEntry": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true }, "etherWisSectionCurrentEntry": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "etherWisPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus.", "readOnly": true }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary", "readOnly": true } } }, "readOnly": true }, "etherWisFarEndPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus.", "readOnly": true } } }, "readOnly": true }, "etherWisDeviceTable": { "type": "object", "description": "The table for Ethernet WIS devices", "properties": { "etherWisDeviceEntry": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "etherWisSectionCurrentTable": { "type": "object", "description": "The table for the current state of Ethernet WIS sections.", "properties": { "etherWisSectionCurrentEntry": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "etherWisPathCurrentTable": { "type": "object", "description": "The table for the current state of Ethernet WIS paths.", "properties": { "etherWisPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus.", "readOnly": true }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary", "readOnly": true } } }, "readOnly": true } }, "readOnly": true }, "etherWisFarEndPathCurrentTable": { "type": "object", "description": "The table for the current far-end state of Ethernet WIS\n paths.", "properties": { "etherWisFarEndPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus.", "readOnly": true } } }, "readOnly": true } }, "readOnly": true } } }, "ETHER-WIS_etherWisDeviceEntry": { "type": "array", "description": "An entry in the Ethernet WIS device table. For each\n instance of this object there MUST be a corresponding\n instance of sonetMediumEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisDeviceTxTestPatternMode": { "type": "string", "description": "This variable controls the transmit test pattern mode.\n The value none(1) puts the the WIS transmit path into\n the normal operating mode. The value squareWave(2) puts\n the WIS transmit path into the square wave test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.1.\n The value prbs31(3) puts the WIS transmit path into the\n PRBS31 test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.2. The value mixedFrequency(4) puts the\n WIS transmit path into the mixed frequency test pattern\n mode described in [IEEE 802.3 Std.] subclause 50.3.8.3.\n Any attempt to set this object to a value other than\n none(1) when the corresponding instance of ifAdminStatus\n has the value up(1) MUST be rejected with the error\n inconsistentValue, and any attempt to set the corresponding\n instance of ifAdminStatus to the value up(1) when an\n instance of this object has a value other than none(1)\n MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternMode": { "type": "string", "description": "This variable controls the receive test pattern mode.\n The value none(1) puts the the WIS receive path into the\n normal operating mode. The value prbs31(3) puts the WIS\n receive path into the PRBS31 test pattern mode described\n in [IEEE 802.3 Std.] subclause 50.3.8.2. The value\n mixedFrequency(4) puts the WIS receive path into the mixed\n frequency test pattern mode described in [IEEE 802.3 Std.]\n subclause 50.3.8.3. Any attempt to set this object to a\n value other than none(1) when the corresponding instance\n of ifAdminStatus has the value up(1) MUST be rejected with\n the error inconsistentValue, and any attempt to set the\n corresponding instance of ifAdminStatus to the value up(1)\n when an instance of this object has a value other than\n none(1) MUST be rejected with the error inconsistentValue.", "readOnly": true }, "etherWisDeviceRxTestPatternErrors": { "type": "integer", "description": "This object counts the number of errors detected when the\n WIS receive path is operating in the PRBS31 test pattern\n mode. It is reset to zero when the WIS receive path\n initially enters that mode, and it increments each time\n the PRBS pattern checker detects an error as described in\n [IEEE 802.3 Std.] subclause 50.3.8.2 unless its value is\n 65535, in which case it remains unchanged. This object is\n writeable so that it may be reset upon explicit request\n of a command generator application while the WIS receive\n path continues to operate in PRBS31 test pattern mode.", "minimum": 0, "maximum": 4294967295, "readOnly": true } } } }, "ETHER-WIS_etherWisSectionCurrentEntry": { "type": "array", "description": "An entry in the etherWisSectionCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetSectionCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisSectionCurrentJ0Transmitted": { "type": "string", "description": "This is the 16-octet section trace message that\n is transmitted in the J0 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the section\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisSectionCurrentJ0Received": { "type": "string", "description": "This is the 16-octet section trace message that\n was most recently received in the J0 byte.", "format": "binary", "readOnly": true } } } }, "ETHER-WIS_etherWisPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status of the\n path payload with a bit map that can indicate multiple\n defects at once. The bit positions are assigned as\n follows:\n \n etherWisPathLOP(0)\n This bit is set to indicate that an\n LOP-P (Loss of Pointer - Path) defect\n is being experienced. Note: when this\n bit is set, sonetPathSTSLOP MUST be set\n in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathAIS(1)\n This bit is set to indicate that an\n AIS-P (Alarm Indication Signal - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSTSAIS MUST be\n set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathPLM(1)\n This bit is set to indicate that a\n PLM-P (Payload Label Mismatch - Path)\n defect is being experienced. Note: when\n this bit is set, sonetPathSignalLabelMismatch\n MUST be set in the corresponding instance of\n sonetPathCurrentStatus.\n \n etherWisPathLCD(3)\n This bit is set to indicate that an\n LCD-P (Loss of Codegroup Delination - Path)\n defect is being experienced. Since this\n defect is detected by the PCS and not by\n the path layer itself, there is no\n corresponding bit in sonetPathCurrentStatus.", "readOnly": true }, "etherWisPathCurrentJ1Transmitted": { "type": "string", "description": "This is the 16-octet path trace message that\n is transmitted in the J1 byte. The value SHOULD\n be '89'h followed by fifteen octets of '00'h\n (or some cyclic shift thereof) when the path\n trace function is not used, and the implementation\n SHOULD use that value (or a cyclic shift thereof)\n as a default if no other value has been set.", "format": "binary", "readOnly": true }, "etherWisPathCurrentJ1Received": { "type": "string", "description": "This is the 16-octet path trace message that\n was most recently received in the J1 byte.", "format": "binary", "readOnly": true } } } }, "ETHER-WIS_etherWisFarEndPathCurrentEntry": { "type": "array", "description": "An entry in the etherWisFarEndPathCurrentTable. For each\n instance of this object there MUST be a corresponding\n instance of sonetFarEndPathCurrentEntry.", "items": { "type": "object", "properties": { "ifIndex": { "type": "string", "description": "ifIndex", "x-yang-type": "leafref", "readOnly": true }, "etherWisFarEndPathCurrentStatus": { "type": "string", "description": "This variable indicates the current status at the\n far end of the path using a bit map that can indicate\n multiple defects at once. The bit positions are\n assigned as follows:\n \n etherWisFarEndPayloadDefect(0)\n A far end payload defect (i.e., far end\n PLM-P or LCD-P) is currently being signaled\n in G1 bits 5-7.\n \n etherWisFarEndServerDefect(1)\n A far end server defect (i.e., far end\n LOP-P or AIS-P) is currently being signaled\n in G1 bits 5-7. Note: when this bit is set,\n sonetPathSTSRDI MUST be set in the corresponding\n instance of sonetPathCurrentStatus.", "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": "ETHER-WIS", "description": "MIB operations for ETHER-WIS" } ], "externalDocs": { "description": "Cisco SNMP Object Navigator", "url": "https://snmp.cloudapps.cisco.com/Support/IOS/do/BrowseMIB.do" } }