{"id":15631954,"url":"https://github.com/jaymzh/setup-oob","last_synced_at":"2025-03-29T19:13:08.680Z","repository":{"id":142270949,"uuid":"438748511","full_name":"jaymzh/setup-oob","owner":"jaymzh","description":"A script for setting up out-of-band management systems","archived":false,"fork":false,"pushed_at":"2024-03-27T23:53:04.000Z","size":40,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T01:43:55.877Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"vicariousinc/setup-oob","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaymzh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-15T19:27:41.000Z","updated_at":"2024-09-23T09:20:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"d587b255-4b2a-4950-9157-191cdb8ecfd5","html_url":"https://github.com/jaymzh/setup-oob","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaymzh%2Fsetup-oob","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaymzh%2Fsetup-oob/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaymzh%2Fsetup-oob/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaymzh%2Fsetup-oob/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaymzh","download_url":"https://codeload.github.com/jaymzh/setup-oob/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246230541,"owners_count":20744349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T10:42:09.308Z","updated_at":"2025-03-29T19:13:08.658Z","avatar_url":"https://github.com/jaymzh.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup OOB\n\n[![Lint](https://github.com/jaymzh/setup-oob/actions/workflows/lint.yml/badge.svg)](https://github.com/jaymzh/setup-oob/actions/workflows/lint.yml)\n[![DCO Check](https://github.com/jaymzh/setup-oob/actions/workflows/dco.yml/badge.svg)](https://github.com/jaymzh/setup-oob/actions/workflows/dco.yml)\n\nThis is a utility for configuring out-of-band management systems from within\nthe running (Linux) OS.\n\nIt is built to be highly modular and easy to add support for new types of OOB\ndevices.\n\nAs of current writing it supports SuperMicro's SMC systems and Dell's iDRAC\nsystems.\n\nIt is specifically designed to be easy to run from a Configuration Management\nsystem such as Chef, and thus has a 'check' mode to enable idempotent behavior.\n\nSetup OOB attempts to do as much as possible with the generic `ipmitool`, and\nfalls back to vendor-specific tools only where necessary. In fact, great\nlengths were taken to determine the underlying IPMI commands in order to not\nrely on vendor tools.\n\n## General Use\n\nNote that the `--help` message is always the best place to find all the current\noptions. This section instead attempts to provide and overview of usage, not an\nexhaustive list of all options.\n\nYou must tell Setup OOB what type of device it needs to configure with the\n`--type` option. As of now it takes either `smc` or `drac`. Let's say you want\nto configure an iDRAC system, you might check to see if it's configured\nproperly with:\n\n```shell\nsetup_oob --type drac --check --name server001-oob --network-mode shared \\\n  --network-src dhcp\n```\n\nThis would return 0 if these were all configured this way or non-zero if\nsomething didn't match. If it was not correct, you could converge it to the\ndesired settings by re-running without `--check`:\n\n```shell\nsetup_oob --type drac --name server001-oob --network-mode shared \\\n  --network-src dhcp\n```\n\nIf configuring a local system, IPMI does not need a password, however for some\ndevices, when vendor-specific tooling is required, it may fail without\nspecifying the password via `--old-password` (unless it's still the device\ndefault).\n\n## Installing\n\nThe easiest way to install is with gem:\n\n```shell\ngem install setup_oob\n```\n\nYou can, alternatively simply run this from the repo:\n\n```shell\n./bin/setup-oob \u003coptions\u003e\n```\n\n## SMC Licensing\n\nSetup OOB can \"activate\" SMC systems for you. Automating this can be a bit\ndifficult without having to store every single license in code or have your\nConfiguration Management system reach out to an external database.\n\nHowever, license keys can be derived from the host MAC address and a private\nkey. *IF YOU HAVE PURCHASED LICENSES* (and if your legal team approves), you\ncan find the key on the internet and pass it into `--key-file`. If you do this,\nthen Setup OOB can generate the license key and activate the license for you.\n\nTo be clear: *DO NOT DO THIS IF YOU HAVE NOT PURCHASED A LICENSE FOR THE\nMACHINES IN QUESTION*. Doing so is certainly a violation of your agreement with\nSMC.\n\nThe authors of this software are not responsible for illegal use of this\noption.\n\n## External tools\n\nSetup OOB requires `ipmitool` at a minimum. For SMC hosts, that is the only\nrequirement. For DRAC hosts, it also requires racadm.\n\n## History\n\nThis is a fork of\n[viariousinc/setup-oob](https://github.com/vicariousinc/setup-oob) which is\ndefunct. This is now the official respository, feel free to send PRs or issues\nhere.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaymzh%2Fsetup-oob","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaymzh%2Fsetup-oob","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaymzh%2Fsetup-oob/lists"}