diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..674bcb2 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,57 @@ +name: Publish Ansible Collection + +on: + push: + tags: + - 'v*.*.*' # Trigger on version tags like x.x.x + +jobs: + build-and-publish: + runs-on: ubuntu-latest + + steps: + # Checkout the repository + - name: Check out the repository + uses: actions/checkout@v3 + + # Set up Python environment + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + + # Install ansible-core + - name: Install Ansible + run: | + python -m pip install --upgrade pip + pip install ansible-core + + # Build the collection + - name: Build Ansible Collection + run: | + ansible-galaxy collection build + # Capture the built file name + id: build + + # Capture the tar.gz filename from the build output + - name: Get tar.gz filename + shell: bash + run: | + COLLECTION_FILE=$(ls *.tar.gz) + echo "COLLECTION_FILE=${COLLECTION_FILE}" >> $GITHUB_ENV + + # Upload the collection file to the release + - name: Upload Release Asset + uses: actions/upload-release-asset@v1 + with: + upload_url: "${{ github.event.release.upload_url }}" + asset_path: "${{ env.COLLECTION_FILE }}" + asset_name: "${{ env.COLLECTION_FILE }}" + asset_content_type: application/gzip + + # Publish the collection to Ansible Galaxy + - name: Publish to Ansible Galaxy + env: + GALAXY_TOKEN: ${{ secrets.GALAXY_TOKEN }} + run: | + ansible-galaxy collection publish "${{ env.COLLECTION_FILE }}" --api-key $GALAXY_TOKEN diff --git a/.gitignore b/.gitignore index f9c2f56..5680451 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ inventory.yml tests/output/ tests/integration/inventory changelogs/.plugin-cache.yaml +*.tar.gz diff --git a/README.md b/README.md index 55ab207..9a01aca 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ # Ansible Collection - sophos.sophos_firewall +This collection provides modules for working with Sophos Firewall running SFOS 18.0+. The modules leverage the [sophosfirewall-python](https://sophosfirewall-python.readthedocs.io) SDK to perform operations on the firewall using the embedded [XML API](https://docs.sophos.com/nsg/sophos-firewall/21.0/API/index.html). + +For installation and usage details, please see the [Documentation](https://sophosfirewall-ansible.readthedocs.io) + + +## Contributing +This is an open source project and we welcome contributions from the community. To get started, fork this repository and perform development in the fork. The following guidelines should be followed: + +- This project uses [Semantic Versioning](https://semver.org) +- When adding new modules, increment the `MINOR` version +- When making bug fixes, increment the `PATCH` version +- When adding new modules, configure the `version_added` field to the new version the module will be added to +- Update the `version` field in `galaxy.yml` to the new version +- In the `changelogs/fragments` directory, add a file named `x.y.z.yaml` where x.y.z indicates the version +- The file should have at a minimum, a `release_summary` field for example: +```yaml +release_summary: | + This release introduces new modules for working with the X feature on Sophos Firewall +``` +- Github Actions will take care of updating the documentation and changelog automatically upon PR merge + +### Tests +When adding a new module, integration tests should be written and stored under the `tests/integration` directory. Each module should have a directory in the `targets` folder, and a `main.yml` file implementing the test cases. Tests can be run against a physical or virtual Sophos Firewall appliance. To run these tests against your own firewall, a file `integration_config.yml` must be created in the `tests` directory. An file `integration.yml.template` file is provided as an example. The variables in the example file should be replaced with the actual values, and the file renamed to `integration.yml`. Once these steps are complete, tests for a specific module can be run using `ansible-test integration [module_name]`: + +```bash +ansible-test integration sfos_syslog -v +``` + + + -Documentation for the collection. diff --git a/docs/conf copy.py b/docs/conf copy.py deleted file mode 100644 index 4fc1b95..0000000 --- a/docs/conf copy.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (c) Ansible Project -# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) -# SPDX-License-Identifier: GPL-3.0-or-later - -# Created with antsibull-docs 2.14.0 - -# This file only contains a selection of the most common options. For a full list see the -# documentation: -# http://www.sphinx-doc.org/en/master/config - -project = 'Sophos Firewall' -copyright = 'Sophos, Ltd.' - -title = 'Sophos Firewall Ansible Collection' -html_short_title = 'Sophos Firewall Ansible Collection' - -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx_antsibull_ext'] - -pygments_style = 'ansible' - -highlight_language = 'YAML+Jinja' - -html_theme = 'sphinx_ansible_theme' -html_show_sphinx = False - -display_version = False - -html_use_smartypants = True -html_use_modindex = False -html_use_index = False -html_copy_source = False - -# See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping for the syntax -intersphinx_mapping = { - 'python': ('https://docs.python.org/2/', (None, '../python2.inv')), - 'python3': ('https://docs.python.org/3/', (None, '../python3.inv')), - 'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')), - 'ansible_devel': ('https://docs.ansible.com/ansible/devel/', (None, '../ansible_devel.inv')), - # If you want references to resolve to a released Ansible version (say, `5`), uncomment and replace X by this version: - # 'ansibleX': ('https://docs.ansible.com/ansible/X/', (None, '../ansibleX.inv')), -} - -default_role = 'any' - -nitpicky = True diff --git a/docs/conf.py b/docs/conf.py index 4fc1b95..e4c3f19 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,8 @@ html_use_index = False html_copy_source = False +html_static_path = ['static'] + # See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping for the syntax intersphinx_mapping = { 'python': ('https://docs.python.org/2/', (None, '../python2.inv')), diff --git a/docs/docsite/config.yml b/docs/docsite/config.yml new file mode 100644 index 0000000..fcdb4e0 --- /dev/null +++ b/docs/docsite/config.yml @@ -0,0 +1,2 @@ +changelog: + write_changelog: true \ No newline at end of file diff --git a/docs/docsite/extra-docs.yml b/docs/docsite/extra-docs.yml new file mode 100644 index 0000000..9af08f2 --- /dev/null +++ b/docs/docsite/extra-docs.yml @@ -0,0 +1,5 @@ +sections: + - title: Installation and Setup + toctree: + - installation + - setup \ No newline at end of file diff --git a/docs/docsite/rst/installation.rst b/docs/docsite/rst/installation.rst new file mode 100644 index 0000000..ffa1535 --- /dev/null +++ b/docs/docsite/rst/installation.rst @@ -0,0 +1,29 @@ +.. _ansible_collections.sophos.sophos_firewall.docsite.installation: + +Installation +============ + +Prerequisites +------------- +The following must be installed prior to installing the module: + +* Python 3.11+ +* Ansible 2.16+ +* sophosfirewall-python 0.1.56+ + +The sophosfirewall-python module can be installed with ``pip``: + +.. code-block:: bash + + $ pip install sophosfirewall-python + +Install +------- +The Sophos Firewall Ansible Collection can be installed using the ``ansible-galaxy`` command-line utility: + +.. code-block:: bash + + $ ansible-galaxy collection install sophos.sophos_firewall + + + diff --git a/docs/docsite/rst/setup.rst b/docs/docsite/rst/setup.rst new file mode 100644 index 0000000..27508d6 --- /dev/null +++ b/docs/docsite/rst/setup.rst @@ -0,0 +1,11 @@ +.. _ansible_collections.sophos.sophos_firewall.docsite.setup: + +Setup +===== +Prior to using the Ansible modules, the firewall must be set up to allow access to the API +from the IP address of the system running Ansible. + +In the firewall dashboard, navigate to **Backup & firmware** and click on the **API** tab. +Check the box to enable API Configuration, and add the Ansible controller to the Allowed IP address field. + +.. image:: ../../_static/images/setup.jpg diff --git a/docs/rst/changelog.rst b/docs/rst/changelog.rst new file mode 100644 index 0000000..d1543d0 --- /dev/null +++ b/docs/rst/changelog.rst @@ -0,0 +1,63 @@ +===================================== +Sophos.Sophos\_Firewall Release Notes +===================================== + +.. contents:: Topics + +v1.2.0 +====== + +Release Summary +--------------- + +This release adds modules for working with IPS and Syslog settings + +New Modules +----------- + +- sophos.sophos_firewall.sfos_ips - Manage IPS protection (Protect > Intrusion Protection > IPS policies). +- sophos.sophos_firewall.sfos_syslog - Manage Syslog servers (Configure > System services > Log settings). + +v1.1.0 +====== + +Release Summary +--------------- + +This release contains new modules for working with the SNMP agent and SNMPv3 users on Sophos Firewall + +New Modules +----------- + +- sophos.sophos_firewall.sfos_snmp_agent - Manage SNMP Agent (System > Administration > SNMP). +- sophos.sophos_firewall.sfos_snmp_user - Manage SNMPv3 User (System > Administration > SNMP). + +v1.0.0 +====== + +Release Summary +--------------- + +This is the first proper release of the ``sophos.sophos_firewall`` collection. + +New Modules +----------- + +- sophos.sophos_firewall.sfos_admin_settings - Manage Admin and user settings (System > Administration). +- sophos.sophos_firewall.sfos_atp - Manage Active Threat Protection (Protect > Active threat response > Sophos X-Ops threat feeds). +- sophos.sophos_firewall.sfos_backup - Manage Backup settings (System > Backup & firmware). +- sophos.sophos_firewall.sfos_device_access_profile - Manage Device Access Profiles (System > Profiles > Device Access). +- sophos.sophos_firewall.sfos_dns - Manage DNS settings (Configure > Network > DNS). +- sophos.sophos_firewall.sfos_firewall_rule - Manage Firewall Rules (Protect > Rules & policies). +- sophos.sophos_firewall.sfos_fqdn_host - Manage FQDN hosts (System > Hosts & services > FQDN host). +- sophos.sophos_firewall.sfos_fqdn_hostgroup - Manage FQDN Host Groups (System > Hosts & services > FQDN host group). +- sophos.sophos_firewall.sfos_ip_host - Manage IP Host (System > Hosts & services > IP host). +- sophos.sophos_firewall.sfos_ip_hostgroup - Manage IP Hostgroup (System > Hosts & services > IP host group). +- sophos.sophos_firewall.sfos_malware_protection - Manage Malware Protection (Configure > System services > Malware protection). +- sophos.sophos_firewall.sfos_service - Manage Service (System > Hosts and services > Services). +- sophos.sophos_firewall.sfos_service_acl_exception - Manage Local Service Exception ACL Rules (System > Administration > Device Access). +- sophos.sophos_firewall.sfos_servicegroup - Manage Service Group (System > Hosts and services > Service Group). +- sophos.sophos_firewall.sfos_time - Manage Date and Time settings (System > Administration > Time). +- sophos.sophos_firewall.sfos_user - Manage Users (Configure > Authentication > Users). +- sophos.sophos_firewall.sfos_xmlapi - Use the XML API to get, create, update, or delete settings on Sophos Firewall. +- sophos.sophos_firewall.sfos_zone - Manage Zones (Configure > Network > Zones). diff --git a/docs/rst/docsite/installation.rst b/docs/rst/docsite/installation.rst new file mode 100644 index 0000000..ffa1535 --- /dev/null +++ b/docs/rst/docsite/installation.rst @@ -0,0 +1,29 @@ +.. _ansible_collections.sophos.sophos_firewall.docsite.installation: + +Installation +============ + +Prerequisites +------------- +The following must be installed prior to installing the module: + +* Python 3.11+ +* Ansible 2.16+ +* sophosfirewall-python 0.1.56+ + +The sophosfirewall-python module can be installed with ``pip``: + +.. code-block:: bash + + $ pip install sophosfirewall-python + +Install +------- +The Sophos Firewall Ansible Collection can be installed using the ``ansible-galaxy`` command-line utility: + +.. code-block:: bash + + $ ansible-galaxy collection install sophos.sophos_firewall + + + diff --git a/docs/rst/docsite/setup.rst b/docs/rst/docsite/setup.rst new file mode 100644 index 0000000..27508d6 --- /dev/null +++ b/docs/rst/docsite/setup.rst @@ -0,0 +1,11 @@ +.. _ansible_collections.sophos.sophos_firewall.docsite.setup: + +Setup +===== +Prior to using the Ansible modules, the firewall must be set up to allow access to the API +from the IP address of the system running Ansible. + +In the firewall dashboard, navigate to **Backup & firmware** and click on the **API** tab. +Check the box to enable API Configuration, and add the Ansible controller to the Allowed IP address field. + +.. image:: ../../_static/images/setup.jpg diff --git a/docs/rst/index.rst b/docs/rst/index.rst index aaf611d..57cb5f3 100644 --- a/docs/rst/index.rst +++ b/docs/rst/index.rst @@ -7,7 +7,7 @@ Sophos.Sophos_Firewall ====================== -Collection version 1.0.0 +Collection version 1.2.0 .. contents:: :local: @@ -16,7 +16,7 @@ Collection version 1.0.0 Description ----------- -This Ansible collection contains modules for working with Sophos Firewall \ +This Ansible collection contains modules for working with Sophos Firewall (https://www.sophos.com/en-us/products/next-gen-firewall) **Author:** @@ -31,9 +31,6 @@ This Ansible collection contains modules for working with Sophos Firewall \`_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1529,9 +1529,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_atp_module.rst b/docs/rst/sfos_atp_module.rst index 6bd9fa2..cd6c485 100644 --- a/docs/rst/sfos_atp_module.rst +++ b/docs/rst/sfos_atp_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_atp module -- Manage Active Threat Protection (Prote .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -563,9 +563,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_backup_module.rst b/docs/rst/sfos_backup_module.rst index 89c1a1f..b385554 100644 --- a/docs/rst/sfos_backup_module.rst +++ b/docs/rst/sfos_backup_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_backup module -- Manage Backup settings (System \> B .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -908,9 +908,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_device_access_profile_module.rst b/docs/rst/sfos_device_access_profile_module.rst index a75204d..6ac092a 100644 --- a/docs/rst/sfos_device_access_profile_module.rst +++ b/docs/rst/sfos_device_access_profile_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_device_access_profile module -- Manage Device Access .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -3013,9 +3013,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_dns_module.rst b/docs/rst/sfos_dns_module.rst index ce6e65d..7557db4 100644 --- a/docs/rst/sfos_dns_module.rst +++ b/docs/rst/sfos_dns_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_dns module -- Manage DNS settings (Configure \> Netw .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -898,9 +898,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_firewall_rule_module.rst b/docs/rst/sfos_firewall_rule_module.rst index 9adb3fc..0e0c002 100644 --- a/docs/rst/sfos_firewall_rule_module.rst +++ b/docs/rst/sfos_firewall_rule_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_firewall_rule module -- Manage Firewall Rules (Prote .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -922,9 +922,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_fqdn_host_module.rst b/docs/rst/sfos_fqdn_host_module.rst index c5cd183..92f95df 100644 --- a/docs/rst/sfos_fqdn_host_module.rst +++ b/docs/rst/sfos_fqdn_host_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_fqdn_host module -- Manage FQDN hosts (System \> Hos .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -589,9 +589,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_fqdn_hostgroup_module.rst b/docs/rst/sfos_fqdn_hostgroup_module.rst index 5e52ae6..8f5c477 100644 --- a/docs/rst/sfos_fqdn_hostgroup_module.rst +++ b/docs/rst/sfos_fqdn_hostgroup_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_fqdn_hostgroup module -- Manage FQDN Host Groups (Sy .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -603,9 +603,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_ip_host_module.rst b/docs/rst/sfos_ip_host_module.rst index 98b8cf1..7e3296e 100644 --- a/docs/rst/sfos_ip_host_module.rst +++ b/docs/rst/sfos_ip_host_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_ip_host module -- Manage IP Host (System \> Hosts & .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -703,9 +703,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_ip_hostgroup_module.rst b/docs/rst/sfos_ip_hostgroup_module.rst index 581a1e2..bbd719b 100644 --- a/docs/rst/sfos_ip_hostgroup_module.rst +++ b/docs/rst/sfos_ip_hostgroup_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_ip_hostgroup module -- Manage IP Hostgroup (System \ .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -603,9 +603,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_ips_module.rst b/docs/rst/sfos_ips_module.rst index 3636870..8a338e9 100644 --- a/docs/rst/sfos_ips_module.rst +++ b/docs/rst/sfos_ips_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_ips module -- Manage IPS protection (Protect \> Intr .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -37,7 +37,7 @@ sophos.sophos_firewall.sfos_ips module -- Manage IPS protection (Protect \> Intr .. rst-class:: ansible-version-added -New in sophos.sophos\_firewall 1.0.0 +New in sophos.sophos\_firewall 1.2.0 .. contents:: :local: @@ -477,9 +477,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_malware_protection_module.rst b/docs/rst/sfos_malware_protection_module.rst index 38d2b06..89cf118 100644 --- a/docs/rst/sfos_malware_protection_module.rst +++ b/docs/rst/sfos_malware_protection_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_malware_protection module -- Manage Malware Protecti .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -477,9 +477,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_service_acl_exception_module.rst b/docs/rst/sfos_service_acl_exception_module.rst index 91d9f54..5978a7b 100644 --- a/docs/rst/sfos_service_acl_exception_module.rst +++ b/docs/rst/sfos_service_acl_exception_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_service_acl_exception module -- Manage Local Service .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -779,9 +779,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_service_module.rst b/docs/rst/sfos_service_module.rst index 1a2b581..3623076 100644 --- a/docs/rst/sfos_service_module.rst +++ b/docs/rst/sfos_service_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_service module -- Manage Service (System \> Hosts an .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -847,9 +847,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_servicegroup_module.rst b/docs/rst/sfos_servicegroup_module.rst index 993a5d8..bd94e30 100644 --- a/docs/rst/sfos_servicegroup_module.rst +++ b/docs/rst/sfos_servicegroup_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_servicegroup module -- Manage Service Group (System .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -560,9 +560,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_snmp_agent_module.rst b/docs/rst/sfos_snmp_agent_module.rst index 30159a8..2afffd0 100644 --- a/docs/rst/sfos_snmp_agent_module.rst +++ b/docs/rst/sfos_snmp_agent_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_snmp_agent module -- Manage SNMP Agent (System \> Ad .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -617,9 +617,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_snmp_user_module.rst b/docs/rst/sfos_snmp_user_module.rst index 5f31a40..918e962 100644 --- a/docs/rst/sfos_snmp_user_module.rst +++ b/docs/rst/sfos_snmp_user_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_snmp_user module -- Manage SNMPv3 User (System \> Ad .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -780,9 +780,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_syslog_module.rst b/docs/rst/sfos_syslog_module.rst index 7c97e44..34934dc 100644 --- a/docs/rst/sfos_syslog_module.rst +++ b/docs/rst/sfos_syslog_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_syslog module -- Manage Syslog servers (Configure \> .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -37,7 +37,7 @@ sophos.sophos_firewall.sfos_syslog module -- Manage Syslog servers (Configure \> .. rst-class:: ansible-version-added -New in sophos.sophos\_firewall 1.0.0 +New in sophos.sophos\_firewall 1.2.0 .. contents:: :local: @@ -3749,9 +3749,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_time_module.rst b/docs/rst/sfos_time_module.rst index 605c73b..c2f1ccb 100644 --- a/docs/rst/sfos_time_module.rst +++ b/docs/rst/sfos_time_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_time module -- Manage Date and Time settings (System .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -789,9 +789,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_user_module.rst b/docs/rst/sfos_user_module.rst index a4d418d..61fdaf1 100644 --- a/docs/rst/sfos_user_module.rst +++ b/docs/rst/sfos_user_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_user module -- Manage Users (Configure \> Authentica .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1272,9 +1272,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_xmlapi_module.rst b/docs/rst/sfos_xmlapi_module.rst index 552a394..5ba8f27 100644 --- a/docs/rst/sfos_xmlapi_module.rst +++ b/docs/rst/sfos_xmlapi_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_xmlapi module -- Use the XML API to get, create, upd .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -689,9 +689,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/rst/sfos_zone_module.rst b/docs/rst/sfos_zone_module.rst index 34e272e..a27a394 100644 --- a/docs/rst/sfos_zone_module.rst +++ b/docs/rst/sfos_zone_module.rst @@ -22,7 +22,7 @@ sophos.sophos_firewall.sfos_zone module -- Manage Zones (Configure \> Network \> .. Collection note .. note:: - This module is part of the `sophos.sophos_firewall collection `_ (version 1.0.0). + This module is part of the `sophos.sophos_firewall collection `_ (version 1.2.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1368,9 +1368,6 @@ Collection links - title: "Issue Tracker" url: "https://github.com/sophos/sophosfirewall-ansible/issues" external: true - - title: "Homepage" - url: "http://example.com" - external: true - title: "Repository (Sources)" url: "https://github.com/sophos/sophosfirewall-ansible" external: true diff --git a/docs/static/images/setup.jpg b/docs/static/images/setup.jpg new file mode 100644 index 0000000..694f07c Binary files /dev/null and b/docs/static/images/setup.jpg differ diff --git a/galaxy.yml b/galaxy.yml index 1ae1b60..897904b 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -8,7 +8,7 @@ namespace: sophos name: sophos_firewall # The version of the collection. Must be compatible with semantic versioning -version: 1.0.0 +version: 1.2.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md @@ -21,7 +21,7 @@ authors: ### OPTIONAL but strongly recommended # A short summary description of the collection -description: This Ansible collection contains modules for working with Sophos Firewall +description: This Ansible collection contains modules for working with Sophos Firewall (https://www.sophos.com/en-us/products/next-gen-firewall) # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file' @@ -46,10 +46,10 @@ dependencies: {} repository: https://github.com/sophos/sophosfirewall-ansible # The URL to any online docs -documentation: http://docs.example.com +documentation: https://sophosfirewall-ansible.readthedocs.io # The URL to the homepage of the collection/project -homepage: http://example.com +homepage: https://sophosfirewall-ansible.readthedocs.io # The URL to the collection issue tracker issues: https://github.com/sophos/sophosfirewall-ansible/issues