community.general.lxca_cmms – Custom module for lxca cmms inventory utility
community.general.lxca_cmms – Custom module for lxca cmms inventory utility
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.lxca_cmms
.
Synopsis
- This module returns/displays a inventory details of cmms
Requirements
The below requirements are needed on the host that executes this module.
- pylxca
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_url string / required |
lxca https full web address | |
chassis string |
uuid of chassis, this is string with length greater than 16. | |
command_options string |
|
options to filter nodes information |
login_password string / required |
The password for use in HTTP basic authentication. | |
login_user string / required |
The username for use in HTTP basic authentication. | |
uuid string |
uuid of device, this is string with length greater than 16. |
Notes
Note
- Additional detail about pylxca can be found at https://github.com/lenovo/pylxca
- Playbooks using these modules can be found at https://github.com/lenovo/ansible.lenovo-lxca
- Check mode is not supported.
Examples
# 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"
# 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
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
result dictionary |
success |
cmms detail from lxca
Sample: {'cmmList': [{'machineType': , 'model': , 'type': 'CMM', 'uuid': '118D2C88C8FD11E4947B6EAE8B4BDCDF'}, {'machineType': , 'model': , 'type': 'CMM', 'uuid': '223D2C88C8FD11E4947B6EAE8B4BDCDF'}]} |
Authors
- Naval Patel (@navalkp)
- Prashant Bhosale (@prabhosa)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/lxca_cmms_module.html