Repository URL to install this package:
Version:
6.0.0 ▾
|
#!/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_delete_api_key
short_description: Delete the API key. For the key to be invalid publish is needed.
description:
- Delete the API key. For the key to be invalid publish is needed.
- All operations are performed over Web Services API.
version_added: "2.9"
author: "Or Soffer (@chkp-orso)"
options:
api_key:
description:
- API key to be deleted.
type: str
admin_uid:
description:
- Administrator uid to generate API key for.
type: str
admin_name:
description:
- Administrator name to generate API key for.
type: str
extends_documentation_fragment: check_point.mgmt.checkpoint_commands
"""
EXAMPLES = """
- name: delete-api-key
cp_mgmt_delete_api_key:
api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00
state: absent
"""
RETURN = """
cp_mgmt_delete_api_key:
description: The checkpoint delete-api-key output.
returned: always.
type: dict
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.check_point.mgmt.plugins.module_utils.checkpoint import checkpoint_argument_spec_for_commands, api_command
def main():
argument_spec = dict(
api_key=dict(type='str'),
admin_uid=dict(type='str'),
admin_name=dict(type='str')
)
argument_spec.update(checkpoint_argument_spec_for_commands)
module = AnsibleModule(argument_spec=argument_spec)
command = "delete-api-key"
result = api_command(module, command)
module.exit_json(**result)
if __name__ == '__main__':
main()