{"id":49104677,"url":"https://github.com/pfrest/ansible-collection-pfsense","last_synced_at":"2026-04-21T01:04:10.422Z","repository":{"id":346933957,"uuid":"1096172662","full_name":"pfrest/ansible-collection-pfsense","owner":"pfrest","description":"An Ansible collection for managing pfSense systems using the pfSense REST API package","archived":false,"fork":false,"pushed_at":"2026-04-15T03:52:41.000Z","size":2333,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-15T05:22:23.605Z","etag":null,"topics":["ansible","infrastructure-as-code","pfsense"],"latest_commit_sha":null,"homepage":"https://galaxy.ansible.com/ui/repo/published/pfrest/pfsense/docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pfrest.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-14T03:19:56.000Z","updated_at":"2026-04-15T03:52:35.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pfrest/ansible-collection-pfsense","commit_stats":null,"previous_names":["pfrest/ansible-collection-pfsense"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/pfrest/ansible-collection-pfsense","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfrest%2Fansible-collection-pfsense","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfrest%2Fansible-collection-pfsense/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfrest%2Fansible-collection-pfsense/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfrest%2Fansible-collection-pfsense/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pfrest","download_url":"https://codeload.github.com/pfrest/ansible-collection-pfsense/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfrest%2Fansible-collection-pfsense/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32072325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T21:26:33.338Z","status":"ssl_error","status_checked_at":"2026-04-20T21:26:22.081Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ansible","infrastructure-as-code","pfsense"],"created_at":"2026-04-21T01:04:09.398Z","updated_at":"2026-04-21T01:04:10.391Z","avatar_url":"https://github.com/pfrest.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pfREST Ansible Collection for pfSense\n\n[![Quality](https://github.com/pfrest/ansible-collection-pfsense/actions/workflows/quality.yml/badge.svg)](https://github.com/pfrest/ansible-collection-pfsense/actions/workflows/quality.yml)\n[![Release](https://github.com/pfrest/ansible-collection-pfsense/actions/workflows/release.yml/badge.svg)](https://github.com/pfrest/ansible-collection-pfsense/actions/workflows/release.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n\nAn Ansible collection for managing [pfSense](https://www.pfsense.org/) firewalls through the unofficial\n[pfSense REST API](https://github.com/pfrest/pfSense-pkg-RESTAPI) package. This collection provides over\n400 fully documented, idempotent modules covering firewall rules, NAT, VPN, services, system configuration,\nand more.\n\n## Key Features\n\n- **Schema-driven development**: Every module is auto-generated from the REST API's native schema. As the\n  API evolves, a single re-generation keeps the entire collection in sync. No handwritten boilerplate to\n  maintain, no modules falling out of date.\n- **Idempotent by design**: Resource modules compare the desired state against the current API state before\n  making changes. Runs are safe to repeat; Ansible only applies what is actually different.\n- **Comprehensive coverage**: Modules are organized by category and include info modules for read-only\n  queries, resource modules for managing single resources, collection modules for managing entire sets of resources as a\n  whole, singleton modules for one-off settings, and action modules for operational tasks.\n\n## Installation\n\nInstall from [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/pfrest/pfsense/):\n\n```bash\nansible-galaxy collection install pfrest.pfsense\n```\n\nTo install a specific version:\n\n```bash\nansible-galaxy collection install pfrest.pfsense:==0.0.0\n```\n\nOr add it to your `requirements.yml` file:\n\n```yaml\ncollections:\n  - name: pfrest.pfsense\n    version: \"\u003e=0.0.0\"\n```\n\nThen install with:\n\n```bash\nansible-galaxy collection install -r requirements.yml\n```\n\n## Connection Options\n\nAll modules share a common set of connection parameters:\n\n| Parameter        | Type | Default      | Description                                |\n|------------------|------|--------------|--------------------------------------------|\n| `api_host`       | str  | *(required)* | Hostname or IP of the pfSense device       |\n| `api_port`       | int  | `443`        | API port number                            |\n| `api_protocol`   | str  | `https`      | Protocol (`http` or `https`)               |\n| `api_username`   | str  | `admin`      | Username for authentication                |\n| `api_password`   | str  | `pfsense`    | Password for authentication                |\n| `api_key`        | str  | —            | API key (alternative to username/password) |\n| `validate_certs` | bool | `true`       | Whether to validate SSL certificates       |\n\n## Contributing\n\nContributions are welcome! Please refer to the [contributing guidelines](docs/CONTRIBUTING.md) for details.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfrest%2Fansible-collection-pfsense","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpfrest%2Fansible-collection-pfsense","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfrest%2Fansible-collection-pfsense/lists"}