From 8e965c59867791a0132cc9e1a6b88735b9a369c4 Mon Sep 17 00:00:00 2001 From: Gaurav Rastogi Date: Tue, 23 Jan 2018 12:22:54 -0800 Subject: [PATCH] New module to setup WAF profile. (#34363) * New module to setup WAF profile. * Update copyright notice. * updated required fields --- .../modules/network/avi/avi_wafprofile.py | 125 ++++++++++++++++++ 1 file changed, 125 insertions(+) create mode 100644 lib/ansible/modules/network/avi/avi_wafprofile.py diff --git a/lib/ansible/modules/network/avi/avi_wafprofile.py b/lib/ansible/modules/network/avi/avi_wafprofile.py new file mode 100644 index 0000000000..01e4fb2d47 --- /dev/null +++ b/lib/ansible/modules/network/avi/avi_wafprofile.py @@ -0,0 +1,125 @@ +#!/usr/bin/python +# +# @author: Gaurav Rastogi (grastogi@avinetworks.com) +# Eric Anderson (eanderson@avinetworks.com) +# module_check: supported +# +# Copyright: (c) 2017 Gaurav Rastogi, +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +# + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community'} + +DOCUMENTATION = ''' +--- +module: avi_wafprofile +author: Gaurav Rastogi (grastogi@avinetworks.com) + +short_description: Module for setup of WafProfile Avi RESTful Object +description: + - This module is used to configure WafProfile object + - more examples at U(https://github.com/avinetworks/devops) +requirements: [ avisdk ] +version_added: "2.5" +options: + state: + description: + - The state that should be applied on the entity. + default: present + choices: ["absent", "present"] + avi_api_update_method: + description: + - Default method for object update is HTTP PUT. + - Setting to patch will override that behavior to use HTTP PATCH. + version_added: "2.5" + default: put + choices: ["put", "patch"] + avi_api_patch_op: + description: + - Patch operation to use when using avi_api_update_method as patch. + version_added: "2.5" + choices: ["add", "replace", "delete"] + config: + description: + - Config params for waf. + - Field introduced in 17.2.1. + required: true + description: + description: + - Field introduced in 17.2.1. + files: + description: + - List of data files used for waf rules. + - Field introduced in 17.2.1. + name: + description: + - Field introduced in 17.2.1. + required: true + tenant_ref: + description: + - It is a reference to an object of type tenant. + - Field introduced in 17.2.1. + url: + description: + - Avi controller URL of the object. + uuid: + description: + - Field introduced in 17.2.1. +extends_documentation_fragment: + - avi +''' + +EXAMPLES = """ +- name: Example to create WafProfile object + avi_wafprofile: + controller: 10.10.25.42 + username: admin + password: something + state: present + name: sample_wafprofile +""" + +RETURN = ''' +obj: + description: WafProfile (api/wafprofile) object + returned: success, changed + type: dict +''' + +from ansible.module_utils.basic import AnsibleModule +try: + from ansible.module_utils.network.avi.avi import ( + avi_common_argument_spec, HAS_AVI, avi_ansible_api) +except ImportError: + HAS_AVI = False + + +def main(): + argument_specs = dict( + state=dict(default='present', + choices=['absent', 'present']), + avi_api_update_method=dict(default='put', + choices=['put', 'patch']), + avi_api_patch_op=dict(choices=['add', 'replace', 'delete']), + config=dict(type='dict', required=True), + description=dict(type='str',), + files=dict(type='list',), + name=dict(type='str', required=True), + tenant_ref=dict(type='str',), + url=dict(type='str',), + uuid=dict(type='str',), + ) + argument_specs.update(avi_common_argument_spec()) + module = AnsibleModule( + argument_spec=argument_specs, supports_check_mode=True) + if not HAS_AVI: + return module.fail_json(msg=( + 'Avi python API SDK (avisdk>=17.1) is not installed. ' + 'For more details visit https://github.com/avinetworks/sdk.')) + return avi_ansible_api(module, 'wafprofile', + set([])) + +if __name__ == '__main__': + main()