/ home / community / community.general / 8.5.0 / module / lxca_cmms

community.general.lxca_cmms (8.5.0) — module

Custom module for lxca cmms inventory utility

Authors: Naval Patel (@navalkp), Prashant Bhosale (@prabhosa)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module returns/displays a inventory details of cmms

Requirements

pylxca

Usage examples

Scanned by Steampunk Spotter

# get all cmms info
- name: Get nodes data from LXCA
  community.general.lxca_cmms:
    login_user: USERID
    login_password: Password
    auth_url: "https://10.243.15.168"

Scanned by Steampunk Spotter

# get specific cmms info by uuid
- name: Get nodes data from LXCA
  community.general.lxca_cmms:
    login_user: USERID
    login_password: Password
    auth_url: "https://10.243.15.168"
    uuid: "3C737AA5E31640CE949B10C129A8B01F"
    command_options: cmms_by_uuid

Scanned by Steampunk Spotter

# get specific cmms info by chassis uuid
- name: Get nodes data from LXCA
  community.general.lxca_cmms:
    login_user: USERID
    login_password: Password
    auth_url: "https://10.243.15.168"
    chassis: "3C737AA5E31640CE949B10C129A8B01F"
    command_options: cmms_by_chassis_uuid

Inputs

    
uuid:
    description: uuid of device, this is string with length greater than 16.
    type: str

chassis:
    description: uuid of chassis, this is string with length greater than 16.
    type: str

auth_url:
    description:
    - lxca HTTPS full web address.
    required: true
    type: str

login_user:
    description:
    - The username for use in HTTP basic authentication.
    required: true
    type: str

login_password:
    description:
    - The password for use in HTTP basic authentication.
    required: true
    type: str

command_options:
    choices:
    - cmms
    - cmms_by_uuid
    - cmms_by_chassis_uuid
    default: cmms
    description: options to filter nodes information
    type: str

Outputs

result:
  description: cmms detail from lxca
  returned: success
  sample:
    cmmList:
    - machineType: ''
      model: ''
      type: CMM
      uuid: 118D2C88C8FD11E4947B6EAE8B4BDCDF
    - machineType: ''
      model: ''
      type: CMM
      uuid: 223D2C88C8FD11E4947B6EAE8B4BDCDF
  type: dict