{"id":22331327,"url":"https://github.com/eoly/puppet-rancid","last_synced_at":"2025-12-11T21:19:33.904Z","repository":{"id":7540824,"uuid":"8893114","full_name":"eoly/puppet-rancid","owner":"eoly","description":"Rancid Puppet Module","archived":false,"fork":false,"pushed_at":"2021-08-25T16:30:11.000Z","size":69,"stargazers_count":6,"open_issues_count":4,"forks_count":28,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-20T23:57:32.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eoly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-20T00:52:42.000Z","updated_at":"2024-09-06T13:27:51.000Z","dependencies_parsed_at":"2022-08-29T14:41:29.271Z","dependency_job_id":null,"html_url":"https://github.com/eoly/puppet-rancid","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/eoly/puppet-rancid","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eoly%2Fpuppet-rancid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eoly%2Fpuppet-rancid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eoly%2Fpuppet-rancid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eoly%2Fpuppet-rancid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eoly","download_url":"https://codeload.github.com/eoly/puppet-rancid/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eoly%2Fpuppet-rancid/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27670442,"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","status":"online","status_checked_at":"2025-12-11T02:00:11.302Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-12-04T04:11:05.762Z","updated_at":"2025-12-11T21:19:33.883Z","avatar_url":"https://github.com/eoly.png","language":"Puppet","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/eoly/puppet-rancid.png?branch=master)](https://travis-ci.org/eoly/puppet-rancid)\n\n# puppet-rancid\n\nRancid Puppet Module\n\nThis module will install the Rancid package, manage Rancid groups, initialize\nper group router.db files, create the rancid-run cron job, and has the\ncapability to add router entries to your router.db file with Hiera. Also manages\n.cloginrc.\n\n===\n\n# Compatibility\n\nCompatible with Puppet v3 (starting at version 3.2.0) with and without\nthe future parser and Puppet v4 with Ruby versions 1.8.7, 1.9.3, 2.0.0,\n2.1.0 and 2.3.1 on the following platforms.\n\n* EL 6 (rancid package from [EPEL](https://fedoraproject.org/wiki/EPEL))\n* Ubuntu 12.04 LTS\n\n* The module now requires rancid \u003e 3.0 (released 2 Apr 2014)\n\n===\n\n# class rancid\n\n## Parameters\n\n    'USE_DEFAULTS' denotes that defaults are made based on osfamily and other such factors.\n\nfilterpwds\n----------\nDetermines which passwords are filtered from configs.\n\n    NO – does not filter any password. All passwords are included in configs in RANCID repository\n\n    YES – passwords which are stored in plain-text or using reversible enryption method will be removed from configs.\n\n    ALL – all password will be removed from configs\n\nNOTE: When setting password filtering be aware that RANCID is sending\nconfiguration and changes via email, so including any passwords is not\nrecommended. String can be 'ALL', 'YES', or 'NO'.\n\n- *Default*: 'ALL'\n\nnocommstr\n---------\nOptionally strip snmp community strings from the configs. String can be 'YES'\nor 'NO'.\n\n- *Default*: 'YES'\n\nmaxrounds\n---------\nDefines how many times rancid should retry collection of\ndevices that fail. The minimum is 1.\n\n- *Default*: '4'\n\noldtime\n-------\nSpecified as a number of hours, OLDTIME defines how many hours should pass\nsince a successful collection of a device’s configuration and when\ncontrol_rancid(1) should start complaining about failures. The value should be\ngreater than the number of hours between rancid-run cron runs.\n\n- *Default*: '4'\n\nlocktime\n--------\nDefines the number of hours a group’s lock file may age before rancid starts to\ncomplain about a hung collection. String that must be a digit.\n\n- *Default*: '4'\n\nparcount\n--------\nDefines the number of rancid processes that par(1) will start simultaneously as\ncontrol_rancid(1) attempts to perform collections. Raising this value will\ndecrease the amount of time necessary for a complete collection of a (or all)\nrancid groups at the expense of system load. The default is relatively\ncautious. If collections are not completing quickly enough for users, use trial\nand error of speed versus system load to find a suitable value. String that\nmust be a digit.\n\n- *Default*: '5'\n\ngroups\n------\nArray of rancid groups.\n\n- *Default*: [ 'routers', 'switches', 'firewalls' ]\n\ndevices\n-------\nHash of devices. See Sample Hiera Structure.\n\n- *Default*: undef\n\npackages\n--------\n- *Default*: 'USE_DEFAULTS'\n\nrancid_config\n-------------\nPath to rancid.conf.\n\n- *Default*: 'USE_DEFAULTS'\n\nrancid_path_env\n---------------\nPATH to use in rancid.conf.\n\n- *Default*: 'USE_DEFAULTS'\n\nhomedir\n-------\nRancid user's home directory.\n\n- *Default*: 'USE_DEFAULTS'\n\nlogdir\n------\nDirectory for storing rancid logs.\n\n- *Default*: 'USE_DEFAULTS'\n\nuser\n----\nRancid user.\n\n- *Default*: 'USE_DEFAULTS'\n\ngroup\n-----\nRancid group\n\n- *Default*: 'USE_DEFAULTS'\n\nshell\n-----\nRancid user's shell.\n\n- *Default*: 'USE_DEFAULTS'\n\ncron_d_file\n-----------\nPath to file in cron.d that will periodically execute rancid.\n\n- *Default*: '/etc/cron.d/rancid'\n\ncloginrc_content\n----------------\nContent of \u003ctt\u003e~rancid/.cloginrc\u003c/tt\u003e\n\n- *Default*: 'USE_DEFAULTS'\n\nshow_cloginrc_diff\n------------------\nWhether to show diffs of \u003ctt\u003e~rancid/.cloginrc\u003c/tt\u003e during puppet runs.\n\n- *Default*: true\n\nvcs\n---\nWhich version control system to use.  Must be one of git, svn, cvs or USE_DEFAULTS.\n\n- *Default*: 'USE_DEFAULTS'\n\nvcsroot\n-------\nUse a different directory than the default for the vcs you've chosen.\n\n- *Default*: 'USE_DEFAULTS'\n\nmanage_vcs_packages\n-------------------\nIf true, we will ensure that the appropriate packages are installed for the vcs you've chosen.\n\n- *Default*: false\n\nvcs_remote_urls\n---------------\nHash (keyed by group name) of remote urls. See Sample Hiera Structure.\n\n- *Default*: undef\n\n===\n\n# define rancid::router_db\n\n## Example Usage\nIf you specify a hash in Hiera, you will not need to call this define directly.\n\n## Parameters\n\ndevices\n-------\nHash of devices. See Sample Hiera Structure.\n\n- *Default*: undef\n\nrancid_cvs_path\n---------------\nPATH for finding \u003ctt\u003erancid-cvs\u003c/tt\u003e and \u003ctt\u003etest\u003c/tt\u003e programs.\n\n- *Default*: '/bin:/usr/bin',\n\nrouter_db_mode\n--------------\nMode of \u003ctt\u003erouter.db\u003c/tt\u003e files.\n\n- *Default*: '0640',\n\n===\n\nSample Hiera Structure\n----------------------\n\u003cpre\u003e\nrancid::cloginrc_content: |\n  add autoenable * 1\n  add method * ssh\n  add user * rancid\n  add password * mypassword\n\nrancid::groups:\n  - 'routers'\n  - 'switches'\n  - 'firewalls'\n\nrancid::devices:\n  routers:\n    cr1.example.com: {\n      hostname: 'cr1.example.com',\n      type: 'juniper',\n      status: 'up'\n    }\n    cr2.example.com: {\n      hostname: 'cr2.example.com',\n      type: 'juniper',\n      status: 'up'\n    }\n  switches:\n    as1.example.com: {\n      hostname: 'as1.example.com',\n      type: 'cisco',\n      status: 'up'\n    }\n    as2.example.com: {\n      hostname: 'as2.example.com',\n      type: 'cisco',\n      status: 'up'\n    }\n  firewalls:\n    fw1.example.com: {\n      hostname: 'fw1.example.com',\n      type: 'cisco',\n      status: 'up'\n    }\n\nrancid::vcs_remote_urls:\n  routers: git@github.com/me/my-routers.git\n  switches: git@github.com/me/my-switches.git\n  firewalls: git@github.com/me/my-firewalls.git\n\u003c/pre\u003e\n\n===\n\n# License\n\n[Apache Software License v2.0](http://www.apache.org/licenses/LICENSE-2.0.html)\n\n===\n\n# Support\n\nPlease log tickets and issues at our [Projects site](https://github.com/eoly/puppet-rancid)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feoly%2Fpuppet-rancid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feoly%2Fpuppet-rancid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feoly%2Fpuppet-rancid/lists"}