scaleuptechnologies.idoit.idoit_cat_access module – Create or update a access category to an object

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_cat_access.

Synopsis

  • Adds C__CATG__ACCESS category to an object if not there or update values

Parameters

Parameter

Comments

description

string

Description of the Model

id

integer

i-doit category id to update

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.

obj_id

integer / required

i-doit object id

primary

boolean

Is this the primary access

Choices:

  • false

  • true

search_by_fields

list / elements=string

field names to compare to find a category to update. Please note, Dialog-Fields can only searched by id

state

string

State of the category

Choices:

  • "present" ← (default)

  • "absent"

  • "merge"

title

string

Title

type

string

Type of the Access

type_id

integer

Id of the type

url

string

Url

Examples

- name: Set a new Idrac
  scaleuptechnologies.idoit.idoit_cat_access:
    idoit: '{{ idoit_access }}'
    obj_id: 1320
    primary: false
    title: IDRAC
    type: BMC
    url: https://idrac-server1.example.org

Return Values

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

Key

Description

changed

boolean

Are there changes?

Returned: always

data

complex

New data

Returned: success

Sample: {"description": "", "firmware": "", "manufacturer_id": 5, "model_id": 22, "product_id": "", "serial": "Test 42", "service_tag": "CZJ037040C"}

id

integer

Category Id of the saved category

Returned: success

return

complex

I-Doit API Result

Returned: success

Authors

  • Sven Anders (during work by ScaleUp Technologies) (@tabacha)