scaleuptechnologies.idoit.idoit_cat_net_port module – Create or update a net_port 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_net_port.

Synopsis

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

Parameters

Parameter

Comments

active

boolean

Active

Choices:

  • false

  • true

addresses

list / elements=integer

Ids of the Adress Object-id

cable_id

integer

Id of the Cable

default_vlan_id

integer

Standard VLAN

description

string

Description of the Model

duplex_id

integer

Id of the duplex (1=Half, 2=Full)

hba_id

integer

Id of the HBA

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.

interface_id

integer

Id of the net_interface

mac

string

MAC-address

mtu

string

MTU (Maximum Transfer Unit)

negotiation_id

integer

Id of the negotiation (1=Automatic, 2=Manuell)

obj_id

integer / required

i-doit object id

plug_type

string

Plug Type (RJ-45,RJ-11, LC, SC)

plug_type_id

integer

Id of the Plug Type

port_mode

string

Mode (Standard, Stacking, Link Aggregation/Trunk)

port_mode_id

integer

Id of the Mode

port_type

string

Type (Ethernet, FR, ISDN, …)

port_type_id

integer

Id of the Type

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

speed

float

Speed of the Interface

speed_type

string

Unit of the Speed (bit/s,kbit/s,Mbit/s,Gbit/s)

speed_type_id

integer

Id of Speed Unit

standard

string

Standard

standard_id

integer

Id of Strandard

state

string

State of the category

Choices:

  • "present" ← (default)

  • "absent"

  • "merge"

title

string

Title

Examples

- name: Set Network Port
  scaleuptechnologies.idoit.idoit_cat_net_port:
    idoit: '{{ idoit_access_test }}'
    mac: C8:1F:66:CA:29:51
    obj_id: 4005
    plug_type: RJ-45
    search_by_fields:
    - title
    state: merge
    title: eth0

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)