New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
dynamic_object module #61437
Merged
Merged
dynamic_object module #61437
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
129 changes: 129 additions & 0 deletions
129
lib/ansible/modules/network/checkpoint/cp_mgmt_dynamic_object.py
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,129 @@ | ||
#!/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_dynamic_object | ||
short_description: Manages dynamic-object objects on Checkpoint over Web Services API | ||
description: | ||
- Manages dynamic-object 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 | ||
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-dynamic-object | ||
cp_mgmt_dynamic_object: | ||
color: yellow | ||
comments: My Dynamic Object 1 | ||
name: Dynamic_Object_1 | ||
state: present | ||
|
||
- name: set-dynamic-object | ||
cp_mgmt_dynamic_object: | ||
name: Dynamic_Object_1 | ||
state: present | ||
|
||
- name: delete-dynamic-object | ||
cp_mgmt_dynamic_object: | ||
name: Dynamic_Object_2 | ||
state: absent | ||
""" | ||
|
||
RETURN = """ | ||
cp_mgmt_dynamic_object: | ||
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), | ||
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 = 'dynamic-object' | ||
|
||
result = api_call(module, api_call_object) | ||
module.exit_json(**result) | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
128 changes: 128 additions & 0 deletions
128
lib/ansible/modules/network/checkpoint/cp_mgmt_dynamic_object_facts.py
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,128 @@ | ||
#!/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_dynamic_object_facts | ||
short_description: Get dynamic-object objects facts on Checkpoint over Web Services API | ||
description: | ||
- Get dynamic-object 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'] | ||
show_membership: | ||
description: | ||
- Indicates whether to calculate and show "groups" field for every object in reply. | ||
type: bool | ||
extends_documentation_fragment: checkpoint_facts | ||
""" | ||
|
||
EXAMPLES = """ | ||
- name: show-dynamic-object | ||
cp_mgmt_dynamic_object_facts: | ||
name: Dynamic_Object_1 | ||
|
||
- name: show-dynamic-objects | ||
cp_mgmt_dynamic_object_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']) | ||
)), | ||
show_membership=dict(type='bool') | ||
) | ||
argument_spec.update(checkpoint_argument_spec_for_facts) | ||
|
||
module = AnsibleModule(argument_spec=argument_spec) | ||
|
||
api_call_object = "dynamic-object" | ||
api_call_object_plural_version = "dynamic-objects" | ||
|
||
result = api_call_facts(module, api_call_object, api_call_object_plural_version) | ||
module.exit_json(ansible_facts=result) | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chkp-amiads can u update the example here, as this example doesn't do anything extra
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This object is a "thin" object (like threat layer) we can add example for setting "generic" attribute like color/comment but i think it is not blocker. Can we skip it?