added bigip_asm_policy_manage (#50115)
* added bigip_asm_policy_manage * Update bigip_asm_policy_manage.py
This commit is contained in:
parent
756ad176cc
commit
59f4871615
2 changed files with 1396 additions and 0 deletions
897
lib/ansible/modules/network/f5/bigip_asm_policy_manage.py
Normal file
897
lib/ansible/modules/network/f5/bigip_asm_policy_manage.py
Normal file
|
@ -0,0 +1,897 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright: (c) 2018, F5 Networks Inc.
|
||||||
|
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'certified'}
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
---
|
||||||
|
module: bigip_asm_policy_manage
|
||||||
|
short_description: Manage BIG-IP ASM policies
|
||||||
|
description:
|
||||||
|
- Manage BIG-IP ASM policies, create from templates and manage global policy settings.
|
||||||
|
version_added: 2.8
|
||||||
|
options:
|
||||||
|
active:
|
||||||
|
description:
|
||||||
|
- If C(yes) will apply and activate existing inactive policy. If C(no), it will
|
||||||
|
deactivate existing active policy. Generally should be C(yes) only in cases where
|
||||||
|
you want to activate new or existing policy.
|
||||||
|
default: no
|
||||||
|
type: bool
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- The ASM policy to manage or create.
|
||||||
|
required: True
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- When C(state) is C(present), and C(template) parameter is provided,
|
||||||
|
new ASM policy is created from template with the given C(name).
|
||||||
|
- When C(state) is present and no C(template) parameter is provided
|
||||||
|
new blank ASM policy is created with the given C(name).
|
||||||
|
- When C(state) is C(absent), ensures that the policy is removed, even if it is
|
||||||
|
currently active.
|
||||||
|
choices:
|
||||||
|
- present
|
||||||
|
- absent
|
||||||
|
default: present
|
||||||
|
template:
|
||||||
|
description:
|
||||||
|
- An ASM policy built-in template. If the template does not exist we will raise an error.
|
||||||
|
- Once the policy has been created, this value cannot change.
|
||||||
|
- The C(Comprehensive), C(Drupal), C(Fundamental), C(Joomla),
|
||||||
|
C(Vulnerability Assessment Baseline), and C(Wordpress) templates are only available
|
||||||
|
on BIG-IP versions >= 13.
|
||||||
|
choices:
|
||||||
|
- ActiveSync v1.0 v2.0 (http)
|
||||||
|
- ActiveSync v1.0 v2.0 (https)
|
||||||
|
- Comprehensive
|
||||||
|
- Drupal
|
||||||
|
- Fundamental
|
||||||
|
- Joomla
|
||||||
|
- LotusDomino 6.5 (http)
|
||||||
|
- LotusDomino 6.5 (https)
|
||||||
|
- OWA Exchange 2003 (http)
|
||||||
|
- OWA Exchange 2003 (https)
|
||||||
|
- OWA Exchange 2003 with ActiveSync (http)
|
||||||
|
- OWA Exchange 2003 with ActiveSync (https)
|
||||||
|
- OWA Exchange 2007 (http)
|
||||||
|
- OWA Exchange 2007 (https)
|
||||||
|
- OWA Exchange 2007 with ActiveSync (http)
|
||||||
|
- OWA Exchange 2007 with ActiveSync (https)
|
||||||
|
- OWA Exchange 2010 (http)
|
||||||
|
- OWA Exchange 2010 (https)
|
||||||
|
- Oracle 10g Portal (http)
|
||||||
|
- Oracle 10g Portal (https)
|
||||||
|
- Oracle Applications 11i (http)
|
||||||
|
- Oracle Applications 11i (https)
|
||||||
|
- PeopleSoft Portal 9 (http)
|
||||||
|
- PeopleSoft Portal 9 (https)
|
||||||
|
- Rapid Deployment Policy
|
||||||
|
- SAP NetWeaver 7 (http)
|
||||||
|
- SAP NetWeaver 7 (https)
|
||||||
|
- SharePoint 2003 (http)
|
||||||
|
- SharePoint 2003 (https)
|
||||||
|
- SharePoint 2007 (http)
|
||||||
|
- SharePoint 2007 (https)
|
||||||
|
- SharePoint 2010 (http)
|
||||||
|
- SharePoint 2010 (https)
|
||||||
|
- Vulnerability Assessment Baseline
|
||||||
|
- Wordpress
|
||||||
|
partition:
|
||||||
|
description:
|
||||||
|
- Device partition to manage resources on.
|
||||||
|
default: Common
|
||||||
|
extends_documentation_fragment: f5
|
||||||
|
author:
|
||||||
|
- Wojciech Wypior (@wojtek0806)
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- name: Create ASM policy from template
|
||||||
|
bigip_asm_policy:
|
||||||
|
name: new_sharepoint_policy
|
||||||
|
template: SharePoint 2007 (http)
|
||||||
|
state: present
|
||||||
|
provider:
|
||||||
|
server: lb.mydomain.com
|
||||||
|
user: admin
|
||||||
|
password: secret
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Create blank ASM policy
|
||||||
|
bigip_asm_policy:
|
||||||
|
name: new_blank_policy
|
||||||
|
state: present
|
||||||
|
provider:
|
||||||
|
server: lb.mydomain.com
|
||||||
|
user: admin
|
||||||
|
password: secret
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Create blank ASM policy and activate
|
||||||
|
bigip_asm_policy:
|
||||||
|
name: new_blank_policy
|
||||||
|
active: yes
|
||||||
|
state: present
|
||||||
|
provider:
|
||||||
|
server: lb.mydomain.com
|
||||||
|
user: admin
|
||||||
|
password: secret
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Activate ASM policy
|
||||||
|
bigip_asm_policy:
|
||||||
|
name: inactive_policy
|
||||||
|
active: yes
|
||||||
|
state: present
|
||||||
|
provider:
|
||||||
|
server: lb.mydomain.com
|
||||||
|
user: admin
|
||||||
|
password: secret
|
||||||
|
delegate_to: localhost
|
||||||
|
|
||||||
|
- name: Deactivate ASM policy
|
||||||
|
bigip_asm_policy_manage:
|
||||||
|
name: active_policy
|
||||||
|
state: present
|
||||||
|
provider:
|
||||||
|
server: lb.mydomain.com
|
||||||
|
user: admin
|
||||||
|
password: secret
|
||||||
|
delegate_to: localhost
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = r'''
|
||||||
|
active:
|
||||||
|
description: Set when activating/deactivating ASM policy
|
||||||
|
returned: changed
|
||||||
|
type: bool
|
||||||
|
sample: yes
|
||||||
|
state:
|
||||||
|
description: Action performed on the target device.
|
||||||
|
returned: changed
|
||||||
|
type: str
|
||||||
|
sample: absent
|
||||||
|
template:
|
||||||
|
description: Name of the built-in ASM policy template
|
||||||
|
returned: changed
|
||||||
|
type: str
|
||||||
|
sample: OWA Exchange 2007 (https)
|
||||||
|
name:
|
||||||
|
description: Name of the ASM policy to be managed/created
|
||||||
|
returned: changed
|
||||||
|
type: str
|
||||||
|
sample: Asm_APP1_Transparent
|
||||||
|
'''
|
||||||
|
|
||||||
|
import time
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.basic import env_fallback
|
||||||
|
from distutils.version import LooseVersion
|
||||||
|
|
||||||
|
try:
|
||||||
|
from library.module_utils.network.f5.bigip import F5RestClient
|
||||||
|
from library.module_utils.network.f5.common import F5ModuleError
|
||||||
|
from library.module_utils.network.f5.common import AnsibleF5Parameters
|
||||||
|
from library.module_utils.network.f5.common import cleanup_tokens
|
||||||
|
from library.module_utils.network.f5.common import fq_name
|
||||||
|
from library.module_utils.network.f5.common import transform_name
|
||||||
|
from library.module_utils.network.f5.common import f5_argument_spec
|
||||||
|
from library.module_utils.network.f5.common import exit_json
|
||||||
|
from library.module_utils.network.f5.common import fail_json
|
||||||
|
from library.module_utils.network.f5.icontrol import tmos_version
|
||||||
|
from library.module_utils.network.f5.icontrol import module_provisioned
|
||||||
|
except ImportError:
|
||||||
|
from ansible.module_utils.network.f5.bigip import F5RestClient
|
||||||
|
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||||
|
from ansible.module_utils.network.f5.common import AnsibleF5Parameters
|
||||||
|
from ansible.module_utils.network.f5.common import cleanup_tokens
|
||||||
|
from ansible.module_utils.network.f5.common import fq_name
|
||||||
|
from ansible.module_utils.network.f5.common import transform_name
|
||||||
|
from ansible.module_utils.network.f5.common import f5_argument_spec
|
||||||
|
from ansible.module_utils.network.f5.common import exit_json
|
||||||
|
from ansible.module_utils.network.f5.common import fail_json
|
||||||
|
from ansible.module_utils.network.f5.icontrol import tmos_version
|
||||||
|
from ansible.module_utils.network.f5.icontrol import module_provisioned
|
||||||
|
|
||||||
|
|
||||||
|
class Parameters(AnsibleF5Parameters):
|
||||||
|
updatables = [
|
||||||
|
'active',
|
||||||
|
]
|
||||||
|
|
||||||
|
returnables = [
|
||||||
|
'name',
|
||||||
|
'template',
|
||||||
|
'active',
|
||||||
|
]
|
||||||
|
|
||||||
|
api_attributes = [
|
||||||
|
'name',
|
||||||
|
'active',
|
||||||
|
]
|
||||||
|
api_map = {
|
||||||
|
}
|
||||||
|
|
||||||
|
@property
|
||||||
|
def template_link(self):
|
||||||
|
if self._values['template_link'] is not None:
|
||||||
|
return self._values['template_link']
|
||||||
|
|
||||||
|
result = None
|
||||||
|
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policy-templates/".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
|
||||||
|
query = "?$filter=contains(name,'{0}')".format(self.template.upper())
|
||||||
|
resp = self.client.api.get(uri + query)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] == 400:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
if 'items' in response and response['items'] != []:
|
||||||
|
result = dict(link=response['items'][0]['selfLink'])
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
|
def to_return(self):
|
||||||
|
result = {}
|
||||||
|
for returnable in self.returnables:
|
||||||
|
result[returnable] = getattr(self, returnable)
|
||||||
|
result = self._filter_params(result)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
class V1Parameters(Parameters):
|
||||||
|
@property
|
||||||
|
def template(self):
|
||||||
|
if self._values['template'] is None:
|
||||||
|
return None
|
||||||
|
template_map = {
|
||||||
|
'ActiveSync v1.0 v2.0 (http)': 'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTP',
|
||||||
|
'ActiveSync v1.0 v2.0 (https)': 'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTPS',
|
||||||
|
'LotusDomino 6.5 (http)': 'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTP',
|
||||||
|
'LotusDomino 6.5 (https)': 'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTPS',
|
||||||
|
'OWA Exchange 2003 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTP',
|
||||||
|
'OWA Exchange 2003 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTPS',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTP',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTPS',
|
||||||
|
'OWA Exchange 2007 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTP',
|
||||||
|
'OWA Exchange 2007 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTPS',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTP',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTPS',
|
||||||
|
'OWA Exchange 2010 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTP',
|
||||||
|
'OWA Exchange 2010 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTPS',
|
||||||
|
'Oracle 10g Portal (http)': 'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTP',
|
||||||
|
'Oracle 10g Portal (https)': 'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTPS',
|
||||||
|
'Oracle Applications 11i (http)': 'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTP',
|
||||||
|
'Oracle Applications 11i (https)': 'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTPS',
|
||||||
|
'PeopleSoft Portal 9 (http)': 'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTP',
|
||||||
|
'PeopleSoft Portal 9 (https)': 'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTPS',
|
||||||
|
'Rapid Deployment Policy': 'POLICY_TEMPLATE_RAPID_DEPLOYMENT',
|
||||||
|
'SAP NetWeaver 7 (http)': 'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTP',
|
||||||
|
'SAP NetWeaver 7 (https)': 'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTPS',
|
||||||
|
'SharePoint 2003 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2003_HTTP',
|
||||||
|
'SharePoint 2003 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2003_HTTPS',
|
||||||
|
'SharePoint 2007 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2007_HTTP',
|
||||||
|
'SharePoint 2007 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2007_HTTPS',
|
||||||
|
'SharePoint 2010 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2010_HTTP',
|
||||||
|
'SharePoint 2010 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2010_HTTPS'
|
||||||
|
}
|
||||||
|
if self._values['template'] in template_map:
|
||||||
|
return template_map[self._values['template']]
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(
|
||||||
|
"The specified template is not valid for this version of BIG-IP."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class V2Parameters(Parameters):
|
||||||
|
@property
|
||||||
|
def template(self):
|
||||||
|
if self._values['template'] is None:
|
||||||
|
return None
|
||||||
|
template_map = {
|
||||||
|
'ActiveSync v1.0 v2.0 (http)': 'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTP',
|
||||||
|
'ActiveSync v1.0 v2.0 (https)': 'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTPS',
|
||||||
|
'Comprehensive': 'POLICY_TEMPLATE_COMPREHENSIVE', # v13
|
||||||
|
'Drupal': 'POLICY_TEMPLATE_DRUPAL', # v13
|
||||||
|
'Fundamental': 'POLICY_TEMPLATE_FUNDAMENTAL', # v13
|
||||||
|
'Joomla': 'POLICY_TEMPLATE_JOOMLA', # v13
|
||||||
|
'LotusDomino 6.5 (http)': 'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTP',
|
||||||
|
'LotusDomino 6.5 (https)': 'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTPS',
|
||||||
|
'OWA Exchange 2003 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTP',
|
||||||
|
'OWA Exchange 2003 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTPS',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTP',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTPS',
|
||||||
|
'OWA Exchange 2007 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTP',
|
||||||
|
'OWA Exchange 2007 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTPS',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTP',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTPS',
|
||||||
|
'OWA Exchange 2010 (http)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTP',
|
||||||
|
'OWA Exchange 2010 (https)': 'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTPS',
|
||||||
|
'Oracle 10g Portal (http)': 'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTP',
|
||||||
|
'Oracle 10g Portal (https)': 'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTPS',
|
||||||
|
'Oracle Applications 11i (http)': 'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTP',
|
||||||
|
'Oracle Applications 11i (https)': 'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTPS',
|
||||||
|
'PeopleSoft Portal 9 (http)': 'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTP',
|
||||||
|
'PeopleSoft Portal 9 (https)': 'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTPS',
|
||||||
|
'Rapid Deployment Policy': 'POLICY_TEMPLATE_RAPID_DEPLOYMENT',
|
||||||
|
'SAP NetWeaver 7 (http)': 'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTP',
|
||||||
|
'SAP NetWeaver 7 (https)': 'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTPS',
|
||||||
|
'SharePoint 2003 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2003_HTTP',
|
||||||
|
'SharePoint 2003 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2003_HTTPS',
|
||||||
|
'SharePoint 2007 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2007_HTTP',
|
||||||
|
'SharePoint 2007 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2007_HTTPS',
|
||||||
|
'SharePoint 2010 (http)': 'POLICY_TEMPLATE_SHAREPOINT_2010_HTTP',
|
||||||
|
'SharePoint 2010 (https)': 'POLICY_TEMPLATE_SHAREPOINT_2010_HTTPS',
|
||||||
|
'Vulnerability Assessment Baseline': 'POLICY_TEMPLATE_VULNERABILITY_ASSESSMENT', # v13
|
||||||
|
'Wordpress': 'POLICY_TEMPLATE_WORDPRESS' # v13
|
||||||
|
}
|
||||||
|
return template_map[self._values['template']]
|
||||||
|
|
||||||
|
|
||||||
|
class Changes(Parameters):
|
||||||
|
@property
|
||||||
|
def template(self):
|
||||||
|
if self._values['template'] is None:
|
||||||
|
return None
|
||||||
|
template_map = {
|
||||||
|
'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTP': 'ActiveSync v1.0 v2.0 (http)',
|
||||||
|
'POLICY_TEMPLATE_ACTIVESYNC_V1_0_V2_0_HTTPS': 'ActiveSync v1.0 v2.0 (https)',
|
||||||
|
'POLICY_TEMPLATE_COMPREHENSIVE': 'Comprehensive',
|
||||||
|
'POLICY_TEMPLATE_DRUPAL': 'Drupal',
|
||||||
|
'POLICY_TEMPLATE_FUNDAMENTAL': 'Fundamental',
|
||||||
|
'POLICY_TEMPLATE_JOOMLA': 'Joomla',
|
||||||
|
'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTP': 'LotusDomino 6.5 (http)',
|
||||||
|
'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTPS': 'LotusDomino 6.5 (https)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTP': 'OWA Exchange 2003 (http)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2003_HTTPS': 'OWA Exchange 2003 (https)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTP': 'OWA Exchange 2003 with ActiveSync (http)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2003_WITH_ACTIVESYNC_HTTPS': 'OWA Exchange 2003 with ActiveSync (https)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTP': 'OWA Exchange 2007 (http)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2007_HTTPS': 'OWA Exchange 2007 (https)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTP': 'OWA Exchange 2007 with ActiveSync (http)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2007_WITH_ACTIVESYNC_HTTPS': 'OWA Exchange 2007 with ActiveSync (https)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTP': 'OWA Exchange 2010 (http)',
|
||||||
|
'POLICY_TEMPLATE_OWA_EXCHANGE_2010_HTTPS': 'OWA Exchange 2010 (https)',
|
||||||
|
'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTP': 'Oracle 10g Portal (http)',
|
||||||
|
'POLICY_TEMPLATE_ORACLE_10G_PORTAL_HTTPS': 'Oracle 10g Portal (https)',
|
||||||
|
'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTP': 'Oracle Applications 11i (http)',
|
||||||
|
'POLICY_TEMPLATE_ORACLE_APPLICATIONS_11I_HTTPS': 'Oracle Applications 11i (https)',
|
||||||
|
'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTP': 'PeopleSoft Portal 9 (http)',
|
||||||
|
'POLICY_TEMPLATE_PEOPLESOFT_PORTAL_9_HTTPS': 'PeopleSoft Portal 9 (https)',
|
||||||
|
'POLICY_TEMPLATE_RAPID_DEPLOYMENT': 'Rapid Deployment Policy',
|
||||||
|
'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTP': 'SAP NetWeaver 7 (http)',
|
||||||
|
'POLICY_TEMPLATE_SAP_NETWEAVER_7_HTTPS': 'SAP NetWeaver 7 (https)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2003_HTTP': 'SharePoint 2003 (http)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2003_HTTPS': 'SharePoint 2003 (https)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2007_HTTP': 'SharePoint 2007 (http)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2007_HTTPS': 'SharePoint 2007 (https)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2010_HTTP': 'SharePoint 2010 (http)',
|
||||||
|
'POLICY_TEMPLATE_SHAREPOINT_2010_HTTPS': 'SharePoint 2010 (https)',
|
||||||
|
'POLICY_TEMPLATE_VULNERABILITY_ASSESSMENT': 'Vulnerability Assessment Baseline',
|
||||||
|
'POLICY_TEMPLATE_WORDPRESS': 'Wordpress',
|
||||||
|
}
|
||||||
|
return template_map[self._values['template']]
|
||||||
|
|
||||||
|
|
||||||
|
class Difference(object):
|
||||||
|
def __init__(self, want, have=None):
|
||||||
|
self.want = want
|
||||||
|
self.have = have
|
||||||
|
|
||||||
|
def compare(self, param):
|
||||||
|
try:
|
||||||
|
result = getattr(self, param)
|
||||||
|
return result
|
||||||
|
except AttributeError:
|
||||||
|
return self.__default(param)
|
||||||
|
|
||||||
|
def __default(self, param):
|
||||||
|
attr1 = getattr(self.want, param)
|
||||||
|
try:
|
||||||
|
attr2 = getattr(self.have, param)
|
||||||
|
if attr1 != attr2:
|
||||||
|
return attr1
|
||||||
|
except AttributeError:
|
||||||
|
return attr1
|
||||||
|
|
||||||
|
@property
|
||||||
|
def active(self):
|
||||||
|
if self.want.active is True and self.have.active is False:
|
||||||
|
return True
|
||||||
|
if self.want.active is False and self.have.active is True:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class BaseManager(object):
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
self.client = kwargs.get('client', None)
|
||||||
|
self.module = kwargs.get('module', None)
|
||||||
|
self.have = None
|
||||||
|
self.changes = Changes()
|
||||||
|
|
||||||
|
def exec_module(self):
|
||||||
|
changed = False
|
||||||
|
result = dict()
|
||||||
|
state = self.want.state
|
||||||
|
|
||||||
|
if state == "present":
|
||||||
|
changed = self.present()
|
||||||
|
elif state == "absent":
|
||||||
|
changed = self.absent()
|
||||||
|
|
||||||
|
changes = self.changes.to_return()
|
||||||
|
result.update(**changes)
|
||||||
|
result.update(dict(changed=changed))
|
||||||
|
return result
|
||||||
|
|
||||||
|
def _set_changed_options(self):
|
||||||
|
changed = {}
|
||||||
|
for key in Parameters.returnables:
|
||||||
|
if getattr(self.want, key) is not None:
|
||||||
|
changed[key] = getattr(self.want, key)
|
||||||
|
if changed:
|
||||||
|
self.changes = Changes(params=changed)
|
||||||
|
|
||||||
|
def should_update(self):
|
||||||
|
result = self._update_changed_options()
|
||||||
|
if result:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _update_changed_options(self):
|
||||||
|
diff = Difference(self.want, self.have)
|
||||||
|
updatables = Parameters.updatables
|
||||||
|
changed = dict()
|
||||||
|
for k in updatables:
|
||||||
|
change = diff.compare(k)
|
||||||
|
if change is None:
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
if isinstance(change, dict):
|
||||||
|
changed.update(change)
|
||||||
|
else:
|
||||||
|
changed[k] = change
|
||||||
|
if changed:
|
||||||
|
self.changes = Changes(params=changed)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def present(self):
|
||||||
|
if self.exists():
|
||||||
|
return self.update()
|
||||||
|
else:
|
||||||
|
return self.create()
|
||||||
|
|
||||||
|
def absent(self):
|
||||||
|
if not self.exists():
|
||||||
|
return False
|
||||||
|
else:
|
||||||
|
return self.remove()
|
||||||
|
|
||||||
|
def create(self):
|
||||||
|
if self.want.active is None:
|
||||||
|
self.want.update(dict(active=False))
|
||||||
|
self._set_changed_options()
|
||||||
|
if self.module.check_mode:
|
||||||
|
return True
|
||||||
|
|
||||||
|
if self.want.template is not None:
|
||||||
|
self.create_from_template()
|
||||||
|
if self.want.template is None:
|
||||||
|
self.create_blank()
|
||||||
|
if self.want.active:
|
||||||
|
self.activate()
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return True
|
||||||
|
|
||||||
|
def update(self):
|
||||||
|
self.have = self.read_current_from_device()
|
||||||
|
if not self.should_update():
|
||||||
|
return False
|
||||||
|
if self.module.check_mode:
|
||||||
|
return True
|
||||||
|
self.update_on_device()
|
||||||
|
if self.changes.active:
|
||||||
|
self.activate()
|
||||||
|
return True
|
||||||
|
|
||||||
|
def activate(self):
|
||||||
|
self.have = self.read_current_from_device()
|
||||||
|
task_id = self.apply_on_device()
|
||||||
|
if self.wait_for_task(task_id):
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
raise F5ModuleError('Apply policy task failed.')
|
||||||
|
|
||||||
|
def create_blank(self):
|
||||||
|
self.create_on_device()
|
||||||
|
if self.exists():
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(
|
||||||
|
'Failed to create ASM policy: {0}'.format(self.want.name)
|
||||||
|
)
|
||||||
|
|
||||||
|
def remove(self):
|
||||||
|
if self.module.check_mode:
|
||||||
|
return True
|
||||||
|
self.remove_from_device()
|
||||||
|
if self.exists():
|
||||||
|
raise F5ModuleError(
|
||||||
|
'Failed to delete ASM policy: {0}'.format(self.want.name)
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
def is_activated(self):
|
||||||
|
if self.want.active is True:
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
|
||||||
|
def exists(self):
|
||||||
|
uri = 'https://{0}:{1}/mgmt/tm/asm/policies/'.format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
|
||||||
|
query = "?$filter=contains(name,'{0}')+and+contains(partition,'{1}')&$select=name,partition".format(
|
||||||
|
self.want.name, self.want.partition
|
||||||
|
)
|
||||||
|
resp = self.client.api.get(uri + query)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
if 'items' in response and response['items'] != []:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def wait_for_task(self, task_id):
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/tasks/apply-policy/{2}".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
task_id
|
||||||
|
)
|
||||||
|
while True:
|
||||||
|
resp = self.client.api.get(uri)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] == 400:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
|
||||||
|
if response['status'] in ['COMPLETED', 'FAILURE']:
|
||||||
|
break
|
||||||
|
time.sleep(1)
|
||||||
|
|
||||||
|
if response['status'] == 'FAILURE':
|
||||||
|
return False
|
||||||
|
if response['status'] == 'COMPLETED':
|
||||||
|
return True
|
||||||
|
|
||||||
|
def _get_policy_id(self):
|
||||||
|
policy_id = None
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policies/".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
query = "?$filter=contains(name,'{0}')+and+contains(partition,'{1}')&$select=name,id".format(
|
||||||
|
self.want.name, self.want.partition
|
||||||
|
)
|
||||||
|
resp = self.client.api.get(uri + query)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'items' in response and response['items'] != []:
|
||||||
|
policy_id = response['items'][0]['id']
|
||||||
|
if not policy_id:
|
||||||
|
raise F5ModuleError("The policy was not found")
|
||||||
|
|
||||||
|
return policy_id
|
||||||
|
|
||||||
|
def update_on_device(self):
|
||||||
|
params = self.changes.api_params()
|
||||||
|
policy_id = self._get_policy_id()
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policies/{2}".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
policy_id
|
||||||
|
)
|
||||||
|
if not params['active']:
|
||||||
|
resp = self.client.api.patch(uri, json=params)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] == 400:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
|
||||||
|
def read_current_from_device(self):
|
||||||
|
policy_id = self._get_policy_id()
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policies/{2}".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
policy_id
|
||||||
|
)
|
||||||
|
resp = self.client.api.get(uri)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] == 400:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
|
||||||
|
response.update((dict(self_link=response['selfLink'])))
|
||||||
|
|
||||||
|
return Parameters(params=response)
|
||||||
|
|
||||||
|
def apply_on_device(self):
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/tasks/apply-policy/".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
params = dict(policyReference={'link': self.have.self_link})
|
||||||
|
resp = self.client.api.post(uri, json=params)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] in [400, 403]:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
return response['id']
|
||||||
|
|
||||||
|
def create_from_template_on_device(self):
|
||||||
|
full_name = fq_name(self.want.partition, self.want.name)
|
||||||
|
cmd = 'tmsh create asm policy {0} policy-template {1}'.format(full_name, self.want.template)
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/util/bash/".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
args = dict(
|
||||||
|
command='run',
|
||||||
|
utilCmdArgs='-c "{0}"'.format(cmd)
|
||||||
|
)
|
||||||
|
resp = self.client.api.post(uri, json=args)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
if 'commandResult' in response:
|
||||||
|
if 'Unexpected Error' in response['commandResult']:
|
||||||
|
raise F5ModuleError(response['commandResult'])
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] == 400:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
|
||||||
|
def create_on_device(self):
|
||||||
|
params = self.changes.api_params()
|
||||||
|
params['name'] = self.want.name
|
||||||
|
params['partition'] = self.want.partition
|
||||||
|
# we need to remove active from params as API will raise an error if the active is set to True,
|
||||||
|
# policies can only be activated via apply-policy task endpoint.
|
||||||
|
params.pop('active')
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policies/".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
)
|
||||||
|
resp = self.client.api.post(uri, json=params)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = resp.json()
|
||||||
|
except ValueError as ex:
|
||||||
|
raise F5ModuleError(str(ex))
|
||||||
|
|
||||||
|
if 'code' in response and response['code'] in [400, 401, 403]:
|
||||||
|
if 'message' in response:
|
||||||
|
raise F5ModuleError(response['message'])
|
||||||
|
else:
|
||||||
|
raise F5ModuleError(resp.content)
|
||||||
|
time.sleep(2)
|
||||||
|
return True
|
||||||
|
|
||||||
|
def remove_from_device(self):
|
||||||
|
policy_id = self._get_policy_id()
|
||||||
|
uri = "https://{0}:{1}/mgmt/tm/asm/policies/{2}".format(
|
||||||
|
self.client.provider['server'],
|
||||||
|
self.client.provider['server_port'],
|
||||||
|
policy_id
|
||||||
|
)
|
||||||
|
response = self.client.api.delete(uri)
|
||||||
|
if response.status in [200, 201]:
|
||||||
|
return True
|
||||||
|
raise F5ModuleError(response.content)
|
||||||
|
|
||||||
|
|
||||||
|
class ModuleManager(object):
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
self.client = kwargs.get('client', None)
|
||||||
|
self.kwargs = kwargs
|
||||||
|
|
||||||
|
def exec_module(self):
|
||||||
|
if not module_provisioned(self.client, 'asm'):
|
||||||
|
raise F5ModuleError(
|
||||||
|
"ASM must be provisioned to use this module."
|
||||||
|
)
|
||||||
|
if self.version_is_less_than_13():
|
||||||
|
manager = self.get_manager('v1')
|
||||||
|
else:
|
||||||
|
manager = self.get_manager('v2')
|
||||||
|
return manager.exec_module()
|
||||||
|
|
||||||
|
def get_manager(self, type):
|
||||||
|
if type == 'v1':
|
||||||
|
return V1Manager(**self.kwargs)
|
||||||
|
elif type == 'v2':
|
||||||
|
return V2Manager(**self.kwargs)
|
||||||
|
|
||||||
|
def version_is_less_than_13(self):
|
||||||
|
version = tmos_version(self.client)
|
||||||
|
if LooseVersion(version) < LooseVersion('13.0.0'):
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class V1Manager(BaseManager):
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
client = kwargs.get('client', None)
|
||||||
|
module = kwargs.get('module', None)
|
||||||
|
super(V1Manager, self).__init__(client=client, module=module)
|
||||||
|
self.want = V1Parameters(params=module.params, client=client)
|
||||||
|
|
||||||
|
def create_from_template(self):
|
||||||
|
self.create_from_template_on_device()
|
||||||
|
|
||||||
|
|
||||||
|
class V2Manager(BaseManager):
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
client = kwargs.get('client', None)
|
||||||
|
module = kwargs.get('module', None)
|
||||||
|
super(V2Manager, self).__init__(client=client, module=module)
|
||||||
|
self.want = V2Parameters(params=module.params, client=client)
|
||||||
|
|
||||||
|
# TODO Include creating ASM policies from custom templates in v13
|
||||||
|
|
||||||
|
def create_from_template(self):
|
||||||
|
if not self.create_from_template_on_device():
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
class ArgumentSpec(object):
|
||||||
|
def __init__(self):
|
||||||
|
self.template_map = [
|
||||||
|
'ActiveSync v1.0 v2.0 (http)',
|
||||||
|
'ActiveSync v1.0 v2.0 (https)',
|
||||||
|
'Comprehensive',
|
||||||
|
'Drupal',
|
||||||
|
'Fundamental',
|
||||||
|
'Joomla',
|
||||||
|
'LotusDomino 6.5 (http)',
|
||||||
|
'LotusDomino 6.5 (https)',
|
||||||
|
'OWA Exchange 2003 (http)',
|
||||||
|
'OWA Exchange 2003 (https)',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (http)',
|
||||||
|
'OWA Exchange 2003 with ActiveSync (https)',
|
||||||
|
'OWA Exchange 2007 (http)',
|
||||||
|
'OWA Exchange 2007 (https)',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (http)',
|
||||||
|
'OWA Exchange 2007 with ActiveSync (https)',
|
||||||
|
'OWA Exchange 2010 (http)',
|
||||||
|
'OWA Exchange 2010 (https)',
|
||||||
|
'Oracle 10g Portal (http)',
|
||||||
|
'Oracle 10g Portal (https)',
|
||||||
|
'Oracle Applications 11i (http)',
|
||||||
|
'Oracle Applications 11i (https)',
|
||||||
|
'PeopleSoft Portal 9 (http)',
|
||||||
|
'PeopleSoft Portal 9 (https)',
|
||||||
|
'Rapid Deployment Policy',
|
||||||
|
'SAP NetWeaver 7 (http)',
|
||||||
|
'SAP NetWeaver 7 (https)',
|
||||||
|
'SharePoint 2003 (http)',
|
||||||
|
'SharePoint 2003 (https)',
|
||||||
|
'SharePoint 2007 (http)',
|
||||||
|
'SharePoint 2007 (https)',
|
||||||
|
'SharePoint 2010 (http)',
|
||||||
|
'SharePoint 2010 (https)',
|
||||||
|
'Vulnerability Assessment Baseline',
|
||||||
|
'Wordpress',
|
||||||
|
]
|
||||||
|
self.supports_check_mode = True
|
||||||
|
argument_spec = dict(
|
||||||
|
name=dict(
|
||||||
|
required=True,
|
||||||
|
),
|
||||||
|
template=dict(
|
||||||
|
choices=self.template_map
|
||||||
|
),
|
||||||
|
active=dict(
|
||||||
|
type='bool',
|
||||||
|
default='no'
|
||||||
|
),
|
||||||
|
state=dict(
|
||||||
|
default='present',
|
||||||
|
choices=['present', 'absent']
|
||||||
|
),
|
||||||
|
partition=dict(
|
||||||
|
default='Common',
|
||||||
|
fallback=(env_fallback, ['F5_PARTITION'])
|
||||||
|
)
|
||||||
|
)
|
||||||
|
self.argument_spec = {}
|
||||||
|
self.argument_spec.update(f5_argument_spec)
|
||||||
|
self.argument_spec.update(argument_spec)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
spec = ArgumentSpec()
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=spec.argument_spec,
|
||||||
|
supports_check_mode=spec.supports_check_mode,
|
||||||
|
)
|
||||||
|
|
||||||
|
client = F5RestClient(**module.params)
|
||||||
|
|
||||||
|
try:
|
||||||
|
mm = ModuleManager(module=module, client=client)
|
||||||
|
results = mm.exec_module()
|
||||||
|
cleanup_tokens(client)
|
||||||
|
exit_json(module, results, client)
|
||||||
|
except F5ModuleError as ex:
|
||||||
|
cleanup_tokens(client)
|
||||||
|
fail_json(module, ex, client)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
499
test/units/modules/network/f5/test_bigip_asm_policy_manage.py
Normal file
499
test/units/modules/network/f5/test_bigip_asm_policy_manage.py
Normal file
|
@ -0,0 +1,499 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright: (c) 2018, F5 Networks Inc.
|
||||||
|
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import os
|
||||||
|
import json
|
||||||
|
import pytest
|
||||||
|
import sys
|
||||||
|
|
||||||
|
if sys.version_info < (2, 7):
|
||||||
|
pytestmark = pytest.mark.skip("F5 Ansible modules require Python >= 2.7")
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
|
try:
|
||||||
|
from library.modules.bigip_asm_policy_manage import V1Parameters
|
||||||
|
from library.modules.bigip_asm_policy_manage import V2Parameters
|
||||||
|
from library.modules.bigip_asm_policy_manage import ModuleManager
|
||||||
|
from library.modules.bigip_asm_policy_manage import V1Manager
|
||||||
|
from library.modules.bigip_asm_policy_manage import V2Manager
|
||||||
|
from library.modules.bigip_asm_policy_manage import ArgumentSpec
|
||||||
|
|
||||||
|
from library.module_utils.network.f5.common import F5ModuleError
|
||||||
|
|
||||||
|
# In Ansible 2.8, Ansible changed import paths.
|
||||||
|
from test.units.compat import unittest
|
||||||
|
from test.units.compat.mock import Mock
|
||||||
|
from test.units.compat.mock import patch
|
||||||
|
|
||||||
|
from test.units.modules.utils import set_module_args
|
||||||
|
except ImportError:
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import V1Parameters
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import V2Parameters
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import ModuleManager
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import V1Manager
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import V2Manager
|
||||||
|
from ansible.modules.network.f5.bigip_asm_policy_manage import ArgumentSpec
|
||||||
|
|
||||||
|
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||||
|
|
||||||
|
# Ansible 2.8 imports
|
||||||
|
from units.compat import unittest
|
||||||
|
from units.compat.mock import Mock
|
||||||
|
from units.compat.mock import patch
|
||||||
|
|
||||||
|
from units.modules.utils import set_module_args
|
||||||
|
|
||||||
|
|
||||||
|
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||||
|
fixture_data = {}
|
||||||
|
|
||||||
|
|
||||||
|
def load_fixture(name):
|
||||||
|
path = os.path.join(fixture_path, name)
|
||||||
|
|
||||||
|
if path in fixture_data:
|
||||||
|
return fixture_data[path]
|
||||||
|
|
||||||
|
with open(path) as f:
|
||||||
|
data = f.read()
|
||||||
|
|
||||||
|
try:
|
||||||
|
data = json.loads(data)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
fixture_data[path] = data
|
||||||
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
class TestParameters(unittest.TestCase):
|
||||||
|
def test_module_parameters_template(self):
|
||||||
|
args = dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
template='LotusDomino 6.5 (http)'
|
||||||
|
)
|
||||||
|
|
||||||
|
p = V1Parameters(params=args)
|
||||||
|
assert p.name == 'fake_policy'
|
||||||
|
assert p.state == 'present'
|
||||||
|
assert p.template == 'POLICY_TEMPLATE_LOTUSDOMINO_6_5_HTTP'
|
||||||
|
|
||||||
|
|
||||||
|
class TestManager(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
self.spec = ArgumentSpec()
|
||||||
|
self.policy = os.path.join(fixture_path, 'fake_policy.xml')
|
||||||
|
self.patcher1 = patch('time.sleep')
|
||||||
|
self.patcher1.start()
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.p1 = patch('library.modules.bigip_asm_policy_manage.module_provisioned')
|
||||||
|
self.m1 = self.p1.start()
|
||||||
|
self.m1.return_value = True
|
||||||
|
except Exception:
|
||||||
|
self.p1 = patch('ansible.modules.network.f5.bigip_asm_policy_manage.module_provisioned')
|
||||||
|
self.m1 = self.p1.start()
|
||||||
|
self.m1.return_value = True
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.patcher1.stop()
|
||||||
|
self.p1.stop()
|
||||||
|
|
||||||
|
def test_activate_create_from_template(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
template='OWA Exchange 2007 (https)',
|
||||||
|
state='present',
|
||||||
|
active='yes',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=False)
|
||||||
|
v1.import_to_device = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(side_effect=[True, True])
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.apply_on_device = Mock(return_value=True)
|
||||||
|
v1.create_from_template_on_device = Mock(return_value=True)
|
||||||
|
v1._file_is_missing = Mock(return_value=False)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['name'] == 'fake_policy'
|
||||||
|
assert results['template'] == 'OWA Exchange 2007 (https)'
|
||||||
|
assert results['active'] is True
|
||||||
|
|
||||||
|
def test_activate_create_by_name(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
active='yes',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=False)
|
||||||
|
v1.import_to_device = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(side_effect=[True, True])
|
||||||
|
v1.create_on_device = Mock(return_value=True)
|
||||||
|
v1.create_blank = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.apply_on_device = Mock(return_value=True)
|
||||||
|
v1._file_is_missing = Mock(return_value=False)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['name'] == 'fake_policy'
|
||||||
|
assert results['active'] is True
|
||||||
|
|
||||||
|
def test_activate_policy_exists_inactive(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
active='yes',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=True)
|
||||||
|
v1.update_on_device = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(side_effect=[True, True])
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.apply_on_device = Mock(return_value=True)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['active'] is True
|
||||||
|
|
||||||
|
def test_activate_policy_exists_active(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
active='yes',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_active.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is False
|
||||||
|
|
||||||
|
def test_deactivate_policy_exists_active(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
active='no'
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_active.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.update_on_device = Mock(return_value=True)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['active'] is False
|
||||||
|
|
||||||
|
def test_deactivate_policy_exists_inactive(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
active='no'
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is False
|
||||||
|
|
||||||
|
def test_create_from_template(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
template='LotusDomino 6.5 (http)',
|
||||||
|
state='present',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=False)
|
||||||
|
v1.create_from_template_on_device = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(side_effect=[True, True])
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1._file_is_missing = Mock(return_value=False)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['name'] == 'fake_policy'
|
||||||
|
assert results['template'] == 'LotusDomino 6.5 (http)'
|
||||||
|
assert results['active'] is False
|
||||||
|
|
||||||
|
def test_create_by_name(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=False)
|
||||||
|
v1.import_to_device = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(side_effect=[True, True])
|
||||||
|
v1.create_on_device = Mock(return_value=True)
|
||||||
|
v1.create_blank = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.apply_on_device = Mock(return_value=True)
|
||||||
|
v1._file_is_missing = Mock(return_value=False)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
assert results['name'] == 'fake_policy'
|
||||||
|
assert results['active'] is False
|
||||||
|
|
||||||
|
def test_delete_policy(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='absent',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(side_effect=[True, False])
|
||||||
|
v1.remove_from_device = Mock(return_value=True)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
results = mm.exec_module()
|
||||||
|
|
||||||
|
assert results['changed'] is True
|
||||||
|
|
||||||
|
def test_activate_policy_raises(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
active='yes',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
current = V1Parameters(params=load_fixture('load_asm_policy_inactive.json'))
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
msg = 'Apply policy task failed.'
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=True)
|
||||||
|
v1.wait_for_task = Mock(return_value=False)
|
||||||
|
v1.update_on_device = Mock(return_value=True)
|
||||||
|
v1.read_current_from_device = Mock(return_value=current)
|
||||||
|
v1.apply_on_device = Mock(return_value=True)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
with pytest.raises(F5ModuleError) as err:
|
||||||
|
mm.exec_module()
|
||||||
|
assert str(err.value) == msg
|
||||||
|
|
||||||
|
def test_create_policy_raises(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='present',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
|
||||||
|
msg = 'Failed to create ASM policy: fake_policy'
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(return_value=False)
|
||||||
|
v1.create_on_device = Mock(return_value=False)
|
||||||
|
v1._file_is_missing = Mock(return_value=False)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
with pytest.raises(F5ModuleError) as err:
|
||||||
|
mm.exec_module()
|
||||||
|
assert str(err.value) == msg
|
||||||
|
|
||||||
|
def test_delete_policy_raises(self, *args):
|
||||||
|
set_module_args(dict(
|
||||||
|
name='fake_policy',
|
||||||
|
state='absent',
|
||||||
|
server='localhost',
|
||||||
|
password='password',
|
||||||
|
user='admin',
|
||||||
|
))
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.spec.argument_spec,
|
||||||
|
supports_check_mode=self.spec.supports_check_mode
|
||||||
|
)
|
||||||
|
msg = 'Failed to delete ASM policy: fake_policy'
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
v1 = V1Manager(module=module)
|
||||||
|
v1.exists = Mock(side_effect=[True, True])
|
||||||
|
v1.remove_from_device = Mock(return_value=True)
|
||||||
|
|
||||||
|
# Override methods to force specific logic in the module to happen
|
||||||
|
mm = ModuleManager(module=module)
|
||||||
|
mm.version_is_less_than_13 = Mock(return_value=False)
|
||||||
|
mm.get_manager = Mock(return_value=v1)
|
||||||
|
|
||||||
|
with pytest.raises(F5ModuleError) as err:
|
||||||
|
mm.exec_module()
|
||||||
|
assert str(err.value) == msg
|
Loading…
Reference in a new issue