archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

threat_indicator module (#61278)

Browse Source 
* threat_indicator module

* remove _

* add '-'

* update examples

* fix
pull/61506/head
chkp-orso 5 years ago committed by Sumit Jaiswal
parent 7f344b7729
commit a26ff97de6
2 changed files with 394 additions and 0 deletions
Show Stats Download Patch File Download Diff File

271
lib/ansible/modules/network/checkpoint/cp_mgmt_threat_indicator.py
Unescape Escape View File

@ -0,0 +1,271 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Ansible module to manage CheckPoint Firewall (c) 2019
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = """
---
module: cp_mgmt_threat_indicator
short_description: Manages threat-indicator objects on Checkpoint over Web Services API
description:
- Manages threat-indicator objects on Checkpoint devices including creating, updating and removing objects.
- All operations are performed over Web Services API.
version_added: "2.9"
author: "Or Soffer (@chkp-orso)"
options:
name:
description:
- Object name.
type: str
required: True
observables:
description:
- The indicator's observables.
type: list
suboptions:
name:
description:
- Object name. Should be unique in the domain.
type: str
md5:
description:
- A valid MD5 sequence.
type: str
url:
description:
- A valid URL.
type: str
ip_address:
description:
- A valid IP-Address.
type: str
ip_address_first:
description:
- A valid IP-Address, the beginning of the range. If you configure this parameter with a value, you must also configure the value of the
'ip-address-last' parameter.
type: str
ip_address_last:
description:
- A valid IP-Address, the end of the range. If you configure this parameter with a value, you must also configure the value of the
'ip-address-first' parameter.
type: str
domain:
description:
- The name of a domain.
type: str
mail_to:
description:
- A valid E-Mail address, recipient filed.
type: str
mail_from:
description:
- A valid E-Mail address, sender field.
type: str
mail_cc:
description:
- A valid E-Mail address, cc field.
type: str
mail_reply_to:
description:
- A valid E-Mail address, reply-to field.
type: str
mail_subject:
description:
- Subject of E-Mail.
type: str
confidence:
description:
- The confidence level the indicator has that a real threat has been uncovered.
type: str
choices: ['low', 'medium', 'high', 'critical']
product:
description:
- The software blade that processes the observable, AV - AntiVirus, AB - AntiBot.
type: str
choices: ['AV', 'AB']
severity:
description:
- The severity level of the threat.
type: str
choices: ['low', 'medium', 'high', 'critical']
comments:
description:
- Comments string.
type: str
ignore_warnings:
description:
- Apply changes ignoring warnings.
type: bool
ignore_errors:
description:
- Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
type: bool
observables_raw_data:
description:
- The contents of a file containing the indicator's observables.
type: str
action:
description:
- The indicator's action.
type: str
choices: ['Inactive', 'Ask', 'Prevent', 'Detect']
profile_overrides:
description:
- Profiles in which to override the indicator's default action.
type: list
suboptions:
action:
description:
- The indicator's action in this profile.
type: str
choices: ['Inactive', 'Ask', 'Prevent', 'Detect']
profile:
description:
- The profile in which to override the indicator's action.
type: str
tags:
description:
- Collection of tag identifiers.
type: list
color:
description:
- Color of the object. Should be one of existing colors.
type: str
choices: ['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green', 'khaki', 'orchid', 'dark orange', 'dark sea green',
'pink', 'turquoise', 'dark blue', 'firebrick', 'brown', 'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon',
'coral', 'sea green', 'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna', 'yellow']
comments:
description:
- Comments string.
type: str
details_level:
description:
- The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed
representation of the object.
type: str
choices: ['uid', 'standard', 'full']
ignore_warnings:
description:
- Apply changes ignoring warnings.
type: bool
ignore_errors:
description:
- Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
type: bool
extends_documentation_fragment: checkpoint_objects
"""
EXAMPLES = """
- name: add-threat-indicator
cp_mgmt_threat_indicator:
action: ask
ignore_warnings: true
name: My_Indicator
observables:
- confidence: medium
mail_to: someone@somewhere.com
name: My_Observable
product: AV
severity: low
profile_overrides:
- action: detect
profile: My_Profile
state: present
- name: set-threat-indicator
cp_mgmt_threat_indicator:
action: prevent
ignore_warnings: true
name: My_Indicator
state: present
- name: delete-threat-indicator
cp_mgmt_threat_indicator:
name: My_Indicator
state: absent
"""
RETURN = """
cp_mgmt_threat_indicator:
description: The checkpoint object created or updated.
returned: always, except when deleting the object.
type: dict
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.network.checkpoint.checkpoint import checkpoint_argument_spec_for_objects, api_call
def main():
argument_spec = dict(
name=dict(type='str', required=True),
observables=dict(type='list', options=dict(
name=dict(type='str'),
md5=dict(type='str'),
url=dict(type='str'),
ip_address=dict(type='str'),
ip_address_first=dict(type='str'),
ip_address_last=dict(type='str'),
domain=dict(type='str'),
mail_to=dict(type='str'),
mail_from=dict(type='str'),
mail_cc=dict(type='str'),
mail_reply_to=dict(type='str'),
mail_subject=dict(type='str'),
confidence=dict(type='str', choices=['low', 'medium', 'high', 'critical']),
product=dict(type='str', choices=['AV', 'AB']),
severity=dict(type='str', choices=['low', 'medium', 'high', 'critical']),
comments=dict(type='str'),
ignore_warnings=dict(type='bool'),
ignore_errors=dict(type='bool')
)),
observables_raw_data=dict(type='str'),
action=dict(type='str', choices=['Inactive', 'Ask', 'Prevent', 'Detect']),
profile_overrides=dict(type='list', options=dict(
action=dict(type='str', choices=['Inactive', 'Ask', 'Prevent', 'Detect']),
profile=dict(type='str')
)),
tags=dict(type='list'),
color=dict(type='str', choices=['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green',
'khaki', 'orchid', 'dark orange', 'dark sea green', 'pink', 'turquoise', 'dark blue', 'firebrick', 'brown',
'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon', 'coral', 'sea green',
'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna',
'yellow']),
comments=dict(type='str'),
details_level=dict(type='str', choices=['uid', 'standard', 'full']),
ignore_warnings=dict(type='bool'),
ignore_errors=dict(type='bool')
)
argument_spec.update(checkpoint_argument_spec_for_objects)
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
api_call_object = 'threat-indicator'
result = api_call(module, api_call_object)
module.exit_json(**result)
if __name__ == '__main__':
main()

123
lib/ansible/modules/network/checkpoint/cp_mgmt_threat_indicator_facts.py
Unescape Escape View File

@ -0,0 +1,123 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Ansible module to manage CheckPoint Firewall (c) 2019
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = """
---
module: cp_mgmt_threat_indicator_facts
short_description: Get threat-indicator objects facts on Checkpoint over Web Services API
description:
- Get threat-indicator objects facts on Checkpoint devices.
- All operations are performed over Web Services API.
- This module handles both operations, get a specific object and get several objects,
For getting a specific object use the parameter 'name'.
version_added: "2.9"
author: "Or Soffer (@chkp-orso)"
options:
name:
description:
- Object name.
This parameter is relevant only for getting a specific object.
type: str
details_level:
description:
- The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed
representation of the object.
type: str
choices: ['uid', 'standard', 'full']
limit:
description:
- No more than that many results will be returned.
This parameter is relevant only for getting few objects.
type: int
offset:
description:
- Skip that many results before beginning to return them.
This parameter is relevant only for getting few objects.
type: int
order:
description:
- Sorts results by the given field. By default the results are sorted in the ascending order by name.
This parameter is relevant only for getting few objects.
type: list
suboptions:
ASC:
description:
- Sorts results by the given field in ascending order.
type: str
choices: ['name']
DESC:
description:
- Sorts results by the given field in descending order.
type: str
choices: ['name']
extends_documentation_fragment: checkpoint_facts
"""
EXAMPLES = """
- name: show-threat-indicator
cp_mgmt_threat_indicator_facts:
name: My_Indicator
- name: show-threat-indicators
cp_mgmt_threat_indicator_facts:
"""
RETURN = """
ansible_facts:
description: The checkpoint object facts.
returned: always.
type: dict
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.network.checkpoint.checkpoint import checkpoint_argument_spec_for_facts, api_call_facts
def main():
argument_spec = dict(
name=dict(type='str'),
details_level=dict(type='str', choices=['uid', 'standard', 'full']),
limit=dict(type='int'),
offset=dict(type='int'),
order=dict(type='list', options=dict(
ASC=dict(type='str', choices=['name']),
DESC=dict(type='str', choices=['name'])
))
)
argument_spec.update(checkpoint_argument_spec_for_facts)
module = AnsibleModule(argument_spec=argument_spec)
api_call_object = "threat-indicator"
api_call_object_plural_version = "threat-indicators"
result = api_call_facts(module, api_call_object, api_call_object_plural_version)
module.exit_json(ansible_facts=result)
if __name__ == '__main__':
main()
Write Preview
Loading…
Cancel
Save