{"id":18798802,"url":"https://github.com/f5networks/f5-beacon","last_synced_at":"2026-01-02T12:30:14.076Z","repository":{"id":145235048,"uuid":"252503413","full_name":"F5Networks/f5-beacon","owner":"F5Networks","description":null,"archived":false,"fork":false,"pushed_at":"2020-05-06T18:33:33.000Z","size":42,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-29T18:24:40.999Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/F5Networks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2020-04-02T16:06:15.000Z","updated_at":"2021-06-07T18:22:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"f41ab838-4013-4e2f-80f8-9675c76623be","html_url":"https://github.com/F5Networks/f5-beacon","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-beacon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-beacon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-beacon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/F5Networks%2Ff5-beacon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/F5Networks","download_url":"https://codeload.github.com/F5Networks/f5-beacon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239727253,"owners_count":19687138,"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-11-07T22:13:01.652Z","updated_at":"2026-01-02T12:30:13.995Z","avatar_url":"https://github.com/F5Networks.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ansible Collection - f5networks.f5_beacon\n\nThis collection is used to configure the F5 Beacon SaaS offering.\n\n## Introduction\nBeacon enables IT leaders and operators to achieve full visibility across their application landscape through insights, application health, dashboards, and more.\n\n## Requirements\n  - Subscription to F5 Beacon ([Register Here](https://beacon.f5.com/register))\n  - Ansible \u003e= 2.9\n\n## Documentation\nFor an overview of Beacon in general please check our hosted [Documentation Page](https://clouddocs.f5.com/cloud-services/latest/f5-cloud-services-Beacon-About.html).  \n\n### Example Playbook\nAnsible modules are documented within each module itself. The example below will create a Token, check for existing data, create an application\n\n```\n---\n- name: Configure Beacon\n  hosts: beacon\n  gather_facts: false\n  connection: httpapi\n  collections:\n    - f5networks.f5_beacon\n\n\n  vars:\n    ansible_host: \"api.cloudservices.f5.com\"\n    ansible_user: \"username\"\n    ansible_httpapi_password: \"password\"\n    ansible_network_os: f5networks.f5_beacon.f5\n    ansible_httpapi_use_ssl: yes\n    cur_state: present\n\n  tasks:\n\n    # Create Token for Data Sources\n    - name: Beacon Token\n      beacon_token:\n        name: \"ExampleToken\"\n        preferred_account_id: \"{{ account_id }}\"\n        description: \"Ansible Token\"\n        state: \"{{ cur_state }}\"\n    \n    # Gather Information about Beacon\n    - name: Collect Beacon Information\n      beacon_info:\n        preferred_account_id: \"{{ account_id }}\"\n        gather_subset:\n          - tokens\n          - sources\n      register: beacon_info\n\n    # Create Application declaration on Beacon\n    - name: Application Declaration\n      beacon_declaration:\n        preferred_account_id: \"{{ account_id }}\"\n        content: \"{{ lookup('file', 'decl.json') }}\"\n        state: \"{{ cur_state }}\"\n```\n\n**IMPORTANT** Please note that the declaration that the Collection expects is only the declaration array object surrounded by `{}`. Beacon handles the deploy/delete objects for you. An example of the input is below.\n\nExample `decl.json`\n```\n{\n    \"declaration\": [\n        {\n            \"metadata\": {\n                \"Version\": \"v1\",\n                \"Operation\": \"\"\n            },\n            \"application\": {\n                \"name\": \"API-Demo-App-5\",\n                \"description\": \"An example for a Beacon application\",\n                ...\n            }\n        }\n    ]\n}\n```\n\n### Installation\nTo install in ansible default or defined paths use:\n\n```ansible-galaxy collection install f5networks.f5_beacon```\n\nTo specify the installation location use -p. If specifying a folder, make sure to update the ansible.cfg so ansible will check this folder as well.\n\n```ansible-galaxy collection install f5networks.f5_beacon -p collections/```\n\nTo specify the version of the collection to install, include it at the end of the collection with :==1.0.0:\n\n```ansible-galaxy collection install f5networks.f5_beacon:==1.0.0```\n\n\n\n## Filing Issues\nIf you come across a bug or other issue when using the F5 Beacon Collection, use [GitHub Issues](https://github.com/f5networks/f5-beacon/issues) to submit an issue for our team.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-beacon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff5networks%2Ff5-beacon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff5networks%2Ff5-beacon/lists"}