Merge pull request #1 from PaloAltoNetworks/develop

Release 1.0.1
PaloAltoNetworks · Feb 6, 2020 · a6b1681 · a6b1681
2 parents 35d5f87 + fb508fb
commit a6b1681
Show file tree

Hide file tree

Showing 78 changed files with 332 additions and 318 deletions.
diff --git a/.github/workflows/galaxy-publish.yml b/.github/workflows/galaxy-publish.yml
@@ -4,7 +4,6 @@ on:
   release:
     types:
       - published
-      - created
 
 jobs:
   build:
@@ -27,4 +26,4 @@ jobs:
       env:
         GALAXY_API_KEY: ${{ secrets.GALAXY_API_KEY }}
       run: |
-        ansible-galaxy collection publish --api-key ${GALAXY_API_KEY} Palo*
+        ansible-galaxy collection publish --api-key ${GALAXY_API_KEY} palo*
diff --git a/.github/workflows/syntax-check.yml b/.github/workflows/syntax-check.yml
@@ -22,10 +22,17 @@ jobs:
       run: |
         pip install ansible
         ansible-galaxy collection build
-        ansible-galaxy collection install PaloAltoNetworks*
+        ansible-galaxy collection install paloaltonetworks*
     - name: Perform Syntax Check
       run: |
         find ./plugins -name \*.py -exec pycodestyle --max-line-length=120 --ignore=E402,E121,E123,E126,E133,E226,E241,E242,E704,W503,W504,W505 {} +
+    - name: Verify documentation can be built
+      run: |
+        for i in $(ls -1 plugins/modules | grep -v init)
+        do
+          echo "Checking $i..."
+          ansible-doc -M plugins/modules $i > /dev/null
+        done
     - name: Run unittests
       run: |
         pip install pytest
diff --git a/galaxy.yml b/galaxy.yml
@@ -3,13 +3,13 @@
 # The namespace of the collection. This can be a company/brand/organization or product namespace under which all
 # content lives. May only contain alphanumeric characters and underscores. Additionally namespaces cannot start with
 # underscores or numbers and cannot contain consecutive underscores
-namespace: 'PaloAltoNetworks'
+namespace: 'paloaltonetworks'
 
 # The name of the collection. Has the same character restrictions as 'namespace'
 name: 'panos'
 
 # The version of the collection. Must be compatible with semantic versioning
-version: '1.0.0'
+version: '1.0.1'
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: 'README.md'

diff --git a/plugins/doc_fragments/panos.py → plugins/doc_fragments/fragments.py b/plugins/doc_fragments/panos.py → plugins/doc_fragments/fragments.py
@@ -164,6 +164,20 @@ class ModuleDocFragment(object):
             - absent
 '''
 
+    ENABLED_STATE = r'''
+options:
+    state:
+        description:
+            - The state.
+        type: str
+        default: present
+        choices:
+            - present
+            - absent
+            - enabled
+            - disabled
+'''
+
     RULEBASE = r'''
 options:
     rulebase:

diff --git a/plugins/modules/panos_address_group.py b/plugins/modules/panos_address_group.py
@@ -39,10 +39,10 @@
     - Panorama is supported.
     - Check mode is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.vsys
-    - panos.device_group
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.vsys
+    - paloaltonetworks.panos.fragments.device_group
+    - paloaltonetworks.panos.fragments.state
 options:
     name:
         description:
@@ -98,7 +98,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_address_object.py b/plugins/modules/panos_address_object.py
@@ -39,10 +39,10 @@
     - Panorama is supported.
     - Check mode is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.vsys
-    - panos.device_group
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.vsys
+    - paloaltonetworks.panos.fragments.device_group
+    - paloaltonetworks.panos.fragments.state
 options:
     name:
         description:
@@ -111,7 +111,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 try:
     from pandevice.objects import AddressObject

diff --git a/plugins/modules/panos_administrator.py b/plugins/modules/panos_administrator.py
@@ -42,9 +42,9 @@
       I(state=present) with I(admin_password) specified will always report
       I(changed=True) in the return value.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.state
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.state
+    - paloaltonetworks.panos.fragments.full_template_support
 options:
     admin_username:
         description:
