Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
ansible / check_point / mgmt / plugins / modules / checkpoint_host_facts.py
Size: Mime:
#!/usr/bin/python
#
# This file is part of Ansible
#
# 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": ["deprecated"],
    "supported_by": "network",
}


DOCUMENTATION = """module: checkpoint_host_facts
short_description: Get host objects facts on Check Point over Web Services API
description:
- Get host objects facts on Check Point devices. All operations are performed over
  Web Services API.
author: Ansible by Red Hat (@rcarrillocruz)
options:
  name:
    description:
    - Name of the host object. If name is not provided, UID is required.
    type: str
  uid:
    description:
    - UID of the host object. If UID is not provided, name is required.
    type: str
"""

EXAMPLES = """
- name: Get host object facts
  checkpoint_host_facts:
    name: attacker
"""

RETURN = """
ansible_hosts:
  description: The checkpoint host object facts.
  returned: always.
  type: list
"""


from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection


def get_host(module, connection):
    name = module.params["name"]
    uid = module.params["uid"]

    if uid:
        payload = {"uid": uid}
    elif name:
        payload = {"name": name}

    code, result = connection.send_request("/web_api/show-host", payload)

    return code, result


def main():
    argument_spec = dict(name=dict(type="str"), uid=dict(type="str"))

    required_one_of = [("name", "uid")]
    module = AnsibleModule(
        argument_spec=argument_spec, required_one_of=required_one_of
    )
    connection = Connection(module._socket_path)

    code, response = get_host(module, connection)

    if code == 200:
        module.exit_json(ansible_facts=dict(checkpoint_hosts=response))
    else:
        module.fail_json(
            msg="Checkpoint device returned error {0} with message {1}".format(
                code, response
            )
        )


if __name__ == "__main__":
    main()