diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ab15e4c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +### :exclamation: Disclaimer +- This Repo is a mirror of various internal MIB files from various Cisco Repos. +- All changes **MUST** be modified at the source and then replicated out to this repo. +- This guide details how this repo handles Pull Requests, Issues and Application support to that all involved are on the same page. + +### :repeat: Pull Requests +- **ONLY** Pull requests from Cisco Systems employees will be accepted. See the [Internal Contributing Page](https://wiki.cisco.com/display/IOXXECHASA/SNMP+MIB+Publishing+guidelines) for the full process. +- Acceptable pull requests from 3rd parties will be converted to an Cisco Defect e.g `CSCxyz1234` to update the internal repository. + - This will be referenced in an issue for the same change. +- All pull requests require an code review and approval before merging by an [individual with commit privledges](https://github.com/orgs/cisco/teams/cisco-mib-commit/members). +- Pull requests for the `v2/CISCO-PRODUCTS-MIB.my`, `v2/CISCO-ENTITY-VENDORTYPE-OID-MIB.my` are owned by the Cisco SNMP Team and all PRs **MUST** be created by them. + +### :beetle: Issues +- Issues with MIB files may be raised on this Repo. + - This includes syntax issues, missing values, missing imports or other general problems with the files. +- For Syntax issues please include `smilint` output. + - Errors 0-2 will be converted to Cisco Defects for the appropriate Cisco development team to triage. + - Errors 3-6 will be triaged a defect filed if it is deemed to be required. + - Reference: [SMILINT Error Levels](https://www.ibr.cs.tu-bs.de/projects/libsmi/smilint.html) + +### :mag: SNMP / Application Support +- Please consult with the [Cisco Technical Assistance Center (TAC)](https://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html) or [Support Forums](https://community.cisco.com/t5/network-management/bd-p/5931-discussions-network-management). +- Issues of this type will be closed and a note redirecting to the worldwide contacts. \ No newline at end of file diff --git a/README.md b/README.md index 62ad698..0134b43 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # Cisco Systems Public MIB Area Various Public Simple Network Management Protocol (SNMP) management information bases (MIBs) from Cisco Systems. -### Usage Guidelines +--- + +### :exclamation: Disclaimer +- This Repo is a mirror of various internal MIB files from various Cisco Repos. +- All changes **MUST** be modified at the source and then replicated out to this repo. + - For contributing, issues, or pull requests. Please review the CONTRIBUTING.md file. + +--- + +### :book: Usage Guidelines The suggested way to retrieve the MIBs applicable to the Cisco products that you wish to manage is as follows: 1. For each product, download and open the desired [Support List](https://github.com/cisco/cisco-mibs/tree/main/supportlists) file: - `supportlists/[product]/supportlist.txt` @@ -16,10 +25,12 @@ The suggested way to retrieve the MIBs applicable to the Cisco products that you - If you are looking for a specific file click “Go to File” and [search for the filename](https://docs.github.com/en/search-github/searching-on-github/finding-files-on-github). - Tip: You may also use Cisco Feature Navigator to find the desired MIB hosted in this Repo: https://cfnng.cisco.com/mibs -### Directory Structure +--- + +### :file_folder: Directory Structure - `app_notes` directory with application notes for using the MIBs. - `archive` directory with MIBs, OIDs, schema for IOS 10.0 and earlier releases. -- `contrib` directory with helpful mib-related scripts/files (see `contrib/README`) +- `contrib` directory with helpful mib-related scripts/files. - `IE1000-MIBS` directory with IE1000 MIBs. - `ME1200-MIBS` directory with ME1200 MIBs. - `oid` directory with SunNet Manager OID files for the MIBs. @@ -33,10 +44,12 @@ The suggested way to retrieve the MIBs applicable to the Cisco products that you - `v2` SNMP version 2 MIBs. - `viptela-mibs` directory with Viptela MIBs. -### Other Notes +--- + +### :speech_balloon: Other Notes - This GitHub repository started as a 2/28/2022 backup of the public `ftp://ftp.cisco.com/pub/mibs/` - Empty folders have not been backed up. -- On 10/15/2022 `ftp.cisco.com` has been officially decomissioned making this the new source for Cisco MIB files. +- On 10/15/2022 `ftp.cisco.com` has been officially decommissioned making this the new source for Cisco MIB files. - Cisco Developers will continue maintain MIB files in this location as they did on `ftp.cisco.com` - Other product MIBs are located on the applicable [software.cisco.com](https://software.cisco.com/download/home) downloads page. - e.g. [3504 Wireless Controller, Release 8.10.162.0 MIBs](https://software.cisco.com/download/home/286312601/type/280775088/release/8.10.162.0)