@@ -135,7 +135,7 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_aggregate_interface.py b/plugins/modules/panos_aggregate_interface.py
@@ -31,10 +31,10 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.vsys_import
-    - panos.template_only
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.vsys_import
+    - paloaltonetworks.panos.fragments.template_only
+    - paloaltonetworks.panos.fragments.state
 options:
     if_name:
         description:
@@ -73,11 +73,11 @@
             - Netflow profile for aggregate interface.
     lldp_enabled:
         description:
-            - Layer2: Enable LLDP
+            - (Layer2) Enable LLDP
         type: bool
     lldp_profile:
         description:
-            - Layer2: Reference to an lldp profile
+            - (Layer2) Reference to an lldp profile
     comment:
         description:
             - Interface comment.
@@ -133,7 +133,7 @@
                     'supported_by': 'community'}
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_api_key.py b/plugins/modules/panos_api_key.py
@@ -39,7 +39,7 @@
     - Panorama is supported.
     - Checkmode is NOT supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
+    - paloaltonetworks.panos.fragments.transitional_provider
 '''
 
 EXAMPLES = '''
@@ -65,7 +65,7 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 def main():

diff --git a/plugins/modules/panos_bgp.py b/plugins/modules/panos_bgp.py
@@ -40,22 +40,14 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.full_template_support
+    - paloaltonetworks.panos.fragments.enabled_state
 options:
     commit:
         description:
             - Commit configuration if changed.
         default: true
-    state:
-        description:
-            - The state.
-        choices:
-            - present
-            - absent
-            - enabled
-            - disabled
-        default: 'present'
     enable:
         description:
             - Enable BGP.
@@ -146,7 +138,7 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_aggregate.py b/plugins/modules/panos_bgp_aggregate.py
@@ -40,9 +40,9 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.state
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.state
+    - paloaltonetworks.panos.fragments.full_template_support
 options:
     commit:
         description:
@@ -157,7 +157,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_auth.py b/plugins/modules/panos_bgp_auth.py
@@ -43,9 +43,9 @@
       if the secret is properly set or not.  Invoking this module with I(state=present)
       will always apply the config to PAN-OS.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.state
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.state
+    - paloaltonetworks.panos.fragments.full_template_support
 options:
     commit:
         description:
@@ -87,7 +87,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_conditional_advertisement.py b/plugins/modules/panos_bgp_conditional_advertisement.py
@@ -49,9 +49,9 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.full_template_support
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.full_template_support
+    - paloaltonetworks.panos.fragments.state
 options:
     commit:
         description:
@@ -105,7 +105,7 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_dampening.py b/plugins/modules/panos_bgp_dampening.py
@@ -40,9 +40,9 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.full_template_support
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.full_template_support
+    - paloaltonetworks.panos.fragments.state
 options:
     commit:
         description:
@@ -98,7 +98,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_peer.py b/plugins/modules/panos_bgp_peer.py
@@ -40,9 +40,9 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.full_template_support
-    - panos.state
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.full_template_support
+    - paloaltonetworks.panos.fragments.state
 options:
     commit:
         description:
@@ -183,7 +183,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_peer_group.py b/plugins/modules/panos_bgp_peer_group.py
@@ -40,9 +40,9 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.state
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.state
+    - paloaltonetworks.panos.fragments.full_template_support
 options:
     commit:
         description:
@@ -115,7 +115,7 @@
 '''
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 
 
 try:

diff --git a/plugins/modules/panos_bgp_policy_filter.py b/plugins/modules/panos_bgp_policy_filter.py
@@ -40,8 +40,8 @@
     - Checkmode is supported.
     - Panorama is supported.
 extends_documentation_fragment:
-    - panos.transitional_provider
-    - panos.full_template_support
+    - paloaltonetworks.panos.fragments.transitional_provider
+    - paloaltonetworks.panos.fragments.full_template_support
 options:
     state:
         description:
@@ -149,7 +149,7 @@
 
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.PaloAltoNetworks.panos.plugins.module_utils.panos import get_connection
+from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import get_connection
 from ansible.module_utils._text import to_text