scaleuptechnologies.idoit.idoit_search module – Fulltext search in i-doit.

Note

This module is part of the scaleuptechnologies.idoit collection (version 0.20.0).

To install it, use: ansible-galaxy collection install scaleuptechnologies.idoit.

To use it in a playbook, specify: scaleuptechnologies.idoit.idoit_search.

Synopsis

• Fulltext search in i-doit. see https://kb.i-doit.com/display/en/Search or https://kb.i-doit.com/display/de/API+Methoden idoit.search

Parameters

Parameter	Comments
idoit dictionary / required	i-doit credentials
api_key string / required	The API Key for i-doit.
api_log boolean	Return an api log of the i-doit api. Choices: false ← (default) true
jrpc_url string / required	The Json RPC Url to i-doit.
password string / required	The password for the user.
user string / required	The username to login in i-doit.
only_exact_match boolean	Filter all results which are not exact the searchsting. Choices: false true
only_key string	Filter all results which are not exact this key.
search string / required	String to seach for

Examples

- name: Search for Server with name
  scaleuptechnologies.idoit.idoit_search:
    idoit: "{{ idoit_access }}"
    search: "ceph004.occ1.ham1.int.yco.de"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
result list / elements=string	List of Results Returned: always Sample: [{"documentId": 3024, "key": "Server > General > Title", "link": "/?objID=3024&catgID=1&cateID=3024&highlight=ceph004.occ1.ham1.int.yco.de", "score": 100, "status": "Normal", "type": "cmdb", "value": "ceph004.occ1.ham1.int.yco.de"}]

Authors

• Sven Anders (@tabacha)

Collection links

Issue Tracker Repository (Sources)