-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(module/panos_edl): New module for External Dynamic Lists (#512)
- Loading branch information
1 parent
218e2d2
commit 1e33995
Showing
5 changed files
with
174 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| #!/usr/bin/python | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| # Copyright 2023 Palo Alto Networks, Inc | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import absolute_import, division, print_function | ||
|
|
||
| __metaclass__ = type | ||
|
|
||
| DOCUMENTATION = """ | ||
| --- | ||
| module: panos_edl | ||
| short_description: Manage external dynamic lists on PAN-OS devices. | ||
| description: | ||
| - Manage external dynamic lists on PAN-OS devices. | ||
| author: | ||
| - Sebastian Czech (@sebastianczech) | ||
| version_added: '2.18.0' | ||
| requirements: | ||
| - pan-python can be obtained from PyPI U(https://pypi.python.org/pypi/pan-python) | ||
| - pandevice can be obtained from PyPI U(https://pypi.python.org/pypi/pandevice) | ||
| notes: | ||
| - Panorama is supported. | ||
| - Check mode is supported. | ||
| extends_documentation_fragment: | ||
| - paloaltonetworks.panos.fragments.transitional_provider | ||
| - paloaltonetworks.panos.fragments.vsys | ||
| - paloaltonetworks.panos.fragments.device_group | ||
| - paloaltonetworks.panos.fragments.network_resource_module_state | ||
| - paloaltonetworks.panos.fragments.deprecated_commit | ||
| - paloaltonetworks.panos.fragments.gathered_filter | ||
| options: | ||
| name: | ||
| description: Name of External Dynamic List to create. | ||
| type: str | ||
| description: | ||
| description: Descriptive name for this EDL. | ||
| type: str | ||
| edl_type: | ||
| description: The EDL type. | ||
| type: str | ||
| choices: | ||
| - "ip" | ||
| - "domain" | ||
| - "url" | ||
| source: | ||
| description: Source. | ||
| type: str | ||
| expand_domain: | ||
| description: | ||
| - PAN-OS 9.0+ | ||
| - Enable/disable expand domain (requires `edl_type=domain`) | ||
| type: bool | ||
| default: false | ||
| certificate_profile: | ||
| description: | ||
| - PAN-OS 8.0+ | ||
| - Profile for authenticating client certificates | ||
| type: str | ||
| exceptions: | ||
| description: | ||
| - PAN-OS 8.0+ | ||
| - Exceptions. | ||
| type: list | ||
| elements: str | ||
| repeat: | ||
| description: Retrieval interval. | ||
| type: str | ||
| choices: | ||
| - "five-minute" | ||
| - "hourly" | ||
| - "daily" | ||
| - "weekly" | ||
| - "monthly" | ||
| repeat_at: | ||
| description: The time specification for the given repeat value. | ||
| type: str | ||
| repeat_day_of_week: | ||
| description: For `repeat=daily`, the day of the week. | ||
| type: str | ||
| repeat_day_of_month: | ||
| description: For `repeat=monthly`, the day of the month. | ||
| type: str | ||
| """ | ||
|
|
||
| EXAMPLES = """ | ||
| - name: Create EDL 'test-edl' | ||
| paloaltonetworks.panos.panos_edl: | ||
| provider: '{{ device }}' | ||
| name: 'test-edl' | ||
| description: 'EDL description' | ||
| edl_type: 'ip' | ||
| source: 'http://1.2.3.4' | ||
| certificate_profile: 'pan-lab-cert-profile' | ||
| repeat: 'hourly' | ||
| state: 'present' | ||
| - name: Delete EDL 'test-edl' | ||
| paloaltonetworks.panos.panos_edl: | ||
| provider: '{{ provider }}' | ||
| name: 'test-edl' | ||
| state: 'absent' | ||
| """ | ||
|
|
||
| RETURN = """ | ||
| # Default return values | ||
| """ | ||
|
|
||
| from ansible.module_utils.basic import AnsibleModule | ||
| from ansible_collections.paloaltonetworks.panos.plugins.module_utils.panos import ( | ||
| get_connection, | ||
| ) | ||
|
|
||
|
|
||
| def main(): | ||
| helper = get_connection( | ||
| vsys=True, | ||
| device_group=True, | ||
| with_classic_provider_spec=True, | ||
| with_network_resource_module_state=True, | ||
| with_commit=True, | ||
| with_gathered_filter=True, | ||
| sdk_cls=("objects", "Edl"), | ||
| sdk_params=dict( | ||
| name=dict(required=True), | ||
| description=dict(), | ||
| edl_type=dict( | ||
| type="str", | ||
| choices=["ip", "domain", "url"], | ||
| ), | ||
| source=dict(), | ||
| expand_domain=dict( | ||
| type="bool", | ||
| default=False, | ||
| ), | ||
| certificate_profile=dict(), | ||
| exceptions=dict(type="list", elements="str"), | ||
| repeat=dict( | ||
| type="str", | ||
| choices=["five-minute", "hourly", "daily", "weekly", "monthly"], | ||
| ), | ||
| repeat_at=dict(), | ||
| repeat_day_of_week=dict(), | ||
| repeat_day_of_month=dict(), | ||
| ), | ||
| ) | ||
|
|
||
| module = AnsibleModule( | ||
| argument_spec=helper.argument_spec, | ||
| required_one_of=helper.required_one_of, | ||
| supports_check_mode=True, | ||
| ) | ||
|
|
||
| helper.process(module) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters